switch.py

Go to the documentation of this file.

"""Pencom relay control."""
 
from __future__ import annotations
 
import logging
from typing import Any
 
from pencompy.pencompy import Pencompy
import voluptuous as vol
 
from homeassistant.components.switch import (
    PLATFORM_SCHEMA as SWITCH_PLATFORM_SCHEMA,
    SwitchEntity,
)
from homeassistant.const import CONF_HOST, CONF_NAME, CONF_PORT
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import PlatformNotReady
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__)
 
CONF_BOARDS = "boards"
CONF_BOARD = "board"
CONF_ADDR = "addr"
CONF_RELAYS = "relays"
 
RELAY_SCHEMA = vol.Schema(
    {
        vol.Required(CONF_NAME): cv.string,
        vol.Required(CONF_ADDR): cv.positive_int,
        vol.Optional(CONF_BOARD, default=0): cv.positive_int,
    }
)
 
PLATFORM_SCHEMA = SWITCH_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_HOST): cv.string,
        vol.Required(CONF_PORT): cv.port,
        vol.Optional(CONF_BOARDS, default=1): cv.positive_int,
        vol.Required(CONF_RELAYS): vol.All(cv.ensure_list, [RELAY_SCHEMA]),
    }
)
 
 
def setup_platform(
    hass: HomeAssistant,
    config: ConfigType,
    add_entities: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None,
) -> None:
    """Pencom relay platform (pencompy)."""
 
    # Assign configuration variables.
    host = config[CONF_HOST]
    port = config[CONF_PORT]
    boards = config[CONF_BOARDS]
 
    # Setup connection
    try:
        hub = Pencompy(host, port, boards=boards)
    except OSError as error:
        _LOGGER.error("Could not connect to pencompy: %s", error)
        raise PlatformNotReady from error
 
    # Add devices.
    devs = []
    for relay in config[CONF_RELAYS]:
        name = relay[CONF_NAME]
        board = relay[CONF_BOARD]
        addr = relay[CONF_ADDR]
        devs.append(PencomRelay(hub, board, addr, name))
    add_entities(devs, True)
 
 
class PencomRelay(SwitchEntity):
    """Representation of a pencom relay."""
 
    def __init__(self, hub, board, addr, name):
        """Create a relay."""
        self._hub_hub = hub
        self._board_board = board
        self._addr_addr = addr
        self._name_name = name
        self._state_state = None
 
    @property
    def name(self):
        """Relay name."""
        return self._name_name
 
    @property
    def is_on(self):
        """Return a relay's state."""
        return self._state_state
 
    def turn_on(self, **kwargs: Any) -> None:
        """Turn a relay on."""
        self._hub_hub.set(self._board_board, self._addr_addr, True)
 
    def turn_off(self, **kwargs: Any) -> None:
        """Turn a relay off."""
        self._hub_hub.set(self._board_board, self._addr_addr, False)
 
    def update(self) -> None:
        """Refresh a relay's state."""
        self._state_state = self._hub_hub.get(self._board_board, self._addr_addr)
 
    @property
    def extra_state_attributes(self):
        """Return supported attributes."""
        return {"board": self._board_board, "addr": self._addr_addr}