129 lines
3.7 KiB
Python
129 lines
3.7 KiB
Python
"""Support for Ubiquiti's UniFi Protect NVR."""
|
|
from __future__ import annotations
|
|
|
|
from dataclasses import dataclass
|
|
from typing import Final
|
|
|
|
from pyunifiprotect.data import ProtectAdoptableDeviceModel
|
|
|
|
from homeassistant.components.button import (
|
|
ButtonDeviceClass,
|
|
ButtonEntity,
|
|
ButtonEntityDescription,
|
|
)
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers.dispatcher import async_dispatcher_connect
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
|
|
from .const import DISPATCH_ADOPT, DOMAIN
|
|
from .data import ProtectData
|
|
from .entity import ProtectDeviceEntity, async_all_device_entities
|
|
from .models import PermRequired, ProtectSetableKeysMixin, T
|
|
from .utils import async_dispatch_id as _ufpd
|
|
|
|
|
|
@dataclass
|
|
class ProtectButtonEntityDescription(
|
|
ProtectSetableKeysMixin[T], ButtonEntityDescription
|
|
):
|
|
"""Describes UniFi Protect Button entity."""
|
|
|
|
ufp_press: str | None = None
|
|
|
|
|
|
DEVICE_CLASS_CHIME_BUTTON: Final = "unifiprotect__chime_button"
|
|
|
|
|
|
ALL_DEVICE_BUTTONS: tuple[ProtectButtonEntityDescription, ...] = (
|
|
ProtectButtonEntityDescription(
|
|
key="reboot",
|
|
entity_registry_enabled_default=False,
|
|
device_class=ButtonDeviceClass.RESTART,
|
|
name="Reboot Device",
|
|
ufp_press="reboot",
|
|
ufp_perm=PermRequired.WRITE,
|
|
),
|
|
)
|
|
|
|
SENSOR_BUTTONS: tuple[ProtectButtonEntityDescription, ...] = (
|
|
ProtectButtonEntityDescription(
|
|
key="clear_tamper",
|
|
name="Clear Tamper",
|
|
icon="mdi:notification-clear-all",
|
|
ufp_press="clear_tamper",
|
|
ufp_perm=PermRequired.WRITE,
|
|
),
|
|
)
|
|
|
|
CHIME_BUTTONS: tuple[ProtectButtonEntityDescription, ...] = (
|
|
ProtectButtonEntityDescription(
|
|
key="play",
|
|
name="Play Chime",
|
|
device_class=DEVICE_CLASS_CHIME_BUTTON,
|
|
icon="mdi:play",
|
|
ufp_press="play",
|
|
),
|
|
ProtectButtonEntityDescription(
|
|
key="play_buzzer",
|
|
name="Play Buzzer",
|
|
icon="mdi:play",
|
|
ufp_press="play_buzzer",
|
|
),
|
|
)
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
entry: ConfigEntry,
|
|
async_add_entities: AddEntitiesCallback,
|
|
) -> None:
|
|
"""Discover devices on a UniFi Protect NVR."""
|
|
data: ProtectData = hass.data[DOMAIN][entry.entry_id]
|
|
|
|
async def _add_new_device(device: ProtectAdoptableDeviceModel) -> None:
|
|
entities = async_all_device_entities(
|
|
data,
|
|
ProtectButton,
|
|
all_descs=ALL_DEVICE_BUTTONS,
|
|
chime_descs=CHIME_BUTTONS,
|
|
sense_descs=SENSOR_BUTTONS,
|
|
ufp_device=device,
|
|
)
|
|
async_add_entities(entities)
|
|
|
|
entry.async_on_unload(
|
|
async_dispatcher_connect(hass, _ufpd(entry, DISPATCH_ADOPT), _add_new_device)
|
|
)
|
|
|
|
entities: list[ProtectDeviceEntity] = async_all_device_entities(
|
|
data,
|
|
ProtectButton,
|
|
all_descs=ALL_DEVICE_BUTTONS,
|
|
chime_descs=CHIME_BUTTONS,
|
|
sense_descs=SENSOR_BUTTONS,
|
|
)
|
|
async_add_entities(entities)
|
|
|
|
|
|
class ProtectButton(ProtectDeviceEntity, ButtonEntity):
|
|
"""A Ubiquiti UniFi Protect Reboot button."""
|
|
|
|
entity_description: ProtectButtonEntityDescription
|
|
|
|
def __init__(
|
|
self,
|
|
data: ProtectData,
|
|
device: ProtectAdoptableDeviceModel,
|
|
description: ProtectButtonEntityDescription,
|
|
) -> None:
|
|
"""Initialize an UniFi camera."""
|
|
super().__init__(data, device, description)
|
|
self._attr_name = f"{self.device.display_name} {self.entity_description.name}"
|
|
|
|
async def async_press(self) -> None:
|
|
"""Press the button."""
|
|
|
|
if self.entity_description.ufp_press is not None:
|
|
await getattr(self.device, self.entity_description.ufp_press)()
|