PTZ Support (#487)

Support added for PTZ cameras. There is a new entity that allows you to move the camera to a preset position.

Author: slopneal

README.md

@@ -229,6 +229,7 @@ Service | Parameters | Description
 `camera.enable_motion_detection` | | Enables motion detection
 `camera.disable_motion_detection` | | Disabled motion detection
 `dahua.set_infrared_mode` | `target`: camera.cam13_main <br /> `mode`: Auto, On, Off <br /> `brightness`: 0 - 100 inclusive| Sets the infrared mode. Useful to set the mode back to Auto
+`dahua.goto_preset_position` | `target`: camera.cam13_main <br /> `position`: 1 - 10 inclusive| Go to a preset position
 `dahua.set_video_profile_mode` | `target`: camera.cam13_main <br /> `mode`: Day, Night| Sets the video profile mode to day or night
 `dahua.set_focus_zoom` | `target`: camera.cam13_main <br /> `focus`: The focus level, e.g.: 0.81 0 - 1 inclusive <br /> `zoom`: The zoom level, e.g.: 0.72 0 - 1 inclusive | Sets the focus and zoom level
 `dahua.set_channel_title` | `target`: camera.cam13_main <br /> `channel`: The camera channel, e.g.: 0 <br /> `text1`: The text 1<br /> `text2`: The text 2| Sets the channel title

custom_components/dahua/__init__.py

@@ -112,10 +112,12 @@ def __init__(self, hass: HomeAssistant, events: list, address: str, port: int, r
         self._supports_disarming_linkage = False
         self._supports_event_notifications = False
         self._supports_smart_motion_detection = False
+        self._supports_ptz_position = False
         self._supports_lighting = False
         self._supports_floodlightmode = False
         self._serial_number: str
         self._profile_mode = "0"
+        self._preset_position = "0"
         self._supports_profile_mode = False
         self._channel = channel
         self._address = address
@@ -247,6 +249,15 @@ async def _async_update_data(self):
                     self._supports_event_notifications = False
                 _LOGGER.info("Device supports event notifications=%s", self._supports_event_notifications)
 
+                # PTZ
+                # The following lines are for Dahua devices
+                try:
+                    await self.client.async_get_ptz_position()
+                    self._supports_ptz_position = True
+                except ClientError:
+                    self._supports_ptz_position = False
+                _LOGGER.info("Device supports PTZ position=%s", self._supports_ptz_position)
+
                 # Smart motion detection is enabled/disabled/fetched differently on Dahua devices compared to Amcrest
                 # The following lines are for Dahua devices
                 try:
@@ -320,6 +331,19 @@ async def _async_update_data(self):
                     # I believe this API is missing on some cameras so we'll just ignore it and move on
                     _LOGGER.debug("Could not get profile mode", exc_info=exception)
                     pass
+            
+            # We need the ptz status
+            if self._supports_ptz_position:
+                try:
+                    ptz_data = await self.client.async_get_ptz_position()
+                    data.update(ptz_data)
+                    self._preset_position = ptz_data.get("status.PresetID", "0")
+                    if not self._preset_position:
+                        self._preset_position = "0"
+                except Exception as exception:
+                    # I believe this API is missing on some cameras so we'll just ignore it and move on
+                    _LOGGER.debug("Could not get preset position", exc_info=exception)
+                    pass
 
             # Figure out which APIs we need to call and then fan out and gather the results
             coros = [
@@ -598,6 +622,12 @@ def supports_illuminator(self) -> bool:
         IPC-HDW3849HP-AS-PV does
         """
         return  not (self.is_amcrest_doorbell() or self.is_flood_light()) and "table.Lighting_V2[{0}][0][0].Mode".format(self._channel) in self.data   
+    
+    def supports_ptz_position(self) -> bool:
+        """
+        Returns true if this camera supports PTZ preset position
+        """
+        return  not (self.is_amcrest_doorbell() or self.is_flood_light()) and "table.Lighting_V2[{0}][0][0].Mode".format(self._channel) in self.data   
 
     def is_motion_detection_enabled(self) -> bool:
         """ Returns true if motion detection is enabled for the camera """

custom_components/dahua/camera.py

@@ -37,6 +37,7 @@
 SERVICE_VTO_CANCEL_CALL = "vto_cancel_call"
 SERVICE_SET_DAY_NIGHT_MODE = "set_video_in_day_night_mode"
 SERVICE_REBOOT = "reboot"
+SERVICE_GOTO_PRESET_POSITION = "goto_preset_position"
 
 
 async def async_setup_entry(hass: HomeAssistant, config_entry, async_add_entities):
@@ -224,6 +225,13 @@ async def async_setup_entry(hass: HomeAssistant, config_entry, async_add_entitie
             "async_set_infrared_mode"
         )
 
+    platform.async_register_entity_service(
+        SERVICE_GOTO_PRESET_POSITION,
+        {
+            vol.Required('position', default=1): vol.All(vol.Coerce(int), vol.Range(min=1, max=10)),
+        },
+        "async_goto_preset_position"
+    )
 
 class DahuaCamera(DahuaBaseEntity, Camera):
     """An implementation of a Dahua IP camera."""
@@ -295,6 +303,12 @@ async def async_set_infrared_mode(self, mode: str, brightness: int):
         await self._coordinator.client.async_set_lighting_v1_mode(channel, mode, brightness)
         await self._coordinator.async_refresh()
 
+    async def async_goto_preset_position(self, position: int):
+        """ Handles the service call from SERVICE_GOTO_PRESET_POSITION to go to a specific preset position """
+        channel = self._coordinator.get_channel()
+        await self._coordinator.client.async_goto_preset_position(channel, position)
+        await self._coordinator.async_refresh()
+
     async def async_set_video_in_day_night_mode(self, config_type: str, mode: str):
         """ Handles the service call from SERVICE_SET_DAY_NIGHT_MODE to set the day/night color mode """
         channel = self._coordinator.get_channel()

custom_components/dahua/client.py

@@ -297,6 +297,23 @@ async def async_get_smart_motion_detection(self) -> dict:
         """
         url = "/cgi-bin/configManager.cgi?action=getConfig&name=SmartMotionDetect"
         return await self.get(url)
+    
+    async def async_get_ptz_position(self) -> dict:
+        """
+        Gets the status of PTZ Example output:
+        status.Action=Preset
+        status.MoveStatus=Idle
+        status.PTS=0
+        status.Postion[0]=91.600000
+        status.Postion[1]=-2.600000
+        status.Postion[2]=1.000000
+        status.PresetID=2
+        status.Sequence=0
+        status.UTC=0
+        status.ZoomStatus=Idle
+        """
+        url = "/cgi-bin/ptz.cgi?action=getStatus"
+        return await self.get(url)
 
     async def async_get_light_global_enabled(self) -> dict:
         """
@@ -348,6 +365,17 @@ async def async_set_lighting_v1_mode(self, channel: int, mode: str, brightness:
             channel=channel, mode=mode, brightness=brightness
         )
         return await self.get(url)
+    
+    async def async_goto_preset_position(self, channel: int, position: int) -> dict:
+        """
+        async_goto_preset_position will go to a specific preset position
+        Position should be between 1 and 10 inclusive.
+        """
+
+        url = "/cgi-bin/ptz.cgi?action=start&channel={0}&code=GotoPreset&arg1=0&arg2={1}&arg3=0".format(
+            channel, position
+        )
+        return await self.get(url)
 
     async def async_set_video_profile_mode(self, channel: int, mode: str):
         """

custom_components/dahua/select.py

@@ -20,6 +20,9 @@ async def async_setup_entry(hass: HomeAssistant, entry, async_add_devices):
     if coordinator.is_amcrest_doorbell() and coordinator.supports_security_light():
         devices.append(DahuaDoorbellLightSelect(coordinator, entry))
 
+    #if coordinator._supports_ptz_position:
+    devices.append(DahuaCameraPresetPositionSelect(coordinator, entry))
+    
     async_add_devices(devices)
 
 
@@ -59,3 +62,36 @@ def name(self):
     def unique_id(self):
         """ https://developers.home-assistant.io/docs/entity_registry_index/#unique-id-requirements """
         return self._attr_unique_id
+
+
+class DahuaCameraPresetPositionSelect(DahuaBaseEntity, SelectEntity):
+    """allows """
+
+    def __init__(self, coordinator: DahuaDataUpdateCoordinator, config_entry):
+        DahuaBaseEntity.__init__(self, coordinator, config_entry)
+        SelectEntity.__init__(self)
+        self._coordinator = coordinator
+        self._attr_name = f"{coordinator.get_device_name()} Preset Position"
+        self._attr_unique_id = f"{coordinator.get_serial_number()}_preset_position"
+        self._attr_options = ["Manual","1","2","3","4","5","6","7","8","9","10"]
+
+    @property
+    def current_option(self) -> str:
+        presetID = self._coordinator.data.get("status.PresetID", "0")
+        if presetID == "0":
+            return "Manual"
+        return presetID
+
+    async def async_select_option(self, option: str) -> None:
+        channel = self._coordinator.get_channel()
+        await self._coordinator.client.async_goto_preset_position(channel, int(option))
+        await self._coordinator.async_refresh()
+
+    @property
+    def name(self):
+        return self._attr_name
+
+    @property
+    def unique_id(self):
+        """ https://developers.home-assistant.io/docs/entity_registry_index/#unique-id-requirements """
+        return self._attr_unique_id

custom_components/dahua/services.yaml

@@ -444,3 +444,22 @@ set_privacy_masking:
       default: true
       selector:
         boolean:
+
+goto_preset_position:
+  name: Go to a preset position
+  description: Go to a position already preset
+  target:
+    entity:
+      integration: dahua
+      domain: camera
+  fields:
+    position:
+      name: Position
+      description: Position number, from 1 to 10 inclusive. 
+      example: 1
+      default: 1
+      selector:
+        number:
+          min: 1
+          max: 10
+          mode: box