switch.py

Go to the documentation of this file.

"""Support for PCA 301 smart switch."""
 
from __future__ import annotations
 
import logging
from typing import Any
 
import pypca
from serial import SerialException
 
from homeassistant.components.switch import SwitchEntity
from homeassistant.const import EVENT_HOMEASSISTANT_STOP
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
_LOGGER = logging.getLogger(__name__)
 
DEFAULT_NAME = "PCA 301"
 
 
def setup_platform(
    hass: HomeAssistant,
    config: ConfigType,
    add_entities: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None,
) -> None:
    """Set up the PCA switch platform."""
 
    if discovery_info is None:
        return
 
    serial_device = discovery_info["device"]
 
    try:
        pca = pypca.PCA(serial_device)
        pca.open()
 
        entities = [SmartPlugSwitch(pca, device) for device in pca.get_devices()]
        add_entities(entities, True)
 
    except SerialException as exc:
        _LOGGER.warning("Unable to open serial port: %s", exc)
        return
 
    hass.bus.listen_once(EVENT_HOMEASSISTANT_STOP, pca.close)
 
    pca.start_scan()
 
 
class SmartPlugSwitch(SwitchEntity):
    """Representation of a PCA Smart Plug switch."""
 
    def __init__(self, pca, device_id):
        """Initialize the switch."""
        self._device_id_device_id = device_id
        self._name_name = "PCA 301"
        self._state_state = None
        self._available_available = True
        self._pca_pca = pca
 
    @property
    def name(self):
        """Return the name of the Smart Plug, if any."""
        return self._name_name
 
    @property
    def available(self) -> bool:
        """Return if switch is available."""
        return self._available_available
 
    @property
    def is_on(self):
        """Return true if switch is on."""
        return self._state_state
 
    def turn_on(self, **kwargs: Any) -> None:
        """Turn the switch on."""
        self._pca_pca.turn_on(self._device_id_device_id)
 
    def turn_off(self, **kwargs: Any) -> None:
        """Turn the switch off."""
        self._pca_pca.turn_off(self._device_id_device_id)
 
    def update(self) -> None:
        """Update the PCA switch's state."""
        try:
            self._state_state = self._pca_pca.get_state(self._device_id_device_id)
            self._available_available = True
 
        except OSError as ex:
            if self._available_available:
                _LOGGER.warning("Could not read state for %s: %s", self.namenamename, ex)
                self._available_available = False