pyezvizapi 1.0.2.7__tar.gz → 1.0.2.9__tar.gz

{pyezvizapi-1.0.2.7/pyezvizapi.egg-info → pyezvizapi-1.0.2.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyezvizapi
-Version: 1.0.2.7
+Version: 1.0.2.9
 Summary: Pilot your Ezviz cameras
 Home-page: https://github.com/RenierM26/pyEzvizApi/
 Author: Renier Moorcroft

{pyezvizapi-1.0.2.7 → pyezvizapi-1.0.2.9}/pyezvizapi/api_endpoints.py

@@ -37,7 +37,9 @@ API_ENDPOINT_DEVICE_BASICS = "/v3/basics/v1/devices/"
 
 API_ENDPOINT_DETECTION_SENSIBILITY = "/api/device/configAlgorithm"
 API_ENDPOINT_DETECTION_SENSIBILITY_GET = "/api/device/queryAlgorithmConfig"
+API_ENDPOINT_SENSITIVITY = "/v3/devconfig/v1/sensitivity/"
 API_ENDPOINT_SET_DEFENCE_SCHEDULE = "/api/device/defence/plan2"
+API_ENDPOINT_DEVICE_SWITCH_STATUS_LEGACY = "/api/device/switchStatus"
 API_ENDPOINT_CAM_ENCRYPTKEY = "/api/device/query/encryptkey"
 API_ENDPOINT_OFFLINE_NOTIFY = "/api/device/notify/switch"
 API_ENDPOINT_CANCEL_ALARM = "/api/device/cancelAlarm"

{pyezvizapi-1.0.2.7 → pyezvizapi-1.0.2.9}/pyezvizapi/client.py

@@ -2,13 +2,12 @@
 
 from __future__ import annotations
 
-from collections.abc import Callable
+from collections.abc import Callable, Mapping
 from datetime import datetime
 import hashlib
 import json
 import logging
 from typing import Any, ClassVar, TypedDict, cast
-import urllib.parse
 from uuid import uuid4
 
 import requests
@@ -28,6 +27,7 @@ from .api_endpoints import (
     API_ENDPOINT_DEVCONFIG_BY_KEY,
     API_ENDPOINT_DEVICE_BASICS,
     API_ENDPOINT_DEVICE_STORAGE_STATUS,
+    API_ENDPOINT_DEVICE_SWITCH_STATUS_LEGACY,
     API_ENDPOINT_DEVICE_SYS_OPERATION,
     API_ENDPOINT_DEVICES,
     API_ENDPOINT_DO_NOT_DISTURB,
@@ -46,6 +46,7 @@ from .api_endpoints import (
     API_ENDPOINT_REMOTE_UNLOCK,
     API_ENDPOINT_RETURN_PANORAMIC,
     API_ENDPOINT_SEND_CODE,
+    API_ENDPOINT_SENSITIVITY,
     API_ENDPOINT_SERVER_INFO,
     API_ENDPOINT_SET_DEFENCE_SCHEDULE,
     API_ENDPOINT_SET_LUMINANCE,
@@ -647,26 +648,103 @@ class EzvizClient:
         self._ensure_ok(json_output, "Could not get unified message list")
         return json_output
 
+    def set_switch_v3(
+        self,
+        serial: str,
+        switch_type: int,
+        enable: bool | int,
+        channel: int = 0,
+        max_retries: int = 0,
+    ) -> dict:
+        """Update a device switch via the v3 endpoint."""
+
+        if max_retries > MAX_RETRIES:
+            raise PyEzvizError("Can't gather proper data. Max retries exceeded.")
+
+        enable_flag = 1 if bool(enable) else 0
+        path = (
+            f"{API_ENDPOINT_DEVICES}{serial}/{channel}/{enable_flag}/"
+            f"{switch_type}{API_ENDPOINT_SWITCH_STATUS}"
+        )
+        payload = self._request_json(
+            "PUT",
+            path,
+            retry_401=True,
+            max_retries=max_retries,
+        )
+        self._ensure_ok(payload, "Could not set the switch")
+        return payload
+
+    def set_switch_legacy(
+        self,
+        serial: str,
+        switch_type: int,
+        enable: bool | int,
+        channel: int = 0,
+        max_retries: int = 0,
+    ) -> dict:
+        """Fallback legacy switch endpoint used by older firmware."""
+
+        if max_retries > MAX_RETRIES:
+            raise PyEzvizError("Can't gather proper data. Max retries exceeded.")
+
+        payload = self._request_json(
+            "POST",
+            API_ENDPOINT_DEVICE_SWITCH_STATUS_LEGACY,
+            data={
+                "serial": serial,
+                "enable": "1" if bool(enable) else "0",
+                "type": str(switch_type),
+                "channel": str(channel),
+            },
+            retry_401=True,
+            max_retries=max_retries,
+        )
+        self._ensure_ok(payload, "Could not set the switch (legacy)")
+        return payload
+
+    def set_switch(
+        self,
+        serial: str,
+        switch_type: int,
+        enable: bool | int,
+        channel: int = 0,
+        max_retries: int = 0,
+    ) -> dict:
+        """Try the v3 switch endpoint, falling back to the legacy API if needed."""
+
+        try:
+            return self.set_switch_v3(
+                serial, switch_type, enable, channel, max_retries=max_retries
+            )
+        except PyEzvizError as first_error:
+            try:
+                return self.set_switch_legacy(
+                    serial, switch_type, enable, channel, max_retries=max_retries
+                )
+            except PyEzvizError:
+                raise first_error from None
+
     def switch_status(
         self,
         serial: str,
         status_type: int,
-        enable: int,
+        enable: bool | int,
         channel_no: int = 0,
         max_retries: int = 0,
     ) -> bool:
         """Camera features are represented as switches. Switch them on or off."""
-        if max_retries > MAX_RETRIES:
-            raise PyEzvizError("Can't gather proper data. Max retries exceeded.")
-        json_output = self._request_json(
-            "PUT",
-            f"{API_ENDPOINT_DEVICES}{serial}/{channel_no}/{enable}/{status_type}{API_ENDPOINT_SWITCH_STATUS}",
-            retry_401=True,
+
+        target_state = bool(enable)
+        self.set_switch(
+            serial,
+            status_type,
+            target_state,
+            channel=channel_no,
             max_retries=max_retries,
         )
-        self._ensure_ok(json_output, "Could not set the switch")
         if self._cameras.get(serial):
-            self._cameras[serial]["switches"][status_type] = bool(enable)
+            self._cameras[serial]["switches"][status_type] = target_state
         return True
 
     def switch_status_other(
@@ -792,36 +870,61 @@ class EzvizClient:
             serial, value=f'{{"mode":{mode}}}', key="display_mode"
         )
 
-    def set_device_config_by_key(
+    def set_dev_config_kv(
         self,
         serial: str,
-        value: Any,
+        channel: int,
         key: str,
+        value: Mapping[str, Any] | str | bytes | float | bool,
         max_retries: int = 0,
-    ) -> bool:
-        """Change value on device by setting key."""
+    ) -> dict:
+        """Update a device configuration key/value pair via devconfig."""
+
         if max_retries > MAX_RETRIES:
             raise PyEzvizError("Can't gather proper data. Max retries exceeded.")
 
-        params = {"key": key, "value": value}
-        params_str = urllib.parse.urlencode(
-            params, safe="}{:"
-        )  # not encode curly braces and colon
+        if isinstance(value, Mapping):
+            value_payload = json.dumps(value, separators=(",", ":"))
+        elif isinstance(value, bytes):
+            value_payload = value.decode()
+        elif isinstance(value, bool):
+            value_payload = "1" if value else "0"
+        elif isinstance(value, (int, float)):
+            value_payload = str(value)
+        else:
+            value_payload = str(value)
 
-        full_url = f"https://{self._token['api_url']}{API_ENDPOINT_DEVCONFIG_BY_KEY}{serial}/1/op"
+        data = {
+            "key": key,
+            "value": value_payload,
+        }
 
-        # EZVIZ api request needs {}: in the url, but requests lib doesn't allow it
-        # so we need to manually prepare it
-        req_prep = requests.Request(
-            method="PUT", url=full_url, headers=self._session.headers
-        ).prepare()
-        req_prep.url = full_url + "?" + params_str
+        payload = self._request_json(
+            "PUT",
+            f"{API_ENDPOINT_DEVCONFIG_BY_KEY}{serial}/{channel}/op",
+            data=data,
+            retry_401=True,
+            max_retries=max_retries,
+        )
+        self._ensure_ok(payload, "Could not set devconfig key")
+        return payload
 
-        req = self._send_prepared(req_prep, retry_401=True, max_retries=max_retries)
-        json_output = self._parse_json(req)
-        if not self._meta_ok(json_output):
-            raise PyEzvizError(f"Could not set config key '${key}': Got {json_output})")
+    def set_device_config_by_key(
+        self,
+        serial: str,
+        value: Any,
+        key: str,
+        max_retries: int = 0,
+    ) -> bool:
+        """Change value on device by setting key."""
 
+        self.set_dev_config_kv(
+            serial,
+            1,
+            key,
+            value,
+            max_retries=max_retries,
+        )
         return True
 
     def set_device_feature_by_key(
@@ -1997,6 +2100,37 @@ class EzvizClient:
 
         return True
 
+    def set_detection_sensitivity(
+        self,
+        serial: str,
+        channel: int,
+        sensitivity_type: int,
+        value: int,
+        max_retries: int = 0,
+    ) -> bool:
+        """Set detection sensitivity via v3 devconfig endpoint."""
+
+        if max_retries > MAX_RETRIES:
+            raise PyEzvizError("Can't gather proper data. Max retries exceeded.")
+
+        if sensitivity_type == 0 and not 1 <= value <= 6:
+            raise PyEzvizError("Detection sensitivity must be within 1..6")
+        if sensitivity_type != 0 and not 1 <= value <= 100:
+            raise PyEzvizError("Detection sensitivity must be within 1..100")
+
+        url_path = (
+            f"{API_ENDPOINT_SENSITIVITY}{serial}/{channel}/{sensitivity_type}/{value}"
+        )
+        json_output = self._request_json(
+            "PUT",
+            url_path,
+            retry_401=True,
+            max_retries=max_retries,
+        )
+        self._ensure_ok(json_output, "Could not set detection sensitivity")
+
+        return True
+
     def get_detection_sensibility(
         self, serial: str, type_value: str = "0", max_retries: int = 0
     ) -> Any:

{pyezvizapi-1.0.2.7 → pyezvizapi-1.0.2.9/pyezvizapi.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyezvizapi
-Version: 1.0.2.7
+Version: 1.0.2.9
 Summary: Pilot your Ezviz cameras
 Home-page: https://github.com/RenierM26/pyEzvizApi/
 Author: Renier Moorcroft

{pyezvizapi-1.0.2.7 → pyezvizapi-1.0.2.9}/setup.py

@@ -5,7 +5,7 @@ with open("README.md", "r") as fh:
 
 setuptools.setup(
     name='pyezvizapi',
-    version="1.0.2.7",
+    version="1.0.2.9",
     license='Apache Software License 2.0',
     author='Renier Moorcroft',
     author_email='RenierM26@users.github.com',