pyimouapi 1.2.7__tar.gz → 1.2.9__tar.gz

{pyimouapi-1.2.7 → pyimouapi-1.2.9}/PKG-INFO

@@ -1,31 +1,21 @@
 Metadata-Version: 2.4
 Name: pyimouapi
-Version: 1.2.7
+Version: 1.2.9
 Summary: A package for imou open api
 Home-page: https://github.com/Imou-OpenPlatform/Py-Imou-Open-Api
 Author: Imou-OpenPlatform
-Author-email: cloud_openteam_service@imou.com
+Author-email: Imou-OpenPlatform <cloud_openteam_service@imou.com>
 License: MIT
-Classifier: Intended Audience :: Developers
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Topic :: Software Development :: Libraries
+Project-URL: Homepage, https://github.com/Imou-OpenPlatform/Py-Imou-Open-Api
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: aiohttp<4.0,>=3.11.9
 Requires-Dist: simpleeval>=1.0.3
 Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
 Dynamic: home-page
-Dynamic: license
 Dynamic: license-file
-Dynamic: requires-dist
 Dynamic: requires-python
-Dynamic: summary
 
 # pyimouapi
 

pyimouapi-1.2.9/pyimouapi/__init__.py

@@ -0,0 +1,20 @@
+__version__ = "1.2.9"
+
+from .device import ImouChannel, ImouDevice, ImouDeviceManager
+from .exceptions import (
+    ConnectFailedException,
+    InvalidAppIdOrSecretException,
+    RequestFailedException,
+)
+from .openapi import ImouOpenApiClient
+
+__all__ = [
+    "ConnectFailedException",
+    "ImouChannel",
+    "ImouDevice",
+    "ImouDeviceManager",
+    "ImouOpenApiClient",
+    "InvalidAppIdOrSecretException",
+    "RequestFailedException",
+    "__version__",
+]

{pyimouapi-1.2.7 → pyimouapi-1.2.9}/pyimouapi/const.py

@@ -22,6 +22,7 @@ API_ENDPOINT_GET_DEVICE_POWER_INFO = "/openapi/getDevicePowerInfo"
 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"
 
 # error_codes
 ERROR_CODE_SUCCESS = "0"
@@ -518,5 +519,5 @@ NIGHT_VISION_MODE_MAP = {
     "infrared": "Infrared",
     "off": "Off",
     "lowlight": "LowLight",
-    "smartlowlight": "SmartLowLight"
+    "smartlowlight": "SmartLowLight",
 }

{pyimouapi-1.2.7 → pyimouapi-1.2.9}/pyimouapi/device.py

@@ -1,69 +1,78 @@
 from __future__ import annotations
 
+from dataclasses import dataclass
 from typing import Any
 
 from .const import (
-    API_ENDPOINT_LIST_DEVICE_DETAILS,
-    PARAM_PAGE_SIZE,
-    PARAM_PAGE,
-    PARAM_DEVICE_ID,
-    PARAM_CHANNEL_ID,
+    API_ENDPOINT_BIND_DEVICE_LIVE,
     API_ENDPOINT_CONTROL_DEVICE_PTZ,
-    API_ENDPOINT_MODIFY_DEVICE_ALARM_STATUS,
-    API_ENDPOINT_GET_DEVICE_STATUS,
-    API_ENDPOINT_SET_DEVICE_STATUS,
-    API_ENDPOINT_GET_DEVICE_NIGHT_VISION_MODE,
+    API_ENDPOINT_DEVICE_SD_CARD_STATUS,
     API_ENDPOINT_DEVICE_STORAGE,
-    API_ENDPOINT_RESTART_DEVICE,
-    API_ENDPOINT_BIND_DEVICE_LIVE,
-    API_ENDPOINT_GET_DEVICE_ONLINE,
+    API_ENDPOINT_GET_DEVICE_ALARM_PARAM,
     API_ENDPOINT_GET_DEVICE_LIVE_INFO,
+    API_ENDPOINT_GET_DEVICE_NIGHT_VISION_MODE,
+    API_ENDPOINT_GET_DEVICE_ONLINE,
+    API_ENDPOINT_GET_DEVICE_POWER_INFO,
+    API_ENDPOINT_GET_DEVICE_STATUS,
+    API_ENDPOINT_GET_IOT_DEVICE_DETAIL_INFO,
+    API_ENDPOINT_GET_IOT_DEVICE_PROPERTIES,
+    API_ENDPOINT_GET_PRODUCT_MODEL,
+    API_ENDPOINT_IOT_DEVICE_CONTROL,
+    API_ENDPOINT_LIST_DEVICE_DETAILS,
+    API_ENDPOINT_MODIFY_DEVICE_ALARM_STATUS,
+    API_ENDPOINT_RESTART_DEVICE,
+    API_ENDPOINT_SET_DEVICE_NIGHT_VISION_MODE,
     API_ENDPOINT_SET_DEVICE_SNAP,
-    PARAM_MODE,
-    PARAM_ENABLE_TYPE,
-    PARAM_ENABLE,
+    API_ENDPOINT_SET_DEVICE_STATUS,
+    API_ENDPOINT_SET_IOT_DEVICE_PROPERTIES,
+    API_ENDPOINT_WAKE_UP_DEVICE,
+    NIGHT_VISION_MODE_MAP,
+    PARAM_ABILITY_REFS,
+    PARAM_ACCESS_TYPE,
+    PARAM_BRAND,
+    PARAM_CHANNEL_ABILITY,
+    PARAM_CHANNEL_ID,
+    PARAM_CHANNEL_LIST,
+    PARAM_CHANNEL_NAME,
+    PARAM_CHANNEL_NUM,
+    PARAM_CHANNEL_STATUS,
+    PARAM_CHANNELS,
+    PARAM_CONTENT,
     PARAM_COUNT,
+    PARAM_DEVICE_ABILITY,
+    PARAM_DEVICE_ID,
     PARAM_DEVICE_LIST,
+    PARAM_DEVICE_MODEL,
     PARAM_DEVICE_NAME,
     PARAM_DEVICE_STATUS,
-    PARAM_DEVICE_ABILITY,
     PARAM_DEVICE_VERSION,
-    PARAM_BRAND,
-    PARAM_DEVICE_MODEL,
-    PARAM_CHANNEL_LIST,
-    PARAM_CHANNEL_NAME,
-    PARAM_CHANNEL_STATUS,
-    PARAM_CHANNEL_ABILITY,
-    PARAM_STREAM_ID,
-    PARAM_OPERATION,
     PARAM_DURATION,
-    API_ENDPOINT_GET_DEVICE_ALARM_PARAM,
-    API_ENDPOINT_SET_DEVICE_NIGHT_VISION_MODE,
+    PARAM_ENABLE,
+    PARAM_ENABLE_TYPE,
+    PARAM_MODE,
+    PARAM_MULTI_FLAG,
+    PARAM_OPERATION,
+    PARAM_PAGE,
+    PARAM_PAGE_SIZE,
+    PARAM_PARENT_DEVICE_ID,
+    PARAM_PARENT_PRODUCT_ID,
     PARAM_PRODUCT_ID,
     PARAM_PROPERTIES,
-    API_ENDPOINT_GET_IOT_DEVICE_PROPERTIES,
-    API_ENDPOINT_SET_IOT_DEVICE_PROPERTIES,
-    API_ENDPOINT_DEVICE_SD_CARD_STATUS,
-    PARAM_CHANNEL_NUM,
-    PARAM_PARENT_PRODUCT_ID,
-    PARAM_PARENT_DEVICE_ID,
     PARAM_REF,
-    PARAM_CONTENT,
-    API_ENDPOINT_IOT_DEVICE_CONTROL,
-    PARAM_MULTI_FLAG,
-    API_ENDPOINT_GET_DEVICE_POWER_INFO,
-    API_ENDPOINT_GET_PRODUCT_MODEL,
-    API_ENDPOINT_GET_IOT_DEVICE_DETAIL_INFO,
-    PARAM_ABILITY_REFS,
-    PARAM_CHANNELS,
-    PARAM_ACCESS_TYPE,
-    API_ENDPOINT_WAKE_UP_DEVICE,
+    PARAM_STREAM_ID,
     PARAM_URL,
-    NIGHT_VISION_MODE_MAP,
 )
 from .openapi import ImouOpenApiClient
 
 
+@dataclass(frozen=True)
+class ImouDeviceSummary:
+    device_id: str
+    name: str
+    model: str
+    status: str  # "0" offline, "1" online
+
+
 class ImouChannel:
     def __init__(
         self,
@@ -286,6 +295,38 @@ class ImouDeviceManager:
             devices.extend(await self.async_get_devices(page + 1, page_size))
         return devices
 
+    async def async_get_device_summaries(
+        self, page: int = 1, page_size: int = 50
+    ) -> list[ImouDeviceSummary]:
+        params = {
+            PARAM_PAGE: page,
+            PARAM_PAGE_SIZE: page_size,
+        }
+        data = await self._imou_api_client.async_request_api(
+            API_ENDPOINT_LIST_DEVICE_DETAILS, params
+        )
+        if data[PARAM_COUNT] == 0:
+            return []
+        summaries: list[ImouDeviceSummary] = []
+        for device in data[PARAM_DEVICE_LIST]:
+            device_id = device.get(PARAM_DEVICE_ID)
+            if not device_id:
+                continue
+            name = device.get(PARAM_DEVICE_NAME) or device_id
+            model = device.get(PARAM_DEVICE_MODEL, "")
+            status = str(device.get(PARAM_DEVICE_STATUS, ""))
+            summaries.append(
+                ImouDeviceSummary(
+                    device_id=device_id,
+                    name=name,
+                    model=model,
+                    status=status,
+                )
+            )
+        if data[PARAM_COUNT] >= page_size:
+            summaries.extend(await self.async_get_device_summaries(page + 1, page_size))
+        return summaries
+
     async def async_control_device_ptz(
         self, device_id: str, channel_id: str, operation: int, duration: int
     ) -> None: