switch.py

Go to the documentation of this file.

"""Support for HomeMatic switches."""
 
from __future__ import annotations
 
from typing import Any
 
from homeassistant.components.switch import SwitchEntity
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
from .const import ATTR_DISCOVER_DEVICES
from .entity import HMDevice
 
 
def setup_platform(
    hass: HomeAssistant,
    config: ConfigType,
    add_entities: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None,
) -> None:
    """Set up the HomeMatic switch platform."""
    if discovery_info is None:
        return
 
    devices = []
    for conf in discovery_info[ATTR_DISCOVER_DEVICES]:
        new_device = HMSwitch(conf)
        devices.append(new_device)
 
    add_entities(devices, True)
 
 
class HMSwitch(HMDevice, SwitchEntity):
    """Representation of a HomeMatic switch."""
 
    @property
    def is_on(self):
        """Return True if switch is on."""
        try:
            return self._hm_get_state_hm_get_state() > 0
        except TypeError:
            return False
 
    @property
    def today_energy_kwh(self):
        """Return the current power usage in kWh."""
        if "ENERGY_COUNTER" in self._data:
            try:
                return self._data["ENERGY_COUNTER"] / 1000
            except ZeroDivisionError:
                return 0
 
        return None
 
    def turn_on(self, **kwargs: Any) -> None:
        """Turn the switch on."""
        self._hmdevice_hmdevice.on(self._channel_channel)
 
    def turn_off(self, **kwargs: Any) -> None:
        """Turn the switch off."""
        self._hmdevice_hmdevice.off(self._channel_channel)
 
    def _init_data_struct(self):
        """Generate the data dictionary (self._data) from metadata."""
        self._state_state_state = "STATE"
        self._data.update({self._state_state_state: None})
 
        # Need sensor values for SwitchPowermeter
        for node in self._hmdevice_hmdevice.SENSORNODE:
            self._data.update({node: None})