homebridge-nuheat2 1.2.5 → 1.2.6

package/CHANGELOG.md

@@ -4,6 +4,17 @@ All notable changes to this project should be documented in this file
 
 ## [Unreleased]
 
+## [1.2.6] - 2026-04-11
+
+### Added
+
+- Add an `enableNotifications` config option so SignalR can be disabled during troubleshooting
+
+### Changed
+
+- Skip group setup and refresh calls unless away-mode groups are actually configured
+- Improve Nuheat API error logging with request method, endpoint, status code, and response snippets
+
 ## [1.2.5] - 2026-04-11
 
 ### Changed

package/config.schema.json

@@ -95,12 +95,17 @@
         "placeholder": 60,
         "minimum": 1
       },
-      "debug": {
-        "title": "Enable debug logs",
-        "type": "boolean"
-      }
-    }
-  },
+      "debug": {
+        "title": "Enable debug logs",
+        "type": "boolean"
+      },
+      "enableNotifications": {
+        "title": "Enable Nuheat notifications (SignalR)",
+        "type": "boolean",
+        "description": "Disable this to use REST polling only while troubleshooting notification or API issues."
+      }
+    }
+  },
   "form": null,
   "display": null
 }

package/index.js

@@ -21,7 +21,7 @@ module.exports = function (homebridge) {
   homebridge.registerPlatform(PLUGIN_NAME, PLATFORM_NAME, NuHeatPlatform, true);
 };
 
-class NuHeatPlatform {
+class NuHeatPlatform {
   constructor(log, config, api) {
     if (!config) {
       log.warn("Ignoring NuHeat Platform setup because it is not configured");
@@ -39,10 +39,10 @@ class NuHeatPlatform {
 
     this.config = config;
     this.config.email = this.config.Email || this.config.email;
-    this.config.holdLength = Math.min(
-      1440,
-      Math.max(0, this.config.holdLength || 1440),
-    );
+    this.config.holdLength = Math.min(
+      1440,
+      Math.max(0, this.config.holdLength || 1440),
+    );
     this.api = api;
     this.accessories = [];
     this.log = new logger.Logger(log, this.config.debug || false);
@@ -63,11 +63,27 @@ class NuHeatPlatform {
     }
   }
 
-  configureAccessory(accessory) {
-    this.accessories.push({ uuid: accessory.UUID, accessory });
-  }
-
-  async setupPlatform() {
+  configureAccessory(accessory) {
+    this.accessories.push({ uuid: accessory.UUID, accessory });
+  }
+
+  getConfiguredGroups() {
+    return (this.config.groups || []).filter(
+      (group) =>
+        group &&
+        typeof group.groupName === "string" &&
+        group.groupName.trim().length > 0,
+    );
+  }
+
+  shouldManageGroups() {
+    return (
+      this.config.autoPopulateAwayModeSwitches ||
+      this.getConfiguredGroups().length > 0
+    );
+  }
+
+  async setupPlatform() {
     if (this.disabled) {
       return;
     }
@@ -98,15 +114,19 @@ class NuHeatPlatform {
         clearInterval(this.refreshTimer);
       }
 
-      this.refreshTimer = setInterval(
-        this.refreshAccessories.bind(this),
-        (this.config.refresh || 60) * 1000,
-      );
-
-      if (!this.NuHeatListener) {
-        this.NuHeatListener = new NuHeatListener(this.NuHeatAPI, this);
-        this.NuHeatListener.connect();
-      }
+      this.refreshTimer = setInterval(
+        this.refreshAccessories.bind(this),
+        (this.config.refresh || 60) * 1000,
+      );
+
+      if (this.config.enableNotifications === false) {
+        this.log.info(
+          "NuHeat notifications are disabled. Using REST polling only.",
+        );
+      } else if (!this.NuHeatListener) {
+        this.NuHeatListener = new NuHeatListener(this.NuHeatAPI, this);
+        this.NuHeatListener.connect();
+      }
     } else {
       this.log.error(
         "Unable to acquire an access token. We will try again later.",
@@ -118,11 +138,11 @@ class NuHeatPlatform {
     }
   }
 
-  async setupGroups() {
-    const groupArray = this.config.groups || [];
-    if (!(this.config.autoPopulateAwayModeSwitches || groupArray.length > 0)) {
-      return;
-    }
+  async setupGroups() {
+    const groupArray = this.getConfiguredGroups();
+    if (!this.shouldManageGroups()) {
+      return;
+    }
 
     const response = await this.NuHeatAPI.refreshGroups();
     if (!response) {
@@ -317,14 +337,20 @@ class NuHeatPlatform {
     });
   }
 
-  async refreshAccessories() {
-    await this.refreshGroups();
-    await this.refreshThermostats();
-  }
-
-  async refreshGroups() {
-    this.log.debug("Trying to refresh groups.");
-    const response = await this.NuHeatAPI.refreshGroups();
+  async refreshAccessories() {
+    if (this.shouldManageGroups()) {
+      await this.refreshGroups();
+    }
+    await this.refreshThermostats();
+  }
+
+  async refreshGroups() {
+    if (!this.shouldManageGroups()) {
+      return true;
+    }
+
+    this.log.debug("Trying to refresh groups.");
+    const response = await this.NuHeatAPI.refreshGroups();
 
     if (!response) {
       this.log.error("Error getting data from NuHeatAPI in group refresh");

package/lib/NuHeatAPI.js

@@ -24,7 +24,7 @@ const {
   normalizeThermostat,
 } = require("./NuHeatModels");
 
-module.exports = class NuHeatAPI {
+module.exports = class NuHeatAPI {
   constructor(email, password, log, options = {}) {
     this.email = email;
     this.password = password;
@@ -290,7 +290,7 @@ module.exports = class NuHeatAPI {
     );
   }
 
-  async makeAPICall(callURL, callOptions = {}, options = {}) {
+  async makeAPICall(callURL, callOptions = {}, options = {}) {
     // Validate and potentially refresh our access token.
     if (!(await this.refreshAccessToken())) {
       return false;
@@ -318,8 +318,25 @@ module.exports = class NuHeatAPI {
       return options.normalize(returnedData);
     }
 
-    return returnedData;
-  }
+    return returnedData;
+  }
+
+  describeRequest(url, options = {}) {
+    return (options.method || "GET") + " " + url;
+  }
+
+  async readResponseBody(response) {
+    try {
+      const responseText = await response.text();
+      if (!responseText) {
+        return "";
+      }
+
+      return responseText.replace(/\s+/g, " ").trim().slice(0, 300);
+    } catch {
+      return "";
+    }
+  }
 
   // Retrieve the NuHeat OAuth authorization page to prepare to login.
   async oauthGetAuthPage() {
@@ -760,51 +777,67 @@ module.exports = class NuHeatAPI {
   }
 
   // Utility to let us streamline error handling and return checking from the NuHeat API.
-  async fetch(url, options = {}, decodeResponse = true, isRetry = false) {
+  async fetch(url, options = {}, decodeResponse = true, isRetry = false) {
     // Set our headers.
     if (!options.headers) {
       options.headers = this.headers;
-    }
-    try {
-      let response = await fetch(url, options);
-      // The caller will sort through responses instead of us.
-      if (!decodeResponse) {
-        return response;
-      }
-      // Bad form data submitted.
-      if (response.status === 400) {
-        this.log.error(
-          "NuHeatAPI: Invalid call. Data submitted doesn't seem right",
-        );
-        return null;
-        // Bad username and password.
-      } else if (response.status === 401) {
-        this.log.error(
-          "NuHeatAPI: Invalid NuHeat credentials given. Check your login and password.",
-        );
-        return null;
-        // Error on the NuHeat side.
-      } else if (response.status === 500) {
-        this.log.error("NuHeatAPI: NuHeat had an internal server error.");
-        if (isRetry) {
-          return null;
-        } else {
-          this.log.error("NuHeatAPI: Trying again.");
-          return this.fetch(url, options, decodeResponse, true);
-        }
-      }
-      // Some other unknown error occurred.
-      if (!response.ok && !isRedirect(response.status)) {
-        this.log.error(
-          "NuHeatAPI: " +
-            url +
-            " Error: " +
-            response.status +
-            " " +
-            response.statusText,
-        );
-        return null;
-      }
+    }
+    try {
+      const requestDescription = this.describeRequest(url, options);
+      let response = await fetch(url, options);
+      // The caller will sort through responses instead of us.
+      if (!decodeResponse) {
+        return response;
+      }
+      // Bad form data submitted.
+      if (response.status === 400) {
+        const responseBody = await this.readResponseBody(response);
+        this.log.error(
+          "NuHeatAPI: " +
+            requestDescription +
+            " failed with 400 Bad Request." +
+            (responseBody ? " Response body: " + responseBody : ""),
+        );
+        return null;
+        // Bad username and password.
+      } else if (response.status === 401) {
+        this.log.error(
+          "NuHeatAPI: " +
+            requestDescription +
+            " failed with 401 Unauthorized. Check your NuHeat credentials.",
+        );
+        return null;
+        // Error on the NuHeat side.
+      } else if (response.status === 500) {
+        const responseBody = await this.readResponseBody(response);
+        this.log.error(
+          "NuHeatAPI: " +
+            requestDescription +
+            " failed with 500 Internal Server Error." +
+            (responseBody ? " Response body: " + responseBody : ""),
+        );
+        if (isRetry) {
+          return null;
+        } else {
+          this.log.error("NuHeatAPI: Trying again.");
+          return this.fetch(url, options, decodeResponse, true);
+        }
+      }
+      // Some other unknown error occurred.
+      if (!response.ok && !isRedirect(response.status)) {
+        const responseBody = await this.readResponseBody(response);
+        this.log.error(
+          "NuHeatAPI: " +
+            requestDescription +
+            " failed with " +
+            response.status +
+            " " +
+            response.statusText +
+            "." +
+            (responseBody ? " Response body: " + responseBody : ""),
+        );
+        return null;
+      }
       return response;
     } catch (error) {
       if (error instanceof FetchError) {
@@ -812,16 +845,20 @@ module.exports = class NuHeatAPI {
           case "ECONNREFUSED":
             this.log.error("NuHeatAPI: Connection refused.");
             break;
-          case "ECONNRESET":
-            // Retry on connection reset, but no more than once.
-            if (!isRetry) {
-              this.log.debug(
-                "NuHeatAPI: Connection has been reset. Retrying the API action.",
-              );
-              return this.fetch(url, options, decodeResponse, true);
-            }
-            this.log.error("NuHeatAPI: Connection has been reset.");
-            break;
+          case "ECONNRESET":
+            // Retry on connection reset, but no more than once.
+            if (!isRetry) {
+              this.log.debug(
+                "NuHeatAPI: Connection reset during " +
+                  requestDescription +
+                  ". Retrying the API action.",
+              );
+              return this.fetch(url, options, decodeResponse, true);
+            }
+            this.log.error(
+              "NuHeatAPI: Connection reset during " + requestDescription + ".",
+            );
+            break;
           case "ENOTFOUND":
             this.log.error("NuHeatAPI: Hostname or IP address not found.");
             break;
@@ -830,14 +867,21 @@ module.exports = class NuHeatAPI {
               "NuHeatAPI: Unable to verify the NuHeat TLS security certificate.",
             );
             break;
-          default:
-            this.log.error(error.message);
-        }
-      } else {
-        this.log.error("Unknown fetch error: " + error);
-      }
-      return null;
-    }
+          default:
+            this.log.error(
+              "NuHeatAPI: " +
+                requestDescription +
+                " failed: " +
+                error.message,
+            );
+        }
+      } else {
+        this.log.error(
+          "NuHeatAPI: " + requestDescription + " failed with error: " + error,
+        );
+      }
+      return null;
+    }
   }
 
   trimSetCookie(setCookie) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "homebridge-nuheat2",
-  "version": "1.2.5",
+  "version": "1.2.6",
   "description": "Homebridge Platform for NuHeat Signature Thermostats",
   "main": "index.js",
   "scripts": {