homebridge-navilink 0.1.2 → 0.1.3

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.1.3](https://github.com/tbaur/homebridge-navilink/compare/v0.1.2...v0.1.3) (2026-09-20)
+
+
+### Bug Fixes
+
+* use a diagnostics slider and name the mqtt channel ([#8](https://github.com/tbaur/homebridge-navilink/issues/8)) ([324d700](https://github.com/tbaur/homebridge-navilink/commit/324d7006dda002ad0469599012c67222558aae53))
+
 ## [0.1.2](https://github.com/tbaur/homebridge-navilink/compare/v0.1.1...v0.1.2) (2026-09-20)
 
 

package/config.schema.json

@@ -60,6 +60,9 @@
             "default": 0,
             "minimum": 0,
             "maximum": 3600,
+            "x-schema-form": {
+              "type": "number"
+            },
             "description": "Emit a plugin health line to the Homebridge log every N seconds. 0 is off (the default). Allowed range 0–3600; values between 1 and 29 are clamped up to 30. Logs only; nothing is exposed in HomeKit."
           },
           "structuredLogs": {

package/dist/diagnostics/format.d.ts

@@ -15,7 +15,7 @@ export declare function diagnosticLabel(msg: string): string;
 export declare function formatReasons(reasons: string[]): string;
 /**
  * Concise summary matching the sibling plugins:
- * `Health: healthy | devices 1/1 | mqtt live | api p50 12ms p95 40ms (req 3, err 0)`.
+ * `Health: healthy | devices 1/1 | Publish-subscribe (mqtt) live | api p50 12ms p95 40ms (req 3, err 0)`.
  */
 export declare function formatDiagnosticLine(report: DiagnosticsSnapshot): string;
 /** State-only line for a healthy/degraded flip. The heartbeat already has the body. */

package/dist/diagnostics/format.js

@@ -13,6 +13,7 @@ exports.diagnosticLabel = diagnosticLabel;
 exports.formatReasons = formatReasons;
 exports.formatDiagnosticLine = formatDiagnosticLine;
 exports.formatHealthTransitionLine = formatHealthTransitionLine;
+const labels_1 = require("../utils/labels");
 /** Short operator-facing label for the MQTT session lifecycle. */
 function formatMqttTransportState(state) {
     switch (state) {
@@ -52,14 +53,14 @@ function formatReasons(reasons) {
 }
 /**
  * Concise summary matching the sibling plugins:
- * `Health: healthy | devices 1/1 | mqtt live | api p50 12ms p95 40ms (req 3, err 0)`.
+ * `Health: healthy | devices 1/1 | Publish-subscribe (mqtt) live | api p50 12ms p95 40ms (req 3, err 0)`.
  */
 function formatDiagnosticLine(report) {
     const { lifecycle, devices, transport, api } = report;
     return [
         `${diagnosticLabel(report.msg)}: ${lifecycle.health}${formatReasons(lifecycle.reasons)}`,
         `devices ${devices.online}/${devices.total}`,
-        `mqtt ${formatMqttTransportState(transport.mqttState)}`,
+        `${labels_1.MQTT_CHANNEL} ${formatMqttTransportState(transport.mqttState)}`,
         `api p50 ${api.p50Ms}ms p95 ${api.p95Ms}ms (req ${api.requests}, err ${api.errors})`,
     ].join(' | ');
 }

package/dist/platform.js

@@ -347,7 +347,7 @@ class NaviLinkPlatform {
         }
         this.cloudOffline = false;
         this.lastOutageWarnAt = 0;
-        this.log.info('mqtt recovered');
+        this.log.info(`${utils_1.MQTT_CHANNEL} recovered`);
     }
     // --- AccessoryHost ----------------------------------------------------------
     deviceFor(deviceId) {

package/dist/session.d.ts

@@ -107,7 +107,7 @@ export declare class NaviLinkSession {
     private readonly announcedFamilies;
     /** Firmware lines already announced at info, so a credential refresh is not a new event. */
     private readonly announcedFirmware;
-    /** True after the first `mqtt up` line, so a refresh is not a boot. */
+    /** True after the first `Publish-subscribe (mqtt) up` line, so a refresh is not a boot. */
     private liveAnnounced;
     /** True after an unexpected drop, so the next connect is a recovery. */
     private liveWasDown;

package/dist/session.js

@@ -80,7 +80,7 @@ class NaviLinkSession {
     announcedFamilies = new Set();
     /** Firmware lines already announced at info, so a credential refresh is not a new event. */
     announcedFirmware = new Set();
-    /** True after the first `mqtt up` line, so a refresh is not a boot. */
+    /** True after the first `Publish-subscribe (mqtt) up` line, so a refresh is not a boot. */
     liveAnnounced = false;
     /** True after an unexpected drop, so the next connect is a recovery. */
     liveWasDown = false;
@@ -416,19 +416,19 @@ class NaviLinkSession {
                 // A refused fallback must not look like an outage mid-establish.
                 connection.onClose((error) => this.handleConnectionClosed(connection, error));
                 if (!this.liveAnnounced || this.liveWasDown) {
-                    this.log.info('mqtt up');
+                    this.log.info(`${utils_1.MQTT_CHANNEL} up`);
                     this.liveAnnounced = true;
                     this.liveWasDown = false;
                 }
                 else {
-                    this.log.debug('mqtt up');
+                    this.log.debug(`${utils_1.MQTT_CHANNEL} up`);
                 }
                 return;
             }
             catch (error) {
                 lastError = error;
                 connection.close();
-                this.log.debug(`MQTT connect failed with host${signHostWithPort ? ':443' : ''} signature: `
+                this.log.debug(`${utils_1.MQTT_CHANNEL} connect failed with host${signHostWithPort ? ':443' : ''} signature: `
                     + (0, utils_1.describeError)(error));
             }
         }

package/dist/utils/labels.d.ts

@@ -11,6 +11,8 @@
  * with. Use the name the user gave the appliance. Fall back to a masked
  * gateway only when there is no name, and say that it is a gateway.
  */
+/** Operator-facing name for the MQTT live channel. */
+export declare const MQTT_CHANNEL = "Publish-subscribe (mqtt)";
 /** The appliance name, or `gateway …ABCD` when none is known. */
 export declare function labelAppliance(input: {
     name?: string;

package/dist/utils/labels.js

@@ -13,9 +13,12 @@
  * gateway only when there is no name, and say that it is a gateway.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.MQTT_CHANNEL = void 0;
 exports.labelAppliance = labelAppliance;
 const validators_1 = require("./validators");
 const redact_1 = require("./redact");
+/** Operator-facing name for the MQTT live channel. */
+exports.MQTT_CHANNEL = 'Publish-subscribe (mqtt)';
 /** The appliance name, or `gateway …ABCD` when none is known. */
 function labelAppliance(input) {
     const name = input.name?.trim();

package/docs/FEATURES.md

@@ -35,7 +35,7 @@ A checklist of what is built. The plugin aims to cover everything about a Navien
 - ✅ Read-only mode: every accessory reports state, and no control command is ever sent (`readOnly; write ignored`)
 - ✅ Power-off guard, on by default, because a combi's power state governs central heating as well as hot water (`power-off disabled (allowPowerOff is off)`)
 - ✅ Accessory name prefix (`options.accessoryPrefix`): one editable stem for every HomeKit tile, without changing accessory identity
-- ✅ Opt-in diagnostics (`options.diagnosticsInterval`, default 0 / off): a periodic heartbeat (`Health: healthy | devices n/n | mqtt live | api p50/p95 (req, err)`), with optional structured JSON (`options.structuredLogs`)
+- ✅ Opt-in diagnostics (`options.diagnosticsInterval`, default 0 / off): a periodic heartbeat (`Health: healthy | devices n/n | Publish-subscribe (mqtt) live | api p50/p95 (req, err)`), with optional structured JSON (`options.structuredLogs`)
 - ✅ Secrets redacted from every log line by shape, not by field name, so an unfamiliar response cannot leak a token
 - ✅ HomeKit serial numbers are opaque generated values, never the gateway MAC
 - ✅ Bounded I/O: separate connect and total timeouts, a capped response size, and a capped MQTT packet size

package/docs/README-DETAILED.md

@@ -106,7 +106,7 @@ An appliance with no probe reports `0`. The plugin treats that as absent, not as
 
 **Control is rate-limited, and the cloud's own limit is honoured.** Commands to one gateway are spaced out. When the cloud refuses one for arriving too soon, the log is `rate limited` and the plugin pauses for 30 seconds. It does not keep sending to a channel that is already refusing.
 
-**Backoff has jitter.** Reconnects use exponential backoff with full jitter to a capped ceiling, so a regional outage does not produce a synchronised stampede when it ends. A real drop logs the close, then `reconnect in Ns`, then `mqtt recovered` when the session is up again.
+**Backoff has jitter.** Reconnects use exponential backoff with full jitter to a capped ceiling, so a regional outage does not produce a synchronised stampede when it ends. A real drop logs the close, then `reconnect in Ns`, then `Publish-subscribe (mqtt) recovered` when the session is up again.
 
 ## Full configuration reference
 
@@ -198,7 +198,7 @@ Startup, in order:
 adding Boiler Hot Water
 adding Boiler Heating
 Boiler firmware 4352
-mqtt up
+Publish-subscribe (mqtt) up
 Boiler channel 1 family=NCB
 1 appliance(s), 8 accessory(ies)
 ```
@@ -228,13 +228,13 @@ An outage, and its recovery. Every outage warns on the way in so that it gets a
 ```
 NaviLink broker closed the connection (code 1006)
 reconnect in 2s
-mqtt up
-mqtt recovered
+Publish-subscribe (mqtt) up
+Publish-subscribe (mqtt) recovered
 ```
 
 A continuing outage repeats at most hourly, at debug in between.
 
-A credential refresh is not an outage. The plugin closes the socket itself a few minutes before the AWS credentials expire, signs in again, and the tiles stay current. That is debug only. `family=`, firmware and `mqtt up` do not repeat at info.
+A credential refresh is not an outage. The plugin closes the socket itself a few minutes before the AWS credentials expire, signs in again, and the tiles stay current. That is debug only. `family=`, firmware and `Publish-subscribe (mqtt) up` do not repeat at info.
 
 ### Diagnostics (optional)
 
@@ -243,7 +243,7 @@ Set `options.diagnosticsInterval` to a value between `30` and `3600` seconds to
 It pairs with `options.structuredLogs: true`, which adds a JSON line next to the human one.
 
 ```
-Health: healthy | devices 1/1 | mqtt live | api p50 80ms p95 120ms (req 3, err 0)
+Health: healthy | devices 1/1 | Publish-subscribe (mqtt) live | api p50 80ms p95 120ms (req 3, err 0)
 ```
 
 | `msg` | Level | When |

package/homebridge-ui/public/index.html

@@ -124,18 +124,14 @@
   </div>
 
   <div class="form-group mt-3 mb-2">
-    <label for="diagnostics-interval" style="font-size: .8rem;">Diagnostics</label>
-    <select class="form-control form-control-sm" id="diagnostics-interval">
-      <option value="0" selected>Off</option>
-      <option value="30">Every 30 seconds</option>
-      <option value="60">Every minute</option>
-      <option value="300">Every 5 minutes</option>
-      <option value="900">Every 15 minutes</option>
-      <option value="1800">Every 30 minutes</option>
-      <option value="3600">Every 60 minutes</option>
-    </select>
+    <label for="diagnostics-interval" style="font-size: .8rem;">
+      Diagnostics interval (seconds)
+      <span id="diagnostics-interval-value" class="float-right">0</span>
+    </label>
+    <input type="range" class="custom-range" id="diagnostics-interval"
+           min="0" max="3600" step="1" value="0" />
     <div class="nl-meta">
-      A health line in the Homebridge log. Off by default. Nothing is exposed in HomeKit.
+      A health line in the Homebridge log. 0 is off. Nothing is exposed in HomeKit.
     </div>
   </div>
   <div class="nl-options">

package/homebridge-ui/public/index.js

@@ -247,14 +247,17 @@
       ? platformConfig.options.accessoryPrefix
       : ''
     const diagnostics = Number(platformConfig.options.diagnosticsInterval) || 0
-    const diagnosticsSelect = byId('diagnostics-interval')
-    if (!Array.from(diagnosticsSelect.options).some((option) => Number(option.value) === diagnostics)) {
-      diagnosticsSelect.append(el('option', { value: String(diagnostics) }, `Every ${diagnostics} seconds`))
-    }
-    diagnosticsSelect.value = String(diagnostics)
+    byId('diagnostics-interval').value = String(diagnostics)
+    syncDiagnosticsLabel()
     byId('structured-logs').checked = platformConfig.options.structuredLogs === true
   }
 
+  /** Keep the slider's number in step with the thumb. 0 is Off. */
+  function syncDiagnosticsLabel() {
+    const seconds = Number(byId('diagnostics-interval').value) || 0
+    byId('diagnostics-interval-value').textContent = seconds === 0 ? 'Off' : String(seconds)
+  }
+
   /**
    * Fold the whole-install settings back into the configuration.
    *
@@ -501,7 +504,14 @@
   byId('accessory-prefix').addEventListener('input', () => changed())
   byId('read-only').addEventListener('change', () => changed())
   byId('allow-power-off').addEventListener('change', () => changed())
-  byId('diagnostics-interval').addEventListener('change', () => changed())
+  byId('diagnostics-interval').addEventListener('input', () => {
+    syncDiagnosticsLabel()
+    changed()
+  })
+  byId('diagnostics-interval').addEventListener('change', () => {
+    syncDiagnosticsLabel()
+    changed()
+  })
   byId('structured-logs').addEventListener('change', () => changed())
   byId('toggle-json').addEventListener('click', () => {
     schemaFormVisible = !schemaFormVisible

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "homebridge-navilink",
   "displayName": "Homebridge NaviLink",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Homebridge plugin for Navien combi boilers and water heaters through the North American NaviLink cloud: hot water and space-heating thermostats, power, recirculation, fault and temperature accessories. Verified on an NCB-240E (firmware 4352)",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",