light.py

Go to the documentation of this file.

"""Support for SCSGate lights."""
 
from __future__ import annotations
 
import logging
from typing import Any
 
from scsgate.tasks import ToggleStatusTask
import voluptuous as vol
 
from homeassistant.components.light import (
    PLATFORM_SCHEMA as LIGHT_PLATFORM_SCHEMA,
    ColorMode,
    LightEntity,
)
from homeassistant.const import ATTR_ENTITY_ID, ATTR_STATE, CONF_DEVICES, CONF_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_SCS_ID, DOMAIN, SCSGATE_SCHEMA
 
PLATFORM_SCHEMA = LIGHT_PLATFORM_SCHEMA.extend(
    {vol.Required(CONF_DEVICES): cv.schema_with_slug_keys(SCSGATE_SCHEMA)}
)
 
 
def setup_platform(
    hass: HomeAssistant,
    config: ConfigType,
    add_entities: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None,
) -> None:
    """Set up the SCSGate switches."""
    devices = config.get(CONF_DEVICES)
    lights = []
    logger = logging.getLogger(__name__)
    scsgate = hass.data[DOMAIN]
 
    if devices:
        for entity_info in devices.values():
            if entity_info[CONF_SCS_ID] in scsgate.devices:
                continue
 
            name = entity_info[CONF_NAME]
            scs_id = entity_info[CONF_SCS_ID]
 
            logger.info("Adding %s scsgate.light", name)
 
            light = SCSGateLight(
                name=name, scs_id=scs_id, logger=logger, scsgate=scsgate
            )
            lights.append(light)
 
    add_entities(lights)
    scsgate.add_devices_to_register(lights)
 
 
class SCSGateLight(LightEntity):
    """Representation of a SCSGate light."""
 
    _attr_color_mode = ColorMode.ONOFF
    _attr_supported_color_modes = {ColorMode.ONOFF}
    _attr_should_poll = False
 
    def __init__(self, scs_id, name, logger, scsgate):
        """Initialize the light."""
        self._attr_name_attr_name = name
        self._scs_id_scs_id = scs_id
        self._toggled_toggled = False
        self._logger_logger = logger
        self._scsgate_scsgate = scsgate
 
    @property
    def scs_id(self):
        """Return the SCS ID."""
        return self._scs_id_scs_id
 
    @property
    def is_on(self):
        """Return true if light is on."""
        return self._toggled_toggled
 
    def turn_on(self, **kwargs: Any) -> None:
        """Turn the device on."""
 
        self._scsgate_scsgate.append_task(ToggleStatusTask(target=self._scs_id_scs_id, toggled=True))
 
        self._toggled_toggled = True
        self.schedule_update_ha_stateschedule_update_ha_state()
 
    def turn_off(self, **kwargs: Any) -> None:
        """Turn the device off."""
 
        self._scsgate_scsgate.append_task(ToggleStatusTask(target=self._scs_id_scs_id, toggled=False))
 
        self._toggled_toggled = False
        self.schedule_update_ha_stateschedule_update_ha_state()
 
    def process_event(self, message):
        """Handle a SCSGate message related with this light."""
        if self._toggled_toggled == message.toggled:
            self._logger_logger.info(
                "Light %s, ignoring message %s because state already active",
                self._scs_id_scs_id,
                message,
            )
            # Nothing changed, ignoring
            return
 
        self._toggled_toggled = message.toggled
        self.schedule_update_ha_stateschedule_update_ha_state()
 
        command = "off"
        if self._toggled_toggled:
            command = "on"
 
        self.hasshass.bus.fire(
            "button_pressed", {ATTR_ENTITY_ID: self._scs_id_scs_id, ATTR_STATE: command}
        )