pyezvizapi 1.0.0.3__tar.gz → 1.0.0.4__tar.gz

{pyezvizapi-1.0.0.3/pyezvizapi.egg-info → pyezvizapi-1.0.0.4}/PKG-INFO

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

{pyezvizapi-1.0.0.3 → pyezvizapi-1.0.0.4}/pyezvizapi/api_endpoints.py

@@ -7,31 +7,36 @@ API_ENDPOINT_LOGIN = "/v3/users/login/v5"
 API_ENDPOINT_LOGOUT = "/v3/users/logout/v2"
 API_ENDPOINT_REFRESH_SESSION_ID = "/v3/apigateway/login"
 API_ENDPOINT_SERVER_INFO = "/v3/configurations/system/info"
+
 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_PANORAMIC_DEVICES_OPERATION = "/v3/panoramicDevices/operation"
 API_ENDPOINT_UPGRADE_DEVICE = "/v3/upgrades/v1/devices/"
 API_ENDPOINT_SEND_CODE = "/v3/sms/nologin/checkcode"
+API_ENDPOINT_UNIFIEDMSG_LIST_GET = "/v3/unifiedmsg/list"
+API_ENDPOINT_IOT_FEATURE = "/v3/iot-feature/feature/"
+API_ENDPOINT_CALLING_NOTIFY = "/v3/calling/"
 
 API_ENDPOINT_ALARMINFO_GET = "/v3/alarms/v2/advanced"
-API_ENDPOINT_UNIFIEDMSG_LIST_GET = "/v3/unifiedmsg/list"
 API_ENDPOINT_V3_ALARMS = "/v3/alarms/"
-API_ENDPOINT_SET_LUMINANCE = "/v3/alarms/device/alarmLight"
+API_ENDPOINT_SET_LUMINANCE = "/v3/alarms/device/alarmLight/"
 
-API_ENDPOINT_PAGELIST = "/v3/userdevices/v1/resources/pagelist"
-API_ENDPOINT_SWITCH_DEFENCE_MODE = "/v3/userdevices/v1/group/switchDefenceMode"
+API_ENDPOINT_DEVCONFIG_BY_KEY = "/v3/devconfig/v1/keyValue/"
+API_ENDPOINT_CAM_AUTH_CODE = "/v3/devconfig/authcode/query/"
 
 API_ENDPOINT_DETECTION_SENSIBILITY = "/api/device/configAlgorithm"
 API_ENDPOINT_DETECTION_SENSIBILITY_GET = "/api/device/queryAlgorithmConfig"
 API_ENDPOINT_SET_DEFENCE_SCHEDULE = "/api/device/defence/plan2"
 API_ENDPOINT_CAM_ENCRYPTKEY = "/api/device/query/encryptkey"
-API_ENDPOINT_CAM_AUTH_CODE = "/v3/devconfig/authcode/query/"
+API_ENDPOINT_OFFLINE_NOTIFY = "/api/device/notify/switch"
 API_ENDPOINT_CANCEL_ALARM = "/api/device/cancelAlarm"
 API_ENDPOINT_DEVICE_SYS_OPERATION = "/api/device/v2/sysOper/"
 API_ENDPOINT_DEVICE_STORAGE_STATUS = "/api/device/queryStorageStatus"
-API_ENDPOINT_DEVCONFIG_BY_KEY = "/v3/devconfig/v1/keyValue/"
-API_ENDPOINT_IOT_FEATURE = "/v3/iot-feature/feature/"
+API_ENDPOINT_CREATE_PANORAMIC = "/api/panoramic/devices/pics/collect"
+API_ENDPOINT_RETURN_PANORAMIC = "/api/panoramic/devices/pics"
 
 # Videogo DeviceApi
 API_ENDPOINT_DEVICES = "/v3/devices/"
@@ -42,10 +47,7 @@ API_ENDPOINT_ALARM_SOUND = "/alarm/sound"
 API_ENDPOINT_SWITCH_SOUND_ALARM = "/sendAlarm"
 API_ENDPOINT_DO_NOT_DISTURB = "/nodisturb"
 API_ENDPOINT_VIDEO_ENCRYPT = "encryptedInfo/risk"
-API_ENDPOINT_CHANGE_DEFENCE_STATUS = "changeDefenceStatusReq"
-
-API_ENDPOINT_CREATE_PANORAMIC = "/api/panoramic/devices/pics/collect"
-API_ENDPOINT_RETURN_PANORAMIC = "/api/panoramic/devices/pics"
+API_ENDPOINT_CHANGE_DEFENCE_STATUS = "/changeDefenceStatusReq"
 
 # MQTT
 API_ENDPOINT_REGISTER_MQTT = "/v1/getClientId"

{pyezvizapi-1.0.0.3 → pyezvizapi-1.0.0.4}/pyezvizapi/client.py

@@ -15,6 +15,7 @@ import requests
 from .api_endpoints import (
     API_ENDPOINT_ALARM_SOUND,
     API_ENDPOINT_ALARMINFO_GET,
+    API_ENDPOINT_CALLING_NOTIFY,
     API_ENDPOINT_CAM_AUTH_CODE,
     API_ENDPOINT_CAM_ENCRYPTKEY,
     API_ENDPOINT_CANCEL_ALARM,
@@ -31,6 +32,7 @@ from .api_endpoints import (
     API_ENDPOINT_IOT_FEATURE,
     API_ENDPOINT_LOGIN,
     API_ENDPOINT_LOGOUT,
+    API_ENDPOINT_OFFLINE_NOTIFY,
     API_ENDPOINT_PAGELIST,
     API_ENDPOINT_PANORAMIC_DEVICES_OPERATION,
     API_ENDPOINT_PTZCONTROL,
@@ -123,7 +125,7 @@ class EzvizClient:
 
         try:
             req = self._session.post(
-                "https://" + self._token["api_url"] + API_ENDPOINT_LOGIN,
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_LOGIN}",
                 allow_redirects=False,
                 data=payload,
                 timeout=self._timeout,
@@ -193,7 +195,7 @@ class EzvizClient:
         """Send verification code."""
         try:
             req = self._session.post(
-                "https://" + self._token["api_url"] + API_ENDPOINT_SEND_CODE,
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_SEND_CODE}",
                 data={
                     "from": self.account,
                     "bizType": "TERMINAL_BIND",
@@ -230,7 +232,7 @@ class EzvizClient:
 
         try:
             req = self._session.get(
-                f"https://{self._token['api_url']}{API_ENDPOINT_SERVER_INFO}",
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_SERVER_INFO}",
                 timeout=self._timeout,
             )
             req.raise_for_status()
@@ -286,7 +288,7 @@ class EzvizClient:
 
         try:
             req = self._session.get(
-                "https://" + self._token["api_url"] + API_ENDPOINT_PAGELIST,
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_PAGELIST}",
                 params=params,
                 timeout=self._timeout,
             )
@@ -355,7 +357,7 @@ class EzvizClient:
 
         try:
             req = self._session.get(
-                "https://" + self._token["api_url"] + API_ENDPOINT_ALARMINFO_GET,
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_ALARMINFO_GET}",
                 params=params,
                 timeout=self._timeout,
             )
@@ -418,7 +420,7 @@ class EzvizClient:
 
         try:
             req = self._session.get(
-                "https://" + self._token["api_url"] + API_ENDPOINT_UNIFIEDMSG_LIST_GET,
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_UNIFIEDMSG_LIST_GET}",
                 params=params,
                 timeout=self._timeout,
             )
@@ -570,7 +572,7 @@ class EzvizClient:
 
         try:
             req = self._session.put(
-                url=f"https://{self._token['api_url']}{API_ENDPOINT_DEVICES}{serial}/{channel_no}/{API_ENDPOINT_CHANGE_DEFENCE_STATUS}",
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_DEVICES}{serial}/{channel_no}{API_ENDPOINT_CHANGE_DEFENCE_STATUS}",
                 timeout=self._timeout,
                 data={
                     "type": arm_type,
@@ -771,11 +773,7 @@ class EzvizClient:
 
         try:
             req = self._session.put(
-                "https://"
-                + self._token["api_url"]
-                + API_ENDPOINT_UPGRADE_DEVICE
-                + serial
-                + "/0/upgrade",
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_UPGRADE_DEVICE}{serial}/0/upgrade",
                 timeout=self._timeout,
             )
 
@@ -862,12 +860,7 @@ class EzvizClient:
 
         try:
             req = self._session.put(
-                "https://"
-                + self._token["api_url"]
-                + API_ENDPOINT_DEVICES
-                + serial
-                + "/0"
-                + API_ENDPOINT_SWITCH_SOUND_ALARM,
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_DEVICES}{serial}/0{API_ENDPOINT_SWITCH_SOUND_ALARM}",
                 data={
                     "enable": enable,
                 },
@@ -908,7 +901,7 @@ class EzvizClient:
 
         try:
             req = self._session.get(
-                f"https://{self._token['api_url']}{API_ENDPOINT_USER_ID}",
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_USER_ID}",
                 timeout=self._timeout,
             )
             req.raise_for_status()
@@ -958,10 +951,7 @@ class EzvizClient:
 
         try:
             req = self._session.put(
-                "https://"
-                + self._token["api_url"]
-                + API_ENDPOINT_DEVICES
-                + API_ENDPOINT_VIDEO_ENCRYPT,
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_DEVICES}{API_ENDPOINT_VIDEO_ENCRYPT}",
                 data={
                     "deviceSerial": serial,
                     "isEncrypt": enable,  # 1 = enable, 0 = disable, 2 = change password
@@ -1068,6 +1058,69 @@ class EzvizClient:
 
         return True
 
+    def set_offline_notification(
+        self,
+        serial: str,
+        enable: int = 1,
+        req_type: int = 1,
+        max_retries: int = 0,
+    ) -> bool:
+        """Set offline notification."""
+        if max_retries > MAX_RETRIES:
+            raise PyEzvizError("Can't gather proper data. Max retries exceeded.")
+
+        try:
+            req = self._session.post(
+                url=f'https://{self._token["api_url"]}{API_ENDPOINT_OFFLINE_NOTIFY}',
+                data={
+                    "reqType": req_type,
+                    "serial": serial,
+                    "status": enable,
+                },
+                timeout=self._timeout,
+            )
+
+            req.raise_for_status()
+
+        except requests.HTTPError as err:
+            if err.response.status_code == 401:
+                # session is wrong, need to relogin
+                self.login()
+                return self.set_offline_notification(
+                    serial,
+                    enable,
+                    req_type,
+                    max_retries + 1,
+                )
+
+            raise HTTPError from err
+
+        try:
+            json_output = req.json()
+
+        except ValueError as err:
+            raise PyEzvizError(
+                "Impossible to decode response: "
+                + str(err)
+                + "\nResponse was: "
+                + str(req.text)
+            ) from err
+
+        if json_output["resultCode"] != "0":
+            if json_output["resultCode"] == "-1":
+                _LOGGER.warning(
+                    "Unable to set offline notification, camera %s is unreachable, retrying %s of %s",
+                    serial,
+                    max_retries,
+                    MAX_RETRIES,
+                )
+                return self.set_offline_notification(
+                    serial, enable, req_type, max_retries + 1
+                )
+            raise PyEzvizError(f"Could not set offline notification {json_output})")
+
+        return True
+
     def get_group_defence_mode(self, max_retries: int = 0) -> Any:
         """Get group arm status. The alarm arm/disarm concept on 1st page of app."""
 
@@ -1076,7 +1129,7 @@ class EzvizClient:
 
         try:
             req = self._session.get(
-                "https://" + self._token["api_url"] + API_ENDPOINT_GROUP_DEFENCE_MODE,
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_GROUP_DEFENCE_MODE}",
                 params={
                     "groupId": -1,
                 },
@@ -1119,7 +1172,7 @@ class EzvizClient:
 
         try:
             req = self._session.post(
-                "https://" + self._token["api_url"] + API_ENDPOINT_CANCEL_ALARM,
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_CANCEL_ALARM}",
                 data={"subSerial": serial},
                 timeout=self._timeout,
             )
@@ -1265,15 +1318,11 @@ class EzvizClient:
 
         try:
             req = self._session.put(
-                "https://"
-                + self._token["api_url"]
-                + API_ENDPOINT_DEVICES
-                + serial
-                + API_ENDPOINT_PTZCONTROL,
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_DEVICES}{serial}{API_ENDPOINT_PTZCONTROL}",
                 data={
                     "command": command,
                     "action": action,
-                    "channelNo": "1",
+                    "channelNo": 1,
                     "speed": speed,
                     "uuid": str(uuid4()),
                     "serial": serial,
@@ -1311,7 +1360,7 @@ class EzvizClient:
 
         try:
             req = self._session.post(
-                "https://" + self._token["api_url"] + API_ENDPOINT_CAM_ENCRYPTKEY,
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_CAM_ENCRYPTKEY}",
                 data={
                     "checkcode": smscode,
                     "serial": serial,
@@ -1383,10 +1432,7 @@ class EzvizClient:
 
         try:
             req = self._session.get(
-                "https://"
-                + self._token["api_url"]
-                + API_ENDPOINT_CAM_AUTH_CODE
-                + serial,
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_CAM_AUTH_CODE}{serial}",
                 params=params,
                 timeout=self._timeout,
             )
@@ -1429,7 +1475,7 @@ class EzvizClient:
 
         try:
             req = self._session.post(
-                "https://" + self._token["api_url"] + API_ENDPOINT_CREATE_PANORAMIC,
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_CREATE_PANORAMIC}",
                 data={"deviceSerial": serial},
                 timeout=self._timeout,
             )
@@ -1477,7 +1523,7 @@ class EzvizClient:
 
         try:
             req = self._session.post(
-                "https://" + self._token["api_url"] + API_ENDPOINT_RETURN_PANORAMIC,
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_RETURN_PANORAMIC}",
                 data={"deviceSerial": serial},
                 timeout=self._timeout,
             )
@@ -1532,9 +1578,7 @@ class EzvizClient:
 
         try:
             req = self._session.post(
-                "https://"
-                + self._token["api_url"]
-                + API_ENDPOINT_PANORAMIC_DEVICES_OPERATION,
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_PANORAMIC_DEVICES_OPERATION}",
                 data={
                     "x": f"{x_axis:.6f}",
                     "y": f"{y_axis:.6f}",
@@ -1568,9 +1612,7 @@ class EzvizClient:
         if self._token["session_id"] and self._token["rf_session_id"]:
             try:
                 req = self._session.put(
-                    "https://"
-                    + self._token["api_url"]
-                    + API_ENDPOINT_REFRESH_SESSION_ID,
+                    url=f"https://{self._token['api_url']}{API_ENDPOINT_REFRESH_SESSION_ID}",
                     data={
                         "refreshSessionId": self._token["rf_session_id"],
                         "featureCode": FEATURE_CODE,
@@ -1632,7 +1674,7 @@ class EzvizClient:
         """Close Ezviz session and remove login session from ezviz servers."""
         try:
             req = self._session.delete(
-                "https://" + self._token["api_url"] + API_ENDPOINT_LOGOUT,
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_LOGOUT}",
                 timeout=self._timeout,
             )
             req.raise_for_status()
@@ -1683,7 +1725,7 @@ class EzvizClient:
         )
         try:
             req = self._session.post(
-                "https://" + self._token["api_url"] + API_ENDPOINT_SET_DEFENCE_SCHEDULE,
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_SET_DEFENCE_SCHEDULE}",
                 data={
                     "devTimingPlan": schedulestring,
                 },
@@ -1732,10 +1774,9 @@ class EzvizClient:
         """Set defence mode for all devices. The alarm panel from main page is used."""
         if max_retries > MAX_RETRIES:
             raise PyEzvizError("Can't gather proper data. Max retries exceeded.")
-
         try:
             req = self._session.post(
-                "https://" + self._token["api_url"] + API_ENDPOINT_SWITCH_DEFENCE_MODE,
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_SWITCH_DEFENCE_MODE}",
                 data={
                     "groupId": -1,
                     "mode": mode,
@@ -1773,7 +1814,7 @@ class EzvizClient:
         self,
         serial: str,
         enable: int = 1,
-        channelno: str = "1",
+        channelno: int = 1,
         max_retries: int = 0,
     ) -> bool:
         """Set do not disturb on camera with specified serial."""
@@ -1782,14 +1823,8 @@ class EzvizClient:
 
         try:
             req = self._session.put(
-                "https://"
-                + self._token["api_url"]
-                + API_ENDPOINT_V3_ALARMS
-                + serial
-                + "/"
-                + channelno
-                + API_ENDPOINT_DO_NOT_DISTURB,
-                data={"enable": enable, "channelNo": channelno, "deviceSerial": serial},
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_V3_ALARMS}{serial}/{channelno}{API_ENDPOINT_DO_NOT_DISTURB}",
+                data={"enable": enable},
                 timeout=self._timeout,
             )
             req.raise_for_status()
@@ -1813,11 +1848,47 @@ class EzvizClient:
 
         return True
 
+    def set_answer_call(
+        self,
+        serial: str,
+        enable: int = 1,
+        max_retries: int = 0,
+    ) -> bool:
+        """Set answer call on camera with specified serial."""
+        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_CALLING_NOTIFY}{serial}{API_ENDPOINT_DO_NOT_DISTURB}",
+                data={"deviceSerial": serial, "switchStatus": enable},
+                timeout=self._timeout,
+            )
+            req.raise_for_status()
+
+        except requests.HTTPError as err:
+            if err.response.status_code == 401:
+                # session is wrong, need to re-log-in
+                self.login()
+                return self.set_answer_call(serial, enable, 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["meta"]["code"] != 200:
+            raise PyEzvizError(f"Could not set answer call: Got {json_output})")
+
+        return True
+
     def set_floodlight_brightness(
         self,
         serial: str,
         luminance: int = 50,
-        channelno: str = "1",
+        channelno: int = 1,
         max_retries: int = 0,
     ) -> bool | str:
         """Set brightness on camera with adjustable light."""
@@ -1831,13 +1902,7 @@ class EzvizClient:
 
         try:
             req = self._session.post(
-                "https://"
-                + self._token["api_url"]
-                + API_ENDPOINT_SET_LUMINANCE
-                + "/"
-                + serial
-                + "/"
-                + channelno,
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_SET_LUMINANCE}{serial}/{channelno}",
                 data={
                     "luminance": luminance,
                 },
@@ -1871,7 +1936,7 @@ class EzvizClient:
         self,
         serial: str,
         luminance: int = 50,
-        channelno: str = "1",
+        channelno: int = 1,
         max_retries: int = 0,
     ) -> bool | str:
         """Facade that changes the brightness to light bulbs or cameras' light."""
@@ -1922,16 +1987,13 @@ class EzvizClient:
             raise PyEzvizError(
                 "Unproper sensibility for type 0 (should be within 1 to 6)."
             )
-
         try:
             req = self._session.post(
-                "https://"
-                + self._token["api_url"]
-                + API_ENDPOINT_DETECTION_SENSIBILITY,
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_DETECTION_SENSIBILITY}",
                 data={
                     "subSerial": serial,
                     "type": type_value,
-                    "channelNo": "1",
+                    "channelNo": 1,
                     "value": sensibility,
                 },
                 timeout=self._timeout,
@@ -1978,12 +2040,9 @@ class EzvizClient:
         """Get detection sensibility notifications."""
         if max_retries > MAX_RETRIES:
             raise PyEzvizError("Can't gather proper data. Max retries exceeded.")
-
         try:
             req = self._session.post(
-                "https://"
-                + self._token["api_url"]
-                + API_ENDPOINT_DETECTION_SENSIBILITY_GET,
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_DETECTION_SENSIBILITY_GET}",
                 data={
                     "subSerial": serial,
                 },
@@ -2045,11 +2104,7 @@ class EzvizClient:
 
         try:
             req = self._session.put(
-                "https://"
-                + self._token["api_url"]
-                + API_ENDPOINT_DEVICES
-                + serial
-                + API_ENDPOINT_ALARM_SOUND,
+                url=f"https://{self._token['api_url']}{API_ENDPOINT_DEVICES}{serial}{API_ENDPOINT_ALARM_SOUND}",
                 data={
                     "enable": enable,
                     "soundType": sound_type,

{pyezvizapi-1.0.0.3 → pyezvizapi-1.0.0.4/pyezvizapi.egg-info}/PKG-INFO

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

{pyezvizapi-1.0.0.3 → pyezvizapi-1.0.0.4}/setup.py

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