Add ELV-SH-WSM (#583) (#593)

Author: hahn-th

CHANGELOG.md

@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 
 - Add IOptionalFeatureOperationDays with attribute operationDays
+- Add support for ELV-SH-WSM (Watering Actuator) (#583)
 
 ## [2.1.0](https://github.com/hahn-th/homematicip-rest-api/compare/2.0.7..2.1.0) 2025-07-15
 
@@ -48,6 +49,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Make websocket connection more robust against errors
 
+### Added
+
+- Add support for ELV-SH-WSM (Watering Actuator) (#583)
+
 ## [2.0.4] 2025-05-30
 
 ### Fixed

homematicip_demo/json_data/home.json

@@ -14797,6 +14797,165 @@
       "serializedGlobalTradeItemNumber": "3014F7110000000000000WKP",
       "type": "WALL_MOUNTED_KEY_PAD",
       "updateState": "UP_TO_DATE"
+    },
+    "3014F71100000000000SHWSM": {
+      "availableFirmwareVersion": "0.0.0",
+      "connectionType": "HMIP_RF",
+      "deviceArchetype": "HMIP",
+      "firmwareVersion": "1.0.10",
+      "firmwareVersionInteger": 65546,
+      "functionalChannels": {
+        "0": {
+          "altitude": null,
+          "busConfigMismatch": null,
+          "coProFaulty": false,
+          "coProRestartNeeded": false,
+          "coProUpdateFailure": false,
+          "configPending": false,
+          "controlsMountingOrientation": null,
+          "daliBusState": null,
+          "dataDecodingFailedError": null,
+          "defaultLinkedGroup": [],
+          "deviceAliveSignalEnabled": null,
+          "deviceCommunicationError": null,
+          "deviceDriveError": null,
+          "deviceDriveModeError": null,
+          "deviceId": "3014F71100000000000SHWSM",
+          "deviceOperationMode": null,
+          "deviceOverheated": false,
+          "deviceOverloaded": false,
+          "devicePowerFailureDetected": false,
+          "deviceUndervoltage": false,
+          "displayContrast": null,
+          "displayMode": null,
+          "displayMountingOrientation": null,
+          "dutyCycle": false,
+          "frostProtectionError": false,
+          "frostProtectionErrorAcknowledged": null,
+          "functionalChannelType": "DEVICE_BASE",
+          "groupIndex": 0,
+          "groups": [
+            "00000000-0000-0000-0000-000000000022"
+          ],
+          "index": 0,
+          "inputLayoutMode": null,
+          "invertedDisplayColors": null,
+          "label": "",
+          "lockJammed": null,
+          "lowBat": false,
+          "mountingModuleError": null,
+          "mountingOrientation": null,
+          "multicastRoutingEnabled": false,
+          "noDataFromLinkyError": null,
+          "operationDays": null,
+          "particulateMatterSensorCommunicationError": null,
+          "particulateMatterSensorError": null,
+          "powerShortCircuit": null,
+          "profilePeriodLimitReached": null,
+          "routerModuleEnabled": false,
+          "routerModuleSupported": false,
+          "rssiDeviceValue": -46,
+          "rssiPeerValue": -43,
+          "sensorCommunicationError": null,
+          "sensorError": null,
+          "shortCircuitDataLine": null,
+          "supportedOptionalFeatures": {
+            "IFeatureBusConfigMismatch": false,
+            "IFeatureDataDecodingFailedError": false,
+            "IFeatureDeviceCoProError": false,
+            "IFeatureDeviceCoProRestart": false,
+            "IFeatureDeviceCoProUpdate": false,
+            "IFeatureDeviceCommunicationError": false,
+            "IFeatureDeviceDaliBusError": false,
+            "IFeatureDeviceDriveError": false,
+            "IFeatureDeviceDriveModeError": false,
+            "IFeatureDeviceIdentify": false,
+            "IFeatureDeviceMountingModuleError": false,
+            "IFeatureDeviceOverheated": true,
+            "IFeatureDeviceOverloaded": false,
+            "IFeatureDeviceParticulateMatterSensorCommunicationError": false,
+            "IFeatureDeviceParticulateMatterSensorError": false,
+            "IFeatureDevicePowerFailure": false,
+            "IFeatureDeviceSensorCommunicationError": false,
+            "IFeatureDeviceSensorError": false,
+            "IFeatureDeviceTempSensorError": false,
+            "IFeatureDeviceTemperatureHumiditySensorCommunicationError": false,
+            "IFeatureDeviceTemperatureHumiditySensorError": false,
+            "IFeatureDeviceTemperatureOutOfRange": false,
+            "IFeatureDeviceUndervoltage": true,
+            "IFeatureMulticastRouter": false,
+            "IFeatureNoDataFromLinkyError": false,
+            "IFeaturePowerShortCircuit": false,
+            "IFeatureProfilePeriodLimit": false,
+            "IFeatureRssiValue": true,
+            "IFeatureShortCircuitDataLine": false,
+            "IFeatureTicVersionError": false,
+            "IOptionalFeatureAltitude": false,
+            "IOptionalFeatureDefaultLinkedGroup": false,
+            "IOptionalFeatureDeviceAliveSignalEnabled": false,
+            "IOptionalFeatureDeviceErrorLockJammed": false,
+            "IOptionalFeatureDeviceFrostProtectionError": true,
+            "IOptionalFeatureDeviceInputLayoutMode": false,
+            "IOptionalFeatureDeviceOperationMode": false,
+            "IOptionalFeatureDeviceSwitchChannelMode": false,
+            "IOptionalFeatureDeviceValveError": true,
+            "IOptionalFeatureDeviceWaterError": true,
+            "IOptionalFeatureDisplayContrast": false,
+            "IOptionalFeatureDisplayMode": false,
+            "IOptionalFeatureDutyCycle": true,
+            "IOptionalFeatureInvertedDisplayColors": false,
+            "IOptionalFeatureLowBat": true,
+            "IOptionalFeatureMountingOrientation": false,
+            "IOptionalFeatureOperationDays": false
+          },
+          "switchChannelMode": null,
+          "temperatureHumiditySensorCommunicationError": null,
+          "temperatureHumiditySensorError": null,
+          "temperatureOutOfRange": false,
+          "temperatureSensorError": null,
+          "ticVersionError": null,
+          "unreach": false,
+          "valveFlowError": false,
+          "valveWaterError": false
+        },
+        "1": {
+          "channelRole": "WATERING_ACTUATOR",
+          "deviceId": "3014F71100000000000SHWSM",
+          "functionalChannelType": "WATERING_ACTUATOR_CHANNEL",
+          "groupIndex": 1,
+          "groups": [
+            "00000000-0000-0000-0000-000000000023"
+          ],
+          "index": 1,
+          "label": "",
+          "profileMode": "AUTOMATIC",
+          "supportedOptionalFeatures": {
+            "IFeatureWateringGroupActuatorChannel": true,
+            "IFeatureWateringProfileActuatorChannel": true
+          },
+          "userDesiredProfileMode": "AUTOMATIC",
+          "waterFlow": 0.0,
+          "waterVolume": 0.0,
+          "waterVolumeSinceOpen": 0.0,
+          "wateringActive": false,
+          "wateringOnTime": 3600.0
+        }
+      },
+      "homeId": "00000000-0000-0000-0000-000000000001",
+      "id": "3014F71100000000000SHWSM",
+      "label": "Bew\u00e4sserungsaktor",
+      "lastStatusUpdate": 1749501203047,
+      "liveUpdateState": "LIVE_UPDATE_NOT_SUPPORTED",
+      "manuallyUpdateForced": false,
+      "manufacturerCode": 9,
+      "measuredAttributes": {},
+      "modelId": 586,
+      "modelType": "ELV-SH-WSM",
+      "oem": "eQ-3",
+      "permanentlyReachable": true,
+      "serializedGlobalTradeItemNumber": "3014F71100000000000SHWSM",
+      "type": "WATERING_ACTUATOR",
+      "updateState": "UP_TO_DATE"
     }
   },
   "groups": {

src/homematicip/base/enums.py

@@ -293,6 +293,7 @@ class DeviceType(AutoNameEnum):
     WALL_MOUNTED_GARAGE_DOOR_CONTROLLER = auto()
     WALL_MOUNTED_UNIVERSAL_ACTUATOR = auto()
     WATER_SENSOR = auto()
+    WATERING_ACTUATOR = auto()
     WEATHER_SENSOR = auto()
     WEATHER_SENSOR_PLUS = auto()
     WEATHER_SENSOR_PRO = auto()
@@ -510,6 +511,7 @@ class FunctionalChannelType(AutoNameEnum):
     WALL_MOUNTED_THERMOSTAT_WITHOUT_DISPLAY_CHANNEL = auto()
     WALL_MOUNTED_THERMOSTAT_WITH_CARBON_CHANNEL = auto()
     WATER_SENSOR_CHANNEL = auto()
+    WATERING_ACTUATOR_CHANNEL = auto()
     WEATHER_SENSOR_CHANNEL = auto()
     WEATHER_SENSOR_PLUS_CHANNEL = auto()
     WEATHER_SENSOR_PRO_CHANNEL = auto()

src/homematicip/base/functionalChannels.py

@@ -2233,3 +2233,52 @@ def from_json(self, js, groups: Iterable[Group]):
 class CodeProtectedSecondaryActionChannel(FunctionalChannel):
     """this is the representative of the CODE_PROTECTED_SECONDARY_ACTION_CHANNEL channel (HmIP-WKP)"""
     pass
+
+
+class WateringActuatorChannel(FunctionalChannel):
+    """this is the representative of the WATERING_ACTUATOR_CHANNEL channel"""
+
+    def __init__(self, device, connection):
+        super().__init__(device, connection)
+
+        self.waterFlow: float | None = None
+        self.waterVolume: float | None = None
+        self.waterVolumeSinceOpen: float | None = None
+        self.wateringActive: bool | None = None
+        self.wateringOnTime: float | None = None
+
+    def from_json(self, js, groups: Iterable[Group]):
+        super().from_json(js, groups)
+        self.waterFlow = js.get("waterFlow")
+        self.waterVolume = js.get("waterVolume")
+        self.waterVolumeSinceOpen = js.get("waterVolumeSinceOpen")
+        self.wateringActive = js.get("wateringActive")
+        self.wateringOnTime = js.get("wateringOnTime")
+
+    async def reset_water_volume_async(self):
+        """Resets the water volume counter of the specified device."""
+        return await functional_channel_commands.reset_water_volume_async(
+            self._connection, self.device.id, self.index
+        )
+
+    async def set_watering_switch_state_async(self, on: bool):
+        """Sets the watering switch state of the specified device."""
+        return await functional_channel_commands.set_watering_switch_state_async(
+            self._connection, self.device.id, self.index, on
+        )
+
+    async def set_watering_switch_state_with_time_async(self, on: bool, seconds: int):
+        """Sets the watering switch state of the specified device with a specified time.
+
+        :param on: True to turn on, False to turn off.
+        :param seconds: The watering time in seconds.
+        """
+        return await functional_channel_commands.set_watering_switch_state_with_time_async(
+            self._connection, self.device.id, self.index, on, seconds
+        )
+
+    async def toggle_watering_state_async(self):
+        """Toggles the watering state of the specified device."""
+        return await functional_channel_commands.toggle_watering_state_async(
+            self._connection, self.device.id, self.index
+        )

src/homematicip/class_maps.py

@@ -99,6 +99,7 @@
     DeviceType.WALL_MOUNTED_THERMOSTAT_PRO: WallMountedThermostatPro,
     DeviceType.WALL_MOUNTED_THERMOSTAT_BASIC_HUMIDITY: WallMountedThermostatBasicHumidity,
     DeviceType.WATER_SENSOR: WaterSensor,
+    DeviceType.WATERING_ACTUATOR: WateringActuator,
     DeviceType.WEATHER_SENSOR: WeatherSensor,
     DeviceType.WEATHER_SENSOR_PLUS: WeatherSensorPlus,
     DeviceType.WEATHER_SENSOR_PRO: WeatherSensorPro,
@@ -258,6 +259,7 @@
     FunctionalChannelType.WALL_MOUNTED_THERMOSTAT_WITHOUT_DISPLAY_CHANNEL: WallMountedThermostatWithoutDisplayChannel,
     FunctionalChannelType.WALL_MOUNTED_THERMOSTAT_WITH_CARBON_CHANNEL: WallMountedThermostatWithCarbonChannel,
     FunctionalChannelType.WATER_SENSOR_CHANNEL: WaterSensorChannel,
+    FunctionalChannelType.WATERING_ACTUATOR_CHANNEL: WateringActuatorChannel,
     FunctionalChannelType.WEATHER_SENSOR_CHANNEL: WeatherSensorChannel,
     FunctionalChannelType.WEATHER_SENSOR_PLUS_CHANNEL: WeatherSensorPlusChannel,
     FunctionalChannelType.WEATHER_SENSOR_PRO_CHANNEL: WeatherSensorProChannel,

src/homematicip/commands/functional_channel_commands.py

@@ -30,6 +30,13 @@ async def reset_passage_counter_async(rest_connection: RestConnection, device_id
 
 
 async def reset_water_volume_async(rest_connection: RestConnection, device_id: str, channel_index: int):
+    """
+    Resets the water volume counter of the specified device.
+
+    :param rest_connection: The REST connection instance.
+    :param device_id: The device ID.
+    :param channel_index: The channel index.
+    """
     data = {
         "channelIndex": channel_index,
         "deviceId": device_id
@@ -796,13 +803,9 @@ async def set_watering_switch_state_async(rest_connection: RestConnection, devic
     Set the watering switch state for a functional channel.
 
     :param rest_connection: The REST connection instance.
-    :type rest_connection: RestConnection
     :param device_id: The device ID.
-    :type device_id: str
     :param channel_index: The channel index.
-    :type channel_index: int
     :param watering_active: The desired watering state (True for active, False for inactive).
-    :type watering_active: bool
     :return: The response from the cloud.
     :rtype: dict
     """
@@ -820,15 +823,10 @@ async def set_watering_switch_state_with_time_async(rest_connection: RestConnect
     Set the watering switch state for a functional channel with a specific watering time.
 
     :param rest_connection: The REST connection instance.
-    :type rest_connection: RestConnection
     :param device_id: The device ID.
-    :type device_id: str
     :param channel_index: The channel index.
-    :type channel_index: int
     :param watering_active: The desired watering state (True for active, False for inactive).
-    :type watering_active: bool
     :param watering_time: The watering time in seconds.
-    :type watering_time: float
     :return: The response from the cloud.
     :rtype: dict
     """
@@ -846,13 +844,9 @@ async def set_display_async(rest_connection: RestConnection, device_id: str, cha
     Set the climate control display.
 
     :param rest_connection: The REST connection instance.
-    :type rest_connection: RestConnection
     :param device_id: The device ID.
-    :type device_id: str
     :param channel_index: The channel index.
-    :type channel_index: int
     :param display: The display as string. Possible values are defined in the ClimateControlDisplay enum.
-    :type display: str
     :return: The response from the cloud.
     :rtype: dict
     """
@@ -996,3 +990,19 @@ async def start_light_scene_async(rest_connection: RestConnection, device_id: st
         "dimLevel": dim_level
     }
     return await rest_connection.async_post("device/control/startLightScene", data)
+
+async def toggle_watering_state_async(rest_connection: RestConnection, device_id: str, channel_index: int):
+    """
+    Toggle the watering state for a functional channel.
+
+    :param rest_connection: The REST connection instance.
+    :param device_id: The device ID.
+    :param channel_index: The channel index.
+    :return: The response from the cloud.
+    :rtype: dict
+    """
+    data = {
+        "channelIndex": channel_index,
+        "deviceId": device_id
+    }
+    return await rest_connection.async_post("device/control/toggleWateringState", data)

src/homematicip/device.py

@@ -2757,3 +2757,7 @@ class MotionDetectorSwitchOutdoor(Device):
 
 class WallMountedKeyPad(Device):
     pass
+
+
+class WateringActuator(Device):
+    pass

tests/test_devices.py

@@ -1827,3 +1827,8 @@ def test_wall_mounted_keypad(fake_home: Home):
     with no_ssl_verification():
         d = fake_home.search_device_by_id("3014F7110000000000000WKP")
         assert isinstance(d, WallMountedKeyPad)
+
+def test_watering_actuator(fake_home: Home):
+    with no_ssl_verification():
+        d = fake_home.search_device_by_id("3014F71100000000000SHWSM")
+        assert isinstance(d, WateringActuator)

tests/test_functional_channels.py

@@ -1,4 +1,4 @@
-from unittest.mock import Mock
+from unittest.mock import Mock, patch, AsyncMock
 
 from homematicip.base.channel_event import ChannelEvent
 from homematicip.base.functionalChannels import *
@@ -524,4 +524,20 @@ def test_code_protected_secondary_channel(fake_home: Home):
 def test_device_blocking_channel(fake_home: Home):
     with no_ssl_verification():
         ch = fake_home.search_channel("3014F7110000000000000WKP", 0)
-        assert isinstance(ch, DeviceBlockingChannel)
+        assert isinstance(ch, DeviceBlockingChannel)
+
+
+async def test_watering_actuator_channel(fake_home: Home):
+    with no_ssl_verification():
+        ch = fake_home.search_channel("3014F71100000000000SHWSM", 1)
+        assert isinstance(ch, WateringActuatorChannel)
+
+        connection_mock = AsyncMock()
+        ch._connection = connection_mock
+
+        await ch.reset_water_volume_async()
+        await ch.set_watering_switch_state_async(True)
+        await ch.set_watering_switch_state_with_time_async(True, 100)
+        await ch.toggle_watering_state_async()
+
+        assert len(connection_mock.mock_calls) == 4