Add support for ELV-SH-SMSI (#595)

Author: hahn-th

CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [UNRELEASED](https://github.com/hahn-th/homematicip-rest-api/compare/2.2.0..master)
 
+### Added 
+
+- Add device SoilMoistureSensorInterface to support ELV-SH-SMSI
+- Add channel SoilMoistureSensorInterfaceChannel to support ELV-SH-SMSI
+
 ### Fixed
 
 - Fix params for sendDoorCommand

homematicip_demo/json_data/home.json

@@ -14956,6 +14956,167 @@
       "serializedGlobalTradeItemNumber": "3014F71100000000000SHWSM",
       "type": "WATERING_ACTUATOR",
       "updateState": "UP_TO_DATE"
+    },
+    "3014F7110000000ELVSHSMSI": {
+      "availableFirmwareVersion": "0.0.0",
+      "connectionType": "HMIP_RF",
+      "deviceArchetype": "HMIP",
+      "firmwareVersion": "1.0.12",
+      "firmwareVersionInteger": 65548,
+      "functionalChannels": {
+        "0": {
+          "altitude": null,
+          "busConfigMismatch": null,
+          "coProFaulty": false,
+          "coProRestartNeeded": false,
+          "coProUpdateFailure": false,
+          "configPending": true,
+          "controlsMountingOrientation": null,
+          "daliBusState": null,
+          "dataDecodingFailedError": null,
+          "defaultLinkedGroup": [],
+          "deviceAliveSignalEnabled": null,
+          "deviceCommunicationError": null,
+          "deviceDriveError": null,
+          "deviceDriveModeError": null,
+          "deviceId": "3014F7110000000ELVSHSMSI",
+          "deviceOperationMode": null,
+          "deviceOverheated": false,
+          "deviceOverloaded": false,
+          "devicePowerFailureDetected": false,
+          "deviceUndervoltage": false,
+          "displayContrast": null,
+          "displayMode": null,
+          "displayMountingOrientation": null,
+          "dutyCycle": false,
+          "frostProtectionError": null,
+          "frostProtectionErrorAcknowledged": null,
+          "functionalChannelType": "DEVICE_BASE",
+          "groupIndex": 0,
+          "groups": [
+            "00000000-0000-0000-0000-000000000057"
+          ],
+          "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": -78,
+          "rssiPeerValue": null,
+          "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": false,
+            "IFeatureDeviceOverloaded": false,
+            "IFeatureDeviceParticulateMatterSensorCommunicationError": false,
+            "IFeatureDeviceParticulateMatterSensorError": false,
+            "IFeatureDevicePowerFailure": false,
+            "IFeatureDeviceSensorCommunicationError": false,
+            "IFeatureDeviceSensorError": false,
+            "IFeatureDeviceTempSensorError": false,
+            "IFeatureDeviceTemperatureHumiditySensorCommunicationError": false,
+            "IFeatureDeviceTemperatureHumiditySensorError": false,
+            "IFeatureDeviceTemperatureOutOfRange": false,
+            "IFeatureDeviceUndervoltage": false,
+            "IFeatureMulticastRouter": false,
+            "IFeatureNoDataFromLinkyError": false,
+            "IFeaturePowerShortCircuit": false,
+            "IFeatureProfilePeriodLimit": false,
+            "IFeatureRssiValue": true,
+            "IFeatureShortCircuitDataLine": false,
+            "IFeatureTicVersionError": false,
+            "IOptionalFeatureAltitude": false,
+            "IOptionalFeatureDefaultLinkedGroup": false,
+            "IOptionalFeatureDeviceAliveSignalEnabled": false,
+            "IOptionalFeatureDeviceErrorLockJammed": false,
+            "IOptionalFeatureDeviceFrostProtectionError": false,
+            "IOptionalFeatureDeviceInputLayoutMode": false,
+            "IOptionalFeatureDeviceOperationMode": false,
+            "IOptionalFeatureDeviceSwitchChannelMode": false,
+            "IOptionalFeatureDeviceValveError": false,
+            "IOptionalFeatureDeviceWaterError": false,
+            "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": null,
+          "valveWaterError": null
+        },
+        "1": {
+          "channelRole": "SOIL_MOISTURE_SENSOR",
+          "deviceId": "3014F7110000000ELVSHSMSI",
+          "functionalChannelType": "SOIL_MOISTURE_SENSOR_INTERFACE_CHANNEL",
+          "groupIndex": 1,
+          "groups": [
+            "00000000-0000-0000-0000-000000000135"
+          ],
+          "index": 1,
+          "label": "",
+          "measuringInterval": 10,
+          "soilMoisture": 56,
+          "soilMoistureMaximumReference": 3000,
+          "soilMoistureMinimumReference": 3900,
+          "soilMoistureNeutralMaximum": 80,
+          "soilMoistureNeutralMinimum": 20,
+          "soilMoistureRawValue": 3439,
+          "soilTemperature": 21.5,
+          "soilTemperatureNeutralMaximum": 28.0,
+          "soilTemperatureNeutralMinimum": 5.0,
+          "supportedOptionalFeatures": {
+            "IFeatureLightGroupSensorChannel": false
+          }
+        }
+      },
+      "homeId": "00000000-0000-0000-0000-000000000001",
+      "id": "3014F7110000000ELVSHSMSI",
+      "label": "Bodenfeuchtesensor",
+      "lastStatusUpdate": 1754056327352,
+      "liveUpdateState": "LIVE_UPDATE_NOT_SUPPORTED",
+      "manuallyUpdateForced": false,
+      "manufacturerCode": 9,
+      "measuredAttributes": {},
+      "modelId": 596,
+      "modelType": "ELV-SH-SMSI",
+      "oem": "eQ-3",
+      "permanentlyReachable": false,
+      "serializedGlobalTradeItemNumber": "3014F7110000000ELVSHSMSI",
+      "type": "SOIL_MOISTURE_SENSOR_INTERFACE",
+      "updateState": "UP_TO_DATE"
     }
   },
   "groups": {

src/homematicip/base/enums.py

@@ -278,6 +278,7 @@ class DeviceType(AutoNameEnum):
     SHUTTER_CONTACT_MAGNETIC = auto()
     SHUTTER_CONTACT_OPTICAL_PLUS = auto()
     SMOKE_DETECTOR = auto()
+    SOIL_MOISTURE_SENSOR_INTERFACE = auto()
     SWITCH_MEASURING_CABLE_OUTDOOR = auto()
     TEMPERATURE_HUMIDITY_SENSOR = auto()
     TEMPERATURE_HUMIDITY_SENSOR_COMPACT = auto()
@@ -500,6 +501,7 @@ class FunctionalChannelType(AutoNameEnum):
     SHUTTER_CONTACT_CHANNEL = auto()
     SINGLE_KEY_CHANNEL = auto()
     SMOKE_DETECTOR_CHANNEL = auto()
+    SOIL_MOISTURE_SENSOR_INTERFACE_CHANNEL = auto()
     SWITCH_CHANNEL = auto()
     SWITCH_MEASURING_CHANNEL = auto()
     TEMPERATURE_SENSOR_2_EXTERNAL_DELTA_CHANNEL = auto()

src/homematicip/base/functionalChannels.py

@@ -985,7 +985,6 @@ def from_json(self, js, groups: Iterable[Group]):
         self.supportingSelfCalibration = js["supportingSelfCalibration"]
         self.userDesiredProfileMode = js["userDesiredProfileMode"]
 
-
     def set_shutter_stop(self):
         return self._run_non_async(self.async_set_shutter_stop)
 
@@ -2180,7 +2179,7 @@ async def set_hue_saturation_dim_level_async(self, hue: int, saturation_level: f
         )
 
     async def set_hue_saturation_dim_level_with_time_async(self, hue: int, saturation_level: float, dim_level: float,
-                                                       on_time: float, ramp_time: float):
+                                                           on_time: float, ramp_time: float):
         return await functional_channel_commands.set_hue_saturation_dim_level_with_time_async(
             self._connection, self.device.id, self.index, hue, saturation_level, dim_level, on_time, ramp_time
         )
@@ -2198,6 +2197,7 @@ async def start_light_scene_async(self, light_scene_id: int, dim_level: float =
             self._connection, self.device.id, self.index, light_scene_id, dim_level
         )
 
+
 class UniversalLightChannelGroup(UniversalLightChannel):
     """Universal-Light-Channel-Group."""
 
@@ -2281,4 +2281,36 @@ 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
-        )
+        )
+
+
+class SoilMoistureSensorInterfaceChannel(FunctionalChannel):
+    """This is the representative of the SOIL_MOISTURE_SENSOR_INTERFACE_CHANNEL channel."""
+
+    def __init__(self, device, connection):
+        super().__init__(device, connection)
+        self.measuringInterval: int | None = None
+        self.soilMoisture: int | None = None
+        self.soilMoistureMaximumReference: int | None = None
+        self.soilMoistureMinimumReference: int | None = None
+        self.soilMoistureNeutralMaximum: int | None = None
+        self.soilMoistureNeutralMinimum: int | None = None
+        self.soilMoistureRawValue: int | None = None
+        self.soilTemperature: float | None = None
+        self.soilTemperatureNeutralMaximum: float | None = None
+        self.soilTemperatureNeutralMinimum: float | None = None
+
+    def from_json(self, js, groups: Iterable[Group]):
+        """Update the channel attributes from a JSON dictionary."""
+
+        super().from_json(js, groups)
+        self.measuringInterval = js.get("measuringInterval", self.measuringInterval)
+        self.soilMoisture = js.get("soilMoisture", self.soilMoisture)
+        self.soilMoistureMaximumReference = js.get("soilMoistureMaximumReference", self.soilMoistureMaximumReference)
+        self.soilMoistureMinimumReference = js.get("soilMoistureMinimumReference", self.soilMoistureMinimumReference)
+        self.soilMoistureNeutralMaximum = js.get("soilMoistureNeutralMaximum", self.soilMoistureNeutralMaximum)
+        self.soilMoistureNeutralMinimum = js.get("soilMoistureNeutralMinimum", self.soilMoistureNeutralMinimum)
+        self.soilMoistureRawValue = js.get("soilMoistureRawValue", self.soilMoistureRawValue)
+        self.soilTemperature = js.get("soilTemperature", self.soilTemperature)
+        self.soilTemperatureNeutralMaximum = js.get("soilTemperatureNeutralMaximum", self.soilTemperatureNeutralMaximum)
+        self.soilTemperatureNeutralMinimum = js.get("soilTemperatureNeutralMinimum", self.soilTemperatureNeutralMinimum)

src/homematicip/class_maps.py

@@ -85,6 +85,7 @@
     DeviceType.SHUTTER_CONTACT_MAGNETIC: ShutterContactMagnetic,
     DeviceType.SHUTTER_CONTACT_OPTICAL_PLUS: ShutterContactOpticalPlus,
     DeviceType.SMOKE_DETECTOR: SmokeDetector,
+    DeviceType.SOIL_MOISTURE_SENSOR_INTERFACE: SoilMoistureSensorInterface,
     DeviceType.SWITCH_MEASURING_CABLE_OUTDOOR: SwitchMeasuring,
     DeviceType.TEMPERATURE_HUMIDITY_SENSOR: TemperatureHumiditySensorWithoutDisplay,
     DeviceType.TEMPERATURE_HUMIDITY_SENSOR_COMPACT: TemperatureHumiditySensorOutdoor,
@@ -249,6 +250,7 @@
     FunctionalChannelType.SHUTTER_CONTACT_CHANNEL: ShutterContactChannel,
     FunctionalChannelType.SINGLE_KEY_CHANNEL: SingleKeyChannel,
     FunctionalChannelType.SMOKE_DETECTOR_CHANNEL: SmokeDetectorChannel,
+    FunctionalChannelType.SOIL_MOISTURE_SENSOR_INTERFACE_CHANNEL: SoilMoistureSensorInterfaceChannel,
     FunctionalChannelType.SWITCH_CHANNEL: SwitchChannel,
     FunctionalChannelType.SWITCH_MEASURING_CHANNEL: SwitchMeasuringChannel,
     FunctionalChannelType.TEMPERATURE_SENSOR_2_EXTERNAL_DELTA_CHANNEL: TemperatureDifferenceSensor2Channel,

src/homematicip/device.py

@@ -951,6 +951,10 @@ class BrandSwitch2(Switch):
     """ELV-SH-BS2 (ELV Smart Home ARR-Bausatz Schaltaktor für Markenschalter – 2-fach powered by Homematic IP)"""
 
 
+class SoilMoistureSensorInterface(Device):
+    """ELV-SH-SMSI (Soil Moisture Sensor Interface)"""
+
+
 class SwitchMeasuring(Switch):
     """Generic class for Switch and Meter"""
 

tests/test_devices.py

@@ -1828,7 +1828,14 @@ def test_wall_mounted_keypad(fake_home: Home):
         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)
+        assert isinstance(d, WateringActuator)
+
+
+def test_soil_moisture_sensor_interface(fake_home: Home):
+    with no_ssl_verification():
+        d = fake_home.search_device_by_id("3014F7110000000ELVSHSMSI")
+        assert isinstance(d, SoilMoistureSensorInterface)

tests/test_functional_channels.py

@@ -541,3 +541,20 @@ async def test_watering_actuator_channel(fake_home: Home):
         await ch.toggle_watering_state_async()
 
         assert len(connection_mock.mock_calls) == 4
+
+
+def test_soil_moisture_sensor_interface_channel(fake_home: Home):
+    with no_ssl_verification():
+        ch = fake_home.search_channel("3014F7110000000ELVSHSMSI", 1)
+        assert isinstance(ch, SoilMoistureSensorInterfaceChannel)
+
+        assert ch.measuringInterval == 10
+        assert ch.soilMoisture == 56
+        assert ch.soilMoistureMaximumReference == 3000
+        assert ch.soilMoistureMinimumReference == 3900
+        assert ch.soilMoistureNeutralMaximum == 80
+        assert ch.soilMoistureNeutralMinimum == 20
+        assert ch.soilMoistureRawValue == 3439
+        assert ch.soilTemperature == 21.5
+        assert ch.soilTemperatureNeutralMaximum == 28.0
+        assert ch.soilTemperatureNeutralMinimum == 5.0