event.py

Go to the documentation of this file.

"""Support for Lutron events."""
 
from enum import StrEnum
 
from pylutron import Button, Keypad, Lutron, LutronEvent
 
from homeassistant.components.event import EventEntity
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import ATTR_ID
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.util import slugify
 
from . import ATTR_ACTION, ATTR_FULL_ID, ATTR_UUID, DOMAIN, LutronData
from .entity import LutronKeypad
 
 
class LutronEventType(StrEnum):
    """Lutron event types."""
 
    SINGLE_PRESS = "single_press"
    PRESS = "press"
    RELEASE = "release"
 
 
LEGACY_EVENT_TYPES: dict[LutronEventType, str] = {
    LutronEventType.SINGLE_PRESS: "single",
    LutronEventType.PRESS: "pressed",
    LutronEventType.RELEASE: "released",
}
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up the Lutron event platform."""
    entry_data: LutronData = hass.data[DOMAIN][config_entry.entry_id]
 
    async_add_entities(
        LutronEventEntity(area_name, keypad, button, entry_data.client)
        for area_name, keypad, button in entry_data.buttons
    )
 
 
class LutronEventEntity(LutronKeypad, EventEntity):
    """Representation of a Lutron keypad button."""
 
    _attr_translation_key = "button"
 
    def __init__(
        self,
        area_name: str,
        keypad: Keypad,
        button: Button,
        controller: Lutron,
    ) -> None:
        """Initialize the button."""
        super().__init__(area_name, button, controller, keypad)
        if (name := button.name) == "Unknown Button":
            name += f" {button.number}"
        self._attr_name_attr_name = name
        self._has_release_event_has_release_event = (
            button.button_type is not None and "RaiseLower" in button.button_type
        )
        if self._has_release_event_has_release_event:
            self._attr_event_types_attr_event_types = [LutronEventType.PRESS, LutronEventType.RELEASE]
        else:
            self._attr_event_types_attr_event_types = [LutronEventType.SINGLE_PRESS]
 
        self._full_id_full_id = slugify(f"{area_name} {name}")
        self._id_id = slugify(name)
 
    async def async_added_to_hass(self) -> None:
        """Register callbacks."""
        await super().async_added_to_hass()
        self.async_on_removeasync_on_remove(self._lutron_device_lutron_device.subscribe(self.handle_eventhandle_event, None))
 
    @callback
    def handle_event(
        self, button: Button, _context: None, event: LutronEvent, _params: dict
    ) -> None:
        """Handle received event."""
        action: LutronEventType | None = None
        if self._has_release_event_has_release_event:
            if event == Button.Event.PRESSED:
                action = LutronEventType.PRESS
            else:
                action = LutronEventType.RELEASE
        elif event == Button.Event.PRESSED:
            action = LutronEventType.SINGLE_PRESS
 
        if action:
            data = {
                ATTR_ID: self._id_id,
                ATTR_ACTION: LEGACY_EVENT_TYPES[action],
                ATTR_FULL_ID: self._full_id_full_id,
                ATTR_UUID: button.uuid,
            }
            self.hasshass.bus.fire("lutron_event", data)
            self._trigger_event_trigger_event(action)
            self.schedule_update_ha_stateschedule_update_ha_state()