pyimouapi 1.2.8__tar.gz → 1.2.9__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyimouapi
-Version: 1.2.8
+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

{pyimouapi-1.2.8 → pyimouapi-1.2.9}/pyimouapi/__init__.py

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

{pyimouapi-1.2.8 → 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"

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

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+from dataclasses import dataclass
 from typing import Any
 
 from .const import (
@@ -64,6 +65,14 @@ from .const import (
 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:

{pyimouapi-1.2.8 → pyimouapi-1.2.9}/pyimouapi/openapi.py

@@ -5,13 +5,15 @@ import logging
 import secrets
 import time
 import uuid
-from typing import Any
+from collections.abc import Iterable
+from typing import Any, Literal
 from urllib.parse import urlparse
 
 import aiohttp
 
 from .const import (
     API_ENDPOINT_ACCESS_TOKEN,
+    API_ENDPOINT_SET_MESSAGE_CALLBACK,
     ERROR_CODE_INVALID_APP,
     ERROR_CODE_INVALID_SIGN,
     ERROR_CODE_SUCCESS,
@@ -133,6 +135,31 @@ class ImouOpenApiClient:
         response_data = response_body[PARAM_RESULT].get(PARAM_DATA, {})
         return response_data
 
+    async def async_set_message_callback(
+        self,
+        *,
+        status: Literal["on", "off"],
+        callback_url: str | None = None,
+        callback_flag: str | Iterable[str] | None = None,
+        base_push: str = "2",
+    ) -> dict[str, Any]:
+        """Register or unregister Imou Open Platform message callback."""
+        params: dict[str, Any] = {
+            "status": status,
+            "basePush": base_push,
+        }
+        if status == "on":
+            if callback_url is None:
+                raise ValueError("callback_url is required when status is 'on'")
+            params["callbackUrl"] = callback_url
+            if callback_flag is None:
+                params["callbackFlag"] = "alarm,deviceStatus"
+            elif isinstance(callback_flag, str):
+                params["callbackFlag"] = callback_flag
+            else:
+                params["callbackFlag"] = ",".join(callback_flag)
+        return await self.async_request_api(API_ENDPOINT_SET_MESSAGE_CALLBACK, params)
+
     @property
     def access_token(self) -> str | None:
         return self._access_token

{pyimouapi-1.2.8 → pyimouapi-1.2.9}/pyimouapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyimouapi
-Version: 1.2.8
+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

{pyimouapi-1.2.8 → pyimouapi-1.2.9}/pyimouapi.egg-info/SOURCES.txt

@@ -14,5 +14,7 @@ pyimouapi.egg-info/dependency_links.txt
 pyimouapi.egg-info/requires.txt
 pyimouapi.egg-info/top_level.txt
 tests/test_collect_property_entities.py
+tests/test_device_summaries.py
 tests/test_lookup_property.py
+tests/test_message_callback.py
 tests/test_update_from_detail.py

{pyimouapi-1.2.8 → pyimouapi-1.2.9}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pyimouapi"
-version = "1.2.8"
+version = "1.2.9"
 description = "A package for imou open api"
 readme = "README.md"
 requires-python = ">=3.11"

{pyimouapi-1.2.8 → pyimouapi-1.2.9}/setup.py

@@ -4,7 +4,7 @@ from setuptools import find_packages, setup
 
 setup(
     name="pyimouapi",
-    version="1.2.8",
+    version="1.2.9",
     packages=find_packages(),
     python_requires=">=3.11",
     install_requires=[

pyimouapi-1.2.9/tests/test_device_summaries.py

@@ -0,0 +1,89 @@
+"""Tests for ImouDeviceManager.async_get_device_summaries."""
+
+from unittest.mock import AsyncMock, MagicMock
+
+import pytest
+from pyimouapi.const import (
+    API_ENDPOINT_LIST_DEVICE_DETAILS,
+    PARAM_COUNT,
+    PARAM_DEVICE_ID,
+    PARAM_DEVICE_LIST,
+    PARAM_DEVICE_MODEL,
+    PARAM_DEVICE_NAME,
+    PARAM_DEVICE_STATUS,
+    PARAM_PAGE,
+    PARAM_PAGE_SIZE,
+)
+from pyimouapi.device import ImouDeviceManager, ImouDeviceSummary
+
+
+def _make_device(
+    device_id: str,
+    name: str | None = "Camera",
+    model: str = "IPC-A1",
+    status: str | int = "1",
+) -> dict:
+    entry: dict = {
+        PARAM_DEVICE_ID: device_id,
+        PARAM_DEVICE_STATUS: status,
+    }
+    if name is not None:
+        entry[PARAM_DEVICE_NAME] = name
+    if model:
+        entry[PARAM_DEVICE_MODEL] = model
+    return entry
+
+
+@pytest.mark.asyncio
+async def test_get_device_summaries_single_page():
+    client = MagicMock()
+    client.async_request_api = AsyncMock(
+        return_value={
+            PARAM_COUNT: 2,
+            PARAM_DEVICE_LIST: [
+                _make_device("dev1", "Front Door", "IPC-A1", "1"),
+                _make_device("dev2", None, "", "0"),
+                {},
+            ],
+        }
+    )
+    manager = ImouDeviceManager(client)
+
+    summaries = await manager.async_get_device_summaries()
+
+    client.async_request_api.assert_awaited_once_with(
+        API_ENDPOINT_LIST_DEVICE_DETAILS,
+        {PARAM_PAGE: 1, PARAM_PAGE_SIZE: 50},
+    )
+    assert summaries == [
+        ImouDeviceSummary(
+            device_id="dev1", name="Front Door", model="IPC-A1", status="1"
+        ),
+        ImouDeviceSummary(device_id="dev2", name="dev2", model="", status="0"),
+    ]
+
+
+@pytest.mark.asyncio
+async def test_get_device_summaries_pagination():
+    page1_devices = [
+        _make_device(f"dev{i}", f"Device {i}", "IPC", "1") for i in range(50)
+    ]
+    page2_devices = [_make_device("dev50", "Device 50", "IPC", "1")]
+
+    async def mock_request(endpoint, params):
+        if params[PARAM_PAGE] == 1:
+            return {PARAM_COUNT: 50, PARAM_DEVICE_LIST: page1_devices}
+        if params[PARAM_PAGE] == 2:
+            return {PARAM_COUNT: 1, PARAM_DEVICE_LIST: page2_devices}
+        raise AssertionError(f"Unexpected page: {params[PARAM_PAGE]}")
+
+    client = MagicMock()
+    client.async_request_api = AsyncMock(side_effect=mock_request)
+    manager = ImouDeviceManager(client)
+
+    summaries = await manager.async_get_device_summaries()
+
+    assert client.async_request_api.await_count == 2
+    assert len(summaries) == 51
+    assert summaries[0].device_id == "dev0"
+    assert summaries[50].device_id == "dev50"

pyimouapi-1.2.9/tests/test_message_callback.py

@@ -0,0 +1,50 @@
+"""Tests for ImouOpenApiClient.async_set_message_callback."""
+
+from unittest.mock import AsyncMock
+
+import pytest
+from pyimouapi.const import API_ENDPOINT_SET_MESSAGE_CALLBACK
+from pyimouapi.openapi import ImouOpenApiClient
+
+
+@pytest.fixture
+def client() -> ImouOpenApiClient:
+    return ImouOpenApiClient("app_id", "app_secret", "api.example.com")
+
+
+@pytest.mark.asyncio
+async def test_set_message_callback_on(client: ImouOpenApiClient) -> None:
+    client.async_request_api = AsyncMock(return_value={})
+    await client.async_set_message_callback(
+        status="on",
+        callback_url="https://example.com/webhook",
+        callback_flag=["alarm", "deviceStatus"],
+    )
+    client.async_request_api.assert_awaited_once_with(
+        API_ENDPOINT_SET_MESSAGE_CALLBACK,
+        {
+            "status": "on",
+            "basePush": "2",
+            "callbackUrl": "https://example.com/webhook",
+            "callbackFlag": "alarm,deviceStatus",
+        },
+    )
+
+
+@pytest.mark.asyncio
+async def test_set_message_callback_off(client: ImouOpenApiClient) -> None:
+    client.async_request_api = AsyncMock(return_value={})
+    await client.async_set_message_callback(status="off")
+    client.async_request_api.assert_awaited_once_with(
+        API_ENDPOINT_SET_MESSAGE_CALLBACK,
+        {
+            "status": "off",
+            "basePush": "2",
+        },
+    )
+
+
+@pytest.mark.asyncio
+async def test_set_message_callback_on_requires_url(client: ImouOpenApiClient) -> None:
+    with pytest.raises(ValueError):
+        await client.async_set_message_callback(status="on")