entity.py

Go to the documentation of this file.

"""Representation of an EnOcean device."""
 
from enocean.protocol.packet import Packet
from enocean.utils import combine_hex
 
from homeassistant.helpers.dispatcher import async_dispatcher_connect, dispatcher_send
from homeassistant.helpers.entity import Entity
 
from .const import SIGNAL_RECEIVE_MESSAGE, SIGNAL_SEND_MESSAGE
 
 
class EnOceanEntity(Entity):
    """Parent class for all entities associated with the EnOcean component."""
 
    def __init__(self, dev_id: list[int]) -> None:
        """Initialize the device."""
        self.dev_iddev_id = dev_id
 
    async def async_added_to_hass(self):
        """Register callbacks."""
        self.async_on_removeasync_on_remove(
            async_dispatcher_connect(
                self.hasshass, SIGNAL_RECEIVE_MESSAGE, self._message_received_callback_message_received_callback
            )
        )
 
    def _message_received_callback(self, packet):
        """Handle incoming packets."""
 
        if packet.sender_int == combine_hex(self.dev_iddev_id):
            self.value_changedvalue_changed(packet)
 
    def value_changed(self, packet):
        """Update the internal state of the device when a packet arrives."""
 
    def send_command(self, data, optional, packet_type):
        """Send a command via the EnOcean dongle."""
 
        packet = Packet(packet_type, data=data, optional=optional)
        dispatcher_send(self.hass, SIGNAL_SEND_MESSAGE, packet)