@camera.ui/server 0.0.70 → 0.0.71-dev.0

package/dist/server/src/_camera_ui_tools/camera_ui_sdk/camera/config.py

@@ -0,0 +1,256 @@
+from __future__ import annotations
+
+from typing import Any, Literal, NotRequired, TypedDict
+
+from ..sensor.base import SensorType
+from .detection import (
+    CameraDetectionSettings,
+    DetectionLine,
+    DetectionZone,
+    PtzAutotrackSettings,
+)
+from .enums import (
+    CameraAspectRatio,
+    CameraRole,
+    CameraType,
+    StreamingRole,
+    VideoStreamingMode,
+)
+from .frames import CameraFrameWorkerSettings, SnapshotSettings
+from .streaming import StreamUrls
+
+
+class CameraInformation(TypedDict, total=False):
+    """Camera hardware/firmware information."""
+
+    model: str
+    """Camera model name."""
+    manufacturer: str
+    """Manufacturer name."""
+    hardware: str
+    """Hardware version/revision."""
+    serialNumber: str
+    """Device serial number."""
+    firmwareVersion: str
+    """Current firmware version."""
+    supportUrl: str
+    """Manufacturer support URL."""
+
+
+class CameraInput(TypedDict):
+    """Camera video input/source with resolved URLs."""
+
+    _id: str
+    """Unique source ID."""
+    name: str
+    """Source display name."""
+    role: CameraRole
+    """Resolution role."""
+    useForSnapshot: bool
+    """Use this source for snapshots."""
+    hotMode: bool
+    """Keep connection always active."""
+    preload: bool
+    """Preload stream on startup."""
+    prebuffer: bool
+    """Enable stream prebuffering."""
+    urls: StreamUrls
+    """Generated streaming URLs."""
+    childSourceId: NotRequired[str]
+    """Child source ID (for snapshot fallback)."""
+
+
+class CameraConfigInputSettings(TypedDict):
+    """Camera input settings for config."""
+
+    name: str
+    """Source display name."""
+    role: CameraRole
+    """Resolution role."""
+    useForSnapshot: bool
+    """Use this source for snapshots."""
+    hotMode: bool
+    """Keep connection always active."""
+    preload: bool
+    """Preload stream on startup."""
+    prebuffer: bool
+    """Enable stream prebuffering."""
+    childSourceId: NotRequired[str]
+    """Child source ID (for snapshot fallback)."""
+    urls: NotRequired[list[str]]
+
+
+class BaseCameraConfig(TypedDict):
+    """Base camera configuration (shared fields)."""
+
+    name: str
+    """Camera display name."""
+    nativeId: NotRequired[str]
+    """Native device ID from plugin."""
+    isCloud: NotRequired[bool]
+    """Whether camera streams from cloud."""
+    disabled: NotRequired[bool]
+    """Disable this camera."""
+    info: NotRequired[CameraInformation]
+    """Camera hardware information."""
+
+
+class CameraConfig(BaseCameraConfig):
+    """Full camera configuration with sources."""
+
+    sources: list[CameraConfigInputSettings]
+    """Video input sources."""
+
+
+class CameraUiSettings(TypedDict):
+    """UI display settings for a camera."""
+
+    streamingMode: VideoStreamingMode
+    """Preferred streaming method."""
+    streamingSource: StreamingRole
+    """Preferred stream quality."""
+    aspectRatio: CameraAspectRatio
+    """Display aspect ratio."""
+
+
+class AssignedPlugin(TypedDict):
+    """Plugin assignment info."""
+
+    id: str
+    """Plugin ID."""
+    name: str
+    """Plugin display name."""
+
+
+class PluginAssignments(TypedDict, total=False):
+    """
+    Plugin assignments for camera sensors/features.
+    Maps sensor types to their assigned plugin(s).
+    """
+
+    motion: AssignedPlugin
+    """Motion detection plugin."""
+    object: AssignedPlugin
+    """Object detection plugin."""
+    audio: AssignedPlugin
+    """Audio detection plugin."""
+    face: AssignedPlugin
+    """Face detection plugin."""
+    licensePlate: AssignedPlugin
+    """License plate detection plugin."""
+    ptz: AssignedPlugin
+    """PTZ control plugin."""
+    battery: AssignedPlugin
+    """Battery info plugin."""
+    cameraController: AssignedPlugin
+    """Camera controller plugin."""
+    light: list[AssignedPlugin]
+    """Light control plugins."""
+    siren: list[AssignedPlugin]
+    """Siren control plugins."""
+    contact: list[AssignedPlugin]
+    """Contact sensor plugins."""
+    doorbell: list[AssignedPlugin]
+    """Doorbell trigger plugins."""
+    hub: list[AssignedPlugin]
+    """Hub/bridge plugins."""
+
+
+class CameraPluginInfo(TypedDict):
+    """Camera source plugin information."""
+
+    id: str
+    """Plugin ID."""
+    name: str
+    """Plugin display name."""
+
+
+class BaseCamera(TypedDict):
+    """Base camera data structure (stored in database)."""
+
+    _id: str
+    """Unique camera ID."""
+    nativeId: str | None
+    """Native device ID from plugin."""
+    pluginInfo: CameraPluginInfo | None
+    """Source plugin information."""
+    name: str
+    """Camera display name."""
+    room: str
+    """Room this camera belongs to."""
+    disabled: bool
+    """Whether camera is disabled."""
+    isCloud: bool
+    """Whether camera streams from cloud."""
+    info: CameraInformation
+    """Camera hardware information."""
+    type: CameraType
+    """Camera type (camera/doorbell)."""
+    snapshotSettings: SnapshotSettings
+    """Snapshot settings."""
+    detectionZones: list[DetectionZone]
+    """Detection zone configurations."""
+    detectionLines: list[DetectionLine]
+    """Detection line configurations (virtual tripwires)."""
+    detectionSettings: CameraDetectionSettings
+    """Detection settings."""
+    ptzAutotrack: PtzAutotrackSettings
+    """PTZ autotracking settings."""
+    frameWorkerSettings: CameraFrameWorkerSettings
+    """Frame worker settings."""
+    interfaceSettings: CameraUiSettings
+    """UI display settings."""
+    plugins: list[AssignedPlugin]
+    """Installed plugins."""
+    assignments: PluginAssignments
+    """Sensor-to-plugin assignments."""
+
+
+class Camera(BaseCamera):
+    """Camera with resolved video sources."""
+
+    sources: list[CameraInput]
+    """Video input sources."""
+
+
+CameraPublicProperties = Literal[
+    "_id",
+    "nativeId",
+    "pluginInfo",
+    "name",
+    "disabled",
+    "isCloud",
+    "info",
+    "type",
+    "snapshotSettings",
+    "detectionZones",
+    "detectionSettings",
+    "ptzAutotrack",
+    "frameWorkerSettings",
+    "interfaceSettings",
+    "recording",
+    "plugins",
+    "assignments",
+    "sources",
+]
+"""Camera public property names for observation."""
+
+
+class SensorEventData(TypedDict):
+    """Emitted when a sensor is added or removed."""
+
+    sensorId: str
+    """Sensor ID."""
+    sensorType: SensorType
+    """Sensor type."""
+
+
+class CameraPropertyObservableObject(TypedDict):
+    """Camera property change event."""
+
+    property: str
+    """Property name that changed."""
+    old_state: Any
+    """Previous value."""
+    new_state: Any
+    """New value."""

package/dist/server/src/_camera_ui_tools/camera_ui_sdk/camera/detection.py

@@ -0,0 +1,135 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, NotRequired, TypedDict
+
+if TYPE_CHECKING:
+    from ..sensor.base import SensorType
+
+from ..sensor.detection import DetectionLabel
+from .enums import LineDirection, MotionResolution, Point, ZoneFilter, ZoneType
+
+
+class DetectionZone(TypedDict):
+    """
+    Detection zone configuration.
+    Defines areas for detection filtering or privacy masking.
+    """
+
+    name: str
+    """Zone display name."""
+    points: list[Point]
+    """Polygon points (0-100 percentage coordinates)."""
+    type: ZoneType
+    """Intersection detection type."""
+    filter: ZoneFilter
+    """Include/exclude filter mode."""
+    labels: list[DetectionLabel]
+    """Labels to filter (empty = all labels)."""
+    isPrivacyMask: bool
+    """Whether this is a privacy mask (blur/block area)."""
+    color: str
+    """Zone display color (hex)."""
+
+
+class DetectionLine(TypedDict):
+    """
+    Detection line configuration.
+    Defines a virtual tripwire for line crossing detection.
+    The two points define grab-handle positions; the actual crossing line
+    is perpendicular through their midpoint.
+    """
+
+    name: str
+    """Line display name."""
+    points: list[Point]
+    """Grab-handle positions (0-100%). Crossing line is perpendicular through midpoint."""
+    direction: LineDirection
+    """Which crossing direction(s) trigger events."""
+    labels: list[DetectionLabel]
+    """Labels to filter (empty = all labels)."""
+    color: str
+    """Line display color (hex)."""
+
+
+class MotionDetectionSettings(TypedDict):
+    """Motion detection settings."""
+
+    resolution: MotionResolution
+    """Detection resolution quality."""
+    timeout: int
+    """Motion dwell time in seconds."""
+
+
+class ObjectDetectionSettings(TypedDict):
+    """Object detection settings."""
+
+    confidence: float
+    """Minimum confidence threshold (0-1)."""
+
+
+class AudioDetectionSettings(TypedDict):
+    """Audio detection settings."""
+
+    minDecibels: float
+    """Minimum volume threshold in dBFS (-100 to 0). Audio below this level is skipped."""
+    timeout: int
+    """Audio dwell time in seconds."""
+
+
+class SensorTriggerRef(TypedDict):
+    """Stable reference to a sensor for cascade trigger configuration.
+    Uses composite key (sensorType + sensorName + pluginId) instead of UUID
+    so references survive plugin restarts."""
+
+    sensorType: SensorType
+    """Sensor type (e.g. 'contact', 'doorbell')."""
+    sensorName: str
+    """Sensor name (stable across restarts)."""
+    pluginId: str
+    """Plugin ID that provides this sensor."""
+
+
+class SensorTriggerSettings(TypedDict):
+    """Sensor trigger settings (contact, doorbell, switch, light, etc.)."""
+
+    timeout: int
+    """Sensor trigger timeout in seconds."""
+    triggers: list[SensorTriggerRef]
+    """Sensors that also trigger the detection cascade (in addition to motion/audio)."""
+
+
+class PtzAutotrackSettings(TypedDict):
+    """PTZ autotracking settings — automatically follow detected objects."""
+
+    enabled: bool
+    """Whether PTZ autotracking is enabled."""
+    targetLabels: list[str]
+    """Object labels to track (e.g. 'person', 'vehicle')."""
+    minConfidence: float
+    """Minimum detection confidence to track (0.3 - 1.0)."""
+    triggerDeadZone: float
+    """Dead zone around frame center (0 - 0.3). No motor command while the
+    target is inside this zone."""
+    returnToHome: bool
+    """Return to home position when no target is found for homeWaitMs."""
+    homeWaitMs: int
+    """How long to wait (ms) without a target before returning home."""
+
+
+class CameraDetectionSettings(TypedDict):
+    """Combined detection settings for a camera."""
+
+    motion: MotionDetectionSettings
+    """Motion detection settings."""
+    object: ObjectDetectionSettings
+    """Object detection settings."""
+    audio: AudioDetectionSettings
+    """Audio detection settings."""
+    sensor: SensorTriggerSettings
+    """Sensor trigger settings."""
+    cascadeDetection: NotRequired[bool]
+    """Whether the detection cascade is enabled"""
+    cascadeTimeout: NotRequired[int]
+    """Cascade hold-open window in seconds"""
+    snooze: NotRequired[bool]
+    """Whether detections are snoozed (paused)."""