134 lines
3.9 KiB
Python
134 lines
3.9 KiB
Python
"""Component to interface with switches that can be controlled remotely."""
|
|
from __future__ import annotations
|
|
|
|
from dataclasses import dataclass
|
|
from datetime import timedelta
|
|
import logging
|
|
from typing import Any, final
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.const import (
|
|
SERVICE_TOGGLE,
|
|
SERVICE_TURN_OFF,
|
|
SERVICE_TURN_ON,
|
|
STATE_ON,
|
|
)
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers.config_validation import ( # noqa: F401
|
|
PLATFORM_SCHEMA,
|
|
PLATFORM_SCHEMA_BASE,
|
|
)
|
|
from homeassistant.helpers.entity import ToggleEntity, ToggleEntityDescription
|
|
from homeassistant.helpers.entity_component import EntityComponent
|
|
from homeassistant.helpers.typing import ConfigType
|
|
from homeassistant.loader import bind_hass
|
|
|
|
DOMAIN = "switch"
|
|
SCAN_INTERVAL = timedelta(seconds=30)
|
|
|
|
ENTITY_ID_FORMAT = DOMAIN + ".{}"
|
|
|
|
ATTR_TODAY_ENERGY_KWH = "today_energy_kwh"
|
|
ATTR_CURRENT_POWER_W = "current_power_w"
|
|
|
|
MIN_TIME_BETWEEN_SCANS = timedelta(seconds=10)
|
|
|
|
PROP_TO_ATTR = {
|
|
"current_power_w": ATTR_CURRENT_POWER_W,
|
|
"today_energy_kwh": ATTR_TODAY_ENERGY_KWH,
|
|
}
|
|
|
|
DEVICE_CLASS_OUTLET = "outlet"
|
|
DEVICE_CLASS_SWITCH = "switch"
|
|
|
|
DEVICE_CLASSES = [DEVICE_CLASS_OUTLET, DEVICE_CLASS_SWITCH]
|
|
|
|
DEVICE_CLASSES_SCHEMA = vol.All(vol.Lower, vol.In(DEVICE_CLASSES))
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
@bind_hass
|
|
def is_on(hass: HomeAssistant, entity_id: str) -> bool:
|
|
"""Return if the switch is on based on the statemachine.
|
|
|
|
Async friendly.
|
|
"""
|
|
return hass.states.is_state(entity_id, STATE_ON)
|
|
|
|
|
|
async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool:
|
|
"""Track states and offer events for switches."""
|
|
component = hass.data[DOMAIN] = EntityComponent(
|
|
_LOGGER, DOMAIN, hass, SCAN_INTERVAL
|
|
)
|
|
await component.async_setup(config)
|
|
|
|
component.async_register_entity_service(SERVICE_TURN_OFF, {}, "async_turn_off")
|
|
component.async_register_entity_service(SERVICE_TURN_ON, {}, "async_turn_on")
|
|
component.async_register_entity_service(SERVICE_TOGGLE, {}, "async_toggle")
|
|
|
|
return True
|
|
|
|
|
|
async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
|
"""Set up a config entry."""
|
|
component: EntityComponent = hass.data[DOMAIN]
|
|
return await component.async_setup_entry(entry)
|
|
|
|
|
|
async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
|
"""Unload a config entry."""
|
|
component: EntityComponent = hass.data[DOMAIN]
|
|
return await component.async_unload_entry(entry)
|
|
|
|
|
|
@dataclass
|
|
class SwitchEntityDescription(ToggleEntityDescription):
|
|
"""A class that describes switch entities."""
|
|
|
|
|
|
class SwitchEntity(ToggleEntity):
|
|
"""Base class for switch entities."""
|
|
|
|
entity_description: SwitchEntityDescription
|
|
_attr_current_power_w: float | None = None
|
|
_attr_today_energy_kwh: float | None = None
|
|
|
|
@property
|
|
def current_power_w(self) -> float | None:
|
|
"""Return the current power usage in W."""
|
|
return self._attr_current_power_w
|
|
|
|
@property
|
|
def today_energy_kwh(self) -> float | None:
|
|
"""Return the today total energy usage in kWh."""
|
|
return self._attr_today_energy_kwh
|
|
|
|
@final
|
|
@property
|
|
def state_attributes(self) -> dict[str, Any] | None:
|
|
"""Return the optional state attributes."""
|
|
data = {}
|
|
|
|
for prop, attr in PROP_TO_ATTR.items():
|
|
value = getattr(self, prop)
|
|
if value is not None:
|
|
data[attr] = value
|
|
|
|
return data
|
|
|
|
|
|
class SwitchDevice(SwitchEntity):
|
|
"""Representation of a switch (for backwards compatibility)."""
|
|
|
|
def __init_subclass__(cls, **kwargs: Any) -> None:
|
|
"""Print deprecation warning."""
|
|
super().__init_subclass__(**kwargs) # type: ignore[call-arg]
|
|
_LOGGER.warning(
|
|
"SwitchDevice is deprecated, modify %s to extend SwitchEntity",
|
|
cls.__name__,
|
|
)
|