uiprotect 0.1.0__py3-none-any.whl

uiprotect/cli/liveviews.py

@@ -0,0 +1,65 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Optional
+
+import typer
+
+from uiprotect.api import ProtectApiClient
+from uiprotect.cli import base
+from uiprotect.data import Liveview
+
+app = typer.Typer(rich_markup_mode="rich")
+
+ARG_DEVICE_ID = typer.Argument(None, help="ID of liveview to select for subcommands")
+ALL_COMMANDS = {"list-ids": app.command(name="list-ids")(base.list_ids)}
+
+app.command(name="protect-url")(base.protect_url)
+
+
+@dataclass
+class LiveviewContext(base.CliContext):
+    devices: dict[str, Liveview]
+    device: Liveview | None = None
+
+
+@app.callback(invoke_without_command=True)
+def main(ctx: typer.Context, device_id: Optional[str] = ARG_DEVICE_ID) -> None:
+    """
+    Liveviews CLI.
+
+    Returns full list of Liveviews without any arguments passed.
+    """
+    protect: ProtectApiClient = ctx.obj.protect
+    context = LiveviewContext(
+        protect=ctx.obj.protect,
+        device=None,
+        devices=protect.bootstrap.liveviews,
+        output_format=ctx.obj.output_format,
+    )
+    ctx.obj = context
+
+    if device_id is not None and device_id not in ALL_COMMANDS:
+        if (device := protect.bootstrap.liveviews.get(device_id)) is None:
+            typer.secho("Invalid liveview ID", fg="red")
+            raise typer.Exit(1)
+        ctx.obj.device = device
+
+    if not ctx.invoked_subcommand:
+        if device_id in ALL_COMMANDS:
+            ctx.invoke(ALL_COMMANDS[device_id], ctx)
+            return
+
+        if ctx.obj.device is not None:
+            base.print_unifi_obj(ctx.obj.device, ctx.obj.output_format)
+            return
+
+        base.print_unifi_dict(ctx.obj.devices)
+
+
+@app.command()
+def owner(ctx: typer.Context) -> None:
+    """Gets the owner for the liveview."""
+    base.require_device_id(ctx)
+    obj: Liveview = ctx.obj.device
+    base.print_unifi_obj(obj.owner, ctx.obj.output_format)

uiprotect/cli/nvr.py

@@ -0,0 +1,154 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from datetime import timedelta
+
+import orjson
+import typer
+
+from uiprotect.cli import base
+from uiprotect.data import NVR, AnalyticsOption
+
+app = typer.Typer(rich_markup_mode="rich")
+
+ARG_TIMEOUT = typer.Argument(..., help="Timeout (in seconds)")
+ARG_DOORBELL_MESSAGE = typer.Argument(..., help="ASCII only. Max length 30")
+OPTION_ENABLE_SMART = typer.Option(
+    False,
+    "--enable-smart",
+    help="Automatically enable smart detections",
+)
+
+
+@dataclass
+class NVRContext(base.CliContext):
+    device: NVR
+
+
+@app.callback(invoke_without_command=True)
+def main(ctx: typer.Context) -> None:
+    """
+    NVR device CLI.
+
+    Return NVR object without any arguments passed.
+    """
+    context = NVRContext(
+        protect=ctx.obj.protect,
+        device=ctx.obj.protect.bootstrap.nvr,
+        output_format=ctx.obj.output_format,
+    )
+    ctx.obj = context
+
+    if not ctx.invoked_subcommand:
+        base.print_unifi_obj(context.device, ctx.obj.output_format)
+
+
+app.command(name="protect-url")(base.protect_url)
+app.command(name="reboot")(base.reboot)
+app.command(name="set-name")(base.set_name)
+
+
+@app.command()
+def set_analytics(ctx: typer.Context, value: AnalyticsOption) -> None:
+    """Sets analytics collection for NVR."""
+    nvr: NVR = ctx.obj.device
+    base.run(ctx, nvr.set_analytics(value))
+
+
+@app.command()
+def set_default_reset_timeout(ctx: typer.Context, timeout: int = ARG_TIMEOUT) -> None:
+    """
+    Sets default message reset timeout.
+
+    This is how long until a custom message is reset back to the default message if no
+    timeout is passed in when the custom message is set.
+    """
+    nvr: NVR = ctx.obj.device
+    base.run(ctx, nvr.set_default_reset_timeout(timedelta(seconds=timeout)))
+    base.print_unifi_obj(nvr.doorbell_settings, ctx.obj.output_format)
+
+
+@app.command()
+def set_default_doorbell_message(
+    ctx: typer.Context,
+    msg: str = ARG_DOORBELL_MESSAGE,
+) -> None:
+    """
+    Sets default message for doorbell.
+
+    This is the message that is set when a custom doorbell message times out or an empty
+    one is set.
+    """
+    nvr: NVR = ctx.obj.device
+    base.run(ctx, nvr.set_default_doorbell_message(msg))
+    base.print_unifi_obj(nvr.doorbell_settings, ctx.obj.output_format)
+
+
+@app.command()
+def add_custom_doorbell_message(
+    ctx: typer.Context,
+    msg: str = ARG_DOORBELL_MESSAGE,
+) -> None:
+    """Adds a custom doorbell message."""
+    nvr: NVR = ctx.obj.device
+    base.run(ctx, nvr.add_custom_doorbell_message(msg))
+    base.print_unifi_obj(nvr.doorbell_settings, ctx.obj.output_format)
+
+
+@app.command()
+def remove_custom_doorbell_message(
+    ctx: typer.Context,
+    msg: str = ARG_DOORBELL_MESSAGE,
+) -> None:
+    """Removes a custom doorbell message."""
+    nvr: NVR = ctx.obj.device
+    base.run(ctx, nvr.remove_custom_doorbell_message(msg))
+    base.print_unifi_obj(nvr.doorbell_settings, ctx.obj.output_format)
+
+
+@app.command()
+def update(ctx: typer.Context, data: str) -> None:
+    """Updates the NVR."""
+    nvr: NVR = ctx.obj.device
+    base.run(ctx, nvr.api.update_nvr(orjson.loads(data)))
+
+
+@app.command()
+def set_smart_detections(ctx: typer.Context, value: bool) -> None:
+    """Set if smart detections are globally enabled or not."""
+    nvr: NVR = ctx.obj.device
+    base.run(ctx, nvr.set_smart_detections(value))
+
+
+@app.command()
+def set_face_recognition(
+    ctx: typer.Context,
+    value: bool,
+    enable_smart: bool = OPTION_ENABLE_SMART,
+) -> None:
+    """Set if face detections is enabled. Requires smart detections to be enabled."""
+    nvr: NVR = ctx.obj.device
+
+    async def callback() -> None:
+        if enable_smart:
+            await nvr.set_smart_detections(True)
+        await nvr.set_face_recognition(value)
+
+    base.run(ctx, callback())
+
+
+@app.command()
+def set_license_plate_recognition(
+    ctx: typer.Context,
+    value: bool,
+    enable_smart: bool = OPTION_ENABLE_SMART,
+) -> None:
+    """Set if license plate detections is enabled. Requires smart detections to be enabled."""
+    nvr: NVR = ctx.obj.device
+
+    async def callback() -> None:
+        if enable_smart:
+            await nvr.set_smart_detections(True)
+        await nvr.set_license_plate_recognition(value)
+
+    base.run(ctx, callback())

uiprotect/cli/sensors.py

@@ -0,0 +1,278 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Optional
+
+import typer
+
+from uiprotect.api import ProtectApiClient
+from uiprotect.cli import base
+from uiprotect.data import MountType, Sensor
+
+app = typer.Typer(rich_markup_mode="rich")
+
+ARG_DEVICE_ID = typer.Argument(None, help="ID of sensor to select for subcommands")
+
+
+@dataclass
+class SensorContext(base.CliContext):
+    devices: dict[str, Sensor]
+    device: Sensor | None = None
+
+
+ALL_COMMANDS, DEVICE_COMMANDS = base.init_common_commands(app)
+
+
+@app.callback(invoke_without_command=True)
+def main(ctx: typer.Context, device_id: Optional[str] = ARG_DEVICE_ID) -> None:
+    """
+    Sensors device CLI.
+
+    Returns full list of Sensors without any arguments passed.
+    """
+    protect: ProtectApiClient = ctx.obj.protect
+    context = SensorContext(
+        protect=ctx.obj.protect,
+        device=None,
+        devices=protect.bootstrap.sensors,
+        output_format=ctx.obj.output_format,
+    )
+    ctx.obj = context
+
+    if device_id is not None and device_id not in ALL_COMMANDS:
+        if (device := protect.bootstrap.sensors.get(device_id)) is None:
+            typer.secho("Invalid sensor ID", fg="red")
+            raise typer.Exit(1)
+        ctx.obj.device = device
+
+    if not ctx.invoked_subcommand:
+        if device_id in ALL_COMMANDS:
+            ctx.invoke(ALL_COMMANDS[device_id], ctx)
+            return
+
+        if ctx.obj.device is not None:
+            base.print_unifi_obj(ctx.obj.device, ctx.obj.output_format)
+            return
+
+        base.print_unifi_dict(ctx.obj.devices)
+
+
+@app.command()
+def camera(ctx: typer.Context, camera_id: Optional[str] = typer.Argument(None)) -> None:
+    """Returns or sets tha paired camera for a sensor."""
+    base.require_device_id(ctx)
+    obj: Sensor = ctx.obj.device
+
+    if camera_id is None:
+        base.print_unifi_obj(obj.camera, ctx.obj.output_format)
+    else:
+        protect: ProtectApiClient = ctx.obj.protect
+        if (camera_obj := protect.bootstrap.cameras.get(camera_id)) is None:
+            typer.secho("Invalid camera ID")
+            raise typer.Exit(1)
+        base.run(ctx, obj.set_paired_camera(camera_obj))
+
+
+@app.command()
+def is_tampering_detected(ctx: typer.Context) -> None:
+    """Returns if tampering is detected for sensor"""
+    base.require_device_id(ctx)
+    obj: Sensor = ctx.obj.device
+    base.json_output(obj.is_tampering_detected)
+
+
+@app.command()
+def is_alarm_detected(ctx: typer.Context) -> None:
+    """Returns if alarm is detected for sensor"""
+    base.require_device_id(ctx)
+    obj: Sensor = ctx.obj.device
+    base.json_output(obj.is_alarm_detected)
+
+
+@app.command()
+def is_contact_enabled(ctx: typer.Context) -> None:
+    """Returns if contact sensor is enabled for sensor"""
+    base.require_device_id(ctx)
+    obj: Sensor = ctx.obj.device
+    base.json_output(obj.is_contact_sensor_enabled)
+
+
+@app.command()
+def is_motion_enabled(ctx: typer.Context) -> None:
+    """Returns if motion sensor is enabled for sensor"""
+    base.require_device_id(ctx)
+    obj: Sensor = ctx.obj.device
+    base.json_output(obj.is_contact_sensor_enabled)
+
+
+@app.command()
+def is_alarm_enabled(ctx: typer.Context) -> None:
+    """Returns if alarm sensor is enabled for sensor"""
+    base.require_device_id(ctx)
+    obj: Sensor = ctx.obj.device
+    base.json_output(obj.is_alarm_sensor_enabled)
+
+
+@app.command()
+def is_light_enabled(ctx: typer.Context) -> None:
+    """Returns if light sensor is enabled for sensor"""
+    base.require_device_id(ctx)
+    obj: Sensor = ctx.obj.device
+    base.json_output(obj.is_light_sensor_enabled)
+
+
+@app.command()
+def is_temperature_enabled(ctx: typer.Context) -> None:
+    """Returns if temperature sensor is enabled for sensor"""
+    base.require_device_id(ctx)
+    obj: Sensor = ctx.obj.device
+    base.json_output(obj.is_temperature_sensor_enabled)
+
+
+@app.command()
+def is_humidity_enabled(ctx: typer.Context) -> None:
+    """Returns if humidity sensor is enabled for sensor"""
+    base.require_device_id(ctx)
+    obj: Sensor = ctx.obj.device
+    base.json_output(obj.is_humidity_sensor_enabled)
+
+
+@app.command()
+def set_status_light(ctx: typer.Context, enabled: bool) -> None:
+    """Sets status light for sensor device."""
+    base.require_device_id(ctx)
+    obj: Sensor = ctx.obj.device
+
+    base.run(ctx, obj.set_status_light(enabled))
+
+
+@app.command()
+def set_mount_type(ctx: typer.Context, mount_type: MountType) -> None:
+    """Sets mount type for sensor device."""
+    base.require_device_id(ctx)
+    obj: Sensor = ctx.obj.device
+
+    base.run(ctx, obj.set_mount_type(mount_type))
+
+
+@app.command()
+def set_motion(ctx: typer.Context, enabled: bool) -> None:
+    """Sets motion sensor status for sensor device."""
+    base.require_device_id(ctx)
+    obj: Sensor = ctx.obj.device
+
+    base.run(ctx, obj.set_motion_status(enabled))
+
+
+@app.command()
+def set_temperature(ctx: typer.Context, enabled: bool) -> None:
+    """Sets temperature sensor status for sensor device."""
+    base.require_device_id(ctx)
+    obj: Sensor = ctx.obj.device
+
+    base.run(ctx, obj.set_temperature_status(enabled))
+
+
+@app.command()
+def set_humidity(ctx: typer.Context, enabled: bool) -> None:
+    """Sets humidity sensor status for sensor device."""
+    base.require_device_id(ctx)
+    obj: Sensor = ctx.obj.device
+
+    base.run(ctx, obj.set_humidity_status(enabled))
+
+
+@app.command()
+def set_light(ctx: typer.Context, enabled: bool) -> None:
+    """Sets light sensor status for sensor device."""
+    base.require_device_id(ctx)
+    obj: Sensor = ctx.obj.device
+
+    base.run(ctx, obj.set_light_status(enabled))
+
+
+@app.command()
+def set_alarm(ctx: typer.Context, enabled: bool) -> None:
+    """Sets alarm sensor status for sensor device."""
+    base.require_device_id(ctx)
+    obj: Sensor = ctx.obj.device
+
+    base.run(ctx, obj.set_alarm_status(enabled))
+
+
+@app.command()
+def set_motion_sensitivity(
+    ctx: typer.Context,
+    sensitivity: int = typer.Argument(..., min=0, max=100),
+) -> None:
+    """Sets motion sensitivity for the sensor."""
+    base.require_device_id(ctx)
+    obj: Sensor = ctx.obj.device
+
+    base.run(ctx, obj.set_motion_sensitivity(sensitivity))
+
+
+@app.command()
+def set_temperature_range(
+    ctx: typer.Context,
+    low: float = typer.Argument(..., min=0, max=44),
+    high: float = typer.Argument(..., min=1, max=45),
+) -> None:
+    """Sets temperature safe range (in °C). Anything out side of range will trigger event."""
+    base.require_device_id(ctx)
+    obj: Sensor = ctx.obj.device
+
+    base.run(ctx, obj.set_temperature_safe_range(low, high))
+
+
+@app.command()
+def set_humidity_range(
+    ctx: typer.Context,
+    low: float = typer.Argument(..., min=1, max=98),
+    high: float = typer.Argument(..., min=2, max=99),
+) -> None:
+    """Sets humidity safe range (in relative % humidity). Anything out side of range will trigger event."""
+    base.require_device_id(ctx)
+    obj: Sensor = ctx.obj.device
+
+    base.run(ctx, obj.set_humidity_safe_range(low, high))
+
+
+@app.command()
+def set_light_range(
+    ctx: typer.Context,
+    low: float = typer.Argument(..., min=1, max=999),
+    high: float = typer.Argument(..., min=2, max=1000),
+) -> None:
+    """Sets light safe range (in lux). Anything out side of range will trigger event."""
+    base.require_device_id(ctx)
+    obj: Sensor = ctx.obj.device
+
+    base.run(ctx, obj.set_light_safe_range(low, high))
+
+
+@app.command()
+def remove_temperature_range(ctx: typer.Context) -> None:
+    """Removes temperature safe ranges so events will no longer fire."""
+    base.require_device_id(ctx)
+    obj: Sensor = ctx.obj.device
+
+    base.run(ctx, obj.remove_temperature_safe_range())
+
+
+@app.command()
+def remove_humidity_range(ctx: typer.Context) -> None:
+    """Removes humidity safe ranges so events will no longer fire."""
+    base.require_device_id(ctx)
+    obj: Sensor = ctx.obj.device
+
+    base.run(ctx, obj.remove_humidity_safe_range())
+
+
+@app.command()
+def remove_light_range(ctx: typer.Context) -> None:
+    """Removes light safe ranges so events will no longer fire."""
+    base.require_device_id(ctx)
+    obj: Sensor = ctx.obj.device
+
+    base.run(ctx, obj.remove_light_safe_range())

uiprotect/cli/viewers.py

@@ -0,0 +1,76 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Optional
+
+import typer
+
+from uiprotect.api import ProtectApiClient
+from uiprotect.cli import base
+from uiprotect.data import Viewer
+
+app = typer.Typer(rich_markup_mode="rich")
+
+ARG_DEVICE_ID = typer.Argument(None, help="ID of viewer to select for subcommands")
+
+
+@dataclass
+class ViewerContext(base.CliContext):
+    devices: dict[str, Viewer]
+    device: Viewer | None = None
+
+
+ALL_COMMANDS, DEVICE_COMMANDS = base.init_common_commands(app)
+
+
+@app.callback(invoke_without_command=True)
+def main(ctx: typer.Context, device_id: Optional[str] = ARG_DEVICE_ID) -> None:
+    """
+    Viewers device CLI.
+
+    Returns full list of Viewers without any arguments passed.
+    """
+    protect: ProtectApiClient = ctx.obj.protect
+    context = ViewerContext(
+        protect=ctx.obj.protect,
+        device=None,
+        devices=protect.bootstrap.viewers,
+        output_format=ctx.obj.output_format,
+    )
+    ctx.obj = context
+
+    if device_id is not None and device_id not in ALL_COMMANDS:
+        if (device := protect.bootstrap.viewers.get(device_id)) is None:
+            typer.secho("Invalid viewer ID", fg="red")
+            raise typer.Exit(1)
+        ctx.obj.device = device
+
+    if not ctx.invoked_subcommand:
+        if device_id in ALL_COMMANDS:
+            ctx.invoke(ALL_COMMANDS[device_id], ctx)
+            return
+
+        if ctx.obj.device is not None:
+            base.print_unifi_obj(ctx.obj.device, ctx.obj.output_format)
+            return
+
+        base.print_unifi_dict(ctx.obj.devices)
+
+
+@app.command()
+def liveview(
+    ctx: typer.Context,
+    liveview_id: Optional[str] = typer.Argument(None),
+) -> None:
+    """Returns or sets the current liveview."""
+    base.require_device_id(ctx)
+    obj: Viewer = ctx.obj.device
+
+    if liveview_id is None:
+        base.print_unifi_obj(obj.liveview, ctx.obj.output_format)
+    else:
+        protect: ProtectApiClient = ctx.obj.protect
+        if (liveview_obj := protect.bootstrap.liveviews.get(liveview_id)) is None:
+            typer.secho("Invalid liveview ID")
+            raise typer.Exit(1)
+        base.run(ctx, obj.set_liveview(liveview_obj))