Add #1269: Preset Patrol mode switch entity

Author: JurajNyiri

README.md

@@ -70,7 +70,7 @@ Doorbells, Cameras (for each lens, if supported):
 - Binary sensor for motion after the motion is detected for the first time and a binary sensor for doorbell press
 - Light entity, if the camera supports a floodlight switch
 - Buttons for Calibrate, Format, Manual Alarm start & stop, Moving the camera, Reboot and syncing time
-- Switch entities for Auto track, Automatic Reboot, Flip setting, LED Indicator, Lens Distortion Correction, (Rich) Notifications, Recording, Microphone Mute, Microphone Noise Cancelling, Automatically Upgrade Firmware, HDR mode, Alarm Trigger Event types, Privacy Zones, Diagnose Mode, Smart Track specific switches, Smart Dual Track specific switches, Audio Recording and Privacy mode
+- Switch entities for Auto track, Automatic Reboot, Flip setting, LED Indicator, Lens Distortion Correction, (Rich) Notifications, Recording, Microphone Mute, Microphone Noise Cancelling, Automatically Upgrade Firmware, HDR mode, Alarm Trigger Event types, Privacy Zones, Diagnose Mode, Smart Track specific switches, Smart Dual Track specific switches, Preset Patrol Mode, Audio Recording and Privacy mode
 - Select entities for Automatic Alarm, Automatic Reboot Time, Light Frequency, Motion Detection, Night Vision, Spotlight Intensity, Alarm Type, Quick Response, Smart Dual Track Method and Move to Preset
 - Number entity for Movement Angle, Speaker Volume, Microphone Volume, Spotlight Intensity, Siren Volume, Siren Duration and Motion Detection Digital Sensitivity
 - Media Source for browsing and playing recordings stored on camera

custom_components/tapo_control/const.py

@@ -9,7 +9,7 @@
 TPLINK_DOMAIN = "tplink"
 
 CONTROL_PORT = "control_port"
-PYTAPO_REQUIRED_VERSION = "3.4.16"
+PYTAPO_REQUIRED_VERSION = "3.4.17"
 DOMAIN = "tapo_control"
 DOMAIN_CONFIG = DOMAIN + "_config"
 BRAND = "TP-Link"

custom_components/tapo_control/manifest.json

@@ -6,9 +6,9 @@
   "codeowners": [
     "@JurajNyiri"
   ],
-  "version": "7.1.22",
+  "version": "7.1.23",
   "requirements": [
-    "pytapo==3.4.16",
+    "pytapo==3.4.17",
     "python-kasa[speedups]==0.10.2"
   ],
   "dependencies": [
@@ -39,4 +39,4 @@
   "loggers": [
     "custom_components.tapo_control"
   ]
-}
+}

custom_components/tapo_control/switch.py

@@ -176,6 +176,13 @@ async def setupEntities(entry):
             LOGGER.debug("Adding tapoAutoTrackSwitch...")
             switches.append(tapoAutoTrackSwitch)
 
+        tapoPatrolModeSwitch = await check_and_create(
+            entry, hass, TapoPatrolModeSwitch, "getCruise", config_entry
+        )
+        if tapoPatrolModeSwitch:
+            LOGGER.debug("Adding tapoPatrolModeSwitch...")
+            switches.append(tapoPatrolModeSwitch)
+
         tapoNotificationsSwitch = await check_and_create(
             entry,
             hass,
@@ -1285,3 +1292,55 @@ def updateTapo(self, camData):
         else:
             self._attr_is_on = camData["auto_track"] == "on"
             self._attr_state = "on" if self._attr_is_on else "off"
+
+
+class TapoPatrolModeSwitch(TapoSwitchEntity):
+    def __init__(self, entry: dict, hass: HomeAssistant, config_entry):
+        TapoSwitchEntity.__init__(
+            self,
+            "Preset Patrol Mode",
+            entry,
+            hass,
+            config_entry,
+            "mdi:map-marker-path",
+        )
+
+    async def async_update(self) -> None:
+        await self._coordinator.async_request_refresh()
+
+    async def async_turn_on(self) -> None:
+        result = await self._hass.async_add_executor_job(
+            self._controller.setPatrolStatus,
+            True,
+        )
+        if "error_code" not in result or result["error_code"] == 0:
+            self._attr_is_on = True
+            self._attr_state = "on"
+        self.async_write_ha_state()
+        await self._coordinator.async_request_refresh()
+
+    async def async_turn_off(self) -> None:
+        result = await self._hass.async_add_executor_job(
+            self._controller.setPatrolStatus,
+            False,
+        )
+        if "error_code" not in result or result["error_code"] == 0:
+            self._attr_is_on = False
+            self._attr_state = "off"
+        self.async_write_ha_state()
+        await self._coordinator.async_request_refresh()
+
+    def updateTapo(self, camData):
+        if (
+            not camData
+            or camData.get("privacy_mode") == "on"
+            or camData.get("patrol_status") is None
+        ):
+            self._attr_state = STATE_UNAVAILABLE
+        else:
+            self._attr_is_on = camData["patrol_status"] != "idle"
+            self._attr_state = "on" if self._attr_is_on else "off"
+
+    @property
+    def entity_category(self):
+        return None

custom_components/tapo_control/utils.py

@@ -1694,6 +1694,12 @@ async def getCamData(hass, controller, chInfo=None):
     else:
         camData["presets"] = {}
 
+    try:
+        patrolStatus = data["getPatrolAction"][0]["patrol"]["patrol"]["action"]
+    except Exception:
+        patrolStatus = None
+    camData["patrol_status"] = patrolStatus
+
     try:
         firmwareUpdateStatus = data["getFirmwareUpdateStatus"][0]["cloud_config"]
     except Exception:
@@ -2194,6 +2200,8 @@ def pytapoFunctionMap(pytapoFunctionName):
         return ["getTargetTrackConfig"]
     elif pytapoFunctionName == "getPresets":
         return ["getPresetConfig"]
+    elif pytapoFunctionName == "getCruise":
+        return ["getPatrolAction"]
     elif pytapoFunctionName == "getLightFrequencyMode":
         return ["getLightFrequencyInfo", "getLightFrequencyCapability"]
     elif pytapoFunctionName == "getChildDevices":