pyezvizapi 1.0.0.0__py3-none-any.whl

pyezvizapi/constants.py

@@ -0,0 +1,381 @@
+"""Device switch types relationship."""
+from enum import Enum, unique
+
+FEATURE_CODE = "1fc28fa018178a1cd1c091b13b2f9f02"
+XOR_KEY = b"\x0c\x0eJ^X\x15@Rr"
+DEFAULT_TIMEOUT = 25
+MAX_RETRIES = 3
+REQUEST_HEADER = {
+    "featureCode": FEATURE_CODE,
+    "clientType": "3",
+    "osVersion": "",
+    "clientVersion": "",
+    "netType": "WIFI",
+    "customno": "1000001",
+    "ssid": "",
+    "clientNo": "web_site",
+    "appId": "ys7",
+    "language": "en_GB",
+    "lang": "en",
+    "sessionId": "",
+    "User-Agent": "okhttp/3.12.1",
+}  # Standard android header.
+MQTT_APP_KEY = "4c6b3cc2-b5eb-4813-a592-612c1374c1fe"
+APP_SECRET = "17454517-cc1c-42b3-a845-99b4a15dd3e6"
+
+
+@unique
+class MessageFilterType(Enum):
+    """Message filter types for unified list."""
+
+    FILTER_TYPE_MOTION = 2402
+    FILTER_TYPE_PERSON = 2403
+    FILTER_TYPE_VEHICLE = 2404
+    FILTER_TYPE_SOUND = 2405
+    FILTER_TYPE_ALL_ALARM = 2401
+    FILTER_TYPE_SYSTEM_MESSAGE = 2101
+
+
+@unique
+class DeviceSwitchType(Enum):
+    """Device switch name and number."""
+
+    ALARM_TONE = 1
+    STREAM_ADAPTIVE = 2
+    LIGHT = 3
+    INTELLIGENT_ANALYSIS = 4
+    LOG_UPLOAD = 5
+    DEFENCE_PLAN = 6
+    PRIVACY = 7
+    SOUND_LOCALIZATION = 8
+    CRUISE = 9
+    INFRARED_LIGHT = 10
+    WIFI = 11
+    WIFI_MARKETING = 12
+    WIFI_LIGHT = 13
+    PLUG = 14
+    SLEEP = 21
+    SOUND = 22
+    BABY_CARE = 23
+    LOGO = 24
+    MOBILE_TRACKING = 25
+    CHANNELOFFLINE = 26
+    ALL_DAY_VIDEO = 29
+    AUTO_SLEEP = 32
+    ROAMING_STATUS = 34
+    DEVICE_4G = 35
+    ALARM_REMIND_MODE = 37
+    OUTDOOR_RINGING_SOUND = 39
+    INTELLIGENT_PQ_SWITCH = 40
+    DOORBELL_TALK = 101
+    HUMAN_INTELLIGENT_DETECTION = 200
+    LIGHT_FLICKER = 301
+    ALARM_LIGHT = 303
+    ALARM_LIGHT_RELEVANCE = 305
+    DEVICE_HUMAN_RELATE_LIGHT = 41
+    TAMPER_ALARM = 306
+    DETECTION_TYPE = 451
+    OUTLET_RECOVER = 600
+    CHIME_INDICATOR_LIGHT = 611
+    TRACKING = 650
+    CRUISE_TRACKING = 651
+    PARTIAL_IMAGE_OPTIMIZE = 700
+    FEATURE_TRACKING = 701
+
+
+@unique
+class SupportExt(Enum):
+    """Supported device extensions."""
+
+    SupportAITag = 522
+    SupportAbsenceReminder = 181
+    SupportActiveDefense = 96
+    SupportAddDelDetector = 19
+    SupportAddSmartChildDev = 156
+    SupportAlarmInterval = 406
+    SupportAlarmLight = 113
+    SupportAlarmVoice = 7
+    SupportAlertDelaySetup = 383
+    SupportAlertTone = 215
+    SupportAntiOpen = 213
+    SupportApMode = 106
+    SupportAssociateDoorlockOnline = 415
+    SupportAudioCollect = 165, 1
+    SupportAudioConfigApn = 695
+    SupportAudioOnoff = 63
+    SupportAutoAdjust = 45
+    SupportAutoOffline = 8
+    SupportAutoSleep = 144
+    SupportBackLight = 303
+    SupportBackendLinkIpcStream = 596
+    SupportBatteryDeviceP2p = 336
+    SupportBatteryManage = 119
+    SupportBatteryNonPerOperateP2p = 417
+    SupportBatteryNumber = 322
+    SupportBellSet = 164
+    SupportBluetooth = 58
+    SupportBodyFaceFilter = 318
+    SupportBodyFaceMarker = 319
+    SupportCall = 191
+    SupportCapture = 14
+    SupportChanType = 52
+    SupportChangeSafePasswd = 15
+    SupportChangeVoice = 481
+    SupportChangeVolume = 203
+    SupportChannelOffline = 70
+    SupportChannelTalk = 192
+    SupportChime = 115
+    SupportChimeDoorbellAutolink = 334
+    SupportChimeIndicatorLight = 186
+    SupportCloseInfraredLight = 48
+    SupportCloud = 11
+    SupportCloudVersion = 12
+    SupportConcealResource = 286, -1
+    SupportCorrelationAlarm = 387
+    SupportCustomVoice = 92
+    SupportCustomVoicePlan = 222
+    SupportDayNightSwitch = 238
+    SupportDdns = 175
+    SupportDecivePowerMessage = 218
+    SupportDecouplingAlarmVoice = 473
+    SupportDefaultVoice = 202
+    SupportDefence = 1
+    SupportDefencePlan = 3
+    SupportDetectHumanCar = 224
+    SupportDetectMoveHumanCar = 302
+    SupportDevOfflineAlarm = 450
+    SupportDeviceIntrusionDetection = 385
+    SupportDeviceLinkDevice = 593
+    SupportDeviceRevisionSetting = 499
+    SupportDeviceRfSignalReport = 325
+    SupportDeviceRing = 185
+    SupportDeviceTransboundaryDetection = 386
+    SupportDevicelog = 216
+    SupportDisk = 4
+    SupportDiskBlackList = 367
+    SupportDisturbMode = 217
+    SupportDisturbNewMode = 292
+    SupportDoorCallPlayBack = 545
+    SupportDoorCallQuickReply = 544
+    SupportDoorbellIndicatorLight = 242
+    SupportDoorbellTalk = 101
+    SupportEcdhV2getString = 519
+    SupportEmojiInteraction = 573
+    SupportEnStandard = 235
+    SupportEncrypt = 9
+    SupportEzvizChime = 380
+    SupportFaceFrameMark = 196
+    SupportFeatureTrack = 321
+    SupportFecCeilingCorrectType = 312
+    SupportFecWallCorrectType = 313
+    SupportFilter = 360
+    SupportFishEye = 91
+    SupportFlashLamp = 496
+    SupportFlowStatistics = 53
+    SupportFullScreenPtz = 81
+    SupportFulldayRecord = 88
+    SupportGetDeviceAuthCode = 492
+    SupportHorizontalPanoramic = 95
+    SupportHostScreen = 240
+    SupportIndicatorBrightness = 188
+    SupportIndicatorLightDay = 331
+    SupportIntellectualHumanFace = 351
+    SupportIntelligentNightVisionDuration = 353
+    SupportIntelligentPQSwitch = 366
+    SupportIntelligentTrack = 73
+    SupportInterconnectionDbChime = 550
+    SupportIpcLink = 20
+    SupportIsapi = 145
+    SupportKeyFocus = 74
+    SupportKindsP2pMode = 566
+    SupportLanguagegetString = 47
+    SupportLightAbilityRemind = 301
+    SupportLightRelate = 297
+    SupportLocalConnect = 507
+    SupportLocalLockGate = 662
+    SupportLockConfigWay = 679
+    SupportMessage = 6
+    SupportMicroVolumnSet = 77
+    SupportMicroscope = 60
+    SupportModifyChanName = 49
+    SupportModifyDetectorguardgetString = 23
+    SupportModifyDetectorname = 21
+    SupportMore = 54
+    SupportMotionDetection = 97
+    SupportMultiScreen = 17
+    SupportMultiSubsys = 255
+    SupportMusic = 67
+    SupportMusicPlay = 602
+    SupportNatPass = 84
+    SupportNetProtect = 290
+    SupportNewSearchRecords = 256
+    SupportNightVisionMode = 206
+    SupportNoencriptViaAntProxy = 79
+    SupportNvrEncrypt = 465
+    SupportOneKeyPatrol = 571
+    SupportPaging = 249
+    SupportPartialImageOptimize = 221
+    SupportPicInPic = 460
+    SupportPirDetect = 100
+    SupportPirSetting = 118
+    SupportPlaybackAsyn = 375
+    SupportPlaybackMaxSpeed = 610
+    SupportPlaybackQualityChange = 200
+    SupportPlaybackSmallSpeed = 585
+    SupportPoweroffRecovery = 189
+    SupportPreP2P = 59
+    SupportPreset = 34
+    SupportPresetAlarm = 72
+    SupportPreviewCorrectionInOldWay = 581
+    SupportProtectionMode = 64
+    SupportPtz = 154
+    SupportPtz45Degree = 32
+    SupportPtzCenterMirror = 37
+    SupportPtzCommonCruise = 35
+    SupportPtzFigureCruise = 36
+    SupportPtzFocus = 99
+    SupportPtzHorizontal360 = 199
+    SupportPtzLeftRight = 31
+    SupportPtzLeftRightMirror = 38
+    SupportPtzManualCtrl = 586
+    SupportPtzModel = 50
+    SupportPtzNew = 605
+    SupportPtzPrivacy = 40
+    SupportPtzTopBottom = 30
+    SupportPtzTopBottomMirror = 39
+    SupportPtzZoom = 33
+    SupportPtzcmdViaP2pv3 = 169
+    SupportQosTalkVersion = 287
+    SupportQuickplayWay = 149
+    SupportRateLimit = 65
+    SupportRebootDevice = 452
+    SupportRegularBrightnessPlan = 384
+    SupportRelatedDevice = 26
+    SupportRelatedStorage = 27
+    SupportRelationCamera = 117
+    SupportRemindAudition = 434
+    SupportRemoteAuthRandcode = 28
+    SupportRemoteOpenDoor = 592
+    SupportRemoteQuiet = 55
+    SupportReplayChanNums = 94
+    SupportReplayDownload = 260
+    SupportReplaySpeed = 68
+    SupportResolutiongetString = 16
+    SupportRestartTime = 103
+    SupportReverseDirect = 69
+    SupportRingingSoundSelect = 241
+    SupportSafeModePlan = 22
+    SupportSdCover = 483
+    SupportSdHideRecord = 600
+    SupportSdkTransport = 29
+    SupportSeekPlayback = 257
+    SupportSensibilityAdjust = 61
+    SupportServerSideEncryption = 261
+    SupportSetWireioType = 205
+    SupportSignalCheck = 535
+    SupportSimCard = 194
+    SupportSleep = 62
+    SupportSmartBodyDetect = 244
+    SupportSmartNightVision = 274
+    SupportSoundLightAlarm = 214
+    SupportSsl = 25
+    SupportSwitchLog = 187
+    SupportSwitchTalkmode = 170
+    SupportTalk = 2
+    SupportTalkType = 51
+    SupportTalkVolumeAdj = 455
+    SupportTamperAlarm = 327
+    SupportTearFilm = 454
+    SupportTemperatureAlarm = 76
+    SupportTextToVoice = 574
+    SupportTimeSchedulePlan = 209
+    SupportTimezone = 46
+    SupportTracking = 198
+    SupportTvEntranceOff = 578
+    SupportUnLock = 78
+    SupportUnbind = 44
+    SupportUpgrade = 10
+    SupportUploadCloudFile = 18
+    SupportVerticalPanoramic = 112
+    SupportVolumnSet = 75
+    SupportWeixin = 24
+    SupportWifi = 13
+    SupportWifi24G = 41
+    SupportWifi5G = 42
+    SupportWifiLock = 541
+    SupportWifiManager = 239
+    SupportWifiPortal = 43
+
+
+@unique
+class SoundMode(Enum):
+    """Alarm sound level description."""
+
+    SILENT = 2
+    SOFT = 0
+    INTENSE = 1
+    CUSTOM = 3
+    PLAN = 4
+    UNKNOWN = -1
+
+
+@unique
+class DefenseModeType(Enum):
+    """Defense mode name and number."""
+
+    HOME_MODE = 1
+    AWAY_MODE = 2
+    SLEEP_MODE = 3
+    UNSET_MODE = 0
+
+
+@unique
+class IntelligentDetectionMode(Enum):
+    """Intelligent detection modes."""
+
+    INTELLI_MODE_HUMAN_SHAPE = 1
+    INTELLI_MODE_PIR = 5
+    INTELLI_MODE_IMAGE_CHANGE = 3
+
+
+@unique
+class NightVisionMode(Enum):
+    """Intelligent detection modes."""
+
+    NIGHT_VISION_COLOUR = 1
+    NIGHT_VISION_B_W = 0
+    NIGHT_VISION_SMART = 2
+
+
+@unique
+class DisplayMode(Enum):
+    """Display modes or image styles."""
+
+    DISPLAY_MODE_ORIGINAL = 1
+    DISPLAY_MODE_SOFT = 2
+    DISPLAY_MODE_VIVID = 3
+
+
+@unique
+class BatteryCameraWorkMode(Enum):
+    """Battery camera work modes."""
+
+    PLUGGED_IN = 2
+    HIGH_PERFORMANCE = 1
+    POWER_SAVE = 0
+    SUPER_POWER_SAVE = 3
+    CUSTOM = 4
+    HYBERNATE = 5  #not sure
+    UNKNOWN = -1
+
+
+class DeviceCatagories(Enum):
+    """Supported device categories."""
+
+    COMMON_DEVICE_CATEGORY = "COMMON"
+    CAMERA_DEVICE_CATEGORY = "IPC"
+    BATTERY_CAMERA_DEVICE_CATEGORY = "BatteryCamera"
+    DOORBELL_DEVICE_CATEGORY = "BDoorBell"
+    BASE_STATION_DEVICE_CATEGORY = "XVR"
+    CAT_EYE_CATEGORY = "CatEye"
+    LIGHTING = "lighting"

pyezvizapi/exceptions.py

@@ -0,0 +1,29 @@
+"""PyEzviz Exceptions."""
+
+
+class PyEzvizError(Exception):
+    """Ezviz api exception."""
+
+
+class InvalidURL(PyEzvizError):
+    """Invalid url exception."""
+
+
+class HTTPError(PyEzvizError):
+    """Invalid host exception."""
+
+
+class InvalidHost(PyEzvizError):
+    """Invalid host exception."""
+
+
+class AuthTestResultFailed(PyEzvizError):
+    """Authentication failed."""
+
+
+class EzvizAuthTokenExpired(PyEzvizError):
+    """Authentication failed because token is invalid or expired."""
+
+
+class EzvizAuthVerificationCode(PyEzvizError):
+    """Authentication failed because MFA verification code is required."""

pyezvizapi/light_bulb.py

@@ -0,0 +1,126 @@
+"""pyezviz camera api."""
+from __future__ import annotations
+
+import json
+from typing import TYPE_CHECKING, Any
+
+from .constants import DeviceSwitchType
+from .exceptions import PyEzvizError
+from .utils import fetch_nested_value
+
+if TYPE_CHECKING:
+    from .client import EzvizClient
+
+
+class EzvizLightBulb:
+    """Initialize Ezviz Light Bulb object."""
+
+    def __init__(
+            self, client: EzvizClient, serial: str, device_obj: dict | None = None
+    ) -> None:
+        """Initialize the light bulb object."""
+        self._client = client
+        self._serial = serial
+        self._device = (
+            device_obj if device_obj else self._client.get_device_infos(self._serial)
+        )
+        self._feature_json = self.get_feature_json()
+        self._switch: dict[int, bool] = {
+            switch["type"]: switch["enable"] for switch in self._device["SWITCH"]
+        }
+        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"]
+
+    def fetch_key(self, keys: list, default_value: Any = None) -> Any:
+        """Fetch dictionary key."""
+        return fetch_nested_value(self._device, keys, default_value)
+
+    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"
+        ):
+            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"
+        ):
+            return self._device["CONNECTION"]["localIp"]
+
+        return "0.0.0.0"
+
+    def get_feature_json(self) -> Any:
+        """Parse the FEATURE json."""
+        try:
+            json_output = json.loads(self._device["FEATURE"]["featureJson"])
+
+        except ValueError as err:
+            raise PyEzvizError(
+                "Impossible to decode FEATURE: "
+                + str(err)
+            ) from err
+
+        return json_output
+
+    def get_feature_item(self, key: str, default_value: Any = None) -> Any:
+        """Get items fron FEATURE."""
+        items = self._feature_json["featureItemDtos"]
+        for item in items:
+            if item["itemKey"] == key:
+                return item
+        return default_value
+
+    def get_product_id(self) -> Any:
+        """Get product id."""
+        return self._feature_json["productId"]
+
+    def status(self) -> dict[Any, Any]:
+        """Return the status of the light bulb."""
+        return {
+            "serial": self._serial,
+            "name": self.fetch_key(["deviceInfos", "name"]),
+            "version": self.fetch_key(["deviceInfos", "version"]),
+            "upgrade_available": bool(
+                self.fetch_key(["UPGRADE", "isNeedUpgrade"]) == 3
+            ),
+            "status": self.fetch_key(["deviceInfos", "status"]),
+            "device_category": self.fetch_key(["deviceInfos", "deviceCategory"]),
+            "device_sub_category": self.fetch_key(["deviceInfos", "deviceSubCategory"]),
+            "upgrade_percent": self.fetch_key(["STATUS", "upgradeProcess"]),
+            "upgrade_in_progress": bool(
+                self.fetch_key(["STATUS", "upgradeStatus"]) == 0
+            ),
+            "latest_firmware_info": self.fetch_key(["UPGRADE", "upgradePackageInfo"]),
+            "local_ip": self._local_ip(),
+            "wan_ip": self.fetch_key(["CONNECTION", "netIp"]),
+            "mac_address": self.fetch_key(["deviceInfos", "mac"]),
+            "supported_channels": self.fetch_key(["deviceInfos", "channelNumber"]),
+            "wifiInfos": self._device["WIFI"],
+            "switches": self._switch,
+            "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"],
+
+            "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."""
+        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"]
+        )