pyezvizapi 1.0.0.7__tar.gz → 1.0.0.9__tar.gz

{pyezvizapi-1.0.0.7/pyezvizapi.egg-info → pyezvizapi-1.0.0.9}/PKG-INFO

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

{pyezvizapi-1.0.0.7 → pyezvizapi-1.0.0.9}/pyezvizapi/__init__.py

@@ -1,14 +1,16 @@
 """init pyezvizapi."""
+
 from .camera import EzvizCamera
 from .cas import EzvizCAS
 from .client import EzvizClient
 from .constants import (
+    AlarmDetectHumanCar,
     BatteryCameraWorkMode,
     DefenseModeType,
     DeviceCatagories,
     DeviceSwitchType,
     DisplayMode,
-    IntelligentDetectionMode,
+    IntelligentDetectionSmartApp,
     MessageFilterType,
     NightVisionMode,
     SoundMode,
@@ -28,27 +30,28 @@ from .mqtt import MQTTClient
 from .test_cam_rtsp import TestRTSPAuth
 
 __all__ = [
-    "EzvizCamera",
-    "EzvizClient",
-    "PyEzvizError",
-    "InvalidURL",
-    "HTTPError",
-    "InvalidHost",
+    "AlarmDetectHumanCar",
     "AuthTestResultFailed",
+    "BatteryCameraWorkMode",
+    "DefenseModeType",
+    "DeviceCatagories",
+    "DeviceSwitchType",
+    "DisplayMode",
     "EzvizAuthTokenExpired",
     "EzvizAuthVerificationCode",
     "EzvizCAS",
+    "EzvizCamera",
+    "EzvizClient",
     "EzvizLightBulb",
+    "HTTPError",
+    "IntelligentDetectionSmartApp",
+    "InvalidHost",
+    "InvalidURL",
     "MQTTClient",
-    "DefenseModeType",
-    "IntelligentDetectionMode",
-    "BatteryCameraWorkMode",
-    "DisplayMode",
-    "NightVisionMode",
     "MessageFilterType",
-    "DeviceCatagories",
-    "DeviceSwitchType",
-    "SupportExt",
+    "NightVisionMode",
+    "PyEzvizError",
     "SoundMode",
+    "SupportExt",
     "TestRTSPAuth",
 ]

{pyezvizapi-1.0.0.7 → pyezvizapi-1.0.0.9}/pyezvizapi/api_endpoints.py

@@ -12,6 +12,7 @@ API_ENDPOINT_USER_ID = "/v3/userdevices/v1/token"
 API_ENDPOINT_GROUP_DEFENCE_MODE = "/v3/userdevices/v1/group/defenceMode"
 API_ENDPOINT_PAGELIST = "/v3/userdevices/v1/resources/pagelist"
 API_ENDPOINT_SWITCH_DEFENCE_MODE = "/v3/userdevices/v1/group/switchDefenceMode"
+API_ENDPOINT_OSD = "/v3/userdevices/v1/devices/"
 
 API_ENDPOINT_PANORAMIC_DEVICES_OPERATION = "/v3/panoramicDevices/operation"
 API_ENDPOINT_UPGRADE_DEVICE = "/v3/upgrades/v1/devices/"
@@ -27,6 +28,10 @@ API_ENDPOINT_SET_LUMINANCE = "/v3/alarms/device/alarmLight/"
 API_ENDPOINT_DEVCONFIG_BY_KEY = "/v3/devconfig/v1/keyValue/"
 API_ENDPOINT_CAM_AUTH_CODE = "/v3/devconfig/authcode/query/"
 
+API_ENDPOINT_INTELLIGENT_APP = "/v3/intelligent-app/load/"
+
+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_SET_DEFENCE_SCHEDULE = "/api/device/defence/plan2"

{pyezvizapi-1.0.0.7 → pyezvizapi-1.0.0.9}/pyezvizapi/camera.py

@@ -164,6 +164,7 @@ class EzvizCamera:
             "Alarm_AdvancedDetect": self.fetch_key(
                 ["STATUS", "optionals", "Alarm_AdvancedDetect", "type"]
             ),
+            "resouceid": self.fetch_key(["resourceInfos", 0, "resourceId"]),
             "wifiInfos": self._device["WIFI"],
             "switches": self._switch,
             "optionals": self.fetch_key(["STATUS", "optionals"]),

{pyezvizapi-1.0.0.7 → pyezvizapi-1.0.0.9}/pyezvizapi/client.py

@@ -24,15 +24,18 @@ from .api_endpoints import (
     API_ENDPOINT_DETECTION_SENSIBILITY,
     API_ENDPOINT_DETECTION_SENSIBILITY_GET,
     API_ENDPOINT_DEVCONFIG_BY_KEY,
+    API_ENDPOINT_DEVICE_BASICS,
     API_ENDPOINT_DEVICE_STORAGE_STATUS,
     API_ENDPOINT_DEVICE_SYS_OPERATION,
     API_ENDPOINT_DEVICES,
     API_ENDPOINT_DO_NOT_DISTURB,
     API_ENDPOINT_GROUP_DEFENCE_MODE,
+    API_ENDPOINT_INTELLIGENT_APP,
     API_ENDPOINT_IOT_FEATURE,
     API_ENDPOINT_LOGIN,
     API_ENDPOINT_LOGOUT,
     API_ENDPOINT_OFFLINE_NOTIFY,
+    API_ENDPOINT_OSD,
     API_ENDPOINT_PAGELIST,
     API_ENDPOINT_PANORAMIC_DEVICES_OPERATION,
     API_ENDPOINT_PTZCONTROL,
@@ -660,7 +663,7 @@ class EzvizClient:
             params, safe="}{:"
         )  # not encode curly braces and colon
 
-        full_url = f'https://{self._token["api_url"]}{API_ENDPOINT_DEVCONFIG_BY_KEY}{serial}/1/op'
+        full_url = f"https://{self._token['api_url']}{API_ENDPOINT_DEVCONFIG_BY_KEY}{serial}/1/op"
 
         # EZVIZ api request needs {}: in the url, but requests lib doesn't allow it
         # so we need to manually prepare it
@@ -721,7 +724,7 @@ class EzvizClient:
 
         payload = json.dumps({"itemKey": key, "productId": product_id, "value": value})
 
-        full_url = f'https://{self._token["api_url"]}{API_ENDPOINT_IOT_FEATURE}{serial.upper()}/0'
+        full_url = f"https://{self._token['api_url']}{API_ENDPOINT_IOT_FEATURE}{serial.upper()}/0"
 
         headers = self._session.headers
         headers.update({"Content-Type": "application/json"})
@@ -1010,7 +1013,7 @@ class EzvizClient:
 
         try:
             req = self._session.post(
-                url=f'https://{self._token["api_url"]}{API_ENDPOINT_DEVICE_SYS_OPERATION}{serial}',
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_DEVICE_SYS_OPERATION}{serial}",
                 data={
                     "oper": operation,
                     "deviceSerial": serial,
@@ -1071,7 +1074,7 @@ class EzvizClient:
 
         try:
             req = self._session.post(
-                url=f'https://{self._token["api_url"]}{API_ENDPOINT_OFFLINE_NOTIFY}',
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_OFFLINE_NOTIFY}",
                 data={
                     "reqType": req_type,
                     "serial": serial,
@@ -1884,6 +1887,175 @@ class EzvizClient:
 
         return True
 
+    def manage_intelligent_app(
+        self,
+        serial: str,
+        resource_id: str,
+        app_name: str,
+        action: str = "add",
+        max_retries: int = 0,
+    ) -> bool:
+        """Manage the intelligent app on the camera by adding (add) or removing (remove) it.
+
+        Args:
+            serial (str): The camera serial.
+            resource_id (str): The resource identifier of the camera.
+            app_name (str): The intelligent app name.
+                "app_video_change" = Image change detection,
+                "app_human_detect" = Human shape detection,
+                "app_car_detect" = Vehicle detection,
+                "app_wave_recognize" = Gesture recognition
+            action (str, optional): Add or remove app ("add" or "remove"). Defaults to "add".
+            max_retries (int, optional): Number of retries attempted. Defaults to 0.
+
+        Raises:
+            PyEzvizError: If max retries are exceeded or if the response indicates failure.
+            HTTPError: If an HTTP error occurs (other than a 401, which triggers re-login).
+
+        Returns:
+            bool: True if the operation was successful.
+
+        """
+        if max_retries > MAX_RETRIES:
+            raise PyEzvizError("Can't gather proper data. Max retries exceeded.")
+
+        url = (
+            f"https://{self._token['api_url']}"
+            f"{API_ENDPOINT_INTELLIGENT_APP}{serial}/{resource_id}/{app_name}"
+        )
+
+        try:
+            # Determine which method to call based on the parameter.
+            action = action.lower()
+            if action == "add":
+                req = self._session.put(url=url, timeout=self._timeout)
+            elif action == "remove":
+                req = self._session.delete(url=url, timeout=self._timeout)
+            else:
+                raise PyEzvizError(f"Invalid action '{action}'. Use 'add' or 'remove'.")
+
+            req.raise_for_status()
+
+        except requests.HTTPError as err:
+            if err.response.status_code == 401:
+                # Session might be invalid; attempt to re-login and retry.
+                self.login()
+                return self.manage_intelligent_app(
+                    serial, resource_id, app_name, action, max_retries + 1
+                )
+            raise HTTPError from err
+
+        try:
+            json_output = req.json()
+        except ValueError as err:
+            raise PyEzvizError("Could not decode response: " + str(err)) from err
+
+        if json_output.get("meta", {}).get("code") != 200:
+            raise PyEzvizError(f"Could not {action} intelligent app: Got {json_output}")
+
+        return True
+
+    def flip_image(
+        self,
+        serial: str,
+        channel: int = 1,
+        max_retries: int = 0,
+    ) -> bool:
+        """Flips the camera image when called.
+
+        Args:
+            serial (str): The camera serial.
+            channel (int, optional): The camera channel number to flip. Defaults to 1.
+            max_retries (int, optional): Number of retries attempted. Defaults to 0.
+
+        Raises:
+            PyEzvizError: If max retries are exceeded or if the response indicates failure.
+            HTTPError: If an HTTP error occurs (other than a 401, which triggers re-login).
+
+        Returns:
+            bool: True if the operation was successful.
+
+        """
+        if max_retries > MAX_RETRIES:
+            raise PyEzvizError("Can't gather proper data. Max retries exceeded.")
+
+        try:
+            req = self._session.put(
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_DEVICE_BASICS}{serial}/{channel}/CENTER/mirror",
+                timeout=self._timeout,
+            )
+            req.raise_for_status()
+
+        except requests.HTTPError as err:
+            if err.response.status_code == 401:
+                # Session might be invalid; attempt to re-login and retry.
+                self.login()
+                return self.flip_image(serial, channel, max_retries + 1)
+            raise HTTPError from err
+
+        try:
+            json_output = req.json()
+
+        except ValueError as err:
+            raise PyEzvizError("Could not decode response: " + str(err)) from err
+
+        if json_output.get("meta", {}).get("code") != 200:
+            raise PyEzvizError(f"Could not flip image on camera: Got {json_output}")
+
+        return True
+
+    def set_camera_osd(
+        self,
+        serial: str,
+        text: str = "",
+        channel: int = 1,
+        max_retries: int = 0,
+    ) -> bool:
+        """Set OSD (on screen display) text.
+
+        Args:
+            serial (str): The camera serial.
+            text (str, optional): The osd text to set. The default of "" will clear.
+            channel (int, optional): The cammera channel to set this on. Defaults to 1.
+            max_retries (int, optional): Number of retries attempted. Defaults to 0.
+
+        Raises:
+            PyEzvizError: If max retries are exceeded or if the response indicates failure.
+            HTTPError: If an HTTP error occurs (other than a 401, which triggers re-login).
+
+        Returns:
+            bool: True if the operation was successful.
+
+        """
+        if max_retries > MAX_RETRIES:
+            raise PyEzvizError("Can't gather proper data. Max retries exceeded.")
+
+        try:
+            req = self._session.put(
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_OSD}{serial}/{channel}/osd",
+                data={"osd": text},
+                timeout=self._timeout,
+            )
+            req.raise_for_status()
+
+        except requests.HTTPError as err:
+            if err.response.status_code == 401:
+                # Session might be invalid; attempt to re-login and retry.
+                self.login()
+                return self.set_camera_osd(serial, text, channel, max_retries + 1)
+            raise HTTPError from err
+
+        try:
+            json_output = req.json()
+
+        except ValueError as err:
+            raise PyEzvizError("Could not decode response: " + str(err)) from err
+
+        if json_output.get("meta", {}).get("code") != 200:
+            raise PyEzvizError(f"Could set osd message on camera: Got {json_output}")
+
+        return True
+
     def set_floodlight_brightness(
         self,
         serial: str,

{pyezvizapi-1.0.0.7 → pyezvizapi-1.0.0.9}/pyezvizapi/constants.py

@@ -1,4 +1,5 @@
 """Device switch types relationship."""
+
 from enum import Enum, unique
 
 FEATURE_CODE = "1fc28fa018178a1cd1c091b13b2f9f02"
@@ -305,6 +306,10 @@ class SupportExt(Enum):
     SupportWifiLock = 541
     SupportWifiManager = 239
     SupportWifiPortal = 43
+    SupportWorkModeList = 502
+    SupportSensitiveUnderDefenceType = 444
+    SupportDefenceTypeFull = 534
+    SupportDetectAreaUnderDefencetype = 504
 
 
 @unique
@@ -330,12 +335,22 @@ class DefenseModeType(Enum):
 
 
 @unique
-class IntelligentDetectionMode(Enum):
-    """Intelligent detection modes."""
+class AlarmDetectHumanCar(Enum):
+    """Detection modes for cameras that support AlarmDetectHumanCar."""
+
+    DETECTION_MODE_HUMAN_SHAPE = 1
+    DETECTION_MODE_PIR = 5
+    DETECTION_MODE_IMAGE_CHANGE = 3
+
+
+@unique
+class IntelligentDetectionSmartApp(Enum):
+    """Intelligent detection modes for cameras using smart apps."""
 
-    INTELLI_MODE_HUMAN_SHAPE = 1
-    INTELLI_MODE_PIR = 5
-    INTELLI_MODE_IMAGE_CHANGE = 3
+    app_human_detect = 1
+    app_video_change = 4
+    app_car_detect = 2
+    app_wave_recognize = 64
 
 
 @unique
@@ -365,7 +380,7 @@ class BatteryCameraWorkMode(Enum):
     POWER_SAVE = 0
     SUPER_POWER_SAVE = 3
     CUSTOM = 4
-    HYBERNATE = 5  #not sure
+    HYBERNATE = 5  # not sure
     UNKNOWN = -1
 
 

{pyezvizapi-1.0.0.7 → pyezvizapi-1.0.0.9}/pyezvizapi/light_bulb.py

@@ -1,4 +1,5 @@
-"""pyezviz camera api."""
+"""Ezviz camera api."""
+
 from __future__ import annotations
 
 import json
@@ -16,7 +17,7 @@ class EzvizLightBulb:
     """Initialize Ezviz Light Bulb object."""
 
     def __init__(
-            self, client: EzvizClient, serial: str, device_obj: dict | None = None
+        self, client: EzvizClient, serial: str, device_obj: dict | None = None
     ) -> None:
         """Initialize the light bulb object."""
         self._client = client
@@ -30,7 +31,9 @@ class EzvizLightBulb:
         }
         if DeviceSwitchType.ALARM_LIGHT.value not in self._switch:
             # trying to have same interface as the camera's light
-            self._switch[DeviceSwitchType.ALARM_LIGHT.value] = self.get_feature_item("light_switch")["dataValue"]
+            self._switch[DeviceSwitchType.ALARM_LIGHT.value] = self.get_feature_item(
+                "light_switch"
+            )["dataValue"]
 
     def fetch_key(self, keys: list, default_value: Any = None) -> Any:
         """Fetch dictionary key."""
@@ -39,15 +42,15 @@ class EzvizLightBulb:
     def _local_ip(self) -> Any:
         """Fix empty ip value for certain cameras."""
         if (
-                self.fetch_key(["WIFI", "address"])
-                and self._device["WIFI"]["address"] != "0.0.0.0"
+            self.fetch_key(["WIFI", "address"])
+            and self._device["WIFI"]["address"] != "0.0.0.0"
         ):
             return self._device["WIFI"]["address"]
 
         # Seems to return none or 0.0.0.0 on some.
         if (
-                self.fetch_key(["CONNECTION", "localIp"])
-                and self._device["CONNECTION"]["localIp"] != "0.0.0.0"
+            self.fetch_key(["CONNECTION", "localIp"])
+            and self._device["CONNECTION"]["localIp"] != "0.0.0.0"
         ):
             return self._device["CONNECTION"]["localIp"]
 
@@ -59,20 +62,19 @@ class EzvizLightBulb:
             json_output = json.loads(self._device["FEATURE"]["featureJson"])
 
         except ValueError as err:
-            raise PyEzvizError(
-                "Impossible to decode FEATURE: "
-                + str(err)
-            ) from err
+            raise PyEzvizError("Impossible to decode FEATURE: " + str(err)) from err
 
         return json_output
 
-    def get_feature_item(self, key: str, default_value: Any = { "dataValue" : "" }) -> Any:
-        """Get items fron FEATURE."""
+    def get_feature_item(self, key: str, default_value: Any = None) -> Any:
+        """Get items from FEATURE."""
         items = self._feature_json["featureItemDtos"]
+
         for item in items:
             if item["itemKey"] == key:
                 return item
-        return default_value
+
+        return default_value if default_value else {"dataValue": ""}
 
     def get_product_id(self) -> Any:
         """Get product id."""
@@ -104,23 +106,46 @@ class EzvizLightBulb:
             "optionals": self.fetch_key(["STATUS", "optionals"]),
             "supportExt": self._device["deviceInfos"]["supportExt"],
             "ezDeviceCapability": self.fetch_key(["deviceInfos", "ezDeviceCapability"]),
-
             "featureItems": self._feature_json["featureItemDtos"],
             "productId": self._feature_json["productId"],
-            "color_temperature": self.get_feature_item("color_temperature")["dataValue"],
-
+            "color_temperature": self.get_feature_item("color_temperature")[
+                "dataValue"
+            ],
             "is_on": self.get_feature_item("light_switch")["dataValue"],
             "brightness": self.get_feature_item("brightness")["dataValue"],
             # same as brightness... added in order to keep "same interface" between camera and light bulb objects
             "alarm_light_luminance": self.get_feature_item("brightness")["dataValue"],
         }
 
-    def toggle_switch(self) -> bool:
-        """Toggle on/off light bulb."""
+    def _write_state(self, state: bool | None = None) -> bool:
+        """Set the light bulb state."""
         item = self.get_feature_item("light_switch")
+
         return self._client.set_device_feature_by_key(
             self._serial,
             self.get_product_id(),
-            not bool(item["dataValue"]),
-            item["itemKey"]
+            state if state else not bool(item["dataValue"]),
+            item["itemKey"],
+        )
+
+    def set_brightness(self, value: int) -> bool:
+        """Set the light bulb brightness.
+
+        The value must be in range 1-100.
+
+        """
+        return self._client.set_device_feature_by_key(
+            self._serial, self.get_product_id(), value, "brightness"
         )
+
+    def toggle_switch(self) -> bool:
+        """Toggle on/off light bulb."""
+        return self._write_state()
+
+    def power_on(self) -> bool:
+        """Power the light bulb on."""
+        return self._write_state(True)
+
+    def power_off(self) -> bool:
+        """Power the light bulb off."""
+        return self._write_state(False)

{pyezvizapi-1.0.0.7 → pyezvizapi-1.0.0.9/pyezvizapi.egg-info}/PKG-INFO

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

{pyezvizapi-1.0.0.7 → pyezvizapi-1.0.0.9}/setup.py

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