uiprotect 7.5.2__py3-none-any.whl → 7.32.0__py3-none-any.whl

uiprotect/cli/__init__.py

@@ -3,19 +3,21 @@ from __future__ import annotations
 import asyncio
 import base64
 import logging
+import ssl
 import sys
 from pathlib import Path
-from typing import Optional, cast
+from typing import cast
 
+import aiohttp
 import orjson
 import typer
 from rich.progress import track
 
-from uiprotect.api import ProtectApiClient
+from uiprotect.api import MetaInfo, ProtectApiClient
 
-from ..data import Version, WSPacket
+from ..data import WSPacket
 from ..test_util import SampleDataGenerator
-from ..utils import RELEASE_CACHE, get_local_timezone, run_async
+from ..utils import get_local_timezone, run_async
 from ..utils import profile_ws as profile_ws_job
 from .aiports import app as aiports_app
 from .base import CliContext, OutputFormatEnum
@@ -60,6 +62,13 @@ OPTION_PASSWORD = typer.Option(
     hide_input=True,
     envvar="UFP_PASSWORD",
 )
+OPTION_API_KEY = typer.Option(
+    None,
+    "--api-key",
+    "-k",
+    help="UniFi Protect API key (required for public API operations)",
+    envvar="UFP_API_KEY",
+)
 OPTION_ADDRESS = typer.Option(
     ...,
     "--address",
@@ -76,10 +85,10 @@ OPTION_PORT = typer.Option(
     envvar="UFP_PORT",
 )
 OPTION_SECONDS = typer.Option(15, "--seconds", "-s", help="Seconds to pull events")
-OPTION_VERIFY = typer.Option(
+OPTION_VERIFY_SSL = typer.Option(
     True,
-    "--no-verify",
-    help="Verify SSL",
+    "--verify-ssl/--no-verify-ssl",
+    help="Verify SSL certificate. Disable for self-signed certificates.",
     envvar="UFP_SSL_VERIFY",
 )
 OPTION_ANON = typer.Option(True, "--actual", help="Do not anonymize test data")
@@ -135,14 +144,36 @@ if backup_app is not None:
     app.add_typer(backup_app, name="backup")
 
 
+def _is_ssl_error(exc: BaseException) -> bool:
+    """Check if an exception is an SSL certificate verification error."""
+    if isinstance(exc, aiohttp.ClientConnectorCertificateError):
+        return True
+    if isinstance(exc, aiohttp.ClientConnectorSSLError):
+        return True
+    if isinstance(exc, ssl.SSLCertVerificationError):
+        return True
+    # Check nested exceptions
+    if exc.__cause__ is not None:
+        return _is_ssl_error(exc.__cause__)
+    return False
+
+
+async def _connect_and_bootstrap(protect: ProtectApiClient) -> None:
+    """Connect to the Protect API and fetch bootstrap data."""
+    protect._bootstrap = await protect.get_bootstrap()
+    await protect.close_session()
+    await protect.close_public_api_session()
+
+
 @app.callback()
 def main(
     ctx: typer.Context,
     username: str = OPTION_USERNAME,
     password: str = OPTION_PASSWORD,
+    api_key: str | None = OPTION_API_KEY,
     address: str = OPTION_ADDRESS,
     port: int = OPTION_PORT,
-    verify: bool = OPTION_VERIFY,
+    verify_ssl: bool = OPTION_VERIFY_SSL,
     output_format: OutputFormatEnum = OPTION_OUT_FORMAT,
     include_unadopted: bool = OPTION_UNADOPTED,
 ) -> None:
@@ -155,15 +186,51 @@ def main(
         port,
         username,
         password,
-        verify_ssl=verify,
+        api_key,
+        verify_ssl=verify_ssl,
         ignore_unadopted=not include_unadopted,
     )
 
-    async def update() -> None:
-        protect._bootstrap = await protect.get_bootstrap()
+    async def close_protect() -> None:
+        """Close the Protect API client sessions."""
         await protect.close_session()
+        await protect.close_public_api_session()
+
+    try:
+        run_async(_connect_and_bootstrap(protect))
+    except Exception as exc:
+        # Always close the session on error to avoid "Unclosed client session" warning
+        run_async(close_protect())
+
+        if verify_ssl and _is_ssl_error(exc):
+            typer.secho(
+                "SSL certificate verification failed. "
+                "This is common with self-signed certificates on UniFi devices.",
+                fg="yellow",
+            )
+            if typer.confirm("Would you like to disable SSL verification and retry?"):
+                # Create new client with SSL disabled
+                protect = ProtectApiClient(
+                    address,
+                    port,
+                    username,
+                    password,
+                    api_key,
+                    verify_ssl=False,
+                    ignore_unadopted=not include_unadopted,
+                )
+                run_async(_connect_and_bootstrap(protect))
+                typer.secho(
+                    "Connected successfully with SSL verification disabled.\n"
+                    "Tip: Use --no-verify-ssl to skip this prompt in the future.",
+                    fg="green",
+                )
+            else:
+                typer.secho("Connection aborted.", fg="red")
+                raise typer.Exit(code=1) from exc
+        else:
+            raise
 
-    run_async(update())
     ctx.obj = CliContext(protect=protect, output_format=output_format)
 
 
@@ -222,7 +289,7 @@ def generate_sample_data(
     ctx: typer.Context,
     anonymize: bool = OPTION_ANON,
     wait_time: int = OPTION_WAIT,
-    output_folder: Optional[Path] = OPTION_OUTPUT,
+    output_folder: Path | None = OPTION_OUTPUT,
     do_zip: bool = OPTION_ZIP,
 ) -> None:
     """Generates sample data for UniFi Protect instance."""
@@ -258,7 +325,7 @@ def generate_sample_data(
 def profile_ws(
     ctx: typer.Context,
     wait_time: int = OPTION_WAIT,
-    output_path: Optional[Path] = OPTION_OUTPUT,
+    output_path: Path | None = OPTION_OUTPUT,
 ) -> None:
     """Profiles Websocket messages for UniFi Protect instance."""
     protect = cast(ProtectApiClient, ctx.obj.protect)
@@ -275,6 +342,7 @@ def profile_ws(
         unsub()
         await protect.async_disconnect_ws()
         await protect.close_session()
+        await protect.close_public_api_session()
 
     _setup_logger()
 
@@ -284,7 +352,7 @@ def profile_ws(
 @app.command()
 def decode_ws_msg(
     ws_file: typer.FileBinaryRead = OPTION_WS_FILE,
-    ws_data: Optional[str] = ARG_WS_DATA,
+    ws_data: str | None = ARG_WS_DATA,
 ) -> None:
     """Decodes a base64 encoded UniFi Protect Websocket binary message."""
     if ws_file is None and ws_data is None:  # type: ignore[unreachable]
@@ -304,19 +372,36 @@ def decode_ws_msg(
 
 
 @app.command()
-def release_versions(ctx: typer.Context) -> None:
-    """Updates the release version cache on disk."""
+def create_api_key(
+    ctx: typer.Context,
+    name: str = typer.Argument(..., help="Name for the API key"),
+) -> None:
+    """Create a new API key for the current user."""
     protect = cast(ProtectApiClient, ctx.obj.protect)
 
-    async def callback() -> set[Version]:
-        versions = await protect.get_release_versions()
+    async def callback() -> str:
+        api_key = await protect.create_api_key(name)
         await protect.close_session()
-        return versions
+        await protect.close_public_api_session()
+        return api_key
 
     _setup_logger()
+    result = run_async(callback())
+    typer.echo(result)
 
-    versions = run_async(callback())
-    output = orjson.dumps(sorted([str(v) for v in versions]))
 
-    Path(RELEASE_CACHE).write_bytes(output)
-    typer.echo(output.decode("utf-8"))
+@app.command()
+def get_meta_info(ctx: typer.Context) -> None:
+    """Get metadata about the current UniFi Protect instance."""
+    protect = cast(ProtectApiClient, ctx.obj.protect)
+
+    async def callback() -> MetaInfo:
+        meta = await protect.get_meta_info()
+        await protect.close_session()
+        await protect.close_public_api_session()
+        return meta
+
+    _setup_logger()
+
+    result = run_async(callback())
+    typer.echo(result.model_dump_json())

uiprotect/cli/aiports.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
-from typing import Optional
 
 import typer
 
@@ -26,7 +25,7 @@ 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:
+def main(ctx: typer.Context, device_id: str | None = ARG_DEVICE_ID) -> None:
     """
     AiPort device CLI.
 

uiprotect/cli/backup.py

@@ -10,7 +10,7 @@ from dataclasses import dataclass
 from datetime import datetime, timedelta, timezone
 from enum import Enum
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, Optional, cast
+from typing import TYPE_CHECKING, Any, cast
 
 import aiofiles
 import aiofiles.os as aos
@@ -396,9 +396,9 @@ def _setup_logger(verbose: bool) -> None:
 @app.callback()
 def main(
     ctx: typer.Context,
-    start: Optional[str] = OPTION_START,
-    end: Optional[str] = OPTION_END,
-    output_folder: Optional[Path] = OPTION_OUTPUT,
+    start: str | None = OPTION_START,
+    end: str | None = OPTION_END,
+    output_folder: Path | None = OPTION_OUTPUT,
     thumbnail_format: str = OPTION_THUMBNAIL_FORMAT,
     gif_format: str = OPTION_GIF_FORMAT,
     event_format: str = OPTION_EVENT_FORMAT,
@@ -1064,6 +1064,7 @@ async def _events(
     finally:
         _LOGGER.debug("Cleaning up Protect connection/database...")
         await ctx.protect.close_session()
+        await ctx.protect.close_public_api_session()
         await ctx.db_engine.dispose()
 
 

uiprotect/cli/base.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 from collections.abc import Callable, Coroutine, Mapping, Sequence
 from dataclasses import dataclass
 from enum import Enum
-from typing import Any, Optional, TypeVar
+from typing import Any, TypeVar
 
 import orjson
 import typer
@@ -36,6 +36,7 @@ def run(ctx: typer.Context, func: Coroutine[Any, Any, T]) -> T:
     async def callback() -> T:
         return_value = await func
         await ctx.obj.protect.close_session()
+        await ctx.obj.protect.close_public_api_session()
         return return_value
 
     try:
@@ -165,7 +166,7 @@ def set_ssh(ctx: typer.Context, enabled: bool) -> None:
     run(ctx, obj.set_ssh(enabled))
 
 
-def set_name(ctx: typer.Context, name: Optional[str] = typer.Argument(None)) -> None:
+def set_name(ctx: typer.Context, name: str | None = typer.Argument(None)) -> None:
     """Sets name for the device"""
     require_device_id(ctx)
     obj: NVR | ProtectAdoptableDeviceModel = ctx.obj.device
@@ -203,7 +204,7 @@ def unadopt(ctx: typer.Context, force: bool = OPTION_FORCE) -> None:
         run(ctx, obj.unadopt())
 
 
-def adopt(ctx: typer.Context, name: Optional[str] = typer.Argument(None)) -> None:
+def adopt(ctx: typer.Context, name: str | None = typer.Argument(None)) -> None:
     """
     Adopts a device.
 
@@ -223,7 +224,6 @@ def init_common_commands(
     device_commands: dict[str, Callable[..., Any]] = {}
 
     deviceless_commands["list-ids"] = app.command()(list_ids)
-    device_commands["protect-url"] = app.command()(protect_url)
     device_commands["is-wired"] = app.command()(is_wired)
     device_commands["is-wifi"] = app.command()(is_wifi)
     device_commands["is-bluetooth"] = app.command()(is_bluetooth)

uiprotect/cli/cameras.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 from dataclasses import dataclass
 from datetime import datetime, timezone
 from pathlib import Path
-from typing import Optional, cast
+from typing import cast
 
 import typer
 from rich.progress import Progress
@@ -27,7 +27,7 @@ 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:
+def main(ctx: typer.Context, device_id: str | None = ARG_DEVICE_ID) -> None:
     """
     Camera device CLI.
 
@@ -74,7 +74,7 @@ def timelapse_url(ctx: typer.Context) -> None:
 @app.command()
 def privacy_mode(
     ctx: typer.Context,
-    enabled: Optional[bool] = typer.Argument(None),
+    enabled: bool | None = typer.Argument(None),
 ) -> None:
     """
     Returns/sets library managed privacy mode.
@@ -91,7 +91,7 @@ def privacy_mode(
 
 
 @app.command()
-def chime_type(ctx: typer.Context, value: Optional[d.ChimeType] = None) -> None:
+def chime_type(ctx: typer.Context, value: d.ChimeType | None = None) -> None:
     """Returns/sets the current chime type if the camera has a chime."""
     base.require_device_id(ctx)
     obj: d.Camera = ctx.obj.device
@@ -137,9 +137,9 @@ def stream_urls(ctx: typer.Context) -> None:
 def save_snapshot(
     ctx: typer.Context,
     output_path: Path = typer.Argument(..., help="JPEG format"),
-    width: Optional[int] = typer.Option(None, "-w", "--width"),
-    height: Optional[int] = typer.Option(None, "-h", "--height"),
-    dt: Optional[datetime] = typer.Option(None, "-t", "--timestamp"),
+    width: int | None = typer.Option(None, "-w", "--width"),
+    height: int | None = typer.Option(None, "-h", "--height"),
+    dt: datetime | None = typer.Option(None, "-t", "--timestamp"),
     package: bool = typer.Option(False, "-p", "--package", help="Get package camera"),
 ) -> None:
     """
@@ -188,7 +188,7 @@ def save_video(
         max=3,
         help="0 = High, 1 = Medium, 2 = Low, 3 = Package",
     ),
-    fps: Optional[int] = typer.Option(
+    fps: int | None = typer.Option(
         None,
         "--fps",
         min=1,
@@ -245,7 +245,7 @@ def save_video(
 def play_audio(
     ctx: typer.Context,
     url: str = typer.Argument(..., help="ffmpeg playable URL"),
-    ffmpeg_path: Optional[Path] = typer.Option(
+    ffmpeg_path: Path | None = typer.Option(
         None,
         "--ffmpeg-path",
         help="Path to ffmpeg executable",
@@ -487,13 +487,37 @@ def set_speaker_volume(
     ctx: typer.Context,
     level: int = typer.Argument(..., min=0, max=100),
 ) -> None:
-    """Sets the speaker sensitivity level on camera"""
+    """Sets the speaker output volume on camera"""
     base.require_device_id(ctx)
     obj: d.Camera = ctx.obj.device
 
     base.run(ctx, obj.set_speaker_volume(level))
 
 
+@app.command()
+def set_volume(
+    ctx: typer.Context,
+    level: int = typer.Argument(..., min=0, max=100),
+) -> None:
+    """Sets the general volume level on camera"""
+    base.require_device_id(ctx)
+    obj: d.Camera = ctx.obj.device
+
+    base.run(ctx, obj.set_volume(level))
+
+
+@app.command()
+def set_ring_volume(
+    ctx: typer.Context,
+    level: int = typer.Argument(..., min=0, max=100),
+) -> None:
+    """Sets the doorbell ring volume"""
+    base.require_device_id(ctx)
+    obj: d.Camera = ctx.obj.device
+
+    base.run(ctx, obj.set_ring_volume(level))
+
+
 @app.command()
 def set_system_sounds(ctx: typer.Context, enabled: bool) -> None:
     """Sets system sound playback through speakers"""
@@ -542,15 +566,15 @@ def set_osd_bitrate(ctx: typer.Context, enabled: bool) -> None:
 @app.command()
 def set_lcd_text(
     ctx: typer.Context,
-    text_type: Optional[d.DoorbellMessageType] = typer.Argument(
+    text_type: d.DoorbellMessageType | None = typer.Argument(
         None,
         help="No value sets it back to the global default doorbell message.",
     ),
-    text: Optional[str] = typer.Argument(
+    text: str | None = typer.Argument(
         None,
         help="Only for CUSTOM_MESSAGE text type",
     ),
-    reset_at: Optional[datetime] = typer.Option(
+    reset_at: datetime | None = typer.Option(
         None,
         "-r",
         "--reset-time",
@@ -572,3 +596,118 @@ def set_lcd_text(
     obj: d.Camera = ctx.obj.device
 
     base.run(ctx, obj.set_lcd_text(text_type, text, reset_at))
+
+
+@app.command()
+def create_rtsps_streams(
+    ctx: typer.Context,
+    qualities: list[str] = typer.Argument(
+        ...,
+        help="List of stream qualities to create (e.g., high medium low)",
+    ),
+) -> None:
+    """
+    Creates RTSPS streams for camera.
+
+    Available qualities are typically: high, medium, low, ultra.
+    Requires API key authentication and public API access.
+    """
+    base.require_device_id(ctx)
+    obj: d.Camera = ctx.obj.device
+
+    async def create_streams() -> None:
+        try:
+            result = await obj.create_rtsps_streams(qualities)
+            if result is None:
+                typer.secho("Failed to create RTSPS streams", fg="red")
+                raise typer.Exit(1)
+
+            if ctx.obj.output_format == base.OutputFormatEnum.JSON:
+                stream_data = {
+                    quality: result.get_stream_url(quality)
+                    for quality in result.get_available_stream_qualities()
+                }
+                base.json_output(stream_data)
+            else:
+                for quality in result.get_available_stream_qualities():
+                    url = result.get_stream_url(quality)
+                    typer.echo(f"{quality:10}\t{url}")
+        except Exception as e:
+            typer.secho(f"Error creating RTSPS streams: {e}", fg="red")
+            raise typer.Exit(1) from e
+
+    base.run(ctx, create_streams())
+
+
+@app.command()
+def get_rtsps_streams(ctx: typer.Context) -> None:
+    """
+    Gets existing RTSPS streams for camera.
+
+    Requires API key authentication and public API access.
+    """
+    base.require_device_id(ctx)
+    obj: d.Camera = ctx.obj.device
+
+    async def get_streams() -> None:
+        try:
+            result = await obj.get_rtsps_streams()
+            if result is None:
+                typer.secho("No RTSPS streams found or failed to retrieve", fg="yellow")
+                return
+
+            if ctx.obj.output_format == base.OutputFormatEnum.JSON:
+                stream_data = {
+                    quality: result.get_stream_url(quality)
+                    for quality in result.get_available_stream_qualities()
+                }
+                base.json_output(stream_data)
+            else:
+                available_qualities = result.get_available_stream_qualities()
+                if not available_qualities:
+                    typer.echo("No RTSPS streams available")
+                else:
+                    for quality in available_qualities:
+                        url = result.get_stream_url(quality)
+                        typer.echo(f"{quality:10}\t{url}")
+        except Exception as e:
+            typer.secho(f"Error getting RTSPS streams: {e}", fg="red")
+            raise typer.Exit(1) from e
+
+    base.run(ctx, get_streams())
+
+
+@app.command()
+def delete_rtsps_streams(
+    ctx: typer.Context,
+    qualities: list[str] = typer.Argument(
+        ...,
+        help="List of stream qualities to delete (e.g., high medium low)",
+    ),
+) -> None:
+    """
+    Deletes RTSPS streams for camera.
+
+    Requires API key authentication and public API access.
+    """
+    base.require_device_id(ctx)
+    obj: d.Camera = ctx.obj.device
+
+    async def delete_streams() -> None:
+        try:
+            result = await obj.delete_rtsps_streams(qualities)
+            if result:
+                typer.secho(
+                    f"Successfully deleted RTSPS streams: {', '.join(qualities)}",
+                    fg="green",
+                )
+            else:
+                typer.secho(
+                    f"Failed to delete RTSPS streams: {', '.join(qualities)}", fg="red"
+                )
+                raise typer.Exit(1)
+        except Exception as e:
+            typer.secho(f"Error deleting RTSPS streams: {e}", fg="red")
+            raise typer.Exit(1) from e
+
+    base.run(ctx, delete_streams())

uiprotect/cli/chimes.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
-from typing import Optional
 
 import typer
 
@@ -26,7 +25,7 @@ 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:
+def main(ctx: typer.Context, device_id: str | None = ARG_DEVICE_ID) -> None:
     """
     Chime device CLI.
 
@@ -114,7 +113,7 @@ def cameras(
 def set_volume(
     ctx: typer.Context,
     value: int = ARG_VOLUME,
-    camera_id: Optional[str] = typer.Option(
+    camera_id: str | None = typer.Option(
         None,
         "-c",
         "--camera",
@@ -138,8 +137,8 @@ def set_volume(
 @app.command()
 def play(
     ctx: typer.Context,
-    volume: Optional[int] = typer.Option(None, "-v", "--volume", min=1, max=100),
-    repeat_times: Optional[int] = typer.Option(None, "-r", "--repeat", min=1, max=6),
+    volume: int | None = typer.Option(None, "-v", "--volume", min=1, max=100),
+    repeat_times: int | None = typer.Option(None, "-r", "--repeat", min=1, max=6),
 ) -> None:
     """Plays chime tone."""
     base.require_device_id(ctx)
@@ -159,7 +158,7 @@ def play_buzzer(ctx: typer.Context) -> None:
 def set_repeat_times(
     ctx: typer.Context,
     value: int = ARG_REPEAT,
-    camera_id: Optional[str] = typer.Option(
+    camera_id: str | None = typer.Option(
         None,
         "-c",
         "--camera",

uiprotect/cli/doorlocks.py

@@ -2,7 +2,6 @@ from __future__ import annotations
 
 from dataclasses import dataclass
 from datetime import timedelta
-from typing import Optional
 
 import typer
 
@@ -25,7 +24,7 @@ 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:
+def main(ctx: typer.Context, device_id: str | None = ARG_DEVICE_ID) -> None:
     """
     Doorlock device CLI.
 
@@ -59,7 +58,7 @@ def main(ctx: typer.Context, device_id: Optional[str] = ARG_DEVICE_ID) -> None:
 
 
 @app.command()
-def camera(ctx: typer.Context, camera_id: Optional[str] = typer.Argument(None)) -> None:
+def camera(ctx: typer.Context, camera_id: str | None = typer.Argument(None)) -> None:
     """Returns or sets tha paired camera for a doorlock."""
     base.require_device_id(ctx)
     obj: Doorlock = ctx.obj.device

uiprotect/cli/events.py

@@ -4,7 +4,6 @@ from collections.abc import Callable
 from dataclasses import dataclass
 from datetime import datetime
 from pathlib import Path
-from typing import Optional
 
 import typer
 from rich.progress import Progress
@@ -43,13 +42,13 @@ ALL_COMMANDS: dict[str, Callable[..., None]] = {}
 @app.callback(invoke_without_command=True)
 def main(
     ctx: typer.Context,
-    event_id: Optional[str] = ARG_EVENT_ID,
-    start: Optional[datetime] = OPTION_START,
-    end: Optional[datetime] = OPTION_END,
-    limit: Optional[int] = OPTION_LIMIT,
-    offset: Optional[int] = OPTION_OFFSET,
-    types: Optional[list[d.EventType]] = OPTION_TYPES,
-    smart_types: Optional[list[d.SmartDetectObjectType]] = OPTION_SMART_TYPES,
+    event_id: str | None = ARG_EVENT_ID,
+    start: datetime | None = OPTION_START,
+    end: datetime | None = OPTION_END,
+    limit: int | None = OPTION_LIMIT,
+    offset: int | None = OPTION_OFFSET,
+    types: list[d.EventType] | None = OPTION_TYPES,
+    smart_types: list[d.SmartDetectObjectType] | None = OPTION_SMART_TYPES,
 ) -> None:
     """
     Events CLI.