118 lines
3.9 KiB
Python
118 lines
3.9 KiB
Python
"""Support for Overkiz (virtual) buttons."""
|
|
from __future__ import annotations
|
|
|
|
from dataclasses import dataclass
|
|
|
|
from pyoverkiz.types import StateType as OverkizStateType
|
|
|
|
from homeassistant.components.button import ButtonEntity, ButtonEntityDescription
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers.entity import EntityCategory
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
|
|
from . import HomeAssistantOverkizData
|
|
from .const import DOMAIN, IGNORED_OVERKIZ_DEVICES
|
|
from .entity import OverkizDescriptiveEntity
|
|
|
|
|
|
@dataclass
|
|
class OverkizButtonDescription(ButtonEntityDescription):
|
|
"""Class to describe an Overkiz button."""
|
|
|
|
press_args: OverkizStateType | None = None
|
|
|
|
|
|
BUTTON_DESCRIPTIONS: list[OverkizButtonDescription] = [
|
|
# My Position (cover, light)
|
|
OverkizButtonDescription(
|
|
key="my",
|
|
name="My position",
|
|
icon="mdi:star",
|
|
),
|
|
# Identify
|
|
OverkizButtonDescription(
|
|
key="identify", # startIdentify and identify are reversed... Swap this when fixed in API.
|
|
name="Start identify",
|
|
icon="mdi:human-greeting-variant",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
),
|
|
OverkizButtonDescription(
|
|
key="stopIdentify",
|
|
name="Stop identify",
|
|
icon="mdi:human-greeting-variant",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
entity_registry_enabled_default=False,
|
|
),
|
|
OverkizButtonDescription(
|
|
key="startIdentify", # startIdentify and identify are reversed... Swap this when fixed in API.
|
|
name="Identify",
|
|
icon="mdi:human-greeting-variant",
|
|
entity_category=EntityCategory.DIAGNOSTIC,
|
|
),
|
|
# RTDIndoorSiren / RTDOutdoorSiren
|
|
OverkizButtonDescription(key="dingDong", name="Ding dong", icon="mdi:bell-ring"),
|
|
OverkizButtonDescription(key="bip", name="Bip", icon="mdi:bell-ring"),
|
|
OverkizButtonDescription(
|
|
key="fastBipSequence", name="Fast bip sequence", icon="mdi:bell-ring"
|
|
),
|
|
OverkizButtonDescription(key="ring", name="Ring", icon="mdi:bell-ring"),
|
|
# DynamicScreen (ogp:blind) uses goToAlias (id 1: favorite1) instead of 'my'
|
|
OverkizButtonDescription(
|
|
key="goToAlias",
|
|
press_args="1",
|
|
name="My position",
|
|
icon="mdi:star",
|
|
),
|
|
]
|
|
|
|
SUPPORTED_COMMANDS = {
|
|
description.key: description for description in BUTTON_DESCRIPTIONS
|
|
}
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
entry: ConfigEntry,
|
|
async_add_entities: AddEntitiesCallback,
|
|
) -> None:
|
|
"""Set up the Overkiz button from a config entry."""
|
|
data: HomeAssistantOverkizData = hass.data[DOMAIN][entry.entry_id]
|
|
entities: list[ButtonEntity] = []
|
|
|
|
for device in data.coordinator.data.values():
|
|
if (
|
|
device.widget in IGNORED_OVERKIZ_DEVICES
|
|
or device.ui_class in IGNORED_OVERKIZ_DEVICES
|
|
):
|
|
continue
|
|
|
|
for command in device.definition.commands:
|
|
if description := SUPPORTED_COMMANDS.get(command.command_name):
|
|
entities.append(
|
|
OverkizButton(
|
|
device.device_url,
|
|
data.coordinator,
|
|
description,
|
|
)
|
|
)
|
|
|
|
async_add_entities(entities)
|
|
|
|
|
|
class OverkizButton(OverkizDescriptiveEntity, ButtonEntity):
|
|
"""Representation of an Overkiz Button."""
|
|
|
|
entity_description: OverkizButtonDescription
|
|
|
|
async def async_press(self) -> None:
|
|
"""Handle the button press."""
|
|
if self.entity_description.press_args:
|
|
await self.executor.async_execute_command(
|
|
self.entity_description.key, self.entity_description.press_args
|
|
)
|
|
return
|
|
|
|
await self.executor.async_execute_command(self.entity_description.key)
|