pyezvizapi 1.0.2.3__tar.gz → 1.0.2.5__tar.gz

{pyezvizapi-1.0.2.3/pyezvizapi.egg-info → pyezvizapi-1.0.2.5}/PKG-INFO

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

{pyezvizapi-1.0.2.3 → pyezvizapi-1.0.2.5}/pyezvizapi/__main__.py

@@ -26,7 +26,9 @@ _LOGGER = logging.getLogger(__name__)
 def _setup_logging(debug: bool) -> None:
     """Configure root logger for CLI usage."""
     level = logging.DEBUG if debug else logging.INFO
-    logging.basicConfig(level=level, stream=sys.stderr, format="%(levelname)s: %(message)s")
+    logging.basicConfig(
+        level=level, stream=sys.stderr, format="%(levelname)s: %(message)s"
+    )
     if debug:
         # Verbose requests logging in debug mode
         requests_log = logging.getLogger("requests.packages.urllib3")
@@ -94,7 +96,7 @@ def _parse_args(argv: list[str] | None = None) -> argparse.Namespace:
         type=str,
         default="status",
         help="Light bulbs action to perform",
-        choices=["status"]
+        choices=["status"],
     )
     parser_device_lights.add_argument(
         "--refresh",
@@ -125,7 +127,9 @@ def _parse_args(argv: list[str] | None = None) -> argparse.Namespace:
 
     subparsers_camera = parser_camera.add_subparsers(dest="camera_action")
 
-    parser_camera_status = subparsers_camera.add_parser("status", help="Get the status of the camera")
+    parser_camera_status = subparsers_camera.add_parser(
+        "status", help="Get the status of the camera"
+    )
     parser_camera_status.add_argument(
         "--refresh",
         action=argparse.BooleanOptionalAction,
@@ -229,14 +233,19 @@ def _parse_args(argv: list[str] | None = None) -> argparse.Namespace:
     )
 
     parser_camera_select = subparsers_camera.add_parser(
-        "select", help="Change the value of a multi-value option (for on/off value, see 'switch' command)"
+        "select",
+        help="Change the value of a multi-value option (for on/off value, see 'switch' command)",
     )
 
     parser_camera_select.add_argument(
         "--battery_work_mode",
         required=False,
         help="Change the work mode for battery powered camera",
-        choices=[mode.name for mode in BatteryCameraWorkMode if mode is not BatteryCameraWorkMode.UNKNOWN],
+        choices=[
+            mode.name
+            for mode in BatteryCameraWorkMode
+            if mode is not BatteryCameraWorkMode.UNKNOWN
+        ],
     )
 
     # Dump full pagelist for exploration
@@ -244,7 +253,8 @@ def _parse_args(argv: list[str] | None = None) -> argparse.Namespace:
 
     # Dump device infos mapping (optionally for a single serial)
     parser_device_infos = subparsers.add_parser(
-        "device_infos", help="Output device infos (raw JSON), optionally filtered by serial"
+        "device_infos",
+        help="Output device infos (raw JSON), optionally filtered by serial",
     )
     parser_device_infos.add_argument(
         "--serial", required=False, help="Optional serial to filter a single device"
@@ -418,7 +428,11 @@ def _handle_pagelist(client: EzvizClient) -> int:
 
 def _handle_device_infos(args: argparse.Namespace, client: EzvizClient) -> int:
     """Output device infos mapping (raw JSON), optionally filtered by serial."""
-    data = client.get_device_infos(args.serial) if args.serial else client.get_device_infos()
+    data = (
+        client.get_device_infos(args.serial)
+        if args.serial
+        else client.get_device_infos()
+    )
     _write_json(data)
     return 0
 
@@ -535,7 +549,10 @@ def _load_token_file(path: str | None) -> dict[str, Any] | None:
         return None
     try:
         return cast(dict[str, Any], json.loads(p.read_text(encoding="utf-8")))
-    except (OSError, json.JSONDecodeError):  # pragma: no cover - tolerate malformed file
+    except (
+        OSError,
+        json.JSONDecodeError,
+    ):  # pragma: no cover - tolerate malformed file
         _LOGGER.warning("Failed to read token file: %s", p)
         return None
 

{pyezvizapi-1.0.2.3 → pyezvizapi-1.0.2.5}/pyezvizapi/cas.py

@@ -38,7 +38,9 @@ class EzvizCAS:
             "api_url": "apiieu.ezvizlife.com",
         }
         if not token or "service_urls" not in token:
-            raise PyEzvizError("Missing service_urls in token; call EzvizClient.login() first")
+            raise PyEzvizError(
+                "Missing service_urls in token; call EzvizClient.login() first"
+            )
         self._service_urls: dict[str, Any] = token["service_urls"]
 
     def cas_get_encryption(self, devserial: str) -> dict[str, Any]:
@@ -53,7 +55,7 @@ class EzvizCAS:
             f"\x01"  # Check or order?
             f"\x00\x00\x00\x00\x00\x00\x02\t\x00\x00\x00\x00"
             f'<?xml version="1.0" encoding="utf-8"?>\n<Request>\n\t'
-            f'<ClientID>{self._token["session_id"]}</ClientID>'
+            f"<ClientID>{self._token['session_id']}</ClientID>"
             f"\n\t<Sign>{FEATURE_CODE}</Sign>\n\t"
             f"<DevSerial>{devserial}</DevSerial>"
             f"\n\t<ClientType>0</ClientType>\n</Request>\n"

{pyezvizapi-1.0.2.3 → pyezvizapi-1.0.2.5}/pyezvizapi/client.py

@@ -167,7 +167,7 @@ class EzvizClient:
         DeviceCatagories.BASE_STATION_DEVICE_CATEGORY.value,
         DeviceCatagories.CAT_EYE_CATEGORY.value,
         DeviceCatagories.LIGHTING.value,
-        DeviceCatagories.W2H_BASE_STATION_DEVICE_CATEGORY.value, # @emeric699 Adding support for W2H Base Station
+        DeviceCatagories.W2H_BASE_STATION_DEVICE_CATEGORY.value,
     ]
 
     def __init__(
@@ -189,7 +189,8 @@ class EzvizClient:
             self._session.headers["sessionId"] = str(token["session_id"])  # ensure str
         self._token: ClientToken = cast(
             ClientToken,
-            token or {
+            token
+            or {
                 "session_id": None,
                 "rf_session_id": None,
                 "username": None,
@@ -262,7 +263,7 @@ class EzvizClient:
         if json_result["meta"]["code"] == 1100:
             self._token["api_url"] = json_result["loginArea"]["apiDomain"]
             _LOGGER.warning(
-                "region_incorrect: serial=%s code=%s msg=%s",
+                "Region_incorrect: serial=%s code=%s msg=%s",
                 "unknown",
                 1100,
                 self._token["api_url"],
@@ -319,7 +320,11 @@ class EzvizClient:
             )
             req.raise_for_status()
         except requests.HTTPError as err:
-            if retry_401 and err.response is not None and err.response.status_code == 401:
+            if (
+                retry_401
+                and err.response is not None
+                and err.response.status_code == 401
+            ):
                 if max_retries >= MAX_RETRIES:
                     raise HTTPError from err
                 # Re-login and retry once
@@ -344,7 +349,10 @@ class EzvizClient:
             return cast(dict, resp.json())
         except ValueError as err:
             raise PyEzvizError(
-                "Impossible to decode response: " + str(err) + "\nResponse was: " + str(resp.text)
+                "Impossible to decode response: "
+                + str(err)
+                + "\nResponse was: "
+                + str(resp.text)
             ) from err
 
     @staticmethod
@@ -413,11 +421,17 @@ class EzvizClient:
             req = self._session.send(request=prepared, timeout=self._timeout)
             req.raise_for_status()
         except requests.HTTPError as err:
-            if retry_401 and err.response is not None and err.response.status_code == 401:
+            if (
+                retry_401
+                and err.response is not None
+                and err.response.status_code == 401
+            ):
                 if max_retries >= MAX_RETRIES:
                     raise HTTPError from err
                 self.login()
-                return self._send_prepared(prepared, retry_401=retry_401, max_retries=max_retries + 1)
+                return self._send_prepared(
+                    prepared, retry_401=retry_401, max_retries=max_retries + 1
+                )
             raise HTTPError from err
         return req
 
@@ -478,7 +492,7 @@ class EzvizClient:
                 # Prefer modern meta.code; fall back to legacy resultCode
                 code = self._response_code(payload)
                 _LOGGER.warning(
-                    "http_retry: serial=%s code=%s msg=%s",
+                    "Http_retry: serial=%s code=%s msg=%s",
                     serial or "unknown",
                     code,
                     log,
@@ -549,7 +563,7 @@ class EzvizClient:
             # session is wrong, need to relogin and retry
             self.login()
             _LOGGER.warning(
-                "http_retry: serial=%s code=%s msg=%s",
+                "Http_retry: serial=%s code=%s msg=%s",
                 "unknown",
                 self._meta_code(json_output),
                 "pagelist_relogin",
@@ -673,7 +687,11 @@ class EzvizClient:
         json_output = self._request_json(
             "PUT",
             f"{API_ENDPOINT_DEVICES}{serial}{API_ENDPOINT_SWITCH_OTHER}",
-            params={"channelNo": channel_number, "enable": enable, "switchType": status_type},
+            params={
+                "channelNo": channel_number,
+                "enable": enable,
+                "switchType": status_type,
+            },
             retry_401=True,
             max_retries=max_retries,
         )
@@ -704,7 +722,9 @@ class EzvizClient:
             serial=serial,
         )
         if self._meta_code(json_output) != 200:
-            raise PyEzvizError(f"Could not arm or disarm Camera {serial}: Got {json_output})")
+            raise PyEzvizError(
+                f"Could not arm or disarm Camera {serial}: Got {json_output})"
+            )
         return True
 
     def set_battery_camera_work_mode(self, serial: str, value: int) -> bool:
@@ -712,11 +732,50 @@ class EzvizClient:
         return self.set_device_config_by_key(serial, value, key="batteryCameraWorkMode")
 
     def set_detection_mode(self, serial: str, value: int) -> bool:
-        """Set detection mode."""
+        """Set detection mode.
+
+        Deprecated in favour of set_alarm_detect_human_car() but kept for
+        backwards compatibility with older callers inside the integration.
+        """
+        return self.set_alarm_detect_human_car(serial, value)
+
+    def set_alarm_detect_human_car(self, serial: str, value: int) -> bool:
+        """Update Alarm_DetectHumanCar type on the device."""
         return self.set_device_config_by_key(
             serial, value=f'{{"type":{value}}}', key="Alarm_DetectHumanCar"
         )
 
+    def set_alarm_advanced_detect(self, serial: str, value: int) -> bool:
+        """Update Alarm_AdvancedDetect type on the device."""
+        return self.set_device_config_by_key(
+            serial, value=f'{{"type":{value}}}', key="Alarm_AdvancedDetect"
+        )
+
+    def set_algorithm_param(
+        self,
+        serial: str,
+        subtype: str | int,
+        value: int,
+        channel: int = 1,
+    ) -> bool:
+        """Update a single AlgorithmInfo subtype value via devconfig."""
+
+        payload = {
+            "AlgorithmInfo": [
+                {
+                    "SubType": str(subtype),
+                    "Value": str(value),
+                    "channel": channel,
+                }
+            ]
+        }
+
+        return self.set_device_config_by_key(
+            serial,
+            value=json.dumps(payload, separators=(",", ":")),
+            key="AlgorithmInfo",
+        )
+
     def set_night_vision_mode(
         self, serial: str, mode: int, luminance: int = 100
     ) -> bool:
@@ -1017,9 +1076,14 @@ class EzvizClient:
                         self._light_bulbs[device] = EzvizLightBulb(
                             self, device, dict(rec.raw)
                         ).status()
-                    except (PyEzvizError, KeyError, TypeError, ValueError) as err:  # pragma: no cover - defensive
+                    except (
+                        PyEzvizError,
+                        KeyError,
+                        TypeError,
+                        ValueError,
+                    ) as err:  # pragma: no cover - defensive
                         _LOGGER.warning(
-                            "load_device_failed: serial=%s code=%s msg=%s",
+                            "Load_device_failed: serial=%s code=%s msg=%s",
                             device,
                             "load_error",
                             str(err),
@@ -1029,9 +1093,14 @@ class EzvizClient:
                         # Create camera object
                         cam = EzvizCamera(self, device, dict(rec.raw))
                         self._cameras[device] = cam.status(refresh=refresh)
-                    except (PyEzvizError, KeyError, TypeError, ValueError) as err:  # pragma: no cover - defensive
+                    except (
+                        PyEzvizError,
+                        KeyError,
+                        TypeError,
+                        ValueError,
+                    ) as err:  # pragma: no cover - defensive
                         _LOGGER.warning(
-                            "load_device_failed: serial=%s code=%s msg=%s",
+                            "Load_device_failed: serial=%s code=%s msg=%s",
                             device,
                             "load_error",
                             str(err),
@@ -1100,7 +1169,9 @@ class EzvizClient:
             try:
                 support_ext = result[_serial].get("deviceInfos", {}).get("supportExt")
                 if isinstance(support_ext, str) and support_ext:
-                    result[_serial]["deviceInfos"]["supportExt"] = json.loads(support_ext)
+                    result[_serial]["deviceInfos"]["supportExt"] = json.loads(
+                        support_ext
+                    )
             except (TypeError, ValueError):
                 # Leave as-is if not valid JSON
                 pass
@@ -1199,14 +1270,16 @@ class EzvizClient:
 
             code = str(json_output.get("resultCode"))
             if code == "20002":
-                raise EzvizAuthVerificationCode(f"MFA code required: Got {json_output})")
+                raise EzvizAuthVerificationCode(
+                    f"MFA code required: Got {json_output})"
+                )
             if code == "2009":
                 raise DeviceException(f"Device not reachable: Got {json_output})")
             if code == "0":
                 return json_output.get("encryptkey")
             if code == "-1" and attempt < attempts:
                 _LOGGER.warning(
-                    "http_retry: serial=%s code=%s msg=%s",
+                    "Http_retry: serial=%s code=%s msg=%s",
                     serial,
                     code,
                     "cam_key_not_found",
@@ -1357,7 +1430,9 @@ class EzvizClient:
             raise PyEzvizError(
                 f"Could not send command to create panoramic photo: Got {json_output})"
             )
-        raise PyEzvizError("Could not send command to create panoramic photo: exceeded retries")
+        raise PyEzvizError(
+            "Could not send command to create panoramic photo: exceeded retries"
+        )
 
     def return_panoramic(self, serial: str, max_retries: int = 0) -> Any:
         """Return panoramic image url list."""
@@ -1526,7 +1601,7 @@ class EzvizClient:
         except requests.HTTPError as err:
             if err.response.status_code == 401:
                 _LOGGER.warning(
-                    "http_warning: serial=%s code=%s msg=%s",
+                    "Http_warning: serial=%s code=%s msg=%s",
                     "unknown",
                     401,
                     "logout_already_invalid",
@@ -1678,7 +1753,9 @@ class EzvizClient:
         else:
             raise PyEzvizError(f"Invalid action '{action}'. Use 'add' or 'remove'.")
 
-        json_output = self._request_json(method, url_path, retry_401=True, max_retries=max_retries)
+        json_output = self._request_json(
+            method, url_path, retry_401=True, max_retries=max_retries
+        )
         self._ensure_ok(json_output, f"Could not {action} intelligent app")
 
         return True

{pyezvizapi-1.0.2.3 → pyezvizapi-1.0.2.5}/pyezvizapi/constants.py

@@ -464,4 +464,4 @@ class DeviceCatagories(Enum):
     BASE_STATION_DEVICE_CATEGORY = "XVR"
     CAT_EYE_CATEGORY = "CatEye"
     LIGHTING = "lighting"
-    W2H_BASE_STATION_DEVICE_CATEGORY = "IGateWay" # @emeric699 Adding support for W2H Base Station
+    W2H_BASE_STATION_DEVICE_CATEGORY = "IGateWay"

{pyezvizapi-1.0.2.3 → pyezvizapi-1.0.2.5}/pyezvizapi/test_cam_rtsp.py

@@ -22,6 +22,7 @@ def genmsg_describe(url: str, seq: int, user_agent: str, auth_seq: str) -> str:
 
 class RTSPDetails(TypedDict):
     """Typed structure for RTSP test parameters."""
+
     bufLen: int
     defaultServerIp: str
     defaultServerPort: int
@@ -37,7 +38,11 @@ class TestRTSPAuth:
     _rtsp_details: RTSPDetails
 
     def __init__(
-        self, ip_addr: str, username: str | None = None, password: str | None = None, test_uri: str = ""
+        self,
+        ip_addr: str,
+        username: str | None = None,
+        password: str | None = None,
+        test_uri: str = "",
     ) -> None:
         """Initialize RTSP credential test."""
         self._rtsp_details = RTSPDetails(
@@ -50,7 +55,9 @@ class TestRTSPAuth:
             defaultPassword=password,
         )
 
-    def generate_auth_string(self, realm: bytes, method: str, uri: str, nonce: bytes) -> str:
+    def generate_auth_string(
+        self, realm: bytes, method: str, uri: str, nonce: bytes
+    ) -> str:
         """Generate the HTTP Digest Authorization header value."""
         m_1 = hashlib.md5(
             f"{self._rtsp_details['defaultUsername']}:{realm.decode()}:{self._rtsp_details['defaultPassword']}".encode()
@@ -60,12 +67,12 @@ class TestRTSPAuth:
 
         return (
             "Digest "
-            f"username=\"{self._rtsp_details['defaultUsername']}\", "
-            f"realm=\"{realm.decode()}\", "
+            f'username="{self._rtsp_details["defaultUsername"]}", '
+            f'realm="{realm.decode()}", '
             'algorithm="MD5", '
-            f"nonce=\"{nonce.decode()}\", "
-            f"uri=\"{uri}\", "
-            f"response=\"{response}\""
+            f'nonce="{nonce.decode()}", '
+            f'uri="{uri}", '
+            f'response="{response}"'
         )
 
     def main(self) -> None:
@@ -74,7 +81,10 @@ class TestRTSPAuth:
 
         try:
             session.connect(
-                (self._rtsp_details["defaultServerIp"], self._rtsp_details["defaultServerPort"])
+                (
+                    self._rtsp_details["defaultServerIp"],
+                    self._rtsp_details["defaultServerPort"],
+                )
             )
         except TimeoutError as err:
             raise AuthTestResultFailed("Invalid ip or camera hibernating") from err
@@ -83,15 +93,23 @@ class TestRTSPAuth:
 
         seq: int = 1
 
-        url: str = "rtsp://" + self._rtsp_details["defaultServerIp"] + self._rtsp_details["defaultTestUri"]
+        url: str = (
+            "rtsp://"
+            + self._rtsp_details["defaultServerIp"]
+            + self._rtsp_details["defaultTestUri"]
+        )
 
         # Basic Authorization header
         auth_b64: bytes = base64.b64encode(
-            f"{self._rtsp_details['defaultUsername']}:{self._rtsp_details['defaultPassword']}".encode("ascii")
+            f"{self._rtsp_details['defaultUsername']}:{self._rtsp_details['defaultPassword']}".encode(
+                "ascii"
+            )
         )
         auth_seq: str = "Basic " + auth_b64.decode()
 
-        describe = genmsg_describe(url, seq, self._rtsp_details["defaultUserAgent"], auth_seq)
+        describe = genmsg_describe(
+            url, seq, self._rtsp_details["defaultUserAgent"], auth_seq
+        )
         print(describe)
         session.send(describe.encode())
         msg1: bytes = session.recv(self._rtsp_details["bufLen"])
@@ -115,9 +133,13 @@ class TestRTSPAuth:
             end = decoded.find('"', begin + 1)
             nonce: bytes = msg1[begin + 1 : end]
 
-            auth_seq = self.generate_auth_string(realm, "DESCRIBE", self._rtsp_details["defaultTestUri"], nonce)
+            auth_seq = self.generate_auth_string(
+                realm, "DESCRIBE", self._rtsp_details["defaultTestUri"], nonce
+            )
 
-            describe = genmsg_describe(url, seq, self._rtsp_details["defaultUserAgent"], auth_seq)
+            describe = genmsg_describe(
+                url, seq, self._rtsp_details["defaultUserAgent"], auth_seq
+            )
             print(describe)
             session.send(describe.encode())
             msg1 = session.recv(self._rtsp_details["bufLen"])
@@ -132,4 +154,6 @@ class TestRTSPAuth:
                 raise AuthTestResultFailed("Credentials not valid!!")
 
         print("Basic Auth test passed. Credentials Valid!")
+
+
 # ruff: noqa: T201

{pyezvizapi-1.0.2.3 → pyezvizapi-1.0.2.5}/pyezvizapi/utils.py

@@ -197,6 +197,7 @@ def generate_unique_code() -> str:
 # Time helpers for alarm/motion handling
 # ---------------------------------------------------------------------------
 
+
 def normalize_alarm_time(
     last_alarm: dict[str, Any], tzinfo: datetime.tzinfo
 ) -> tuple[datetime.datetime | None, datetime.datetime | None, str | None]:
@@ -241,14 +242,15 @@ def normalize_alarm_time(
                         raw_norm, "%Y-%m-%d %H:%M:%S"
                     ).replace(tzinfo=tzinfo)
                     diff = abs(
-                        (event_utc - dt_str_local.astimezone(datetime.UTC)).total_seconds()
+                        (
+                            event_utc - dt_str_local.astimezone(datetime.UTC)
+                        ).total_seconds()
                     )
                     if diff > 120:
                         # Reinterpret epoch as local clock time in camera tz
-                        naive_utc = (
-                            datetime.datetime.fromtimestamp(ts, tz=datetime.UTC)
-                            .replace(tzinfo=None)
-                        )
+                        naive_utc = datetime.datetime.fromtimestamp(
+                            ts, tz=datetime.UTC
+                        ).replace(tzinfo=None)
                         event_local_reint = naive_utc.replace(tzinfo=tzinfo)
                         alarm_dt_local = event_local_reint
                         alarm_dt_utc = event_local_reint.astimezone(datetime.UTC)
@@ -266,9 +268,9 @@ def normalize_alarm_time(
     if raw_time_str:
         raw = raw_time_str.replace("Today", str(now_local.date()))
         try:
-            alarm_dt_local = datetime.datetime.strptime(raw, "%Y-%m-%d %H:%M:%S").replace(
-                tzinfo=tzinfo
-            )
+            alarm_dt_local = datetime.datetime.strptime(
+                raw, "%Y-%m-%d %H:%M:%S"
+            ).replace(tzinfo=tzinfo)
             alarm_dt_utc = alarm_dt_local.astimezone(datetime.UTC)
             alarm_str = alarm_dt_local.strftime("%Y-%m-%d %H:%M:%S")
         except ValueError:

{pyezvizapi-1.0.2.3 → pyezvizapi-1.0.2.5/pyezvizapi.egg-info}/PKG-INFO

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

{pyezvizapi-1.0.2.3 → pyezvizapi-1.0.2.5}/setup.py

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