Introduce IPUtils for checking if IPAddresses are set or not (#231)

Author: rjwats

lib/framework/IPUtils.h

@@ -0,0 +1,18 @@
+#ifndef IPUtils_h
+#define IPUtils_h
+
+#include <IPAddress.h>
+
+const IPAddress IP_NOT_SET = IPAddress(INADDR_NONE);
+
+class IPUtils {
+ public:
+   static bool isSet(const IPAddress& ip) {
+    return ip != IP_NOT_SET;
+  }
+  static bool isNotSet(const IPAddress& ip) {
+    return ip == IP_NOT_SET;
+  }
+};
+
+#endif  // end IPUtils_h

lib/framework/JsonUtils.h

@@ -2,7 +2,7 @@
 #define JsonUtils_h
 
 #include <Arduino.h>
-#include <IPAddress.h>
+#include <IPUtils.h>
 #include <ArduinoJson.h>
 
 class JsonUtils {
@@ -20,7 +20,7 @@ class JsonUtils {
     }
   }
   static void writeIP(JsonObject& root, const String& key, const IPAddress& ip) {
-    if (ip != INADDR_NONE) {
+    if (IPUtils::isSet(ip)) {
       root[key] = ip.toString();
     }
   }

lib/framework/WiFiSettingsService.h

@@ -24,8 +24,6 @@
 
 #define WIFI_RECONNECTION_DELAY 1000 * 30
 
-const IPAddress IP_NOT_SET = IPAddress(INADDR_NONE);
-
 class WiFiSettings {
  public:
   // core wifi configuration
@@ -70,16 +68,16 @@ class WiFiSettings {
     JsonUtils::readIP(root, "dns_ip_2", settings.dnsIP2);
 
     // Swap around the dns servers if 2 is populated but 1 is not
-    if (settings.dnsIP1 == IP_NOT_SET && settings.dnsIP2 != IP_NOT_SET) {
+    if (IPUtils::isNotSet(settings.dnsIP1) && IPUtils::isSet(settings.dnsIP2)) {
       settings.dnsIP1 = settings.dnsIP2;
       settings.dnsIP2 = INADDR_NONE;
     }
 
     // Turning off static ip config if we don't meet the minimum requirements
     // of ipAddress, gateway and subnet. This may change to static ip only
     // as sensible defaults can be assumed for gateway and subnet
-    if (settings.staticIPConfig &&
-        (settings.localIP == IP_NOT_SET || settings.gatewayIP == IP_NOT_SET || settings.subnetMask == IP_NOT_SET)) {
+    if (settings.staticIPConfig && (IPUtils::isNotSet(settings.localIP) || IPUtils::isNotSet(settings.gatewayIP) ||
+                                    IPUtils::isNotSet(settings.subnetMask))) {
       settings.staticIPConfig = false;
     }
     return StateUpdateResult::CHANGED;

lib/framework/WiFiStatus.cpp

@@ -63,10 +63,10 @@ void WiFiStatus::wifiStatus(AsyncWebServerRequest* request) {
     root["gateway_ip"] = WiFi.gatewayIP().toString();
     IPAddress dnsIP1 = WiFi.dnsIP(0);
     IPAddress dnsIP2 = WiFi.dnsIP(1);
-    if (dnsIP1 != INADDR_NONE) {
+    if (IPUtils::isSet(dnsIP1)) {
       root["dns_ip_1"] = dnsIP1.toString();
     }
-    if (dnsIP2 != INADDR_NONE) {
+    if (IPUtils::isSet(dnsIP2)) {
       root["dns_ip_2"] = dnsIP2.toString();
     }
   }

lib/framework/WiFiStatus.h

@@ -12,7 +12,7 @@
 #include <ArduinoJson.h>
 #include <AsyncJson.h>
 #include <ESPAsyncWebServer.h>
-#include <IPAddress.h>
+#include <IPUtils.h>
 #include <SecurityManager.h>
 
 #define MAX_WIFI_STATUS_SIZE 1024