switch.py

Go to the documentation of this file.

"""Support for Orvibo S20 Wifi Smart Switches."""
 
from __future__ import annotations
 
import logging
from typing import Any
 
from orvibo.s20 import S20, S20Exception, discover
import voluptuous as vol
 
from homeassistant.components.switch import (
    PLATFORM_SCHEMA as SWITCH_PLATFORM_SCHEMA,
    SwitchEntity,
)
from homeassistant.const import (
    CONF_DISCOVERY,
    CONF_HOST,
    CONF_MAC,
    CONF_NAME,
    CONF_SWITCHES,
)
from homeassistant.core import HomeAssistant
import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
_LOGGER = logging.getLogger(__name__)
 
DEFAULT_NAME = "Orvibo S20 Switch"
DEFAULT_DISCOVERY = True
 
PLATFORM_SCHEMA = SWITCH_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_SWITCHES, default=[]): vol.All(
            cv.ensure_list,
            [
                {
                    vol.Required(CONF_HOST): cv.string,
                    vol.Optional(CONF_MAC): cv.string,
                    vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
                }
            ],
        ),
        vol.Optional(CONF_DISCOVERY, default=DEFAULT_DISCOVERY): cv.boolean,
    }
)
 
 
def setup_platform(
    hass: HomeAssistant,
    config: ConfigType,
    add_entities_callback: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None,
) -> None:
    """Set up S20 switches."""
 
    switch_data = {}
    switches = []
    switch_conf = config.get(CONF_SWITCHES, [config])
 
    if config.get(CONF_DISCOVERY):
        _LOGGER.debug("Discovering S20 switches")
        switch_data.update(discover())
 
    for switch in switch_conf:
        switch_data[switch.get(CONF_HOST)] = switch
 
    for host, data in switch_data.items():
        try:
            switches.append(
                S20Switch(data.get(CONF_NAME), S20(host, mac=data.get(CONF_MAC)))
            )
            _LOGGER.debug("Initialized S20 at %s", host)
        except S20Exception:
            _LOGGER.error("S20 at %s couldn't be initialized", host)
 
    add_entities_callback(switches)
 
 
class S20Switch(SwitchEntity):
    """Representation of an S20 switch."""
 
    def __init__(self, name, s20):
        """Initialize the S20 device."""
 
        self._name_name = name
        self._s20_s20 = s20
        self._state_state = False
        self._exc_exc = S20Exception
 
    @property
    def name(self):
        """Return the name of the switch."""
        return self._name_name
 
    @property
    def is_on(self):
        """Return true if device is on."""
        return self._state_state
 
    def update(self) -> None:
        """Update device state."""
        try:
            self._state_state = self._s20_s20.on
        except self._exc_exc:
            _LOGGER.exception("Error while fetching S20 state")
 
    def turn_on(self, **kwargs: Any) -> None:
        """Turn the device on."""
        try:
            self._s20_s20.on = True
        except self._exc_exc:
            _LOGGER.exception("Error while turning on S20")
 
    def turn_off(self, **kwargs: Any) -> None:
        """Turn the device off."""
        try:
            self._s20_s20.on = False
        except self._exc_exc:
            _LOGGER.exception("Error while turning off S20")