cover.py

Go to the documentation of this file.

"""Support for SCSGate covers."""
 
from __future__ import annotations
 
import logging
from typing import Any
 
from scsgate.tasks import (
    HaltRollerShutterTask,
    LowerRollerShutterTask,
    RaiseRollerShutterTask,
)
import voluptuous as vol
 
from homeassistant.components.cover import (
    PLATFORM_SCHEMA as COVER_PLATFORM_SCHEMA,
    CoverEntity,
)
from homeassistant.const import 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 = COVER_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 cover."""
    devices = config.get(CONF_DEVICES)
    covers = []
    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.cover", name)
 
            cover = SCSGateCover(
                name=name, scs_id=scs_id, logger=logger, scsgate=scsgate
            )
            scsgate.add_device(cover)
            covers.append(cover)
 
    add_entities(covers)
 
 
class SCSGateCover(CoverEntity):
    """Representation of SCSGate cover."""
 
    _attr_should_poll = False
 
    def __init__(self, scs_id, name, logger, scsgate):
        """Initialize the cover."""
        self._scs_id_scs_id = scs_id
        self._name_name = name
        self._logger_logger = logger
        self._scsgate_scsgate = scsgate
 
    @property
    def scs_id(self):
        """Return the SCSGate ID."""
        return self._scs_id_scs_id
 
    @property
    def name(self) -> str:
        """Return the name of the cover."""
        return self._name_name
 
    @property
    def is_closed(self) -> None:
        """Return if the cover is closed."""
        return None
 
    def open_cover(self, **kwargs: Any) -> None:
        """Move the cover."""
        self._scsgate_scsgate.append_task(RaiseRollerShutterTask(target=self._scs_id_scs_id))
 
    def close_cover(self, **kwargs: Any) -> None:
        """Move the cover down."""
        self._scsgate_scsgate.append_task(LowerRollerShutterTask(target=self._scs_id_scs_id))
 
    def stop_cover(self, **kwargs: Any) -> None:
        """Stop the cover."""
        self._scsgate_scsgate.append_task(HaltRollerShutterTask(target=self._scs_id_scs_id))
 
    def process_event(self, message):
        """Handle a SCSGate message related with this cover."""
        self._logger_logger.debug("Cover %s, got message %s", self._scs_id_scs_id, message.toggled)