pyimouapi 1.3.4__tar.gz → 1.4.0__tar.gz

{pyimouapi-1.3.4 → pyimouapi-1.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyimouapi
-Version: 1.3.4
+Version: 1.4.0
 Summary: A package for imou open api
 Home-page: https://github.com/Imou-OpenPlatform/Py-Imou-Open-Api
 Author: Imou-OpenPlatform
@@ -31,8 +31,10 @@ Async Python client for the **Imou Open Platform** cloud APIs. Built on **aiohtt
 |--------|------|
 | `pyimouapi.openapi` | `ImouOpenApiClient` — auth, signing, token lifecycle, HTTP calls |
 | `pyimouapi.device` | `ImouDeviceManager`, `ImouDevice`, `ImouChannel` — listing, PTZ, alarms, storage, collection points (`getCollection` / `turnCollection`), and related endpoints |
-| `pyimouapi.collection_point` | Parsing helpers for PaaS / IoT collection point (preset) name lists |
-| `pyimouapi.ha_device` | `ImouHaDeviceManager`, `ImouHaDevice`, … — aggregated “device model” helpers for automation stacks (including `select.collection_point` when the device exposes `CollectionPoint` or IoT refs `21500`/`22000`) |
+| `pyimouapi.collection_point` | Parsing helpers for PaaS / IoT collection point name lists |
+| `pyimouapi.push` | Open Platform event-push helpers: normalize payload fields, alarm vs status `msgType`, IoT envelope check, event-ref lookup, picture URLs (`thumbUrl` first, then `picUrlArray` / `picUrlArr` / `picUrl`) |
+| `pyimouapi.pic_decode` | `LCOpenPicDecoder` — decrypts alarm pictures **you have already downloaded**, through the official LCOpenSDK native libraries (linux x86-64). Also TCM detection and encrypt-key resolution. No Open Platform call, token, or CA bundle is involved |
+| `pyimouapi.ha_device` | `ImouHaDeviceManager`, `ImouHaDevice`, … — aggregated “device model” helpers for automation stacks (including `alarm_control_panel` for IoT ref `15200`, feature switches, and `select.collection_point` when the device exposes `CollectionPoint` or IoT refs `21500`/`22000`) |
 | `pyimouapi.exceptions` | `ImouException` and typed errors (connect, request, invalid credentials, …) |
 
 The top-level `pyimouapi` package re-exports common symbols. Import submodules directly when needed, for example `from pyimouapi.ha_device import ImouHaDeviceManager`.

{pyimouapi-1.3.4 → pyimouapi-1.4.0}/README.md

@@ -12,8 +12,10 @@ Async Python client for the **Imou Open Platform** cloud APIs. Built on **aiohtt
 |--------|------|
 | `pyimouapi.openapi` | `ImouOpenApiClient` — auth, signing, token lifecycle, HTTP calls |
 | `pyimouapi.device` | `ImouDeviceManager`, `ImouDevice`, `ImouChannel` — listing, PTZ, alarms, storage, collection points (`getCollection` / `turnCollection`), and related endpoints |
-| `pyimouapi.collection_point` | Parsing helpers for PaaS / IoT collection point (preset) name lists |
-| `pyimouapi.ha_device` | `ImouHaDeviceManager`, `ImouHaDevice`, … — aggregated “device model” helpers for automation stacks (including `select.collection_point` when the device exposes `CollectionPoint` or IoT refs `21500`/`22000`) |
+| `pyimouapi.collection_point` | Parsing helpers for PaaS / IoT collection point name lists |
+| `pyimouapi.push` | Open Platform event-push helpers: normalize payload fields, alarm vs status `msgType`, IoT envelope check, event-ref lookup, picture URLs (`thumbUrl` first, then `picUrlArray` / `picUrlArr` / `picUrl`) |
+| `pyimouapi.pic_decode` | `LCOpenPicDecoder` — decrypts alarm pictures **you have already downloaded**, through the official LCOpenSDK native libraries (linux x86-64). Also TCM detection and encrypt-key resolution. No Open Platform call, token, or CA bundle is involved |
+| `pyimouapi.ha_device` | `ImouHaDeviceManager`, `ImouHaDevice`, … — aggregated “device model” helpers for automation stacks (including `alarm_control_panel` for IoT ref `15200`, feature switches, and `select.collection_point` when the device exposes `CollectionPoint` or IoT refs `21500`/`22000`) |
 | `pyimouapi.exceptions` | `ImouException` and typed errors (connect, request, invalid credentials, …) |
 
 The top-level `pyimouapi` package re-exports common symbols. Import submodules directly when needed, for example `from pyimouapi.ha_device import ImouHaDeviceManager`.

{pyimouapi-1.3.4 → pyimouapi-1.4.0}/pyimouapi/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "1.3.4"
+__version__ = "1.4.0"
 
 from .device import ImouChannel, ImouDevice, ImouDeviceManager
 from .exceptions import (

pyimouapi-1.4.0/pyimouapi/alarm_mode.py

@@ -0,0 +1,22 @@
+"""Friendly keys for IoT alarm mode (ref 15200)."""
+
+from __future__ import annotations
+
+ALARM_MODES: tuple[str, ...] = ("home", "away", "disarm")
+
+_RAW_TO_FRIENDLY = {"0": "home", "1": "away", "2": "disarm"}
+_FRIENDLY_TO_RAW = {v: k for k, v in _RAW_TO_FRIENDLY.items()}
+
+
+def to_friendly(raw: object) -> str:
+    """Map vendor raw (int or str) to home / away / disarm."""
+    key = "" if raw is None else str(raw).strip()
+    return _RAW_TO_FRIENDLY.get(key, key)
+
+
+def to_raw(mode: str) -> str:
+    """Map home / away / disarm to the IoT integer string."""
+    key = mode.strip().lower()
+    if key not in _FRIENDLY_TO_RAW:
+        raise ValueError(f"unknown alarm mode: {mode!r}")
+    return _FRIENDLY_TO_RAW[key]

{pyimouapi-1.3.4 → pyimouapi-1.4.0}/pyimouapi/const.py

@@ -1,3 +1,5 @@
+from typing import Any
+
 # API Endpoints
 API_ENDPOINT_ACCESS_TOKEN = "/openapi/accessToken"
 API_ENDPOINT_LIST_DEVICE_DETAILS = "/openapi/listDeviceDetailsByPage"
@@ -10,6 +12,7 @@ API_ENDPOINT_GET_DEVICE_NIGHT_VISION_MODE = "/openapi/getNightVisionMode"
 API_ENDPOINT_SET_DEVICE_NIGHT_VISION_MODE = "/openapi/setNightVisionMode"
 API_ENDPOINT_DEVICE_STORAGE = "/openapi/deviceStorage"
 API_ENDPOINT_RESTART_DEVICE = "/openapi/restartDevice"
+API_ENDPOINT_BIND_DEVICE = "/openapi/bindDevice"
 API_ENDPOINT_BIND_DEVICE_LIVE = "/openapi/bindDeviceLive"
 API_ENDPOINT_GET_DEVICE_ONLINE = "/openapi/deviceOnline"
 API_ENDPOINT_GET_DEVICE_LIVE_INFO = "/openapi/getLiveStreamInfo"
@@ -88,6 +91,7 @@ PARAM_STATUS = "status"
 PARAM_CURRENT_OPTION = "current_option"
 PARAM_MODES = "modes"
 PARAM_OPTIONS = "options"
+PARAM_SUPPORTED = "supported"
 PARAM_CHANNELS = "channels"
 PARAM_USED_BYTES = "usedBytes"
 PARAM_TOTAL_BYTES = "totalBytes"
@@ -155,7 +159,7 @@ PARAM_ABILITY = "ability"
 PARAM_FUNCTION_TYPE = "function_type"
 
 # Required capacity for various switch types
-SWITCH_TYPE_ABILITY = {
+SWITCH_TYPE_ABILITY: dict[str, list[dict[str, Any]]] = {
     "motion_detect": [
         {
             "ability": "MobileDetect",
@@ -224,17 +228,63 @@ SWITCH_TYPE_ABILITY = {
             "function_type": "smdHuman",
         },
     ],
+    "frame_reverse": [
+        {
+            "ability": "FrameReverse",
+            "default": False,
+            "function_type": "frameReverse",
+        }
+    ],
+    "wide_dynamic": [
+        {
+            "ability": "WideDynamic",
+            "default": False,
+            "function_type": "wideDynamic",
+        }
+    ],
+    "smart_track": [
+        {
+            "ability": "SmartTrack",
+            "default": False,
+            "function_type": "smartTrack",
+        }
+    ],
+    "play_sound": [
+        {
+            "ability": "PlaySound",
+            "default": False,
+            "function_type": "playSound",
+        }
+    ],
+    "linkage_siren": [
+        {
+            "ability": "LinkageSiren",
+            "default": False,
+            "function_type": "linkageSiren",
+        }
+    ],
+    "linkage_white_light": [
+        {
+            "ability": "WhiteLight",
+            "default": False,
+            "function_type": "linkageWhiteLight",
+        },
+        {
+            "ability": "ChnWhiteLight",
+            "default": False,
+            "function_type": "linkageWhiteLight",
+        },
+    ],
 }
 
-SWITCH_TYPE_REF = {
+SWITCH_TYPE_REF: dict[str, list[dict[str, Any]]] = {
     "motion_detect": [
         {
             "ref": "14800",
             "default": False,
-        },
-        {
-            "ref": "305000",
-            "default": False,
+            "excepts": [
+                "FKX9UYL4",
+            ],
         },
         {
             "ref": "108800",
@@ -257,25 +307,13 @@ SWITCH_TYPE_REF = {
         {
             "ref": "14200",
             "default": False,
-        },
-        {
-            "ref": "115300",
-            "default": False,
-        },
+        }
     ],
     "audio_encode_control": [
         {
             "ref": "13900",
             "default": False,
-        },
-        {
-            "ref": "104000",
-            "default": False,
-        },
-        {
-            "ref": "103800",
-            "default": False,
-        },
+        }
     ],
     "header_detect": [
         {
@@ -311,9 +349,51 @@ SWITCH_TYPE_REF = {
             "default": False,
         }
     ],
+    "pet_detect": [
+        {
+            "ref": "18300",
+            "default": False,
+        }
+    ],
+    "frame_reverse": [
+        {
+            "ref": "13500",
+            "default": False,
+        }
+    ],
+    "wide_dynamic": [
+        {
+            "ref": "19400",
+            "default": False,
+        }
+    ],
+    "smart_track": [
+        {
+            "ref": "13300",
+            "default": False,
+        }
+    ],
+    "play_sound": [
+        {
+            "ref": "14000",
+            "default": False,
+        }
+    ],
+    "linkage_siren": [
+        {
+            "ref": "102000",
+            "default": False,
+        }
+    ],
+    "linkage_white_light": [
+        {
+            "ref": "17300",
+            "default": False,
+        }
+    ],
 }
 #  Required capacity for various button types
-BUTTON_TYPE_ABILITY = {
+BUTTON_TYPE_ABILITY: dict[str, list[str]] = {
     "restart_device": ["Reboot"],
     "siren_start": ["Siren"],
     "siren_stop": ["Siren"],
@@ -322,7 +402,7 @@ BUTTON_TYPE_ABILITY = {
     "ptz_left": ["PT", "PTZ"],
     "ptz_right": ["PT", "PTZ"],
 }
-BUTTON_TYPE_REF = {
+BUTTON_TYPE_REF: dict[str, list[dict[str, Any]]] = {
     "restart_device": [
         {"ref": "2300"},
         {"ref": "21200"},
@@ -401,11 +481,11 @@ BUTTON_TYPE_REF = {
     ],
 }
 #  Required capacity for various select types
-SELECT_TYPE_ABILITY = {
+SELECT_TYPE_ABILITY: dict[str, list[str]] = {
     "night_vision_mode": ["NVM"],
     "collection_point": ["CollectionPoint"],
 }
-SELECT_TYPE_REF = {
+SELECT_TYPE_REF: dict[str, list[dict[str, Any]]] = {
     "night_vision_mode": [
         {
             "ref": "17400",
@@ -432,14 +512,6 @@ SELECT_TYPE_REF = {
             "value_type": "int",
         },
     ],
-    "mode": [
-        {
-            "ref": "15200",
-            "default": "home",
-            "options": ["home", "away", "disarm"],
-            "value_type": "int",
-        }
-    ],
     "device_volume": [
         {
             "ref": "15400",
@@ -459,12 +531,20 @@ SELECT_TYPE_REF = {
         }
     ],
 }
+ALARM_CONTROL_PANEL_REF: list[dict[str, Any]] = [
+    {
+        "ref": "15200",
+        "default": "home",
+        "supported": ["home", "away", "disarm"],
+        "value_type": "int",
+    }
+]
 #  Required capacity for various sensor types
-SENSOR_TYPE_ABILITY = {
+SENSOR_TYPE_ABILITY: dict[str, list[str]] = {
     "storage_used": ["LocalStorage", "LocalStorageEnable"],
     "battery": ["Electric"],
 }
-SENSOR_TYPE_REF = {
+SENSOR_TYPE_REF: dict[str, list[dict[str, Any]]] = {
     "storage_used": [
         {
             "ref": "14600",
@@ -536,10 +616,12 @@ SENSOR_TYPE_REF = {
     ],
 }
 
-BINARY_SENSOR_TYPE_ABILITY = {}
-BINARY_SENSOR_TYPE_REF = {"door_contact_status": [{"ref": "16300", "default": False}]}
+BINARY_SENSOR_TYPE_ABILITY: dict[str, list[str]] = {}
+BINARY_SENSOR_TYPE_REF: dict[str, list[dict[str, Any]]] = {
+    "door_contact_status": [{"ref": "16300", "default": False}]
+}
 
-TEXT_TYPE_REF = {
+TEXT_TYPE_REF: dict[str, list[dict[str, Any]]] = {
     "count_down_switch": [
         {
             "ref": "28800",