mirror of https://github.com/home-assistant/core
130 lines
3.8 KiB
Python
130 lines
3.8 KiB
Python
"""Support for deCONZ buttons."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from dataclasses import dataclass
|
|
|
|
from pydeconz.models.event import EventType
|
|
from pydeconz.models.scene import Scene as PydeconzScene
|
|
from pydeconz.models.sensor.presence import Presence
|
|
|
|
from homeassistant.components.button import (
|
|
DOMAIN as BUTTON_DOMAIN,
|
|
ButtonDeviceClass,
|
|
ButtonEntity,
|
|
ButtonEntityDescription,
|
|
)
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.const import EntityCategory
|
|
from homeassistant.core import HomeAssistant, callback
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
|
|
from .entity import DeconzDevice, DeconzSceneMixin
|
|
from .hub import DeconzHub
|
|
|
|
|
|
@dataclass(frozen=True, kw_only=True)
|
|
class DeconzButtonDescription(ButtonEntityDescription):
|
|
"""Class describing deCONZ button entities."""
|
|
|
|
button_fn: str
|
|
suffix: str
|
|
|
|
|
|
ENTITY_DESCRIPTIONS = {
|
|
PydeconzScene: [
|
|
DeconzButtonDescription(
|
|
key="store",
|
|
button_fn="store",
|
|
suffix="Store Current Scene",
|
|
icon="mdi:inbox-arrow-down",
|
|
entity_category=EntityCategory.CONFIG,
|
|
)
|
|
]
|
|
}
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
config_entry: ConfigEntry,
|
|
async_add_entities: AddEntitiesCallback,
|
|
) -> None:
|
|
"""Set up the deCONZ button entity."""
|
|
hub = DeconzHub.get_hub(hass, config_entry)
|
|
hub.entities[BUTTON_DOMAIN] = set()
|
|
|
|
@callback
|
|
def async_add_scene(_: EventType, scene_id: str) -> None:
|
|
"""Add scene button from deCONZ."""
|
|
scene = hub.api.scenes[scene_id]
|
|
async_add_entities(
|
|
DeconzSceneButton(scene, hub, description)
|
|
for description in ENTITY_DESCRIPTIONS.get(PydeconzScene, [])
|
|
)
|
|
|
|
hub.register_platform_add_device_callback(
|
|
async_add_scene,
|
|
hub.api.scenes,
|
|
)
|
|
|
|
@callback
|
|
def async_add_presence_sensor(_: EventType, sensor_id: str) -> None:
|
|
"""Add presence sensor reset button from deCONZ."""
|
|
sensor = hub.api.sensors.presence[sensor_id]
|
|
if sensor.presence_event is not None:
|
|
async_add_entities([DeconzPresenceResetButton(sensor, hub)])
|
|
|
|
hub.register_platform_add_device_callback(
|
|
async_add_presence_sensor,
|
|
hub.api.sensors.presence,
|
|
)
|
|
|
|
|
|
class DeconzSceneButton(DeconzSceneMixin, ButtonEntity):
|
|
"""Representation of a deCONZ button entity."""
|
|
|
|
TYPE = BUTTON_DOMAIN
|
|
|
|
def __init__(
|
|
self,
|
|
device: PydeconzScene,
|
|
hub: DeconzHub,
|
|
description: DeconzButtonDescription,
|
|
) -> None:
|
|
"""Initialize deCONZ number entity."""
|
|
self.entity_description: DeconzButtonDescription = description
|
|
super().__init__(device, hub)
|
|
|
|
self._attr_name = f"{self._attr_name} {description.suffix}"
|
|
|
|
async def async_press(self) -> None:
|
|
"""Store light states into scene."""
|
|
async_button_fn = getattr(
|
|
self.hub.api.scenes,
|
|
self.entity_description.button_fn,
|
|
)
|
|
await async_button_fn(self._device.group_id, self._device.id)
|
|
|
|
def get_device_identifier(self) -> str:
|
|
"""Return a unique identifier for this scene."""
|
|
return f"{super().get_device_identifier()}-{self.entity_description.key}"
|
|
|
|
|
|
class DeconzPresenceResetButton(DeconzDevice[Presence], ButtonEntity):
|
|
"""Representation of a deCONZ presence reset button entity."""
|
|
|
|
_name_suffix = "Reset Presence"
|
|
unique_id_suffix = "reset_presence"
|
|
|
|
_attr_entity_category = EntityCategory.CONFIG
|
|
_attr_device_class = ButtonDeviceClass.RESTART
|
|
|
|
TYPE = BUTTON_DOMAIN
|
|
|
|
async def async_press(self) -> None:
|
|
"""Store reset presence state."""
|
|
await self.hub.api.sensors.presence.set_config(
|
|
id=self._device.resource_id,
|
|
reset_presence=True,
|
|
)
|