scene.py

Go to the documentation of this file.

"""Support for LCN scenes."""
 
from collections.abc import Iterable
from functools import partial
from typing import Any
 
import pypck
 
from homeassistant.components.scene import DOMAIN as DOMAIN_SCENE, Scene
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import CONF_DOMAIN, CONF_ENTITIES, CONF_SCENE
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.typing import ConfigType
 
from .const import (
    ADD_ENTITIES_CALLBACKS,
    CONF_DOMAIN_DATA,
    CONF_OUTPUTS,
    CONF_REGISTER,
    CONF_TRANSITION,
    DOMAIN,
    OUTPUT_PORTS,
)
from .entity import LcnEntity
 
PARALLEL_UPDATES = 0
 
 
def add_lcn_entities(
    config_entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
    entity_configs: Iterable[ConfigType],
) -> None:
    """Add entities for this domain."""
    entities = [
        LcnScene(entity_config, config_entry) for entity_config in entity_configs
    ]
 
    async_add_entities(entities)
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up LCN switch entities from a config entry."""
    add_entities = partial(
        add_lcn_entities,
        config_entry,
        async_add_entities,
    )
 
    hass.data[DOMAIN][config_entry.entry_id][ADD_ENTITIES_CALLBACKS].update(
        {DOMAIN_SCENE: add_entities}
    )
 
    add_entities(
        (
            entity_config
            for entity_config in config_entry.data[CONF_ENTITIES]
            if entity_config[CONF_DOMAIN] == DOMAIN_SCENE
        ),
    )
 
 
class LcnScene(LcnEntity, Scene):
    """Representation of a LCN scene."""
 
    def __init__(self, config: ConfigType, config_entry: ConfigEntry) -> None:
        """Initialize the LCN scene."""
        super().__init__(config, config_entry)
 
        self.register_idregister_id = config[CONF_DOMAIN_DATA][CONF_REGISTER]
        self.scene_idscene_id = config[CONF_DOMAIN_DATA][CONF_SCENE]
        self.output_portsoutput_ports = []
        self.relay_portsrelay_ports = []
 
        for port in config[CONF_DOMAIN_DATA][CONF_OUTPUTS]:
            if port in OUTPUT_PORTS:
                self.output_portsoutput_ports.append(pypck.lcn_defs.OutputPort[port])
            else:  # in RELEAY_PORTS
                self.relay_portsrelay_ports.append(pypck.lcn_defs.RelayPort[port])
 
        if config[CONF_DOMAIN_DATA][CONF_TRANSITION] is None:
            self.transitiontransition = None
        else:
            self.transitiontransition = pypck.lcn_defs.time_to_ramp_value(
                config[CONF_DOMAIN_DATA][CONF_TRANSITION] * 1000.0
            )
 
    async def async_activate(self, **kwargs: Any) -> None:
        """Activate scene."""
        await self.device_connectiondevice_connection.activate_scene(
            self.register_idregister_id,
            self.scene_idscene_id,
            self.output_portsoutput_ports,
            self.relay_portsrelay_ports,
            self.transitiontransition,
        )