harbor-python 1.0.0__tar.gz

harbor_python-1.0.0/.gitignore

@@ -0,0 +1,13 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+/reference/
+/keys/
+.idea

harbor_python-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Harbor Systems
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

harbor_python-1.0.0/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.4
+Name: harbor-python
+Version: 1.0.0
+Summary: A package to locally connect to a Harbor Sleep Camera
+Author: Andres Garcia, Lash-L
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: baby,baby monitor,harbor
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: <4,>=3.11
+Requires-Dist: aiomqtt>=2.5.0
+Requires-Dist: pydantic>=2.12.2
+Description-Content-Type: text/markdown
+
+# Harbor Python
+
+A Python package to locally connect to Harbor Sleep Cameras.

harbor_python-1.0.0/README.md

@@ -0,0 +1,3 @@
+# Harbor Python
+
+A Python package to locally connect to Harbor Sleep Cameras.

harbor_python-1.0.0/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_python-1.0.0/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_python-1.0.0/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_python-1.0.0/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_python-1.0.0/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