feat: remove cloud calls and add UDP handshake

Author: matchews

bundles/org.openhab.binding.haywardomnilogiclocal/src/main/java/org/openhab/binding/haywardomnilogiclocal/internal/handler/HaywardBridgeHandler.java

@@ -109,11 +109,9 @@ public void initialize() {
             try {
                 scheduledInitialize();
             } catch (UnknownHostException e) {
-                // TODO Auto-generated catch block
-                e.printStackTrace();
+                logger.error("Initialization failed", e);
             }
         }, 1, TimeUnit.SECONDS);
-        return;
     }
 
     public void scheduledInitialize() throws UnknownHostException {
@@ -124,54 +122,21 @@ public void scheduledInitialize() throws UnknownHostException {
             clearPolling(pollTelemetryFuture);
             clearPolling(pollAlarmsFuture);
 
-            if (!(login())) {
+            if (!handshake()) {
                 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR,
-                        "Unable to Login to Hayward's server");
+                        "Unable to complete UDP handshake");
                 clearPolling(pollTelemetryFuture);
                 clearPolling(pollAlarmsFuture);
                 commFailureCount = 50;
                 initPolling(60);
                 return;
             }
 
-            if (!(getSiteList())) {
-                updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR,
-                        "Unable to getMSP from Hayward's server");
-                clearPolling(pollTelemetryFuture);
-                clearPolling(pollAlarmsFuture);
-                commFailureCount = 50;
-                initPolling(60);
-                return;
-            }
-
-            if (!(mspConfigUnits())) {
-                updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR,
-                        "Unable to getMSPConfigUnits from Hayward's server");
-                clearPolling(pollTelemetryFuture);
-                clearPolling(pollAlarmsFuture);
-                commFailureCount = 50;
-                initPolling(60);
-                return;
-            }
-
-            if (logger.isTraceEnabled()) {
-                if (!(getApiDef())) {
-                    updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.COMMUNICATION_ERROR,
-                            "Unable to getApiDef from Hayward's server");
-                    clearPolling(pollTelemetryFuture);
-                    clearPolling(pollAlarmsFuture);
-                    commFailureCount = 50;
-                    initPolling(60);
-                    return;
-                }
-            }
-
             if (this.thing.getStatus() != ThingStatus.ONLINE) {
                 updateStatus(ThingStatus.ONLINE);
             }
 
-            logger.debug("Succesfully opened connection to Hayward's server: {} Username:{}", config.endpointUrl,
-                    config.username);
+            logger.debug("Successfully opened connection to Hayward controller: {}", config.endpointUrl);
 
             initPolling(0);
             logger.trace("Hayward Telemetry polling scheduled");
@@ -186,145 +151,24 @@ public void scheduledInitialize() throws UnknownHostException {
             clearPolling(pollAlarmsFuture);
             commFailureCount = 50;
             initPolling(60);
-            return;
-        } catch (InterruptedException e) {
-            return;
-        }
-    }
-
-    public synchronized boolean login() throws HaywardException {
-        String xmlRequest = "<?xml version=\"1.0\" encoding=\"utf-8\"?><Request><Name>Login</Name><Parameters>"
-                + "<Parameter name=\"UserName\" dataType=\"String\">" + config.username + "</Parameter>"
-                + "<Parameter name=\"Password\" dataType=\"String\">" + config.password + "</Parameter>"
-                + "</Parameters></Request>";
-
-        String xmlResponse = udpXmlResponse(xmlRequest, MSG_TYPE_REQUEST);
-
-        if (xmlResponse.isEmpty()) {
-            logger.debug("Hayward Connection thing: Login XML response was null");
-            return false;
-        }
-
-        String status = evaluateXPath("/Response/Parameters//Parameter[@name='Status']/text()", xmlResponse).get(0);
-
-        if (!("0".equals(status))) {
-            logger.debug("Hayward Connection thing: Login XML response: {}", xmlResponse);
-            return false;
-        }
-
-        account.token = evaluateXPath("/Response/Parameters//Parameter[@name='Token']/text()", xmlResponse).get(0);
-        account.userID = evaluateXPath("/Response/Parameters//Parameter[@name='UserID']/text()", xmlResponse).get(0);
-        return true;
-    }
-
-
-    public synchronized boolean getApiDef() throws HaywardException, InterruptedException {
-        String xmlResponse;
-
-        // *****getApiDef from Hayward server
-        String urlParameters = """
-                <?xml version="1.0" encoding="utf-8"?><Request><Name>GetAPIDef</Name><Parameters>\
-                <Parameter name="Token" dataType="String">\
-                """ + account.token + "</Parameter>" + "<Parameter name=\"MspSystemID\" dataType=\"int\">"
-                + account.mspSystemID + "</Parameter>;"
-                + "<Parameter name=\"Version\" dataType=\"string\">0.4</Parameter >\r\n"
-                + "<Parameter name=\"Language\" dataType=\"string\">en</Parameter >\r\n"
-                + "</Parameters></GetTelemetry>";
-
-        xmlResponse = udpXmlResponse(urlParameters, MSG_TYPE_REQUEST);
-
-        if (xmlResponse.isEmpty()) {
-            logger.debug("Hayward Connection thing: getApiDef XML response was null");
-            return false;
         }
-        return true;
     }
 
-    public synchronized boolean getSiteList() throws HaywardException, InterruptedException {
-        String xmlResponse;
-        String status;
-
-        // *****Get MSP
-        String urlParameters = """
-                <?xml version="1.0" encoding="utf-8"?><Request><Name>GetSiteList</Name><Parameters>\
-                <Parameter name="Token" dataType="String">\
-                """ + account.token + "</Parameter><Parameter name=\"UserID\" dataType=\"String\">" + account.userID
-                + "</Parameter></Parameters></GetTelemetry>";
-
-        xmlResponse = udpXmlResponse(urlParameters, MSG_TYPE_REQUEST);
-
-        if (xmlResponse.isEmpty()) {
-            logger.debug("Hayward Connection thing: getSiteList XML response was null");
-            return false;
-        }
-
-        status = evaluateXPath("/Response/Parameters//Parameter[@name='Status']/text()", xmlResponse).get(0);
-
-        if (!("0".equals(status))) {
-            logger.debug("Hayward Connection thing: getSiteList XML response: {}", xmlResponse);
-            return false;
-        }
-
-        account.mspSystemID = evaluateXPath("/Response/Parameters/Parameter/Item//Property[@name='MspSystemID']/text()",
-                xmlResponse).get(0);
-        account.backyardName = evaluateXPath(
-                "/Response/Parameters/Parameter/Item//Property[@name='BackyardName']/text()", xmlResponse).get(0);
-        account.address = evaluateXPath("/Response/Parameters/Parameter/Item//Property[@name='Address']/text()",
-                xmlResponse).get(0);
-        return true;
-    }
 
-    public synchronized String getMspConfig() throws HaywardException, InterruptedException {
-        // *****getMspConfig from Hayward server
-        String urlParameters = """
-                <?xml version="1.0" encoding="utf-8"?><Request><Name>GetMspConfigFile</Name><Parameters>\
-                <Parameter name="Token" dataType="String">\
-                """ + account.token + "</Parameter>" + "<Parameter name=\"MspSystemID\" dataType=\"int\">"
-                + account.mspSystemID + "</Parameter><Parameter name=\"Version\" dataType=\"string\">0</Parameter>\r\n"
-                + "</Parameters></GetTelemetry>";
+    private synchronized boolean handshake() throws HaywardException {
+        String xmlRequest = "<?xml version=\"1.0\" encoding=\"utf-8\"?><Request><Name>Ping</Name><Parameters/></Request>";
 
-        String xmlResponse = udpXmlResponse(urlParameters, MSG_TYPE_REQUEST);
+        String xmlResponse = udpXmlResponse(xmlRequest, MSG_TYPE_REQUEST);
 
         if (xmlResponse.isEmpty()) {
-            logger.debug("Hayward Connection thing: getMSPConfig XML response was null");
-            return "Fail";
-        }
-
-        if (evaluateXPath("//Backyard/Name/text()", xmlResponse).isEmpty()) {
-            logger.debug("Hayward Connection thing: getMSPConfig XML response: {}", xmlResponse);
-            return "Fail";
-        }
-        return xmlResponse;
-    }
-
-    public synchronized boolean mspConfigUnits() throws HaywardException, InterruptedException {
-        List<String> property1 = new ArrayList<>();
-        List<String> property2 = new ArrayList<>();
-
-        String xmlResponse = getMspConfig();
-
-        if (xmlResponse.contentEquals("Fail")) {
+            logger.debug("Hayward Connection thing: Handshake XML response was null");
             return false;
         }
-
-        // Get Units (Standard, Metric)
-        property1 = evaluateXPath("//System/Units/text()", xmlResponse);
-        account.units = property1.get(0);
-
-        // Get Variable Speed Pump Units (percent, RPM)
-        property2 = evaluateXPath("//System/Msp-Vsp-Speed-Format/text()", xmlResponse);
-        account.vspSpeedFormat = property2.get(0);
-
         return true;
     }
 
-    public synchronized boolean getTelemetryData() throws HaywardException, InterruptedException {
-        // *****getTelemetry from Hayward server
-        String urlParameters = """
-                <?xml version="1.0" encoding="utf-8"?><Request><Name>GetTelemetryData</Name><Parameters>\
-                <Parameter name="Token" dataType="String">\
-                """ + account.token + "</Parameter>" + "<Parameter name=\"MspSystemID\" dataType=\"int\">"
-                + account.mspSystemID + "</Parameter></Parameters></GetTelemetry>";
+    public synchronized boolean getTelemetryData() throws HaywardException {
+        String urlParameters = "<?xml version=\"1.0\" encoding=\"utf-8\"?><Request><Name>GetTelemetryData</Name><Parameters/></Request>";
 
         String xmlResponse = udpXmlResponse(urlParameters, MSG_TYPE_TELEMETRY);
 
@@ -349,6 +193,7 @@ public synchronized boolean getTelemetryData() throws HaywardException, Interrup
         return true;
     }
 
+
     public synchronized boolean getAlarmList() throws HaywardException {
         for (Thing thing : getThing().getThings()) {
             Map<String, String> properties = thing.getProperties();
@@ -382,11 +227,8 @@ private synchronized void initPolling(int initalDelay) {
                 updateStatus(ThingStatus.ONLINE);
             } catch (HaywardException e) {
                 logger.debug("Hayward Connection thing: Exception during poll: {}", e.getMessage());
-            } catch (InterruptedException e) {
-                return;
             }
         }, initalDelay, config.telemetryPollTime, TimeUnit.SECONDS);
-        return;
     }
 
     private synchronized void initAlarmPolling(int initalDelay) {