[miio] change deviceID to Xiaomi used string (openhab#10951)

* [miio] change deviceID to Xiaomi used string Change the deviceId from the current hexadecimal to the string used by Xiaomi. This is needed as we have some devices that have deviceIds that are non-numeric, hence breaking the current logic. Note: separately removing the upnp discovery as this has become irrelevant with cloud discovery and devices supporting the udp regular discovery. Signed-off-by: Marcel Verpaalen <[email protected]> * Update bundles/org.openhab.binding.miio/src/main/java/org/openhab/binding/miio/internal/handler/MiIoAbstractHandler.java Signed-off-by: Fabian Wolter <[email protected]> Co-authored-by: Fabian Wolter <[email protected]>
computergeek1507 · Jul 13, 2021 · f0f299c · f0f299c
1 parent ba46248
commit f0f299c
Show file tree

Hide file tree

Showing 8 changed files with 73 additions and 199 deletions.
diff --git a/bundles/org.openhab.binding.miio/README.base.md b/bundles/org.openhab.binding.miio/README.base.md
@@ -76,7 +76,7 @@ However, for devices that are unsupported, you may override the value and try to
 |-----------------|---------|----------|---------------------------------------------------------------------|
 | host            | text    | true     | Device IP address                                                   |
 | token           | text    | true     | Token for communication (in Hex)                                    |
-| deviceId        | text    | true     | Device ID number for communication (in Hex)                         |
+| deviceId        | text    | true     | Device Id (typically a number for normal devices) for communication |
 | model           | text    | false    | Device model string, used to determine the subtype                  |
 | refreshInterval | integer | false    | Refresh interval for refreshing the data in seconds. (0=disabled)   |
 | timeout         | integer | false    | Timeout time in milliseconds                                        |
@@ -86,11 +86,11 @@ Note: Suggest to use the cloud communication only for devices that require it. I
 
 ### Example Thing file
 
-`Thing miio:basic:light "My Light" [ host="192.168.x.x", token="put here your token", deviceId="0326xxxx", model="philips.light.bulb", communication="direct"  ]` 
+`Thing miio:basic:light "My Light" [ host="192.168.x.x", token="put here your token", deviceId="326xxxx", model="philips.light.bulb", communication="direct" ]` 
 
 or in case of unknown models include the model information of a similar device that is supported:
 
-`Thing miio:vacuum:s50 "vacuum" @ "livingroom" [ host="192.168.15.20", token="xxxxxxx", deviceId=“0470DDAA”, model="roborock.vacuum.s4", communication="cloud"]`
+`Thing miio:vacuum:s50 "vacuum" @ "livingroom" [ host="192.168.15.20", token="xxxxxxx", deviceId="326xxxx", model="roborock.vacuum.s4", communication="direct" ]`
 
 # Advanced: Unsupported devices
 

diff --git a/bundles/org.openhab.binding.miio/README.md b/bundles/org.openhab.binding.miio/README.md
@@ -76,7 +76,7 @@ However, for devices that are unsupported, you may override the value and try to
 |-----------------|---------|----------|---------------------------------------------------------------------|
 | host            | text    | true     | Device IP address                                                   |
 | token           | text    | true     | Token for communication (in Hex)                                    |
-| deviceId        | text    | true     | Device ID number for communication (in Hex)                         |
+| deviceId        | text    | true     | Device Id (typically a number for normal devices) for communication |
 | model           | text    | false    | Device model string, used to determine the subtype                  |
 | refreshInterval | integer | false    | Refresh interval for refreshing the data in seconds. (0=disabled)   |
 | timeout         | integer | false    | Timeout time in milliseconds                                        |
@@ -86,11 +86,11 @@ Note: Suggest to use the cloud communication only for devices that require it. I
 
 ### Example Thing file
 
-`Thing miio:basic:light "My Light" [ host="192.168.x.x", token="put here your token", deviceId="0326xxxx", model="philips.light.bulb", communication="direct"  ]` 
+`Thing miio:basic:light "My Light" [ host="192.168.x.x", token="put here your token", deviceId="326xxxx", model="philips.light.bulb", communication="direct" ]` 
 
 or in case of unknown models include the model information of a similar device that is supported:
 
-`Thing miio:vacuum:s50 "vacuum" @ "livingroom" [ host="192.168.15.20", token="xxxxxxx", deviceId=“0470DDAA”, model="roborock.vacuum.s4", communication="cloud"]`
+`Thing miio:vacuum:s50 "vacuum" @ "livingroom" [ host="192.168.15.20", token="xxxxxxx", deviceId="326xxxx", model="roborock.vacuum.s4", communication="direct" ]`
 
 # Advanced: Unsupported devices
 

diff --git a/bundles/org.openhab.binding.miio/src/main/java/org/openhab/binding/miio/internal/Utils.java b/bundles/org.openhab.binding.miio/src/main/java/org/openhab/binding/miio/internal/Utils.java
@@ -127,4 +127,17 @@ public static String fromHEX(String value) {
         }
         return value;
     }
+
+    /**
+     * Formats the deviceId to a hex string if possible. Otherwise returns the id unmodified.
+     *
+     * @param did
+     * @return did
+     */
+    public static String getHexId(String did) {
+        if (!did.isBlank() && !did.contains(".")) {
+            return toHEX(did);
+        }
+        return did;
+    }
 }
diff --git a/...ab.binding.miio/src/main/java/org/openhab/binding/miio/internal/cloud/CloudConnector.java b/...ab.binding.miio/src/main/java/org/openhab/binding/miio/internal/cloud/CloudConnector.java
@@ -208,10 +208,9 @@ public List<CloudDeviceDTO> getDevicesList() {
         if (deviceListState != DeviceListState.AVAILABLE) {
             return null;
         }
-        String did = Long.toString(Long.parseUnsignedLong(id, 16));
         List<CloudDeviceDTO> devicedata = new ArrayList<>();
         for (CloudDeviceDTO deviceDetails : deviceList) {
-            if (deviceDetails.getDid().contentEquals(did)) {
+            if (deviceDetails.getDid().contentEquals(id)) {
                 devicedata.add(deviceDetails);
             }
         }

diff --git a/...binding.miio/src/main/java/org/openhab/binding/miio/internal/discovery/MiIoDiscovery.java b/...binding.miio/src/main/java/org/openhab/binding/miio/internal/discovery/MiIoDiscovery.java
@@ -184,7 +184,7 @@ private void cloudDiscovery() {
         if (cloudConnector.isConnected()) {
             List<CloudDeviceDTO> dv = cloudConnector.getDevicesList();
             for (CloudDeviceDTO device : dv) {
-                String id = Utils.toHEX(device.getDid());
+                String id = device.getDid();
                 if (cloudDiscoveryMode.contentEquals(SUPPORTED)) {
                     if (MiIoDevices.getType(device.getModel()).getThingType().equals(THING_TYPE_UNSUPPORTED)) {
                         logger.warn("Discovered from cloud, but ignored because not supported: {} {}", id, device);
@@ -194,7 +194,7 @@ private void cloudDiscovery() {
                     logger.debug("Discovered from cloud: {} {}", id, device);
                     cloudDevices.put(id, device.getLocalip());
                     String token = device.getToken();
-                    String label = device.getName() + " " + id + " (" + device.getDid() + ")";
+                    String label = device.getName() + " " + id + " (" + Utils.getHexId(id) + ")";
                     String country = device.getServer();
                     boolean isOnline = device.getIsOnline();
                     String ip = device.getLocalip();
@@ -210,8 +210,9 @@ private void discovered(String ip, byte[] response) {
         logger.trace("Discovery responses from : {}:{}", ip, Utils.getSpacedHex(response));
         Message msg = new Message(response);
         String token = Utils.getHex(msg.getChecksum());
-        String id = Utils.getHex(msg.getDeviceId());
-        String label = "Xiaomi Mi Device " + id + " (" + Utils.fromHEX(id) + ")";
+        String hexId = Utils.getHex(msg.getDeviceId());
+        String id = Utils.fromHEX(hexId);
+        String label = "Xiaomi Mi Device " + id + " (" + Utils.getHexId(id) + ")";
         String country = "";
         boolean isOnline = false;
         if (ip.equals(cloudDevices.get(id))) {
@@ -224,7 +225,7 @@ private void discovered(String ip, byte[] response) {
             if (cloudInfo != null) {
                 logger.debug("Cloud Info: {}", cloudInfo);
                 token = cloudInfo.getToken();
-                label = cloudInfo.getName() + " " + id + " (" + Utils.fromHEX(id) + ")";
+                label = cloudInfo.getName() + " " + id + " (" + Utils.getHexId(id) + ")";
                 country = cloudInfo.getServer();
                 isOnline = cloudInfo.getIsOnline();
             }
@@ -233,17 +234,17 @@ private void discovered(String ip, byte[] response) {
     }
 
     private void submitDiscovery(String ip, String token, String id, String label, String country, boolean isOnline) {
-        ThingUID uid = new ThingUID(THING_TYPE_MIIO, id.replace(".", "_"));
+        ThingUID uid = new ThingUID(THING_TYPE_MIIO, Utils.getHexId(id).replace(".", "_"));
         DiscoveryResultBuilder dr = DiscoveryResultBuilder.create(uid).withProperty(PROPERTY_HOST_IP, ip)
                 .withProperty(PROPERTY_DID, id);
         if (IGNORED_TOKENS.contains(token)) {
-            logger.debug("Discovered Mi Device {} ({}) at {} as {}", id, Utils.fromHEX(id), ip, uid);
+            logger.debug("Discovered Mi Device {} ({}) at {} as {}", id, Utils.getHexId(id), ip, uid);
             logger.debug(
                     "No token discovered for device {}. For options how to get the token, check the binding readme.",
                     id);
             dr = dr.withRepresentationProperty(PROPERTY_DID).withLabel(label);
         } else {
-            logger.debug("Discovered Mi Device {} ({}) at {} as {} with token {}", id, Utils.fromHEX(id), ip, uid,
+            logger.debug("Discovered Mi Device {} ({}) at {} as {} with token {}", id, Utils.getHexId(id), ip, uid,
                     token);
             dr = dr.withProperty(PROPERTY_TOKEN, token).withRepresentationProperty(PROPERTY_DID)
                     .withLabel(label + " with token");

diff --git a/...o/src/main/java/org/openhab/binding/miio/internal/discovery/MiIoDiscoveryParticipant.java b/...o/src/main/java/org/openhab/binding/miio/internal/discovery/MiIoDiscoveryParticipant.java