ONVIF Event Implementation (#35406)
Initial implementation of ONVIF event sensors
This commit is contained in:
1 parent
9eb1505aa1
commit
132bb4e890
12 files changed
+762
-20
No files matched your search
@@ -0,0 +1,169 @@
|
||||
"""ONVIF event abstraction."""
|
||||
import datetime as dt
|
||||
from typing import Callable, Dict, List, Optional, Set
|
||||
|
||||
from aiohttp.client_exceptions import ServerDisconnectedError
|
||||
from onvif import ONVIFCamera, ONVIFService
|
||||
from zeep.exceptions import Fault
|
||||
|
||||
from homeassistant.core import CALLBACK_TYPE, HomeAssistant, callback
|
||||
from homeassistant.helpers.event import async_track_point_in_utc_time
|
||||
from homeassistant.util import dt as dt_util
|
||||
|
||||
from .const import LOGGER
|
||||
from .models import Event
|
||||
from .parsers import PARSERS
|
||||
|
||||
UNHANDLED_TOPICS = set()
|
||||
|
||||
|
||||
class EventManager:
|
||||
"""ONVIF Event Manager."""
|
||||
|
||||
def __init__(self, hass: HomeAssistant, device: ONVIFCamera, unique_id: str):
|
||||
"""Initialize event manager."""
|
||||
self.hass: HomeAssistant = hass
|
||||
self.device: ONVIFCamera = device
|
||||
self.unique_id: str = unique_id
|
||||
self.started: bool = False
|
||||
|
||||
self._subscription: ONVIFService = None
|
||||
self._events: Dict[str, Event] = {}
|
||||
self._listeners: List[CALLBACK_TYPE] = []
|
||||
self._unsub_refresh: Optional[CALLBACK_TYPE] = None
|
||||
|
||||
super().__init__()
|
||||
|
||||
@property
|
||||
def platforms(self) -> Set[str]:
|
||||
"""Return platforms to setup."""
|
||||
return {event.platform for event in self._events.values()}
|
||||
|
||||
@callback
|
||||
def async_add_listener(self, update_callback: CALLBACK_TYPE) -> Callable[[], None]:
|
||||
"""Listen for data updates."""
|
||||
# This is the first listener, set up polling.
|
||||
if not self._listeners:
|
||||
self._unsub_refresh = async_track_point_in_utc_time(
|
||||
self.hass,
|
||||
self.async_pull_messages,
|
||||
dt_util.utcnow() + dt.timedelta(seconds=1),
|
||||
)
|
||||
|
||||
self._listeners.append(update_callback)
|
||||
|
||||
@callback
|
||||
def remove_listener() -> None:
|
||||
"""Remove update listener."""
|
||||
self.async_remove_listener(update_callback)
|
||||
|
||||
return remove_listener
|
||||
|
||||
@callback
|
||||
def async_remove_listener(self, update_callback: CALLBACK_TYPE) -> None:
|
||||
"""Remove data update."""
|
||||
self._listeners.remove(update_callback)
|
||||
|
||||
if not self._listeners and self._unsub_refresh:
|
||||
self._unsub_refresh()
|
||||
self._unsub_refresh = None
|
||||
|
||||
async def async_start(self) -> bool:
|
||||
"""Start polling events."""
|
||||
if await self.device.create_pullpoint_subscription():
|
||||
# Initialize events
|
||||
pullpoint = self.device.create_pullpoint_service()
|
||||
await pullpoint.SetSynchronizationPoint()
|
||||
req = pullpoint.create_type("PullMessages")
|
||||
req.MessageLimit = 100
|
||||
req.Timeout = dt.timedelta(seconds=5)
|
||||
response = await pullpoint.PullMessages(req)
|
||||
|
||||
# Parse event initialization
|
||||
await self.async_parse_messages(response.NotificationMessage)
|
||||
|
||||
# Create subscription manager
|
||||
self._subscription = self.device.create_subscription_service(
|
||||
"PullPointSubscription"
|
||||
)
|
||||
|
||||
self.started = True
|
||||
|
||||
return self.started
|
||||
|
||||
async def async_stop(self, event=None) -> None:
|
||||
"""Unsubscribe from events."""
|
||||
if not self._subscription:
|
||||
return
|
||||
|
||||
await self._subscription.Unsubscribe()
|
||||
self._subscription = None
|
||||
|
||||
async def async_renew(self) -> None:
|
||||
"""Renew subscription."""
|
||||
if not self._subscription:
|
||||
return
|
||||
|
||||
await self._subscription.Renew(dt_util.utcnow() + dt.timedelta(minutes=10))
|
||||
|
||||
async def async_pull_messages(self, _now: dt = None) -> None:
|
||||
"""Pull messages from device."""
|
||||
try:
|
||||
pullpoint = self.device.get_service("pullpoint")
|
||||
req = pullpoint.create_type("PullMessages")
|
||||
req.MessageLimit = 100
|
||||
req.Timeout = dt.timedelta(seconds=60)
|
||||
response = await pullpoint.PullMessages(req)
|
||||
|
||||
# Renew subscription if less than 60 seconds left
|
||||
if (response.TerminationTime - dt_util.utcnow()).total_seconds() < 60:
|
||||
await self.async_renew()
|
||||
|
||||
# Parse response
|
||||
await self.async_parse_messages(response.NotificationMessage)
|
||||
|
||||
except ServerDisconnectedError:
|
||||
pass
|
||||
except Fault:
|
||||
pass
|
||||
|
||||
# Update entities
|
||||
for update_callback in self._listeners:
|
||||
update_callback()
|
||||
|
||||
# Reschedule another pull
|
||||
if self._listeners:
|
||||
self._unsub_refresh = async_track_point_in_utc_time(
|
||||
self.hass,
|
||||
self.async_pull_messages,
|
||||
dt_util.utcnow() + dt.timedelta(seconds=1),
|
||||
)
|
||||
|
||||
# pylint: disable=protected-access
|
||||
async def async_parse_messages(self, messages) -> None:
|
||||
"""Parse notification message."""
|
||||
for msg in messages:
|
||||
# LOGGER.debug("ONVIF Event Message %s: %s", self.device.host, pformat(msg))
|
||||
topic = msg.Topic._value_1
|
||||
parser = PARSERS.get(topic)
|
||||
if not parser:
|
||||
if topic not in UNHANDLED_TOPICS:
|
||||
LOGGER.info("No registered handler for event: %s", msg)
|
||||
UNHANDLED_TOPICS.add(topic)
|
||||
continue
|
||||
|
||||
event = await parser(self.unique_id, msg)
|
||||
|
||||
if not event:
|
||||
LOGGER.warning("Unable to parse event: %s", msg)
|
||||
return
|
||||
|
||||
self._events[event.uid] = event
|
||||
|
||||
def get_uid(self, uid) -> Event:
|
||||
"""Retrieve event for given id."""
|
||||
return self._events[uid]
|
||||
|
||||
def get_platform(self, platform) -> List[Event]:
|
||||
"""Retrieve events for given platform."""
|
||||
return [event for event in self._events.values() if event.platform == platform]
|
||||
Reference in new issue
Block a user