switch.py

Go to the documentation of this file.

"""Allows to configure a switch using RPi GPIO."""
 
from __future__ import annotations
 
from typing import Any
 
import voluptuous as vol
 
from homeassistant.components.switch import (
    PLATFORM_SCHEMA as SWITCH_PLATFORM_SCHEMA,
    SwitchEntity,
)
from homeassistant.const import CONF_HOST, DEVICE_DEFAULT_NAME
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
 
from . import CONF_INVERT_LOGIC, DEFAULT_INVERT_LOGIC, setup_output, write_output
 
CONF_PORTS = "ports"
 
_SENSORS_SCHEMA = vol.Schema({cv.positive_int: cv.string})
 
PLATFORM_SCHEMA = SWITCH_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_HOST): cv.string,
        vol.Required(CONF_PORTS): _SENSORS_SCHEMA,
        vol.Optional(CONF_INVERT_LOGIC, default=DEFAULT_INVERT_LOGIC): cv.boolean,
    }
)
 
 
def setup_platform(
    hass: HomeAssistant,
    config: ConfigType,
    add_entities: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None,
) -> None:
    """Set up the Remote Raspberry PI GPIO devices."""
    address = config[CONF_HOST]
    invert_logic = config[CONF_INVERT_LOGIC]
    ports = config[CONF_PORTS]
 
    devices = []
    for port, name in ports.items():
        try:
            led = setup_output(address, port, invert_logic)
        except (ValueError, IndexError, KeyError, OSError):
            return
        new_switch = RemoteRPiGPIOSwitch(name, led)
        devices.append(new_switch)
 
    add_entities(devices)
 
 
class RemoteRPiGPIOSwitch(SwitchEntity):
    """Representation of a Remote Raspberry Pi GPIO."""
 
    _attr_should_poll = False
 
    def __init__(self, name, led):
        """Initialize the pin."""
        self._name_name = name or DEVICE_DEFAULT_NAME
        self._state_state = False
        self._switch_switch = led
 
    @property
    def name(self):
        """Return the name of the switch."""
        return self._name_name
 
    @property
    def assumed_state(self):
        """If unable to access real state of the entity."""
        return True
 
    @property
    def is_on(self):
        """Return true if device is on."""
        return self._state_state
 
    def turn_on(self, **kwargs: Any) -> None:
        """Turn the device on."""
        write_output(self._switch_switch, 1)
        self._state_state = True
        self.schedule_update_ha_stateschedule_update_ha_state()
 
    def turn_off(self, **kwargs: Any) -> None:
        """Turn the device off."""
        write_output(self._switch_switch, 0)
        self._state_state = False
        self.schedule_update_ha_stateschedule_update_ha_state()