pyimouapi 1.1.0__tar.gz → 1.1.2__tar.gz

{pyimouapi-1.1.0 → pyimouapi-1.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyimouapi
-Version: 1.1.0
+Version: 1.1.2
 Summary: A package for imou open api
 Home-page: https://github.com/Imou-OpenPlatform/Py-Imou-Open-Api
 Author: Imou-OpenPlatform

pyimouapi-1.1.2/pyimouapi/const.py

@@ -0,0 +1,299 @@
+# API Endpoints
+API_ENDPOINT_ACCESS_TOKEN = "/openapi/accessToken"
+API_ENDPOINT_LIST_DEVICE_DETAILS = "/openapi/listDeviceDetailsByPage"
+API_ENDPOINT_CONTROL_DEVICE_PTZ = "/openapi/controlMovePTZ"
+API_ENDPOINT_MODIFY_DEVICE_ALARM_STATUS = "/openapi/modifyDeviceAlarmStatus"
+API_ENDPOINT_GET_DEVICE_ALARM_PARAM = "/openapi/getDeviceAlarmParam"
+API_ENDPOINT_GET_DEVICE_STATUS = "/openapi/getDeviceCameraStatus"
+API_ENDPOINT_SET_DEVICE_STATUS = "/openapi/setDeviceCameraStatus"
+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_LIVE = "/openapi/bindDeviceLive"
+API_ENDPOINT_GET_DEVICE_ONLINE = "/openapi/deviceOnline"
+API_ENDPOINT_GET_DEVICE_LIVE_INFO = "/openapi/getLiveStreamInfo"
+API_ENDPOINT_SET_DEVICE_SNAP = "/openapi/setDeviceSnapEnhanced"
+API_ENDPOINT_GET_IOT_DEVICE_PROPERTIES = "/openapi/getIotDeviceProperties"
+API_ENDPOINT_SET_IOT_DEVICE_PROPERTIES = "/openapi/setIotDeviceProperties"
+API_ENDPOINT_DEVICE_SD_CARD_STATUS = "/openapi/deviceSdcardStatus"
+API_ENDPOINT_IOT_DEVICE_CONTROL = "/openapi/iotDeviceControl"
+API_ENDPOINT_GET_DEVICE_POWER_INFO = "/openapi/getDevicePowerInfo"
+API_ENDPOINT_GET_PRODUCT_MODEL = "/openapi/getProductModel"
+
+# error_codes
+ERROR_CODE_SUCCESS = "0"
+ERROR_CODE_TOKEN_OVERDUE = "TK1002"
+ERROR_CODE_INVALID_SIGN = "SN1001"
+ERROR_CODE_INVALID_APP = "SN1004"
+ERROR_CODE_DEVICE_OFFLINE = "DV1007"
+ERROR_CODE_NO_STORAGE_MEDIUM = "DV1049"
+ERROR_CODE_LIVE_NOT_EXIST = "LV1002"
+ERROR_CODE_LIVE_ALREADY_EXIST = "LV1001"
+
+# params key
+PARAM_APP_ID = "appId"
+PARAM_APP_SECRET = "appSecret"
+PARAM_SYSTEM = "system"
+PARAM_ACCESS_TOKEN = "accessToken"
+PARAM_CURRENT_DOMAIN = "currentDomain"
+PARAM_DEVICE_ID = "deviceId"
+PARAM_CHANNEL_ID = "channelId"
+PARAM_VER = "ver"
+PARAM_SIGN = "sign"
+PARAM_TIME = "time"
+PARAM_NONCE = "nonce"
+PARAM_PARAMS = "params"
+PARAM_ID = "id"
+PARAM_RESULT = "result"
+PARAM_CODE = "code"
+PARAM_MSG = "msg"
+PARAM_DATA = "data"
+PARAM_PAGE = "page"
+PARAM_PAGE_SIZE = "pageSize"
+PARAM_TOKEN = "token"
+PARAM_PRODUCT_ID = "productId"
+PARAM_PARENT_PRODUCT_ID = "parentProductId"
+PARAM_PARENT_DEVICE_ID = "parentDeviceId"
+PARAM_CHANNEL_NUM = "channelNum"
+PARAM_MODE = "mode"
+PARAM_ENABLE_TYPE = "enableType"
+PARAM_ENABLE = "enable"
+PARAM_COUNT = "count"
+PARAM_DEVICE_LIST = "deviceList"
+PARAM_DEVICE_NAME = "deviceName"
+PARAM_DEVICE_STATUS = "deviceStatus"
+PARAM_DEVICE_ABILITY = "deviceAbility"
+PARAM_DEVICE_VERSION = "deviceVersion"
+PARAM_BRAND = "brand"
+PARAM_DEVICE_MODEL = "deviceModel"
+PARAM_CHANNEL_LIST = "channelList"
+PARAM_CHANNEL_NAME = "channelName"
+PARAM_CHANNEL_STATUS = "channelStatus"
+PARAM_CHANNEL_ABILITY = "channelAbility"
+PARAM_STREAM_ID = "streamId"
+PARAM_OPERATION = "operation"
+PARAM_DURATION = "duration"
+PARAM_PROPERTIES = "properties"
+PARAM_API_URL = "api_url"
+PARAM_STATUS = "status"
+PARAM_CURRENT_OPTION = "current_option"
+PARAM_MODES = "modes"
+PARAM_OPTIONS = "options"
+PARAM_CHANNELS = "channels"
+PARAM_USED_BYTES = "usedBytes"
+PARAM_TOTAL_BYTES = "totalBytes"
+PARAM_STREAMS = "streams"
+PARAM_HLS = "hls"
+PARAM_URL = "url"
+PARAM_KEY = "key"
+PARAM_DEFAULT = "default"
+PARAM_REF = "ref"
+PARAM_CONTENT = "content"
+PARAM_ON = "on"
+PARAM_BUTTON_TYPE_REF = "button_type_ref"
+PARAM_SENSOR_TYPE_REF = "sensor_type_ref"
+PARAM_SWITCH_TYPE_REF = "switch_type_ref"
+PARAM_SELECT_TYPE_REF = "select_type_ref"
+PARAM_BINARY_SENSOR_TYPE_REF = "binary_sensor_type_ref"
+PARAM_ONLINE = "onLine"
+PARAM_HD = "HD"
+PARAM_MULTI_FLAG = "multiFlag"
+PARAM_MOTION_DETECT = "motion_detect"
+PARAM_STORAGE_USED = "storage_used"
+PARAM_RESTART_DEVICE = "restart_device"
+PARAM_NIGHT_VISION_MODE = "night_vision_mode"
+PARAM_PTZ = "ptz"
+PARAM_TEMPERATURE_CURRENT = "temperature_current"
+PARAM_HUMIDITY_CURRENT = "humidity_current"
+PARAM_BATTERY = "battery"
+PARAM_ELECTRICITYS = "electricitys"
+PARAM_ELECTRIC = "electric"
+PARAM_LITELEC = "litElec"
+PARAM_ALKELEC = "alkElec"
+PARAM_SERVICES = "services"
+PARAM_STATE = "state"
+PARAM_TYPE = "type"
+PARAM_EXCEPTS = "excepts"
+
+
+# Required capacity for various switch types
+SWITCH_TYPE_ABILITY = {
+    "motion_detect": ["MobileDetect", "MotionDetect", "AlarmMD"],
+    "close_camera": ["CloseCamera"],
+    "white_light": ["WhiteLight", "ChnWhiteLight"],
+    "ab_alarm_sound": ["AbAlarmSound"],
+    "audio_encode_control": ["AudioEncodeControl", "AudioEncodeControlV2"],
+    "header_detect": ["HeaderDetect", "AiHuman", "SMDH"],
+}
+SWITCH_TYPE_REF = {
+    "motion_detect": [{"ref": "14800", "default": False, "type": "properties"}],
+    "close_camera": [{"ref": "13100", "default": False, "type": "properties"}],
+    "white_light": [{"ref": "19700", "default": False, "type": "properties"}],
+    "ab_alarm_sound": [
+        {"ref": "14200", "default": False, "type": "properties"},
+        {"ref": "115300", "default": False, "type": "properties"},
+    ],
+    "audio_encode_control": [
+        {"ref": "13900", "default": False, "type": "properties"},
+        {"ref": "111900", "default": False, "type": "properties"},
+        {"ref": "103800", "default": False, "type": "properties"},
+    ],
+    "header_detect": [
+        {"ref": "17100", "default": False, "type": "properties"},
+        {"ref": "17900", "default": False, "type": "properties"},
+        {"ref": "108900", "default": False, "type": "properties"},
+    ],
+    "light": [{"ref": "11400", "default": False, "type": "properties"}],
+}
+#  Required capacity for various button types
+BUTTON_TYPE_ABILITY = {
+    "restart_device": ["Reboot"],
+    "ptz_up": ["PT", "PTZ"],
+    "ptz_down": ["PT", "PTZ"],
+    "ptz_left": ["PT", "PTZ"],
+    "ptz_right": ["PT", "PTZ"],
+}
+BUTTON_TYPE_REF = {
+    "restart_device": [{"ref": "2300", "type": "services"}],
+    "mute": [
+        {
+            "ref": "21600",
+            "type": "services",
+            "excepts": [
+                "emi4a5sapwg0pnj0",
+                "BZFACWD1",
+                "Q5egDcb6",
+                "2BFWLKHL",
+                "2BTLSNHP",
+                "GF3QAMMD",
+                "35gL0U5A",
+            ],
+        },
+        {
+            "ref": "2200",
+            "type": "services",
+            "excepts": [
+                "emi4a5sapwg0pnj0",
+                "BZFACWD1",
+                "Q5egDcb6",
+                "2BFWLKHL",
+                "2BTLSNHP",
+                "GF3QAMMD",
+                "35gL0U5A",
+            ],
+        },
+    ],
+}
+#  Required capacity for various select types
+SELECT_TYPE_ABILITY = {
+    "night_vision_mode": ["NVM"],
+}
+SELECT_TYPE_REF = {
+    "night_vision_mode": [
+        {
+            "ref": "17400",
+            "default": "0",
+            "options": ["0", "1", "2", "3", "5"],
+            "type": "properties",
+        },
+        {
+            "ref": "139700",
+            "default": "0",
+            "options": ["0", "1", "2", "3", "4"],
+            "type": "properties",
+        },
+        {"ref": "112400", "default": "2", "options": ["2", "3"], "type": "properties"},
+    ],
+    "mode": [
+        {
+            "ref": "15200",
+            "default": "0",
+            "type": "properties",
+            "options": ["0", "1", "2"],
+        }
+    ],
+    "device_volume": [
+        {
+            "ref": "15400",
+            "default": "0",
+            "type": "properties",
+            "options": ["-1", "0", "1", "2"],
+        }
+    ],
+}
+#  Required capacity for various sensor types
+SENSOR_TYPE_ABILITY = {
+    "storage_used": ["LocalStorage", "LocalStorageEnable"],
+    "battery": ["Electric"],
+}
+SENSOR_TYPE_REF = {
+    "battery": [{"ref": "11600", "default": "15", "type": "properties"}],
+    "temperature_current": [
+        {
+            "ref": "16000",
+            "type": "properties",
+            "default": "10",
+        }
+    ],
+    "humidity_current": [
+        {
+            "ref": "16100",
+            "type": "properties",
+            "default": "10",
+        }
+    ],
+}
+
+BINARY_SENSOR_TYPE_ABILITY = {}
+BINARY_SENSOR_TYPE_REF = {
+    "door_contact_status": [
+        {
+            "ref": "16300",
+            "type": "properties",
+            "default": False,
+        }
+    ]
+}
+
+# Levels of capacity
+ABILITY_LEVEL_TYPE = {
+    "MobileDetect": 2,
+    "MotionDetect": 2,
+    "PT": 2,
+    "PTZ": 2,
+    "CloseCamera": 2,
+    "WhiteLight": 1,
+    "ChnWhiteLight": 2,
+    "AbAlarmSound": 1,
+    "AudioEncodeControl": 2,
+    "AudioEncodeControlV2": 2,
+    "NVM": 2,
+    "LocalStorage": 1,
+    "LocalStorageEnable": 1,
+    "Reboot": 1,
+    "Electric": 3,
+    "HeaderDetect": 2,
+    "AlarmMD": 2,
+    "HumanDetect": 2,
+    "AiHuman": 2,
+    "SMDH": 2,
+}
+
+
+# The parameter values for switch
+SWITCH_TYPE_ENABLE = {
+    "motion_detect": ["motionDetect", "mobileDetect"],
+    "close_camera": ["closeCamera"],
+    "white_light": ["whiteLight"],
+    "audio_encode_control": ["audioEncodeControl"],
+    "ab_alarm_sound": ["abAlarmSound"],
+    "header_detect": ["headerDetect", "aiHuman", "smdHuman"],
+}
+
+BUTTON_TYPE_PARAM_VALUE = {
+    "ptz_up": 0,
+    "ptz_down": 1,
+    "ptz_left": 2,
+    "ptz_right": 3,
+}

{pyimouapi-1.1.0 → pyimouapi-1.1.2}/pyimouapi/device.py

@@ -48,6 +48,7 @@ from .const import (
     API_ENDPOINT_IOT_DEVICE_CONTROL,
     PARAM_MULTI_FLAG,
     API_ENDPOINT_GET_DEVICE_POWER_INFO,
+    API_ENDPOINT_GET_PRODUCT_MODEL,
 )
 from .openapi import ImouOpenApiClient
 
@@ -204,7 +205,7 @@ class ImouDeviceManager:
             device_name = device[PARAM_DEVICE_NAME]
             device_status = device[PARAM_DEVICE_STATUS]
             brand = device[PARAM_BRAND]
-            device_model = device.get(PARAM_DEVICE_MODEL,"unknown")
+            device_model = device.get(PARAM_DEVICE_MODEL, "unknown")
             imou_device = ImouDevice(
                 device_id, device_name, device_status, brand, device_model
             )
@@ -428,10 +429,18 @@ class ImouDeviceManager:
             API_ENDPOINT_IOT_DEVICE_CONTROL, params
         )
 
-    async def async_get_device_power_info(self, device_id):
+    async def async_get_device_power_info(self, device_id: str):
         params = {
             PARAM_DEVICE_ID: device_id,
         }
         return await self._imou_api_client.async_request_api(
             API_ENDPOINT_GET_DEVICE_POWER_INFO, params
         )
+
+    async def async_get_product_model(self, product_id: str):
+        params = {
+            PARAM_DEVICE_ID: product_id,
+        }
+        return await self._imou_api_client.async_request_api(
+            API_ENDPOINT_GET_PRODUCT_MODEL, params
+        )