[ecovacs] Add support for DEEBOT X2 Omni (#16487)

Fixes #16117 * [ecovacs] Interpret empty error code list as 'no error' Newer devices don't explicitly report 'no error' anymore, but instead send an empty list. Signed-off-by: Danny Baumann <[email protected]>
openhab · Mar 12, 2024 · 2edaceb · 2edaceb
1 parent 7dfebd6
commit 2edaceb
Show file tree

Hide file tree

Showing 7 changed files with 57 additions and 10 deletions.
diff --git a/...vacs/src/main/java/org/openhab/binding/ecovacs/internal/api/commands/GetErrorCommand.java b/...vacs/src/main/java/org/openhab/binding/ecovacs/internal/api/commands/GetErrorCommand.java
@@ -44,10 +44,8 @@ public Optional<Integer> convertResponse(AbstractPortalIotCommandResponse respon
             Gson gson) throws DataParsingException {
         if (response instanceof PortalIotCommandJsonResponse jsonResponse) {
             ErrorReport resp = jsonResponse.getResponsePayloadAs(gson, ErrorReport.class);
-            if (resp.errorCodes.isEmpty()) {
-                return Optional.empty();
-            }
-            return Optional.of(resp.errorCodes.get(0));
+            int responseCode = resp.errorCodes.isEmpty() ? 0 : resp.errorCodes.get(0);
+            return Optional.of(responseCode);
         } else {
             String payload = ((PortalIotCommandXmlResponse) response).getResponsePayloadXml();
             return DeviceInfo.parseErrorInfo(payload);

diff --git a/.../main/java/org/openhab/binding/ecovacs/internal/api/commands/SpotAreaCleaningCommand.java b/.../main/java/org/openhab/binding/ecovacs/internal/api/commands/SpotAreaCleaningCommand.java
@@ -21,7 +21,13 @@
  */
 @NonNullByDefault
 public class SpotAreaCleaningCommand extends AbstractAreaCleaningCommand {
-    public SpotAreaCleaningCommand(List<String> roomIds, int cleanPasses) {
-        super("spotArea", String.join(",", roomIds), cleanPasses);
+    public SpotAreaCleaningCommand(List<String> roomIds, int cleanPasses, boolean usesFreeClean) {
+        super(usesFreeClean ? "freeClean" : "spotArea", prepareRoomIds(roomIds, usesFreeClean), cleanPasses);
+    }
+
+    private static String prepareRoomIds(List<String> roomIds, boolean usesFreeClean) {
+        String prefix = usesFreeClean ? "1," : "";
+        String separator = usesFreeClean ? ";" : ",";
+        return prefix + String.join(separator, roomIds);
     }
 }
diff --git a/...ecovacs/src/main/java/org/openhab/binding/ecovacs/internal/api/impl/JsonReportParser.java b/...ecovacs/src/main/java/org/openhab/binding/ecovacs/internal/api/impl/JsonReportParser.java
@@ -109,8 +109,12 @@ public void handleMessage(String eventName, String payload) throws DataParsingEx
             }
             case "error": {
                 ErrorReport report = payloadAs(response, ErrorReport.class);
-                for (Integer code : report.errorCodes) {
-                    listener.onErrorReported(device, code);
+                if (report.errorCodes.isEmpty()) {
+                    listener.onErrorReported(device, 0);
+                } else {
+                    for (Integer code : report.errorCodes) {
+                        listener.onErrorReported(device, code);
+                    }
                 }
             }
             case "stats": {

diff --git a/...nding.ecovacs/src/main/java/org/openhab/binding/ecovacs/internal/api/model/CleanMode.java b/...nding.ecovacs/src/main/java/org/openhab/binding/ecovacs/internal/api/model/CleanMode.java
@@ -27,7 +27,7 @@ public enum CleanMode {
     EDGE,
     @SerializedName("spot")
     SPOT,
-    @SerializedName(value = "SpotArea", alternate = { "spotArea" })
+    @SerializedName(value = "SpotArea", alternate = { "spotArea", "freeClean" })
     SPOT_AREA,
     @SerializedName(value = "CustomArea", alternate = { "customArea" })
     CUSTOM_AREA,

diff --git a/...covacs/src/main/java/org/openhab/binding/ecovacs/internal/api/model/DeviceCapability.java b/...covacs/src/main/java/org/openhab/binding/ecovacs/internal/api/model/DeviceCapability.java
@@ -29,6 +29,8 @@ public enum DeviceCapability {
     VOICE_REPORTING,
     @SerializedName("spot_area_cleaning")
     SPOT_AREA_CLEANING,
+    @SerializedName("free_clean_command")
+    FREE_CLEAN_FOR_SPOT_AREA,
     @SerializedName("custom_area_cleaning")
     CUSTOM_AREA_CLEANING,
     @SerializedName("single_room_cleaning")

diff --git a/...vacs/src/main/java/org/openhab/binding/ecovacs/internal/handler/EcovacsVacuumHandler.java b/...vacs/src/main/java/org/openhab/binding/ecovacs/internal/handler/EcovacsVacuumHandler.java
@@ -761,7 +761,8 @@ private State stringToState(@Nullable String value) {
                     }
                 }
                 if (!roomIds.isEmpty()) {
-                    return new SpotAreaCleaningCommand(roomIds, passes);
+                    return new SpotAreaCleaningCommand(roomIds, passes,
+                            device.hasCapability(DeviceCapability.FREE_CLEAN_FOR_SPOT_AREA));
                 }
             } else {
                 logger.info("{}: spotArea command needs to have the form spotArea:<room1>[;<room2>][;<...roomX>][:x2]",

diff --git a/bundles/org.openhab.binding.ecovacs/src/main/resources/devices/supported_device_list.json b/bundles/org.openhab.binding.ecovacs/src/main/resources/devices/supported_device_list.json
@@ -557,5 +557,41 @@
         "modelName": "DEEBOT U2 SE",
         "deviceClass": "zjna8m",
         "deviceClassLink": "ipzjy0"
+    },
+
+    {
+        "modelName": "DEEBOT X2",
+        "deviceClass": "e6ofmn",
+        "protoVersion": "json_v2",
+        "usesMqtt": true,
+        "capabilities": [
+            "mopping_system",
+            "main_brush",
+            "spot_area_cleaning",
+            "free_clean_command",
+            "custom_area_cleaning",
+            "clean_speed_control",
+            "voice_reporting",
+            "read_network_info",
+            "unit_care_lifespan",
+            "true_detect_3d",
+            "mapping",
+            "auto_empty_station"
+        ]
+    },
+    {
+        "modelName": "DEEBOT X2 OMNI",
+        "deviceClass": "lf3bn4",
+        "deviceClassLink": "e6ofmn"
+    },
+    {
+        "modelName": "DEEBOT X2 COMBO",
+        "deviceClass": "e6rcnf",
+        "deviceClassLink": "e6ofmn"
+    },
+    {
+        "modelName": "DEEBOT X2 PRO OMNI",
+        "deviceClass": "ip3mmy",
+        "deviceClassLink": "e6ofmn"
     }
 ]