entity.py

Go to the documentation of this file.

"""Base class for SUPLA channels."""
 
from __future__ import annotations
 
import logging
 
from homeassistant.helpers.update_coordinator import CoordinatorEntity
 
_LOGGER = logging.getLogger(__name__)
 
 
class SuplaEntity(CoordinatorEntity):
    """Base class of a SUPLA Channel (an equivalent of HA's Entity)."""
 
    def __init__(self, config, server, coordinator):
        """Init from config, hookup[ server and coordinator."""
        super().__init__(coordinator)
        self.server_nameserver_name = config["server_name"]
        self.channel_idchannel_id = config["channel_id"]
        self.serverserver = server
 
    @property
    def channel_data(self):
        """Return channel data taken from coordinator."""
        return self.coordinator.data.get(self.channel_idchannel_id)
 
    @property
    def unique_id(self) -> str:
        """Return a unique ID."""
        uid = self.channel_datachannel_data["iodevice"]["gUIDString"].lower()
        channel_number = self.channel_datachannel_data["channelNumber"]
        return f"supla-{uid}-{channel_number}"
 
    @property
    def name(self) -> str | None:
        """Return the name of the device."""
        return self.channel_datachannel_data["caption"]
 
    @property
    def available(self) -> bool:
        """Return True if entity is available."""
        if self.channel_datachannel_data is None:
            return False
        if (state := self.channel_datachannel_data.get("state")) is None:
            return False
        return state.get("connected")
 
    async def async_action(self, action, **add_pars):
        """Run server action.
 
        Actions are currently hardcoded in components.
        SUPLA's API enables autodiscovery
        """
        _LOGGER.debug(
            "Executing action %s on channel %d, params: %s",
            action,
            self.channel_datachannel_data["id"],
            add_pars,
        )
        await self.serverserver.execute_action(self.channel_datachannel_data["id"], action, **add_pars)
 
        # Update state
        await self.coordinator.async_request_refresh()