mirror of
https://github.com/home-assistant/core
synced 2024-08-28 03:36:46 +02:00
99 lines
3.1 KiB
Python
99 lines
3.1 KiB
Python
"""Base classes for Axis entities."""
|
|
|
|
from abc import abstractmethod
|
|
|
|
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
|
|
|
|
from .const import DOMAIN as AXIS_DOMAIN
|
|
from .device import AxisNetworkDevice
|
|
|
|
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",
|
|
}
|
|
|
|
|
|
class AxisEntity(Entity):
|
|
"""Base common to all Axis entities."""
|
|
|
|
_attr_has_entity_name = True
|
|
|
|
def __init__(self, device: AxisNetworkDevice) -> None:
|
|
"""Initialize the Axis event."""
|
|
self.device = device
|
|
|
|
self._attr_device_info = DeviceInfo(
|
|
identifiers={(AXIS_DOMAIN, device.unique_id)}, # type: ignore[arg-type]
|
|
serial_number=device.unique_id,
|
|
)
|
|
|
|
async def async_added_to_hass(self) -> None:
|
|
"""Subscribe device events."""
|
|
self.async_on_remove(
|
|
async_dispatcher_connect(
|
|
self.hass,
|
|
self.device.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.device.available
|
|
self.async_write_ha_state()
|
|
|
|
|
|
class AxisEventEntity(AxisEntity):
|
|
"""Base common to all Axis entities from event stream."""
|
|
|
|
_attr_should_poll = False
|
|
|
|
def __init__(self, event: Event, device: AxisNetworkDevice) -> None:
|
|
"""Initialize the Axis event."""
|
|
super().__init__(device)
|
|
|
|
self._event_id = event.id
|
|
self._event_topic = event.topic_base
|
|
self._event_type = TOPIC_TO_EVENT_TYPE[event.topic_base]
|
|
|
|
self._attr_name = f"{self._event_type} {event.id}"
|
|
self._attr_unique_id = f"{device.unique_id}-{event.topic}-{event.id}"
|
|
|
|
self._attr_device_class = event.group.value
|
|
|
|
@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.device.api.event.subscribe(
|
|
self.async_event_callback,
|
|
id_filter=self._event_id,
|
|
topic_filter=self._event_topic,
|
|
)
|
|
)
|