pyimouapi 1.3.1__tar.gz → 1.3.3__tar.gz

{pyimouapi-1.3.1 → pyimouapi-1.3.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyimouapi
-Version: 1.3.1
+Version: 1.3.3
 Summary: A package for imou open api
 Home-page: https://github.com/Imou-OpenPlatform/Py-Imou-Open-Api
 Author: Imou-OpenPlatform
@@ -30,8 +30,9 @@ Async Python client for the **Imou Open Platform** cloud APIs. Built on **aiohtt
 | Module | Role |
 |--------|------|
 | `pyimouapi.openapi` | `ImouOpenApiClient` — auth, signing, token lifecycle, HTTP calls |
-| `pyimouapi.device` | `ImouDeviceManager`, `ImouDevice`, `ImouChannel` — listing, PTZ, alarms, storage, and related endpoints |
-| `pyimouapi.ha_device` | `ImouHaDeviceManager`, `ImouHaDevice`, … — aggregated “device model” helpers for automation stacks |
+| `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.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.1 → pyimouapi-1.3.3}/README.md

@@ -11,8 +11,9 @@ Async Python client for the **Imou Open Platform** cloud APIs. Built on **aiohtt
 | Module | Role |
 |--------|------|
 | `pyimouapi.openapi` | `ImouOpenApiClient` — auth, signing, token lifecycle, HTTP calls |
-| `pyimouapi.device` | `ImouDeviceManager`, `ImouDevice`, `ImouChannel` — listing, PTZ, alarms, storage, and related endpoints |
-| `pyimouapi.ha_device` | `ImouHaDeviceManager`, `ImouHaDevice`, … — aggregated “device model” helpers for automation stacks |
+| `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.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.1 → pyimouapi-1.3.3}/pyimouapi/__init__.py

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

pyimouapi-1.3.3/pyimouapi/collection_point.py

@@ -0,0 +1,89 @@
+"""Collection point (PTZ preset) parsing helpers."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from .const import IOT_COLLECTION_NAME_REF, PARAM_COLLECTION_POINT_PROMPT
+
+
+def parse_paas_collection_names(data: dict[str, Any]) -> list[str]:
+    """Extract preset names from getCollection PaaS response data."""
+    names: list[str] = []
+    for item in data.get("collections") or []:
+        if not isinstance(item, dict):
+            continue
+        name = item.get("name")
+        if name and str(name) != PARAM_COLLECTION_POINT_PROMPT:
+            names.append(str(name))
+    return unique_preserve_order(names)
+
+
+def _name_from_collection_item(item: dict[str, Any]) -> str | None:
+    for key in ("Name", "name", IOT_COLLECTION_NAME_REF):
+        value = item.get(key)
+        if value:
+            return str(value)
+    return None
+
+
+def parse_iot_collection_names(output_data: Any) -> list[str]:
+    """Extract preset names from GetCollection IoT outputData."""
+    names: list[str] = []
+    if output_data is None:
+        return names
+
+    if isinstance(output_data, dict):
+        for value in output_data.values():
+            if isinstance(value, list):
+                names.extend(_names_from_collection_items(value))
+            elif isinstance(value, str) and value != PARAM_COLLECTION_POINT_PROMPT:
+                names.append(value)
+        return unique_preserve_order(names)
+
+    if isinstance(output_data, list):
+        if output_data and all(isinstance(item, dict) for item in output_data):
+            if any(
+                item.get("identifier") == "collection"
+                or IOT_COLLECTION_NAME_REF in item
+                or "Name" in item
+                for item in output_data
+            ):
+                names.extend(_names_from_collection_items(output_data))
+            else:
+                for item in output_data:
+                    if not isinstance(item, dict):
+                        continue
+                    nested = item.get("value")
+                    if isinstance(nested, list):
+                        names.extend(_names_from_collection_items(nested))
+        return unique_preserve_order(names)
+
+    return names
+
+
+def _names_from_collection_items(items: list[Any]) -> list[str]:
+    names: list[str] = []
+    for item in items:
+        if not isinstance(item, dict):
+            continue
+        name = _name_from_collection_item(item)
+        if name and name != PARAM_COLLECTION_POINT_PROMPT:
+            names.append(name)
+    return names
+
+
+def unique_preserve_order(names: list[str]) -> list[str]:
+    seen: set[str] = set()
+    ordered: list[str] = []
+    for name in names:
+        if name in seen:
+            continue
+        seen.add(name)
+        ordered.append(name)
+    return ordered
+
+
+def build_collection_point_options(names: list[str]) -> list[str]:
+    """Build select options with placeholder first, preserving API order."""
+    return [PARAM_COLLECTION_POINT_PROMPT, *unique_preserve_order(names)]

{pyimouapi-1.3.1 → pyimouapi-1.3.3}/pyimouapi/const.py

@@ -23,6 +23,10 @@ API_ENDPOINT_GET_PRODUCT_MODEL = "/openapi/getProductModel"
 API_ENDPOINT_GET_IOT_DEVICE_DETAIL_INFO = "/openapi/getIotDeviceDetailInfo"
 API_ENDPOINT_WAKE_UP_DEVICE = "/openapi/wakeUpDevice"
 API_ENDPOINT_SET_MESSAGE_CALLBACK = "/openapi/setMessageCallback"
+API_ENDPOINT_GET_COLLECTION = "/openapi/getCollection"
+API_ENDPOINT_TURN_COLLECTION = "/openapi/turnCollection"
+API_ENDPOINT_SIREN_START = "/openapi/sirenStart"
+API_ENDPOINT_SIREN_STOP = "/openapi/sirenStop"
 
 # error_codes
 ERROR_CODE_SUCCESS = "0"
@@ -109,6 +113,10 @@ PARAM_MOTION_DETECT = "motion_detect"
 PARAM_STORAGE_USED = "storage_used"
 PARAM_RESTART_DEVICE = "restart_device"
 PARAM_NIGHT_VISION_MODE = "night_vision_mode"
+PARAM_COLLECTION_POINT = "collection_point"
+PARAM_COLLECTION_POINT_PROMPT = "select_collection_point"
+PARAM_SIREN_START = "siren_start"
+PARAM_SIREN_STOP = "siren_stop"
 PARAM_PTZ = "ptz"
 PARAM_TEMPERATURE_CURRENT = "temperature_current"
 PARAM_HUMIDITY_CURRENT = "humidity_current"
@@ -128,6 +136,18 @@ PARAM_ABILITY_REFS = "abilityRefs"
 PARAM_REF_TYPE = "ref_type"
 PARAM_EXPRESSION = "expression"
 PARAM_OUTPUT_DATA = "outputData"
+PARAM_TURN_REF = "turn_ref"
+PARAM_TURN_INPUT_REF = "turn_input_ref"
+PARAM_INPUT_REF = "input_ref"
+PARAM_COLLECTION_NAME = "name"
+
+IOT_GET_COLLECTION_REF = "21500"
+IOT_TURN_COLLECTION_REF = "22000"
+IOT_TURN_COLLECTION_NAME_REF = "22001"
+IOT_COLLECTION_NAME_REF = "21551"
+IOT_SIREN_START_REF = "25500"
+IOT_SIREN_START_INPUT_REF = "25501"
+IOT_SIREN_STOP_REF = "22200"
 PARAM_VALUE_TYPE = "value_type"
 PARAM_ACCESS_TYPE = "accessType"
 PARAM_ABILITY = "ability"
@@ -294,6 +314,8 @@ SWITCH_TYPE_REF = {
 #  Required capacity for various button types
 BUTTON_TYPE_ABILITY = {
     "restart_device": ["Reboot"],
+    "siren_start": ["Siren"],
+    "siren_stop": ["Siren"],
     "ptz_up": ["PT", "PTZ"],
     "ptz_down": ["PT", "PTZ"],
     "ptz_left": ["PT", "PTZ"],
@@ -331,6 +353,15 @@ BUTTON_TYPE_REF = {
             ],
         },
     ],
+    "siren_start": [
+        {
+            "ref": IOT_SIREN_START_REF,
+            "input_ref": IOT_SIREN_START_INPUT_REF,
+        },
+    ],
+    "siren_stop": [
+        {"ref": IOT_SIREN_STOP_REF},
+    ],
     "ptz_up": [
         {"ref": "22100"},
         {"ref": "88700"},
@@ -371,6 +402,7 @@ BUTTON_TYPE_REF = {
 #  Required capacity for various select types
 SELECT_TYPE_ABILITY = {
     "night_vision_mode": ["NVM"],
+    "collection_point": ["CollectionPoint"],
 }
 SELECT_TYPE_REF = {
     "night_vision_mode": [
@@ -404,6 +436,16 @@ SELECT_TYPE_REF = {
             "value_type": "int",
         }
     ],
+    "collection_point": [
+        {
+            "ref": IOT_GET_COLLECTION_REF,
+            "turn_ref": IOT_TURN_COLLECTION_REF,
+            "turn_input_ref": IOT_TURN_COLLECTION_NAME_REF,
+            "ref_type": "services",
+            "default": PARAM_COLLECTION_POINT_PROMPT,
+            "options": [PARAM_COLLECTION_POINT_PROMPT],
+        }
+    ],
 }
 #  Required capacity for various sensor types
 SENSOR_TYPE_ABILITY = {

{pyimouapi-1.3.1 → pyimouapi-1.3.3}/pyimouapi/device.py

@@ -10,6 +10,7 @@ from .const import (
     API_ENDPOINT_CONTROL_DEVICE_PTZ,
     API_ENDPOINT_DEVICE_SD_CARD_STATUS,
     API_ENDPOINT_DEVICE_STORAGE,
+    API_ENDPOINT_GET_COLLECTION,
     API_ENDPOINT_GET_DEVICE_ALARM_PARAM,
     API_ENDPOINT_GET_DEVICE_LIVE_INFO,
     API_ENDPOINT_GET_DEVICE_NIGHT_VISION_MODE,
@@ -27,6 +28,9 @@ from .const import (
     API_ENDPOINT_SET_DEVICE_SNAP,
     API_ENDPOINT_SET_DEVICE_STATUS,
     API_ENDPOINT_SET_IOT_DEVICE_PROPERTIES,
+    API_ENDPOINT_SIREN_START,
+    API_ENDPOINT_SIREN_STOP,
+    API_ENDPOINT_TURN_COLLECTION,
     API_ENDPOINT_WAKE_UP_DEVICE,
     NIGHT_VISION_MODE_MAP,
     PARAM_ABILITY_REFS,
@@ -39,6 +43,7 @@ from .const import (
     PARAM_CHANNEL_NUM,
     PARAM_CHANNEL_STATUS,
     PARAM_CHANNELS,
+    PARAM_COLLECTION_NAME,
     PARAM_CONTENT,
     PARAM_COUNT,
     PARAM_DEVICE_ABILITY,
@@ -206,6 +211,10 @@ class ImouDevice:
     def parent_device_id(self) -> str | None:
         return self._parent_device_id
 
+    @property
+    def channel_number(self) -> int:
+        return self._channel_number
+
     @property
     def is_ipc(self) -> bool:
         return (
@@ -258,6 +267,10 @@ class ImouDeviceManager:
         self._event_map_locks: dict[str, asyncio.Lock] = {}
         self._event_map_locks_guard = asyncio.Lock()
 
+    async def async_close(self) -> None:
+        """Close the underlying Open API HTTP session."""
+        await self._imou_api_client.async_close()
+
     async def _async_lock_for_product(self, product_id: str) -> asyncio.Lock:
         async with self._event_map_locks_guard:
             lock = self._event_map_locks.get(product_id)
@@ -555,11 +568,13 @@ class ImouDeviceManager:
                 }
             ]
         }
-        return (
-            await self._imou_api_client.async_request_api(
-                API_ENDPOINT_GET_IOT_DEVICE_PROPERTIES, params
-            )
-        ).get(PARAM_DEVICE_LIST, [{}])[0]
+        data = await self._imou_api_client.async_request_api(
+            API_ENDPOINT_GET_IOT_DEVICE_PROPERTIES, params
+        )
+        device_list = data.get(PARAM_DEVICE_LIST) if isinstance(data, dict) else None
+        if not device_list:
+            return {}
+        return device_list[0]
 
     async def async_set_iot_device_properties(
         self, device_id: str, channel_id: str | None, product_id: str, properties: dict
@@ -635,6 +650,45 @@ class ImouDeviceManager:
             API_ENDPOINT_GET_IOT_DEVICE_DETAIL_INFO, params
         )
 
+    async def async_get_device_collection(
+        self, device_id: str, channel_id: str
+    ) -> dict[str, Any]:
+        params = {
+            PARAM_DEVICE_ID: device_id,
+            PARAM_CHANNEL_ID: channel_id,
+        }
+        return await self._imou_api_client.async_request_api(
+            API_ENDPOINT_GET_COLLECTION, params
+        )
+
+    async def async_turn_device_collection(
+        self, device_id: str, channel_id: str, name: str
+    ) -> None:
+        params = {
+            PARAM_DEVICE_ID: device_id,
+            PARAM_CHANNEL_ID: channel_id,
+            PARAM_COLLECTION_NAME: name,
+        }
+        await self._imou_api_client.async_request_api(
+            API_ENDPOINT_TURN_COLLECTION, params
+        )
+
+    async def async_siren_start(
+        self, device_id: str, channels: list[int] | None = None
+    ) -> None:
+        params: dict[str, Any] = {PARAM_DEVICE_ID: device_id}
+        if channels is not None:
+            params[PARAM_CHANNELS] = channels
+        await self._imou_api_client.async_request_api(API_ENDPOINT_SIREN_START, params)
+
+    async def async_siren_stop(
+        self, device_id: str, channels: list[int] | None = None
+    ) -> None:
+        params: dict[str, Any] = {PARAM_DEVICE_ID: device_id}
+        if channels is not None:
+            params[PARAM_CHANNELS] = channels
+        await self._imou_api_client.async_request_api(API_ENDPOINT_SIREN_STOP, params)
+
     async def _async_update_device_ability_refs(self, imou_device: ImouDevice) -> None:
         device_id = imou_device.device_id
         if imou_device.parent_product_id is not None:
@@ -655,12 +709,15 @@ class ImouDeviceManager:
         if device_detail.get(PARAM_CHANNELS) and imou_device.channels:
             channels_detail = device_detail.get(PARAM_CHANNELS)
             channel_detail_map = {
-                channel_detail.get(PARAM_CHANNEL_ID): channel_detail.get(
+                str(channel_detail.get(PARAM_CHANNEL_ID)): channel_detail.get(
                     PARAM_ABILITY_REFS, "unknown"
                 )
                 for channel_detail in channels_detail
+                if channel_detail.get(PARAM_CHANNEL_ID) is not None
             }
             for channel in imou_device.channels:
-                channel_id = channel.channel_id
-                if channel_id in channel_detail_map:
+                channel_id = (
+                    str(channel.channel_id) if channel.channel_id is not None else None
+                )
+                if channel_id is not None and channel_id in channel_detail_map:
                     channel.set_channel_ability_refs(channel_detail_map[channel_id])