entity.py

Go to the documentation of this file.

"""Support for Qwikswitch devices."""
 
from __future__ import annotations
 
from homeassistant.components.light import ATTR_BRIGHTNESS
from homeassistant.core import callback
from homeassistant.helpers.dispatcher import async_dispatcher_connect
from homeassistant.helpers.entity import Entity
 
from . import DOMAIN
 
 
class QSEntity(Entity):
    """Qwikswitch Entity base."""
 
    _attr_should_poll = False
 
    def __init__(self, qsid, name):
        """Initialize the QSEntity."""
        self._name_name = name
        self.qsidqsid = qsid
 
    @property
    def name(self):
        """Return the name of the sensor."""
        return self._name_name
 
    @property
    def unique_id(self):
        """Return a unique identifier for this sensor."""
        return f"qs{self.qsid}"
 
    @callback
    def update_packet(self, packet):
        """Receive update packet from QSUSB. Match dispather_send signature."""
        self.async_write_ha_stateasync_write_ha_state()
 
    async def async_added_to_hass(self):
        """Listen for updates from QSUSb via dispatcher."""
        self.async_on_removeasync_on_remove(
            async_dispatcher_connect(self.hasshass, self.qsidqsid, self.update_packetupdate_packet)
        )
 
 
class QSToggleEntity(QSEntity):
    """Representation of a Qwikswitch Toggle Entity.
 
    Implemented:
     - QSLight extends QSToggleEntity and Light[2] (ToggleEntity[1])
     - QSSwitch extends QSToggleEntity and SwitchEntity[3] (ToggleEntity[1])
 
    [1] /helpers/entity.py
    [2] /components/light/__init__.py
    [3] /components/switch/__init__.py
    """
 
    def __init__(self, qsid, qsusb):
        """Initialize the ToggleEntity."""
        self.devicedevice = qsusb.devices[qsid]
        super().__init__(qsid, self.devicedevice.name)
 
    @property
    def is_on(self):
        """Check if device is on (non-zero)."""
        return self.devicedevice.value > 0
 
    async def async_turn_on(self, **kwargs):
        """Turn the device on."""
        new = kwargs.get(ATTR_BRIGHTNESS, 255)
        self.hasshass.data[DOMAIN].devices.set_value(self.qsidqsid, new)
 
    async def async_turn_off(self, **_):
        """Turn the device off."""
        self.hasshass.data[DOMAIN].devices.set_value(self.qsidqsid, 0)