uiprotect 7.0.2__py3-none-any.whl → 7.2.0__py3-none-any.whl

uiprotect/api.py

@@ -57,7 +57,7 @@ from .data import (
     create_from_unifi_dict,
 )
 from .data.base import ProtectModelWithId
-from .data.devices import Chime
+from .data.devices import AiPort, Chime
 from .data.types import IteratorCallback, ProgressCallback
 from .exceptions import BadRequest, NotAuthorized, NvrError
 from .utils import (
@@ -1268,6 +1268,14 @@ class ProtectApiClient(BaseApiClient):
         """
         return cast(list[Chime], await self.get_devices(ModelType.CHIME, Chime))
 
+    async def get_aiports(self) -> list[AiPort]:
+        """
+        Gets the list of aiports straight from the NVR.
+
+        The websocket is connected and running, you likely just want to use `self.bootstrap.aiports`
+        """
+        return cast(list[AiPort], await self.get_devices(ModelType.AIPORT, AiPort))
+
     async def get_viewers(self) -> list[Viewer]:
         """
         Gets the list of viewers straight from the NVR.
@@ -1386,6 +1394,14 @@ class ProtectApiClient(BaseApiClient):
         """
         return cast(Chime, await self.get_device(ModelType.CHIME, device_id, Chime))
 
+    async def get_aiport(self, device_id: str) -> AiPort:
+        """
+        Gets a AiPort straight from the NVR.
+
+        The websocket is connected and running, you likely just want to use `self.bootstrap.aiport[device_id]`
+        """
+        return cast(AiPort, await self.get_device(ModelType.AIPORT, device_id, AiPort))
+
     async def get_viewer(self, device_id: str) -> Viewer:
         """
         Gets a viewer straight from the NVR.
@@ -1790,10 +1806,12 @@ class ProtectApiClient(BaseApiClient):
         *,
         volume: int | None = None,
         repeat_times: int | None = None,
+        ringtone_id: str | None = None,
+        track_no: int | None = None,
     ) -> None:
         """Plays chime tones on a chime"""
         data: dict[str, Any] | None = None
-        if volume or repeat_times:
+        if volume or repeat_times or ringtone_id or track_no:
             chime = self.bootstrap.chimes.get(device_id)
             if chime is None:
                 raise BadRequest("Invalid chime ID %s", device_id)
@@ -1801,8 +1819,11 @@ class ProtectApiClient(BaseApiClient):
             data = {
                 "volume": volume or chime.volume,
                 "repeatTimes": repeat_times or chime.repeat_times,
-                "trackNo": chime.track_no,
+                "trackNo": track_no or chime.track_no,
             }
+            if ringtone_id:
+                data["ringtoneId"] = ringtone_id
+                data.pop("trackNo", None)
 
         await self.api_request(
             f"chimes/{device_id}/play-speaker",
@@ -1814,6 +1835,16 @@ class ProtectApiClient(BaseApiClient):
         """Plays chime tones on a chime"""
         await self.api_request(f"chimes/{device_id}/play-buzzer", method="post")
 
+    async def set_light_is_led_force_on(
+        self, device_id: str, is_led_force_on: bool
+    ) -> None:
+        """Sets isLedForceOn for light."""  # workaround because forceOn doesnt work via websocket
+        await self.api_request(
+            f"lights/{device_id}",
+            method="patch",
+            json={"lightOnSettings": {"isLedForceOn": is_led_force_on}},
+        )
+
     async def clear_tamper_sensor(self, device_id: str) -> None:
         """Clears tamper status for sensor"""
         await self.api_request(f"sensors/{device_id}/clear-tamper-flag", method="post")

uiprotect/cli/__init__.py

@@ -17,6 +17,7 @@ from ..data import Version, WSPacket
 from ..test_util import SampleDataGenerator
 from ..utils import RELEASE_CACHE, 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
 from .cameras import app as camera_app
 from .chimes import app as chime_app
@@ -128,6 +129,7 @@ app.add_typer(doorlock_app, name="doorlocks")
 app.add_typer(light_app, name="lights")
 app.add_typer(sensor_app, name="sensors")
 app.add_typer(viewer_app, name="viewers")
+app.add_typer(aiports_app, name="aiports")
 
 if backup_app is not None:
     app.add_typer(backup_app, name="backup")

uiprotect/cli/aiports.py

@@ -0,0 +1,59 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Optional
+
+import typer
+
+from ..api import ProtectApiClient
+from ..cli import base
+from ..data import AiPort
+
+app = typer.Typer(rich_markup_mode="rich")
+
+ARG_DEVICE_ID = typer.Argument(
+    None, help="ID of AiPort device to select for subcommands"
+)
+
+
+@dataclass
+class AiPortContext(base.CliContext):
+    devices: dict[str, AiPort]
+    device: AiPort | 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:
+    """
+    AiPort device CLI.
+
+    Returns full list of AiPorts without any arguments passed.
+    """
+    protect: ProtectApiClient = ctx.obj.protect
+    context = AiPortContext(
+        protect=ctx.obj.protect,
+        device=None,
+        devices=protect.bootstrap.aiports,
+        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.aiports.get(device_id)) is None:
+            typer.secho("Invalid aiport 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)

uiprotect/data/__init__.py

@@ -10,6 +10,7 @@ from .base import (
 from .bootstrap import Bootstrap
 from .convert import create_from_unifi_dict
 from .devices import (
+    AiPort,
     Bridge,
     Camera,
     CameraChannel,
@@ -85,6 +86,7 @@ __all__ = [
     "DEFAULT_TYPE",
     "NVR",
     "WS_HEADER_SIZE",
+    "AiPort",
     "AnalyticsOption",
     "AudioStyle",
     "Bootstrap",

uiprotect/data/bootstrap.py

@@ -23,12 +23,14 @@ from .base import (
 )
 from .convert import MODEL_TO_CLASS, create_from_unifi_dict
 from .devices import (
+    AiPort,
     Bridge,
     Camera,
     Chime,
     Doorlock,
     Light,
     ProtectAdoptableDeviceModel,
+    Ringtone,
     Sensor,
     Viewer,
 )
@@ -181,6 +183,8 @@ class Bootstrap(ProtectBaseObject):
     sensors: dict[str, Sensor]
     doorlocks: dict[str, Doorlock]
     chimes: dict[str, Chime]
+    aiports: dict[str, AiPort]
+    ringtones: list[Ringtone]
     last_update_id: str
 
     # TODO:

uiprotect/data/convert.py

@@ -8,6 +8,7 @@ from uiprotect.data.base import ProtectModelWithId
 
 from ..exceptions import DataDecodeError
 from .devices import (
+    AiPort,
     Bridge,
     Camera,
     Chime,
@@ -40,6 +41,7 @@ MODEL_TO_CLASS: dict[str, type[ProtectModel]] = {
     ModelType.SENSOR: Sensor,
     ModelType.DOORLOCK: Doorlock,
     ModelType.CHIME: Chime,
+    ModelType.AIPORT: AiPort,
     ModelType.KEYRING: Keyring,
     ModelType.ULP_USER: UlpUser,
 }

uiprotect/data/devices.py

@@ -976,6 +976,8 @@ class Camera(ProtectMotionDeviceModel):
     audio_settings: CameraAudioSettings | None = None
     # requires 5.0.33+
     is_third_party_camera: bool | None = None
+    # requires 5.1.78+
+    is_paired_with_ai_port: bool | None = None
     # TODO: used for adopting
     # apMac read only
     # apRssi read only
@@ -3382,3 +3384,16 @@ class Chime(ProtectAdoptableDeviceModel):
                 raise BadRequest("Camera %s is not paired with chime", camera.id)
 
         await self.queue_update(callback)
+
+
+class AiPort(Camera):
+    paired_cameras: list[str]
+
+
+class Ringtone(ProtectBaseObject):
+    id: str
+    name: str
+    size: int
+    is_default: bool
+    nvr_mac: str
+    model_key: str

uiprotect/data/types.py

@@ -124,9 +124,11 @@ class ModelType(str, UnknownValuesEnumMixin, enum.Enum):
     DOORLOCK = "doorlock"
     SCHEDULE = "schedule"
     CHIME = "chime"
+    AIPORT = "aiport"
     DEVICE_GROUP = "deviceGroup"
     RECORDING_SCHEDULE = "recordingSchedule"
     ULP_USER = "ulpUser"
+    RINGTONE = "ringtone"
     KEYRING = "keyring"
     UNKNOWN = "unknown"
 
@@ -173,6 +175,7 @@ class ModelType(str, UnknownValuesEnumMixin, enum.Enum):
             ModelType.SENSOR,
             ModelType.DOORLOCK,
             ModelType.CHIME,
+            ModelType.AIPORT,
         )
 
     @classmethod

uiprotect/test_util/__init__.py

@@ -131,6 +131,7 @@ class SampleDataGenerator:
             "sensor": len(bootstrap["sensors"]),
             "doorlock": len(bootstrap["doorlocks"]),
             "chime": len(bootstrap["chimes"]),
+            "aiport": len(bootstrap["aiports"]),
         }
 
         self.log("Generating event data...")
@@ -283,6 +284,7 @@ class SampleDataGenerator:
             self.generate_sensor_data(),
             self.generate_lock_data(),
             self.generate_chime_data(),
+            self.generate_aiport_data(),
             self.generate_bridge_data(),
             self.generate_liveview_data(),
         )
@@ -469,6 +471,21 @@ class SampleDataGenerator:
         obj = await self.client.api_request_obj(f"chimes/{device_id}")
         await self.write_json_file("sample_chime", obj)
 
+    async def generate_aiport_data(self) -> None:
+        objs = await self.client.api_request_list("aiports")
+        device_id: str | None = None
+        for obj_dict in objs:
+            device_id = obj_dict["id"]
+            if is_online(obj_dict):
+                break
+
+        if device_id is None:
+            self.log("No aiport found. Skipping aiport endpoints...")
+            return
+
+        obj = await self.client.api_request_obj(f"aiports/{device_id}")
+        await self.write_json_file("sample_aiport", obj)
+
     async def generate_bridge_data(self) -> None:
         objs = await self.client.api_request_list("bridges")
         device_id: str | None = None

{uiprotect-7.0.2.dist-info → uiprotect-7.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: uiprotect
-Version: 7.0.2
+Version: 7.2.0
 Summary: Python API for Unifi Protect (Unofficial)
 Home-page: https://github.com/uilibs/uiprotect
 Author: UI Protect Maintainers

{uiprotect-7.0.2.dist-info → uiprotect-7.2.0.dist-info}/RECORD

@@ -1,8 +1,9 @@
 uiprotect/__init__.py,sha256=Oz6i1tonIz4QWVnEPkbielJDJ3WQdwZVgYtjY4IwGAQ,636
 uiprotect/__main__.py,sha256=C_bHCOkv5qj6WMy-6ELoY3Y6HDhLxOa1a30CzmbZhsg,462
 uiprotect/_compat.py,sha256=HThmb1zQZCEssCxYYbQzFhJq8zYYlVaSnIEZabKc-6U,302
-uiprotect/api.py,sha256=qj6qEKLY3j25kNTL7Jlo-wwreOdmFzcV_MZxkNo7Oeg,69038
-uiprotect/cli/__init__.py,sha256=1MO8rJmjjAsfVx2x01gn5DJo8B64xdPGo6gRVJbWd18,8868
+uiprotect/api.py,sha256=5oWPmVqMqNeug4eZFbyF0X7tq2pXseSLmKDeH3zrGso,70311
+uiprotect/cli/__init__.py,sha256=gHo9G2WusvrWgnHhecT8Q2NLRXG0VS-rc9TKy4V5Kw8,8951
+uiprotect/cli/aiports.py,sha256=wpEr2w_hY18CGpFiQM2Yc0FiVwG_1l2CzZhZLGNigvI,1576
 uiprotect/cli/backup.py,sha256=ZiS7RZnJGKI8TJKLW2cOUzkRM8nyTvE5Ov_jZZGtvSM,36708
 uiprotect/cli/base.py,sha256=GVHQMrI3thQ-4ixJlunTCfEMF90xCnt-bvRPMDupDss,7588
 uiprotect/cli/cameras.py,sha256=YvvMccQEYG3Wih0Ix8tan1R1vfaJ6cogg6YKWLzMUV8,16973
@@ -14,25 +15,25 @@ uiprotect/cli/liveviews.py,sha256=GU5z-ZLRBXHyspDKiJpiv-kbaBcvxK_-K70rPoqx2Ms,18
 uiprotect/cli/nvr.py,sha256=TwxEg2XT8jXAbOqv6gc7KFXELKadeItEDYweSL4_-e8,4260
 uiprotect/cli/sensors.py,sha256=fQtcDJCVxs4VbAqcavgBy2ABiVxAW3GXtna6_XFBp2k,8153
 uiprotect/cli/viewers.py,sha256=2cyrp104ffIvgT0wYGIO0G35QMkEbFe7fSVqLwDXQYQ,2171
-uiprotect/data/__init__.py,sha256=OcfuJl2qXfHcj_mdnrHhzZ5tEIZrw8auziX5IE7dn-I,2938
+uiprotect/data/__init__.py,sha256=audwJBjxRiYdNPeYlP6iofFIOq3gyQzh6VpDsOCM2dQ,2964
 uiprotect/data/base.py,sha256=LRqmK60PKeDFgP2k5qpVj93AxEvdfC6kLk0Cqvt1W5k,35481
-uiprotect/data/bootstrap.py,sha256=oWjjWsLg8f_OERG_9h__5exB3qCmwI6KX4khBGZEzoc,23251
-uiprotect/data/convert.py,sha256=CDPkSMxSEhvDigmzmLFKpjrz0oa5FOvOdkNIHZrOZ4Q,2586
-uiprotect/data/devices.py,sha256=Brj9bT9oJPb5jqAY5vc2JhFG6m7DJt8u58qVe-oTw6M,113803
+uiprotect/data/bootstrap.py,sha256=Umija3z2SI4RPJmbzZNolm3jw-GSP4a2d9Fd0xcmf9c,23338
+uiprotect/data/convert.py,sha256=xEN878_hm0HZZCVYGwJSxcSp2as9zpkvsemVIibReOA,2628
+uiprotect/data/devices.py,sha256=ls-paEN3RITVASL0Nezfevpt5ROvxnhbBGYg8dPfAyM,114061
 uiprotect/data/nvr.py,sha256=E18DgE0nXl9VZ_ULotTPcXSi3M1u3mWQsuZbY1gIajs,47490
-uiprotect/data/types.py,sha256=YCRqY5aMSFNX-X-3eqsHnUO5s1ZbPjKc5o2-eH12E34,19086
+uiprotect/data/types.py,sha256=GVY6E88M41-_HjkIwVI7_EIObJSwH4c9BiunmEeo11Y,19164
 uiprotect/data/user.py,sha256=Del5LUmt5uCfAQMI9-kl_GaKm085oTLjxmcCrlEKXxc,10526
 uiprotect/data/websocket.py,sha256=m4EV1Qfh08eKOihy70ycViYgEQpeNSGZQJWdtGIYJDA,6791
 uiprotect/exceptions.py,sha256=kgn0cRM6lTtgLza09SDa3ZiX6ue1QqHCOogQ4qu6KTQ,965
 uiprotect/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 uiprotect/release_cache.json,sha256=NamnSFy78hOWY0DPO87J9ELFCAN6NnVquv8gQO75ZG4,386
 uiprotect/stream.py,sha256=MWiTRFIhUfFLPA_csSrKl5-SkUbPZ2VhDu0XW2oVr-U,4800
-uiprotect/test_util/__init__.py,sha256=Ky8mTL61nhp5II2mxTKBAsSGvNqK8U_CfKC5AGwToAI,18704
+uiprotect/test_util/__init__.py,sha256=HlQBgIgdtrvT-gQ5OWP92LbgVr_YzsD5NFImLRonUZk,19320
 uiprotect/test_util/anonymize.py,sha256=f-8ijU-_y9r-uAbhIPn0f0I6hzJpAkvJzc8UpWihObI,8478
 uiprotect/utils.py,sha256=q2YYQfxr0b3QEWMSP7SdpcJZbB4huEhpo8PbtnTbEFI,20481
 uiprotect/websocket.py,sha256=tEyenqblNXHcjWYuf4oRP1E7buNwx6zoECMwpBr-jig,8191
-uiprotect-7.0.2.dist-info/LICENSE,sha256=INx18jhdbVXMEiiBANeKEbrbz57ckgzxk5uutmmcxGk,1111
-uiprotect-7.0.2.dist-info/METADATA,sha256=rtp7lvceFYj6ZjMcu6s0RtFwTCZQ4KJrRgbfRr9aUNE,11142
-uiprotect-7.0.2.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-uiprotect-7.0.2.dist-info/entry_points.txt,sha256=J78AUTPrTTxgI3s7SVgrmGqDP7piX2wuuEORzhDdVRA,47
-uiprotect-7.0.2.dist-info/RECORD,,
+uiprotect-7.2.0.dist-info/LICENSE,sha256=INx18jhdbVXMEiiBANeKEbrbz57ckgzxk5uutmmcxGk,1111
+uiprotect-7.2.0.dist-info/METADATA,sha256=_N35r5x3l7De3JMKKJv6kImajl786yjdJBMWHs8i_60,11142
+uiprotect-7.2.0.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+uiprotect-7.2.0.dist-info/entry_points.txt,sha256=J78AUTPrTTxgI3s7SVgrmGqDP7piX2wuuEORzhDdVRA,47
+uiprotect-7.2.0.dist-info/RECORD,,