mirror of
https://github.com/home-assistant/core.git
synced 2025-11-04 00:19:31 +00:00
123 lines
3.8 KiB
Python
123 lines
3.8 KiB
Python
"""Base classes for Axis entities."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from abc import abstractmethod
|
|
from collections.abc import Callable
|
|
from dataclasses import dataclass
|
|
from typing import TYPE_CHECKING
|
|
|
|
from axis.models.event import Event, EventTopic
|
|
|
|
from homeassistant.core import callback
|
|
from homeassistant.helpers.device_registry import DeviceInfo
|
|
from homeassistant.helpers.dispatcher import async_dispatcher_connect
|
|
from homeassistant.helpers.entity import Entity, EntityDescription
|
|
|
|
from .const import DOMAIN as AXIS_DOMAIN
|
|
|
|
if TYPE_CHECKING:
|
|
from .hub import AxisHub
|
|
|
|
TOPIC_TO_EVENT_TYPE = {
|
|
EventTopic.DAY_NIGHT_VISION: "DayNight",
|
|
EventTopic.FENCE_GUARD: "Fence Guard",
|
|
EventTopic.LIGHT_STATUS: "Light",
|
|
EventTopic.LOITERING_GUARD: "Loitering Guard",
|
|
EventTopic.MOTION_DETECTION: "Motion",
|
|
EventTopic.MOTION_DETECTION_3: "VMD3",
|
|
EventTopic.MOTION_DETECTION_4: "VMD4",
|
|
EventTopic.MOTION_GUARD: "Motion Guard",
|
|
EventTopic.OBJECT_ANALYTICS: "Object Analytics",
|
|
EventTopic.PIR: "PIR",
|
|
EventTopic.PORT_INPUT: "Input",
|
|
EventTopic.PORT_SUPERVISED_INPUT: "Supervised Input",
|
|
EventTopic.PTZ_IS_MOVING: "is_moving",
|
|
EventTopic.PTZ_ON_PRESET: "on_preset",
|
|
EventTopic.RELAY: "Relay",
|
|
EventTopic.SOUND_TRIGGER_LEVEL: "Sound",
|
|
}
|
|
|
|
|
|
@dataclass(frozen=True, kw_only=True)
|
|
class AxisEventDescription(EntityDescription):
|
|
"""Axis event based entity description."""
|
|
|
|
event_topic: tuple[EventTopic, ...] | EventTopic
|
|
"""Event topic that provides state updates."""
|
|
name_fn: Callable[[AxisHub, Event], str] = lambda hub, event: ""
|
|
"""Function providing the corresponding name to the event ID."""
|
|
supported_fn: Callable[[AxisHub, Event], bool] = lambda hub, event: True
|
|
"""Function validating if event is supported."""
|
|
|
|
|
|
class AxisEntity(Entity):
|
|
"""Base common to all Axis entities."""
|
|
|
|
_attr_has_entity_name = True
|
|
|
|
def __init__(self, hub: AxisHub) -> None:
|
|
"""Initialize the Axis event."""
|
|
self.hub = hub
|
|
|
|
self._attr_device_info = DeviceInfo(
|
|
identifiers={(AXIS_DOMAIN, hub.unique_id)},
|
|
serial_number=hub.unique_id,
|
|
)
|
|
|
|
async def async_added_to_hass(self) -> None:
|
|
"""Subscribe device events."""
|
|
self.async_on_remove(
|
|
async_dispatcher_connect(
|
|
self.hass,
|
|
self.hub.signal_reachable,
|
|
self.async_signal_reachable_callback,
|
|
)
|
|
)
|
|
|
|
@callback
|
|
def async_signal_reachable_callback(self) -> None:
|
|
"""Call when device connection state change."""
|
|
self._attr_available = self.hub.available
|
|
self.async_write_ha_state()
|
|
|
|
|
|
class AxisEventEntity(AxisEntity):
|
|
"""Base common to all Axis entities from event stream."""
|
|
|
|
entity_description: AxisEventDescription
|
|
|
|
_attr_should_poll = False
|
|
|
|
def __init__(
|
|
self, hub: AxisHub, description: AxisEventDescription, event: Event
|
|
) -> None:
|
|
"""Initialize the Axis event."""
|
|
super().__init__(hub)
|
|
|
|
self.entity_description = description
|
|
|
|
self._event_id = event.id
|
|
self._event_topic = event.topic_base
|
|
|
|
event_type = TOPIC_TO_EVENT_TYPE[event.topic_base]
|
|
self._attr_name = description.name_fn(hub, event) or f"{event_type} {event.id}"
|
|
|
|
self._attr_unique_id = f"{hub.unique_id}-{event.topic}-{event.id}"
|
|
|
|
@callback
|
|
@abstractmethod
|
|
def async_event_callback(self, event: Event) -> None:
|
|
"""Update the entities state."""
|
|
|
|
async def async_added_to_hass(self) -> None:
|
|
"""Subscribe sensors events."""
|
|
await super().async_added_to_hass()
|
|
self.async_on_remove(
|
|
self.hub.api.event.subscribe(
|
|
self.async_event_callback,
|
|
id_filter=self._event_id,
|
|
topic_filter=self._event_topic,
|
|
)
|
|
)
|