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

uiprotect/cli/lights.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:
     """
     Lights 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 light."""
     base.require_device_id(ctx)
     obj: Light = ctx.obj.device
@@ -117,3 +116,12 @@ def set_duration(
     obj: Light = ctx.obj.device
 
     base.run(ctx, obj.set_duration(timedelta(seconds=duration)))
+
+
+@app.command()
+def set_flood_light(ctx: typer.Context, enabled: bool) -> None:
+    """Sets flood light (force on) for light device."""
+    base.require_device_id(ctx)
+    obj: Light = ctx.obj.device
+
+    base.run(ctx, obj.set_flood_light(enabled))

uiprotect/cli/liveviews.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
-from typing import Optional
 
 import typer
 
@@ -24,7 +23,7 @@ class LiveviewContext(base.CliContext):
 
 
 @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:
     """
     Liveviews CLI.
 

uiprotect/cli/sensors.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
-from typing import Optional
 
 import typer
 
@@ -24,7 +23,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:
     """
     Sensors device CLI.
 
@@ -58,7 +57,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 sensor."""
     base.require_device_id(ctx)
     obj: Sensor = ctx.obj.device

uiprotect/cli/viewers.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 from dataclasses import dataclass
-from typing import Optional
 
 import typer
 
@@ -24,7 +23,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:
     """
     Viewers device CLI.
 
@@ -60,7 +59,7 @@ def main(ctx: typer.Context, device_id: Optional[str] = ARG_DEVICE_ID) -> None:
 @app.command()
 def liveview(
     ctx: typer.Context,
-    liveview_id: Optional[str] = typer.Argument(None),
+    liveview_id: str | None = typer.Argument(None),
 ) -> None:
     """Returns or sets the current liveview."""
     base.require_device_id(ctx)

uiprotect/data/base.py

@@ -7,8 +7,8 @@ import logging
 from collections.abc import Callable
 from datetime import datetime, timedelta
 from functools import cache
-from ipaddress import IPv4Address
-from typing import TYPE_CHECKING, Any, NamedTuple, TypeVar
+from ipaddress import IPv4Address, IPv6Address
+from typing import TYPE_CHECKING, Any, NamedTuple
 from uuid import UUID
 
 from convertertools import pop_dict_set_if_none, pop_dict_tuple
@@ -27,14 +27,12 @@ from ..utils import (
     to_snake_case,
 )
 from .types import (
-    SHAPE_DICT_V1,
-    SHAPE_LIST_V1,
     ModelType,
     PercentFloat,
     PermissionNode,
     ProtectWSPayloadFormat,
     StateType,
-    extract_type_shape,
+    get_field_type,
 )
 from .websocket import (
     WSJSONPacketFrame,
@@ -53,7 +51,6 @@ if TYPE_CHECKING:
     from ..data.user import User
 
 
-ProtectObject = TypeVar("ProtectObject", bound="ProtectBaseObject")
 RECENT_EVENT_MAX = timedelta(seconds=30)
 EVENT_PING_INTERVAL = timedelta(seconds=3)
 EVENT_PING_INTERVAL_SECONDS = EVENT_PING_INTERVAL.total_seconds()
@@ -224,11 +221,11 @@ class ProtectBaseObject(BaseModel):
 
         for name, field in cls.model_fields.items():
             try:
-                type_, shape = extract_type_shape(field.annotation)  # type: ignore[arg-type]
+                origin, type_ = get_field_type(field.annotation)  # type: ignore[arg-type]
                 if _is_protect_base_object(type_):
-                    if shape == SHAPE_LIST_V1:
+                    if origin is list:
                         lists[name] = type_
-                    elif shape == SHAPE_DICT_V1:
+                    elif origin is dict:
                         dicts[name] = type_
                     else:
                         objs[name] = type_
@@ -319,23 +316,26 @@ class ProtectBaseObject(BaseModel):
         # convert to snake_case and remove extra fields
         _fields = cls.model_fields
         for key in data.copy():
-            if key in remaps:
+            current_key = key
+            if current_key in remaps:
                 # remap keys that will not be converted correctly by snake_case convert
-                remapped_key = remaps[key]
-                data[remapped_key] = data.pop(key)
-                key = remapped_key
+                remapped_key = remaps[current_key]
+                data[remapped_key] = data.pop(current_key)
+                current_key = remapped_key
 
-            new_key = to_snake_case(key)
-            data[new_key] = data.pop(key)
-            key = new_key
+            new_key = to_snake_case(current_key)
+            data[new_key] = data.pop(current_key)
+            current_key = new_key
 
-            if key == "api":
+            if current_key == "api":
                 continue
 
-            if key not in _fields:
-                del data[key]
+            if current_key not in _fields:
+                del data[current_key]
                 continue
-            data[key] = convert_unifi_data(data[key], _fields[key])
+            data[current_key] = convert_unifi_data(
+                data[current_key], _fields[current_key]
+            )
 
         if not data:
             return data
@@ -478,7 +478,7 @@ class ProtectBaseObject(BaseModel):
 
         return new_data
 
-    def update_from_dict(cls: ProtectObject, data: dict[str, Any]) -> ProtectObject:
+    def update_from_dict(self, data: dict[str, Any]) -> Self:
         """
         Updates current object from a cleaned UFP JSON dict.
 
@@ -490,17 +490,17 @@ class ProtectBaseObject(BaseModel):
             has_unifi_objs,
             unifi_lists,
             has_unifi_lists,
-            unifi_dicts,
-            has_unifi_dicts,
-        ) = cls._get_protect_model()
-        api = cls._api
-        _fields = cls.model_fields
+            _unifi_dicts,
+            _has_unifi_dicts,
+        ) = self._get_protect_model()
+        api = self._api
+        _fields = self.__class__.model_fields
         unifi_obj: ProtectBaseObject | None
         value: Any
 
         for key, item in data.items():
             if has_unifi_objs and key in unifi_objs and isinstance(item, dict):
-                if (unifi_obj := getattr(cls, key)) is not None:
+                if (unifi_obj := getattr(self, key)) is not None:
                     value = unifi_obj.update_from_dict(item)
                 else:
                     value = unifi_objs[key](**item, api=api)
@@ -514,9 +514,9 @@ class ProtectBaseObject(BaseModel):
             else:
                 value = convert_unifi_data(item, _fields[key])
 
-            setattr(cls, key, value)
+            setattr(self, key, value)
 
-        return cls
+        return self
 
     def dict_with_excludes(self) -> dict[str, Any]:
         """Returns a dict of the current object without any UFP objects converted to dicts."""
@@ -859,7 +859,7 @@ class ProtectDeviceModel(ProtectModelWithId):
 
 
 class WiredConnectionState(ProtectBaseObject):
-    phy_rate: int | None = None
+    phy_rate: float | None = None
 
 
 class WirelessConnectionState(ProtectBaseObject):
@@ -872,7 +872,7 @@ class BluetoothConnectionState(WirelessConnectionState):
 
 
 class WifiConnectionState(WirelessConnectionState):
-    phy_rate: int | None = None
+    phy_rate: float | None = None
     channel: int | None = None
     frequency: int | None = None
     ssid: str | None = None
@@ -887,7 +887,7 @@ class WifiConnectionState(WirelessConnectionState):
 
 class ProtectAdoptableDeviceModel(ProtectDeviceModel):
     state: StateType
-    connection_host: IPv4Address | str | None = None
+    connection_host: IPv4Address | IPv6Address | str | None = None
     connected_since: datetime | None = None
     latest_firmware_version: str | None = None
     firmware_build: str | None = None

uiprotect/data/bootstrap.py

@@ -178,12 +178,12 @@ class Bootstrap(ProtectBaseObject):
     liveviews: dict[str, Liveview]
     nvr: NVR
     viewers: dict[str, Viewer]
-    lights: dict[str, Light]
-    bridges: dict[str, Bridge]
-    sensors: dict[str, Sensor]
-    doorlocks: dict[str, Doorlock]
-    chimes: dict[str, Chime]
-    aiports: dict[str, AiPort]
+    lights: dict[str, Light] = {}
+    bridges: dict[str, Bridge] = {}
+    sensors: dict[str, Sensor] = {}
+    doorlocks: dict[str, Doorlock] = {}
+    chimes: dict[str, Chime] = {}
+    aiports: dict[str, AiPort] = {}
     ringtones: list[Ringtone]
     last_update_id: str
 
@@ -215,14 +215,19 @@ class Bootstrap(ProtectBaseObject):
         data["idLookup"] = id_lookup
         data["macLookup"] = mac_lookup
 
+        # Fields that are not (always?) available in newer Protect versions
+        optional_fields = {"doorlocks"}
+
         for model_type in ModelType.bootstrap_models_types_set:
             key = model_type.devices_key  # type: ignore[attr-defined]
             items: dict[str, ProtectModel] = {}
             if key not in data:
-                data[key] = {}
-                _LOGGER.error(
-                    f"Missing key in bootstrap: {key}. This may be fixed by updating Protect."
-                )
+                # Optional fields with defaults don't need logging or setting
+                if key not in optional_fields:
+                    data[key] = {}
+                    _LOGGER.error(
+                        f"Missing key in bootstrap: {key}. This may be fixed by updating Protect."
+                    )
                 continue
             for item in data[key]:
                 if (
@@ -420,7 +425,7 @@ class Bootstrap(ProtectBaseObject):
                 changed_data=add_obj.model_dump(),
                 new_obj=add_obj,
             )
-        elif action_type == "remove":
+        if action_type == "remove":
             to_remove = obj_from_bootstrap.by_id(action_id)
             if to_remove is None:
                 return None
@@ -431,7 +436,7 @@ class Bootstrap(ProtectBaseObject):
                 changed_data={},
                 old_obj=to_remove,
             )
-        elif action_type == "update":
+        if action_type == "update":
             updated_obj = obj_from_bootstrap.by_id(action_id)
             if updated_obj is None:
                 return None
@@ -588,7 +593,7 @@ class Bootstrap(ProtectBaseObject):
 
         return message
 
-    def _make_ws_packet_message(
+    def _make_ws_packet_message(  # noqa: PLR0911
         self,
         action: dict[str, Any],
         data: dict[str, Any],
@@ -680,5 +685,5 @@ class Bootstrap(ProtectBaseObject):
         _LOGGER.debug("Successfully refresh model: %s %s", model_type, device_id)
 
     async def get_is_prerelease(self) -> bool:
-        """Get if current version of Protect is a prerelease version."""
-        return await self.nvr.get_is_prerelease()
+        """[DEPRECATED] Always returns False. Will be removed after HA 2025.8.0."""
+        return False