harbor-python 1.0.0__py3-none-any.whl

harbor/__init__.py

@@ -0,0 +1,62 @@
+from .config import HarborCameraConfig
+from .core import Harbor
+from .data.mqtt_models import (
+    HeartbeatEvent,
+    LocalLivekitHeartbeatEvent,
+    MotionDetectedEvent,
+    SettingsEvent,
+    ViewerJoinedEvent,
+    ViewerLeftEvent,
+)
+from .device import HarborDevice
+from .devices.camera import HarborCamera
+from .devices.monitor import HarborMonitor
+from .events import (
+    CameraEventUpdate,
+    EventType,
+    HarborEvent,
+    HarborEventBus,
+    HeartbeatUpdate,
+    LocalLivekitHeartbeatUpdate,
+    MotionDetectedUpdate,
+    RawEventUpdate,
+    SettingsUpdate,
+    ViewerInfo,
+    ViewerJoinedUpdate,
+    ViewerLeftUpdate,
+    parse_message,
+)
+from .mqtt import HarborMQTTClient
+from .state import HarborDeviceState, HarborEventState, HarborSourceType, HarborViewer
+
+__all__ = [
+    "Harbor",
+    "HarborCameraConfig",
+    "HarborMQTTClient",
+    "HarborDevice",
+    "HarborCamera",
+    "HarborMonitor",
+    "HarborEvent",
+    "HarborEventBus",
+    "EventType",
+    "RawEventUpdate",
+    "HeartbeatUpdate",
+    "LocalLivekitHeartbeatUpdate",
+    "ViewerJoinedUpdate",
+    "ViewerLeftUpdate",
+    "SettingsUpdate",
+    "CameraEventUpdate",
+    "MotionDetectedUpdate",
+    "ViewerInfo",
+    "parse_message",
+    "HeartbeatEvent",
+    "LocalLivekitHeartbeatEvent",
+    "SettingsEvent",
+    "ViewerJoinedEvent",
+    "ViewerLeftEvent",
+    "MotionDetectedEvent",
+    "HarborSourceType",
+    "HarborViewer",
+    "HarborEventState",
+    "HarborDeviceState",
+]

harbor/config.py

@@ -0,0 +1,11 @@
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True)
+class HarborCameraConfig:
+    serial: str
+    cert_path: str
+    key_path: str
+    cert_dir: str
+
+    ip_address: str | None = None

harbor/core.py

@@ -0,0 +1,63 @@
+import logging
+from typing import Any
+
+from .config import HarborCameraConfig
+from .device import HarborDevice
+from .mqtt import HarborMQTTClient
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class Harbor:
+    """
+    High-level API for managing Harbor devices and MQTT connections.
+    """
+
+    def __init__(self) -> None:
+        self._devices: dict[str, HarborDevice] = {}
+        self._clients: dict[str, HarborMQTTClient] = {}
+        self._topics_cache: set[str] = set()
+
+    def add_device(self, device: HarborDevice) -> None:
+        """Add a device (camera or monitor) to be managed."""
+        self._devices[device.serial] = device
+        self._topics_cache.update(device.get_topics())
+        _LOGGER.debug("Added device: %s (%s)", device.serial, type(device).__name__)
+
+    def add_camera_connection(self, config: HarborCameraConfig) -> None:
+        """
+        Add a camera connection configuration.
+        This creates an MQTT client for the specified camera.
+        """
+        if config.serial in self._clients:
+            _LOGGER.warning("Camera connection already exists: %s", config.serial)
+            return
+        topics = list(self._topics_cache)
+        client = HarborMQTTClient(
+            config=config,
+            topics=topics,
+            message_handler=self.handle_message,
+            client_id=f"harbor-client-{config.serial}",
+        )
+        self._clients[config.serial] = client
+        _LOGGER.info("Added MQTT client for camera: %s", config.serial)
+
+    async def start(self) -> None:
+        """Start all MQTT clients."""
+        for client in self._clients.values():
+            await client.start()
+
+    async def stop(self) -> None:
+        """Stop all MQTT clients and release device resources."""
+        for client in self._clients.values():
+            await client.stop()
+        for device in self._devices.values():
+            device.shutdown()
+
+    async def handle_message(self, topic: str, payload: Any) -> None:
+        """
+        Central message handler.
+        Dispatches messages to all interested devices.
+        """
+        for device in self._devices.values():
+            await device.handle_message(topic, payload)

harbor/data/mqtt_models.py

@@ -0,0 +1,123 @@
+from __future__ import annotations
+
+from typing import Any
+
+from pydantic import BaseModel, ConfigDict, Field
+
+
+class HarborMQTTPayload(BaseModel):
+    """Base model for Harbor MQTT payloads."""
+
+    model_config = ConfigDict(extra="allow")
+
+
+class LocalLivekitHeartbeatEvent(HarborMQTTPayload):
+    """Payload for a local LiveKit heartbeat."""
+
+    app_start_time: str | None = None
+    app_version: str | None = None
+    bitrate: float | None = None
+    camera_present: bool | None = None
+    camera_state: str | None = None
+    is_healthy: dict[str, Any] = Field(default_factory=dict)
+    network_bars: int | None = None
+    os_version: str | None = None
+    receiver_present: bool | None = None
+    speaker_state: str | None = None
+    stream_quality: str | None = None
+    stream_start_time: str | None = None
+    viewers_by_identity: dict[str, Any] = Field(default_factory=dict)
+    viewers_by_identity_full: dict[str, Any] = Field(default_factory=dict)
+
+
+class HeartbeatEvent(HarborMQTTPayload):
+    """Payload for a device heartbeat."""
+
+    app_version: str | None = None
+    efuse_voltage: int | None = None
+    image_sensor_temperature: float | None = None
+    ntc_adc_voltage: int | None = None
+    ntc_temperature: float | None = None
+    os_version: str | None = None
+    raw_temperature: float | None = None
+    sensor_temperature: float | None = None
+    temperature: float | None = None
+
+
+class Settings(HarborMQTTPayload):
+    """Camera settings included with a settings event."""
+
+    log_level: str | None = None
+    preference_ai: dict[str, Any] = Field(default_factory=dict)
+    preference_anomaly_configs: dict[str, Any] = Field(default_factory=dict)
+    preference_anomaly_throttle_duration_seconds: int | None = None
+    preference_auto_pinning: bool | None = None
+    preference_connection_band: str | None = None
+    preference_connection_bssid: str | None = None
+    preference_display_name: str | None = None
+    preference_moment_length: int | None = None
+    preference_operating_mode: str | None = None
+    preference_scheduled_reboot: str | None = None
+    preference_silence_alerting_until: str | None = None
+    preference_stream_paused: bool | None = None
+    preference_video_clock_display_tz_abbrev: str | None = None
+    preference_video_clock_display_tz_offset: int | None = None
+    preference_video_flip: bool | None = None
+    preference_video_has_clock_display: bool | None = None
+    preference_video_ir_brightness: int | None = None
+    preference_video_night_mode: str | None = None
+
+
+class SettingsState(HarborMQTTPayload):
+    """Runtime state attached to a settings event."""
+
+    application_state: int | None = None
+    network_bars: int | None = None
+    stream_state: int | None = None
+    temperature: float | None = None
+    video_night_mode: bool | None = None
+
+
+class SettingsEvent(HarborMQTTPayload):
+    """Payload for a settings event."""
+
+    client: str | None = None
+    is_updating: bool | None = None
+    seq: str | None = None
+    settings: Settings | None = None
+    state: SettingsState | None = None
+    triggered_by: str | None = None
+    updated: dict[str, Any] = Field(default_factory=dict)
+
+
+class ViewerJoinedEvent(HarborMQTTPayload):
+    """Payload for a viewer joined event."""
+
+    client: str | None = None
+    identity: str | None = None
+    is_local: bool | None = None
+    role: str | None = None
+    viewer_id: str | None = None
+
+
+class ViewerLeftEvent(HarborMQTTPayload):
+    """Payload for a viewer left event."""
+
+    client: str | None = None
+    identity: str | None = None
+    is_local: bool | None = None
+    role: str | None = None
+    viewer_id: str | None = None
+
+
+class MotionDetectedEvent(HarborMQTTPayload):
+    """Payload for a motion detection event."""
+
+    active_config: str | None = None
+    duration: str | float | int | None = None
+    filename: str | None = None
+    level: str | None = None
+    sensitivity: str | None = None
+    threshold: str | None = None
+    thumbnail: str | None = None
+    timestamp: str | None = None

harbor/device.py

@@ -0,0 +1,179 @@
+from __future__ import annotations
+
+import asyncio
+import logging
+from abc import ABC, abstractmethod
+from collections.abc import Callable
+from datetime import UTC
+from typing import Any, TypeVar, overload
+
+from pydantic import BaseModel
+
+from .data.mqtt_models import (
+    HeartbeatEvent as HarborHeartbeatPayload,
+)
+from .data.mqtt_models import (
+    SettingsEvent as HarborSettingsPayload,
+)
+from .events import (
+    HarborEvent,
+    HeartbeatUpdate,
+    SettingsUpdate,
+    SubscriptionManager,
+    parse_message,
+)
+from .state import HarborDeviceState, HarborSourceType
+
+LOGGER = logging.getLogger(__name__)
+
+UpdateCallbackType = Callable[[HarborDeviceState], Any]
+EventT = TypeVar("EventT", bound=HarborEvent)
+
+
+class HarborDevice(ABC):
+    """Abstract base class for Harbor devices."""
+
+    def __init__(self, serial: str, source_type: HarborSourceType) -> None:
+        self.serial = serial
+        self._source_type = source_type
+        self.state = HarborDeviceState(serial=serial, source_type=source_type)
+        self._subscriptions = SubscriptionManager()
+        self._update_subscriptions: list[UpdateCallbackType] = []
+
+    @property
+    def source_type(self) -> HarborSourceType:
+        """Return the source type for events from this device."""
+        return self._source_type
+
+    @abstractmethod
+    def get_topics(self) -> list[str]:
+        """Return a list of topics to subscribe to."""
+        pass
+
+    async def handle_message(self, topic: str, payload: Any) -> HarborEvent | None:
+        """Handle an incoming MQTT message."""
+        if not (event := parse_message(topic, payload)):
+            return None
+
+        if event.source_type != self.source_type or event.source_sn != self.serial:
+            return None
+
+        self._apply_event(event)
+        await self._emit_event(event)
+        await self._emit_update()
+        return event
+
+    @overload
+    def subscribe(
+        self,
+        event_type: type[EventT],
+        callback: Callable[[EventT], Any],
+    ) -> Callable[[], None]: ...
+
+    @overload
+    def subscribe(
+        self,
+        event_type: type[BaseModel],
+        callback: Callable[[HarborEvent], Any],
+    ) -> Callable[[], None]: ...
+
+    @overload
+    def subscribe(
+        self,
+        event_type: None,
+        callback: Callable[[HarborEvent], Any],
+    ) -> Callable[[], None]: ...
+
+    def subscribe(
+        self,
+        event_type: type[HarborEvent] | type[BaseModel] | None,
+        callback: Callable[[Any], Any],
+    ) -> Callable[[], None]:
+        """Subscribe to a specific Harbor event type or all events."""
+
+        return self._subscriptions.subscribe(event_type, callback)
+
+    async def _emit_event(self, event: HarborEvent) -> None:
+        """Emit a parsed Harbor event to subscribers."""
+
+        await self._subscriptions.emit(event)
+
+    def subscribe_updates(
+        self,
+        callback: UpdateCallbackType,
+    ) -> Callable[[], None]:
+        """Subscribe to device state updates."""
+        self._update_subscriptions.append(callback)
+
+        def unsubscribe() -> None:
+            if callback in self._update_subscriptions:
+                self._update_subscriptions.remove(callback)
+
+        return unsubscribe
+
+    async def _emit_update(self) -> None:
+        """Emit a state update to subscribers."""
+        for callback in list(self._update_subscriptions):
+            try:
+                result = callback(self.state)
+                if asyncio.iscoroutine(result):
+                    await result
+            except Exception:
+                LOGGER.exception(
+                    "Error in device update callback %s for %s",
+                    getattr(callback, "__qualname__", repr(callback)),
+                    self.serial,
+                )
+
+    def shutdown(self) -> None:
+        """Release device resources."""
+
+    def _apply_event(self, event: HarborEvent) -> None:
+        """Apply a parsed Harbor event to device state.
+
+        Subclasses should override this to handle device-specific event types,
+        calling ``super()._apply_event(event)`` to keep the shared handling.
+        """
+        self.state.last_seen = event.timestamp.astimezone(UTC)
+        self._update_shared_metadata(event)
+
+        match event:
+            case HeartbeatUpdate(payload=payload):
+                self._apply_heartbeat(payload)
+            case SettingsUpdate(payload=payload):
+                self._apply_settings(payload)
+
+    def _update_shared_metadata(self, event: HarborEvent) -> None:
+        """Update metadata shared across Harbor event types."""
+        if event.os_version is not None:
+            self.state.os_version = event.os_version
+
+        if event.app_version is not None:
+            self.state.app_version = event.app_version
+
+        if event.display_name is not None:
+            self.state.display_name = event.display_name
+
+    def _apply_heartbeat(self, payload: HarborHeartbeatPayload) -> None:
+        """Apply a device heartbeat payload."""
+        self._set_state_value("temperature", payload.temperature)
+        self._set_state_value("sensor_temperature", payload.sensor_temperature)
+        self._set_state_value("raw_temperature", payload.raw_temperature)
+        self._set_state_value(
+            "image_sensor_temperature",
+            payload.image_sensor_temperature,
+        )
+        self._set_state_value("ntc_temperature", payload.ntc_temperature)
+
+    def _apply_settings(self, payload: HarborSettingsPayload) -> None:
+        """Apply a settings payload."""
+        if payload.state is None:
+            return
+
+        self._set_state_value("wifi_strength", payload.state.network_bars)
+        self._set_state_value("temperature", payload.state.temperature)
+
+    def _set_state_value(self, key: str, value: Any) -> None:
+        """Set a state value when the payload exposed a concrete value."""
+        if value is not None:
+            self.state.values[key] = value

harbor/devices/camera.py

@@ -0,0 +1,177 @@
+from __future__ import annotations
+
+import asyncio
+import logging
+
+from ..config import HarborCameraConfig
+from ..device import HarborDevice
+from ..events import (
+    CameraEventUpdate,
+    HarborEvent,
+    LocalLivekitHeartbeatUpdate,
+    ViewerInfo,
+    ViewerJoinedUpdate,
+    ViewerLeftUpdate,
+)
+from ..state import HarborEventState, HarborViewer
+
+_LOGGER = logging.getLogger(__name__)
+
+DEFAULT_CAMERA_EVENT_KEYS = ("motion_detection", "cry_detection", "noise_detection")
+DEFAULT_EVENT_ACTIVE_SECONDS = 5.0
+
+
+class HarborCamera(HarborDevice):
+    """Represents a Harbor camera device."""
+
+    def __init__(self, config: HarborCameraConfig) -> None:
+        """Initialize the camera device."""
+        super().__init__(config.serial, "camera")
+        self.config = config
+        self._event_reset_handles: dict[str, asyncio.TimerHandle] = {}
+
+        for event_key in DEFAULT_CAMERA_EVENT_KEYS:
+            self._ensure_camera_event(event_key)
+
+    def get_topics(self) -> list[str]:
+        """Return topics that should be subscribed for this device."""
+
+        return [f"cameras/{self.serial}/events/#"]
+
+    def _apply_event(self, event: HarborEvent) -> None:
+        """Apply a Harbor event to camera state, including camera-only events."""
+        super()._apply_event(event)
+        match event:
+            case LocalLivekitHeartbeatUpdate(payload=payload, viewers=viewers):
+                self._apply_local_livekit_heartbeat(payload, viewers)
+            case ViewerJoinedUpdate(viewer=viewer):
+                self._apply_viewer_joined(viewer)
+            case ViewerLeftUpdate(viewer_id=viewer_id):
+                self._apply_viewer_left(viewer_id)
+            case CameraEventUpdate():
+                self._apply_camera_event(event)
+
+    def _apply_local_livekit_heartbeat(
+        self,
+        payload,
+        viewers: tuple[ViewerInfo, ...],
+    ) -> None:
+        """Apply a local LiveKit heartbeat payload."""
+        self._set_state_value("bitrate", payload.bitrate)
+        self._set_state_value("wifi_strength", payload.network_bars)
+        self._set_state_value("camera_present", payload.camera_present)
+        self._set_state_value("speaker_state", payload.speaker_state)
+        self._set_state_value("stream_quality", payload.stream_quality)
+        self._set_state_value("app_start_time", payload.app_start_time)
+        self._set_state_value("stream_start_time", payload.stream_start_time)
+
+        self.state.viewers = {
+            viewer.viewer_id: HarborViewer(
+                viewer_id=viewer.viewer_id,
+                identity=viewer.identity,
+                client=viewer.client,
+                is_local=viewer.is_local,
+                role=viewer.role,
+            )
+            for viewer in viewers
+        }
+        self.state.values["num_viewers"] = len(self.state.viewers)
+
+    def _apply_viewer_joined(self, viewer: ViewerInfo | None) -> None:
+        """Apply a viewer joined update."""
+        if viewer is None:
+            return
+
+        self.state.viewers[viewer.viewer_id] = HarborViewer(
+            viewer_id=viewer.viewer_id,
+            identity=viewer.identity,
+            client=viewer.client,
+            is_local=viewer.is_local,
+            role=viewer.role,
+        )
+        self.state.values["num_viewers"] = len(self.state.viewers)
+
+    def _apply_viewer_left(self, viewer_id: str | None) -> None:
+        """Apply a viewer left update."""
+        if viewer_id is None:
+            return
+
+        self.state.viewers.pop(viewer_id, None)
+        self.state.values["num_viewers"] = len(self.state.viewers)
+
+    def _apply_camera_event(self, event: CameraEventUpdate) -> None:
+        """Apply a transient camera event update."""
+        event_state = self._ensure_camera_event(event.event_key, topic=event.topic)
+        event_state.topic = event.topic
+        event_state.last_seen = event.timestamp
+        event_state.last_payload = event.raw_payload
+
+        if handle := self._event_reset_handles.pop(event.event_key, None):
+            handle.cancel()
+
+        if event.explicit_state is False:
+            event_state.is_on = False
+            return
+
+        event_state.is_on = True
+        active_seconds = event.active_seconds
+        if active_seconds <= 0:
+            active_seconds = DEFAULT_EVENT_ACTIVE_SECONDS
+
+        loop = asyncio.get_running_loop()
+        self._event_reset_handles[event.event_key] = loop.call_later(
+            active_seconds,
+            lambda: asyncio.create_task(self._async_reset_event(event.event_key)),
+        )
+        _LOGGER.debug(
+            "Camera %s received event on topic %s: %s",
+            self.serial,
+            event.topic,
+            event.raw_payload,
+        )
+
+    def shutdown(self) -> None:
+        """Release camera resources."""
+        for handle in self._event_reset_handles.values():
+            handle.cancel()
+        self._event_reset_handles.clear()
+
+    async def _async_reset_event(self, event_key: str) -> None:
+        """Reset a transient event to off after its active period."""
+        self._event_reset_handles.pop(event_key, None)
+        if event_state := self.state.events.get(event_key):
+            event_state.is_on = False
+            await self._emit_update()
+
+    def _ensure_camera_event(
+        self,
+        event_key: str,
+        *,
+        topic: str | None = None,
+    ) -> HarborEventState:
+        """Ensure an event state exists for the camera."""
+        if existing := self.state.events.get(event_key):
+            if topic is not None:
+                existing.topic = topic
+            return existing
+
+        event_state = HarborEventState(
+            key=event_key,
+            topic=topic or event_key.replace("_", "-"),
+            friendly_name=_event_name_from_key(event_key),
+        )
+        self.state.events[event_key] = event_state
+        return event_state
+
+
+def _event_name_from_key(event_key: str) -> str:
+    """Return a user-facing event name for an event key."""
+    if event_key == "cry_detection":
+        return "Cry detected"
+    if event_key == "motion_detection":
+        return "Motion detected"
+    if event_key == "noise_detection":
+        return "Noise detected"
+
+    words = event_key.replace("_", " ").strip()
+    return words[:1].upper() + words[1:] if words else event_key

harbor/devices/monitor.py

@@ -0,0 +1,16 @@
+from __future__ import annotations
+
+from ..device import HarborDevice
+
+
+class HarborMonitor(HarborDevice):
+    """Represents a Harbor monitor device."""
+
+    def __init__(self, serial: str) -> None:
+        """Initialize the monitor device."""
+        super().__init__(serial, "monitor")
+
+    def get_topics(self) -> list[str]:
+        """Return topics that should be subscribed for this device."""
+
+        return [f"monitors/{self.serial}/events/#"]