homebridge-navilink 0.1.0 → 0.1.2

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## [0.1.2](https://github.com/tbaur/homebridge-navilink/compare/v0.1.1...v0.1.2) (2026-09-20)
+
+
+### Features
+
+* add accessory name prefix and opt-in diagnostics ([#6](https://github.com/tbaur/homebridge-navilink/issues/6)) ([d18f3cd](https://github.com/tbaur/homebridge-navilink/commit/d18f3cd0890611e8ac596b182f01086a8149d5d7))
+
+## [0.1.1](https://github.com/tbaur/homebridge-navilink/compare/v0.1.0...v0.1.1) (2026-09-19)
+
+
+### Bug Fixes
+
+* align the version-bump table with release-please before 1.0 ([#2](https://github.com/tbaur/homebridge-navilink/issues/2)) ([b35aea7](https://github.com/tbaur/homebridge-navilink/commit/b35aea7c30fd23de88c0dd81d0a23119ee6fd20b))
+* drop the removed OSV --skip-git flag ([#4](https://github.com/tbaur/homebridge-navilink/issues/4)) ([655cf3b](https://github.com/tbaur/homebridge-navilink/commit/655cf3beededed5eafbd0ac0f7dc21e4c18c702a))
+* read FirmwareRevision from package.json in tests ([#5](https://github.com/tbaur/homebridge-navilink/issues/5)) ([d263493](https://github.com/tbaur/homebridge-navilink/commit/d2634938622739d1adf559bd0c099c0305be915d))
+
+## Changelog
+
 All notable changes to this project are documented here. This file is generated by
 [release-please](https://github.com/googleapis/release-please) from Conventional Commit
 messages; do not edit it by hand. See [RELEASING.md](RELEASING.md).

package/README.md

@@ -1,31 +1,29 @@
 # homebridge-navilink
 
-[![Tests](https://github.com/tbaur/homebridge-navilink/actions/workflows/test.yml/badge.svg)](https://github.com/tbaur/homebridge-navilink/actions/workflows/test.yml) [![npm version](https://img.shields.io/npm/v/homebridge-navilink?style=flat-square)](https://www.npmjs.com/package/homebridge-navilink) [![npm downloads](https://img.shields.io/npm/dt/homebridge-navilink?label=downloads&style=flat-square)](https://www.npmjs.com/package/homebridge-navilink) [![Node.js](https://img.shields.io/badge/node-22%20%7C%7C%2024%20%7C%7C%2026-green)](https://nodejs.org) [![Homebridge](https://img.shields.io/badge/homebridge-2.x-purple)](https://homebridge.io) [![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
+![Tests](https://github.com/tbaur/homebridge-navilink/actions/workflows/test.yml/badge.svg) ![npm version](https://img.shields.io/npm/v/homebridge-navilink?style=flat-square) ![npm downloads](https://img.shields.io/npm/dt/homebridge-navilink?label=downloads&style=flat-square) ![Node.js](https://img.shields.io/badge/node-22%20%7C%7C%2024%20%7C%7C%2026-green) ![Homebridge](https://img.shields.io/badge/homebridge-2.x-purple) ![License](https://img.shields.io/badge/license-Apache--2.0-blue)
 
 **Navien combi boilers and water heaters in Apple HomeKit.** Hot water and space-heating thermostats, recirculation, faults and temperature probes, with changes arriving as they happen rather than on a polling loop. Verified against an NCB-240E (firmware 4352).
 
 Scheduling, weekly programmes and commissioning stay in the NaviLink app, which does them properly. This plugin adds the tile, the scene, the automation and the spoken command. It also adds a fault sensor that tells you the boiler has stopped before the shower does.
 
-> **This plugin talks to Navien's cloud, not to your boiler.** There is no local API on a NaviLink gateway. It needs your NaviLink account. See [Supported devices](#supported-devices) and [Security](#security) before you install it.
-
 ## Features
 
 ### Per appliance
 
-- **Hot water thermostat:** the domestic hot water setpoint, reading the actual outlet temperature. Respects the range your installer set
-- **Heating thermostat:** the space-heating flow temperature. This is the boiler's water temperature, not a room thermostat. Your room thermostat still decides when heat is called for
-- **Power switch:** on and off, with switching *off* refused by default because it stops central heating too
-- **Recirculation switch:** starts the on-demand pump, so hot water reaches the tap without running it first. Only offered where a pump is fitted. The appliance runs the pump for a fixed period and then stops; the tile turns itself off when that happens
-- **Fault sensor:** a contact sensor that opens on an error code, so HomeKit can notify you. The code goes to the log
-- **Temperature sensors:** hot water in and out, heating flow and return, and the outdoor probe if one is fitted. Each disables itself if the appliance does not report it
+- **Hot water thermostat:** the domestic hot water setpoint, reading the actual outlet temperature
+- **Heating thermostat:** the space-heating flow temperature. This is the boiler's water temperature
+- **Power switch:** on and off, with switching *off* refused by default because it stops central heating
+- **Recirculation switch:** starts the on-demand pump, so hot water reaches the tap without running it first. Only offered where a pump is fitted.
+- **Fault sensor:** a contact sensor that opens and logs on an error code, so HomeKit can notify you
+- **Temperature sensors:** hot water in and out, heating flow and return, and the optional outdoor probe
 
 ### Reliability
 
 - **Push, not polling.** The gateway sends changes as they happen, so a setpoint changed at the wall controller or in the NaviLink app reaches HomeKit in about a second. The poll is only a backstop
 - **A rejected password is never retried.** Repeating a wrong password at a cloud is how an account gets locked. The plugin stops, says so once, and waits for you
-- **Credentials are renewed on a clock,** a few minutes before they expire, so the connection is not already dead in the middle of the night
-- **A connected socket is not a live appliance.** Readings carry the time they were taken, and a stale one becomes No Response instead of yesterday's setpoint
-- **Honest state:** No Response until the appliance has actually been read, never a value it cannot confirm
+- **Credentials are renewed on a clock,** a few minutes before they expire
+- **A connected socket is not a live appliance.** Readings carry the time they were taken, and a stale one becomes No Response instead
+- **State:** No Response until the appliance has actually been read, and not a value it cannot confirm
 - **Never loses your rooms:** a broken config disables the platform without unregistering anything
 
 ### Quality
@@ -91,19 +89,19 @@ Accessories appear in the Home app after restart, showing No Response for the fe
 
 Any Navien appliance that the NaviLink app controls. The cloud interface is the same for all of them; what differs is which capabilities an appliance reports.
 
-| Verified against | Notes |
-|---|---|
+| Verified against  | Notes                                             |
+| ----------------- | ------------------------------------------------- |
 | **NCB-240E (NG)** | Combi: hot water and space heating, firmware 4352 |
 
 Other families are decoded from the same table the NaviLink app uses and are expected to work, but nobody has confirmed them here:
 
-| Family | Expected |
-|---|---|
+| Family             | Expected                                                                       |
+| ------------------ | ------------------------------------------------------------------------------ |
 | **NPE, NPE2, NPN** | Tankless water heaters. Hot water only; the heating thermostat disables itself |
-| **NCB-H** | Combi with a buffer tank |
-| **NHB** | Boiler. Space heating only |
-| **NFB, NFC** | Boilers with hot water and space heating |
-| **NVW** | Water heater with a tank |
+| **NCB-H**          | Combi with a buffer tank                                                       |
+| **NHB**            | Boiler. Space heating only                                                     |
+| **NFB, NFC**       | Boilers with hot water and space heating                                       |
+| **NVW**            | Water heater with a tank                                                       |
 
 If yours is not listed, it will most likely work. Please open an issue with the output of `node scripts/capture-fixture.js --redact` either way, so the table can say so with confidence.
 
@@ -111,31 +109,34 @@ If yours is not listed, it will most likely work. Please open an issue with the
 
 Only one `NaviLink` platform block is supported. It can hold as many appliances as the account owns.
 
-| Option | Required to run | Description |
-|---|:-:|---|
-| `name` | ✓ | Plugin instance name shown in Homebridge logs |
-| `email` | ✓ | Your NaviLink account address. Needed before the plugin signs in |
-| `password` | ✓ | Your NaviLink password. Needed before the plugin signs in |
-| `devices` | ✓ | List of appliances. Needed before the plugin signs in |
-| `options.statusIntervalSec` | | Backstop refresh, 30–3600 seconds (default 120) |
-| `options.readOnly` | | Report everything, change nothing (default false) |
-| `options.allowPowerOff` | | Let HomeKit switch the appliance off (default false) |
+| Option                        | Required to run | Description                                                                     |
+| ----------------------------- | --------------- | ------------------------------------------------------------------------------- |
+| `name`                        | ✓               | Plugin instance name shown in Homebridge logs                                   |
+| `email`                       | ✓               | Your NaviLink account address. Needed before the plugin signs in                |
+| `password`                    | ✓               | Your NaviLink password. Needed before the plugin signs in                       |
+| `devices`                     | ✓               | List of appliances. Needed before the plugin signs in                           |
+| `options.statusIntervalSec`   |                 | Backstop refresh, 30–3600 seconds (default 120)                                 |
+| `options.readOnly`            |                 | Report everything, change nothing (default false)                               |
+| `options.allowPowerOff`       |                 | Let HomeKit switch the appliance off (default false)                            |
+| `options.diagnosticsInterval` |                 | Seconds between health lines in the log; `0` is off (default), else `30`–`3600` |
+| `options.structuredLogs`      |                 | With diagnostics, also emit a JSON line (default false)                         |
+| `options.accessoryPrefix`     |                 | Prefix for every HomeKit name. Blank uses each appliance's name                 |
 
 Each entry in `devices[]` takes `id` and `name`, plus an optional `channel` and one flag per accessory: `dhw`, `heating`, `power`, `recirculation`, `fault`, `temperatureSensors` and `outdoorSensor`. The [detailed documentation](docs/README-DETAILED.md#devices-entries) describes each one.
 
 ## Not Working?
 
 1. **"NaviLink rejected the email address or password."** Sign in to the NaviLink app with the same credentials. The plugin has stopped trying on purpose, so fix the password and restart Homebridge
-2. **Everything shows No Response.** Check the log for `the NaviLink platform is disabled`, which means the configuration could not be read
+2. **Everything shows No Response.** Check the log for `platform disabled`, which means the configuration could not be read
 3. **The heating thermostat says it has no loop.** Your appliance reports no space-heating circuit. Turn the accessory off in the settings
 4. **A recirculation switch that is not offered.** No pump is fitted, or it is not commissioned. Check the NaviLink app
-5. **"The appliance refused a command for arriving too soon."** The cloud rate-limits control. The plugin pauses and retries on your next press
+5. **`rate limited`.** The cloud rate-limits control. The plugin pauses and retries on the next press
 
 The [full troubleshooting list](docs/README-DETAILED.md#troubleshooting) covers more, including what Off on the hot water tile does once you allow power-off.
 
 ## Security
 
-This plugin needs your NaviLink password, stores it in the Homebridge configuration file as every Homebridge credential is stored, and sends it to Navien to sign in. It is never written to the Homebridge log, never put into an accessory's cache, and redacted from anything the plugin prints. That is the honest summary; [SECURITY.md](SECURITY.md) has the detail, including what a capture contains and why the fixtures in this repository are pseudonymised.
+This plugin needs your NaviLink password, stores it in the Homebridge configuration file as every Homebridge credential is stored, and sends it to Navien to sign in. It is never written to the Homebridge log, never put into an accessory's cache, and redacted from anything the plugin prints. That is the summary; [SECURITY.md](SECURITY.md) has the detail, including what a capture contains and why the fixtures in this repository are pseudonymised.
 
 ## Requirements
 

package/SECURITY.md

@@ -26,15 +26,16 @@ If those are not acceptable, this plugin is not for you, and that is a reasonabl
 
 - **Credentials in one place.** The password is read from configuration, used to sign in, and held only in memory. It is never written to a log, never placed in an accessory's cache, never sent anywhere except Navien's sign-in endpoint over HTTPS, and never passed to a script as a command-line argument.
 - **Redaction by shape, not by name.** `src/utils/redact.ts` matches JWTs, AWS key ids, signed-URL parameters and credential-shaped JSON fields by their *form*. A field name list would miss a token in a response shape nobody anticipated; this does not.
-- **Masked identifiers in the log.** The account address appears as `s…e@example.com` and a gateway MAC as `…E5F6`. Both identify you, and a Homebridge log gets pasted into issues.
+- **Masked identifiers in the log.** The account address is debug only, and appears as `s…e@example.com`. Appliance lines use the name you configured. A gateway MAC is logged only as a fallback, as `gateway …E5F6` (last four characters). Discovery warnings use that fallback too: the cloud's own appliance label is often a room, so it stays on the settings page and out of the log. Both the configured name and the masked MAC identify you, and a Homebridge log gets pasted into issues. `options.accessoryPrefix` is a room-shaped name: it is length-capped and stripped of control characters the same way, and it never appears in structured diagnostics (those emit a boolean: set or not).
 - **The accessory cache holds identity, not credentials.** Homebridge persists `{mac}:{channel}` as `deviceId` so a restart adopts the same tile. That file is plain JSON and is included in diagnostic bundles, so it must never hold the password, a token or a signed AWS URL. The MAC is the appliance's address in every MQTT topic. HomeKit serial numbers are opaque generated values, not the MAC.
 - **HomeKit serial numbers are opaque generated values,** not the gateway MAC. The Home app displays them, so they reach screenshots.
-- **Input validation.** Config is checked at startup. A missing account, or a `devices` value that is not a list, disables the platform without unregistering accessories. A bad appliance entry is skipped. Names are stripped of control characters and length-capped before they reach a log line or a characteristic.
+- **Input validation.** Config is checked at startup. A missing account, or a `devices` value that is not a list, disables the platform without unregistering accessories. A bad appliance entry is skipped. Appliance names and `options.accessoryPrefix` are stripped of control characters and length-capped before they reach a log line or a characteristic.
 - **Bounded I/O.** Separate connect and total timeouts on every request, a capped HTTP response size, and a capped MQTT packet size, so a hostile or broken response cannot exhaust memory.
 - **A rejected credential stops the session.** Retrying a wrong password is how an account gets locked; the plugin declines to do it.
 - **Minimal dependencies.** One at runtime: Homebridge's own UI helper. The MQTT client is in this repository, for a protocol reason ([PROTOCOL.md](docs/PROTOCOL.md)) that also reduces supply-chain surface.
 - **Dependencies audited.** CI runs `npm audit` on the runtime tree and OSV-Scanner on the full tree.
 - **A CI step rejects credential-shaped strings** in the published docs, fixtures, schema and issue templates, so a token cannot be committed by accident. Unit tests that hold fake JWTs are outside that scan on purpose.
+- **Opt-in diagnostics are logs only.** `options.diagnosticsInterval` writes a periodic health line from in-memory counters. It never makes a network call, never appears in HomeKit, and the structured JSON (`options.structuredLogs`) omits credentials, appliance names and the accessory prefix string.
 
 ## The settings page
 

package/config.schema.json

@@ -53,6 +53,27 @@
             "type": "boolean",
             "default": false,
             "description": "Off by default, and worth leaving off. On a combi appliance the power state governs central heating as well as hot water, so \"turn off the water heater\" said to Siri, or a scene that turns everything off, would stop the heating in a house that may be empty and freezing. With this off, a power-off request is declined and explained instead of obeyed."
+          },
+          "diagnosticsInterval": {
+            "title": "Diagnostics Interval (seconds)",
+            "type": "integer",
+            "default": 0,
+            "minimum": 0,
+            "maximum": 3600,
+            "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": {
+            "title": "Structured (JSON) Logs",
+            "type": "boolean",
+            "default": false,
+            "description": "When diagnostics are on (diagnosticsInterval > 0), also emit each report as a JSON line next to the human summary. Has no effect while diagnostics are off."
+          },
+          "accessoryPrefix": {
+            "title": "Accessory Name Prefix",
+            "type": "string",
+            "maxLength": 64,
+            "examples": ["Zone One"],
+            "description": "HomeKit tiles become this plus the accessory: \"Zone One Hot Water\", \"Zone One Heating\", and so on. Leave blank to use each appliance's own name. Changing it renames the tiles; it does not detach rooms or automations."
           }
         }
       },
@@ -78,7 +99,7 @@
               "type": "string",
               "maxLength": 64,
               "examples": ["Zone One"],
-              "description": "The appliance's name. Accessories are named from it: \"Boiler\" gives \"Boiler Hot Water\", \"Boiler Heating\", \"Boiler Fault\" and so on."
+              "description": "The appliance's name. Accessories are named from it unless options.accessoryPrefix is set: \"Boiler\" gives \"Boiler Hot Water\", \"Boiler Heating\", \"Boiler Fault\" and so on."
             },
             "channel": {
               "title": "Channel",

package/dist/api/mqtt.js

@@ -151,7 +151,7 @@ class MqttConnection {
         this.socket = open(url, {
             onOpen: () => this.handleOpen(),
             onMessage: (data) => this.handleData(data),
-            onClose: (reason) => this.fail(new errors_1.ConnectionError(`the broker closed the connection (${reason})`)),
+            onClose: (reason) => this.fail(new errors_1.ConnectionError(`NaviLink broker closed the connection (${reason})`)),
             onError: (error) => this.fail(error),
         });
         return handshake;
@@ -210,7 +210,7 @@ class MqttConnection {
         if (this.connected) {
             this.trySend((0, mqtt_codec_1.encodeDisconnect)());
         }
-        this.fail(new errors_1.ConnectionError('the connection was closed by this plugin'), { expected: true });
+        this.fail(new errors_1.ConnectionError('the connection was closed by this plugin', { expected: true }), { expected: true });
     }
     // --- Internals ------------------------------------------------------------
     handleOpen() {

package/dist/api/rest.d.ts

@@ -62,6 +62,11 @@ export interface NaviLinkRestOptions {
     now?: () => number;
     /** Cancels in-flight calls, so Homebridge shutdown need not wait out a deadline. */
     signal?: AbortSignal;
+    /** One sample per REST attempt, for diagnostics. Never receives the body. */
+    metrics?: (sample: {
+        durationMs: number;
+        ok: boolean;
+    }) => void;
 }
 /** Talks to the NaviLink REST service. */
 export declare class NaviLinkRest {
@@ -69,6 +74,7 @@ export declare class NaviLinkRest {
     private readonly post;
     private readonly now;
     private readonly signal;
+    private readonly metrics;
     constructor(options: NaviLinkRestOptions);
     /**
      * Exchange an email and password for a session.

package/dist/api/rest.js

@@ -54,11 +54,13 @@ class NaviLinkRest {
     post;
     now;
     signal;
+    metrics;
     constructor(options) {
         this.log = options.log;
         this.post = options.post ?? http_1.postJson;
         this.now = options.now ?? Date.now;
         this.signal = options.signal;
+        this.metrics = options.metrics;
     }
     /**
      * Exchange an email and password for a session.
@@ -128,8 +130,7 @@ class NaviLinkRest {
                 return found;
             }
         }
-        this.log.warn(`the account listed ${MAX_DEVICE_LIST_PAGES * DEVICE_LIST_PAGE_SIZE} gateways, `
-            + 'which is this plugin\'s cap; any further gateway is not shown');
+        this.log.warn(`device list capped at ${MAX_DEVICE_LIST_PAGES * DEVICE_LIST_PAGE_SIZE}`);
         return found;
     }
     /** One page of the device list, already parsed. */
@@ -178,7 +179,7 @@ class NaviLinkRest {
             // Not fatal, and deliberately quiet: firmware is a nicety, and this
             // endpoint has been observed answering 403 on accounts where the device
             // list works perfectly well.
-            this.log.debug(`device/info answered HTTP ${response.status}; firmware will be unknown`);
+            this.log.debug(`device/info HTTP ${response.status}; firmware unknown`);
             return undefined;
         }
         const body = this.readBody(response.body, 'device info');
@@ -189,15 +190,24 @@ class NaviLinkRest {
         // The path, never the body: the body of the very first call is the
         // password.
         this.log.debug(`POST ${path}`);
-        return this.post(`${settings_1.API_BASE}${path}`, body, {
-            connectTimeoutMs: settings_1.CONNECT_TIMEOUT_MS,
-            totalTimeoutMs: settings_1.REST_TIMEOUT_MS,
-            maxBytes: settings_1.MAX_REST_BYTES,
-            // No `Bearer` prefix. The API wants the raw token, and sending a
-            // correctly-formed bearer header gets a 401.
-            ...(accessToken === undefined ? {} : { headers: { authorization: accessToken } }),
-            ...(this.signal === undefined ? {} : { signal: this.signal }),
-        });
+        const started = this.now();
+        try {
+            const response = await this.post(`${settings_1.API_BASE}${path}`, body, {
+                connectTimeoutMs: settings_1.CONNECT_TIMEOUT_MS,
+                totalTimeoutMs: settings_1.REST_TIMEOUT_MS,
+                maxBytes: settings_1.MAX_REST_BYTES,
+                // No `Bearer` prefix. The API wants the raw token, and sending a
+                // correctly-formed bearer header gets a 401.
+                ...(accessToken === undefined ? {} : { headers: { authorization: accessToken } }),
+                ...(this.signal === undefined ? {} : { signal: this.signal }),
+            });
+            this.metrics?.({ durationMs: this.now() - started, ok: true });
+            return response;
+        }
+        catch (error) {
+            this.metrics?.({ durationMs: this.now() - started, ok: false });
+            throw error;
+        }
     }
     readBody(text, what) {
         const parsed = (0, http_1.parseJsonBody)(text);
@@ -249,8 +259,7 @@ class NaviLinkRest {
             .filter((value) => value !== undefined)
             .filter((value) => value >= MIN_BELIEVABLE_SESSION_MS && value <= MAX_BELIEVABLE_SESSION_MS);
         if (candidates.length === 0) {
-            this.log.debug('the cloud did not report a believable session lifetime; '
-                + `assuming ${Math.round(FALLBACK_SESSION_MS / 60_000)} minutes`);
+            this.log.debug(`session lifetime missing; assuming ${Math.round(FALLBACK_SESSION_MS / 60_000)}m`);
             return FALLBACK_SESSION_MS;
         }
         return Math.min(...candidates);
@@ -266,7 +275,7 @@ class NaviLinkRest {
         const record = asRecord(asRecord(entry)?.deviceInfo) ?? asRecord(entry);
         const macAddress = asNonEmptyString(record?.macAddress)?.toLowerCase();
         if (record === undefined || macAddress === undefined) {
-            this.log.debug('skipping a device-list entry with no MAC address');
+            this.log.debug('skipping device-list entry: no MAC');
             return undefined;
         }
         return {

package/dist/devices/base-accessory.d.ts

@@ -96,9 +96,9 @@ export declare abstract class BaseAccessory {
      * True when the write must not happen, having said so at most once.
      *
      * Shared so a thermostat, a power switch and recirculation all use the same
-     * sentence when `options.readOnly` is on.
+     * line when `options.readOnly` is on.
      */
-    protected declineIfReadOnly(what: string): boolean;
+    protected declineIfReadOnly(): boolean;
     /** Update Accessory Information once the appliance has named itself. */
     updateIdentity(input: {
         model: string;

package/dist/devices/base-accessory.js

@@ -63,7 +63,7 @@ class BaseAccessory {
         catch (error) {
             // A subclass fault must not stop the other accessories being updated
             // from the same frame.
-            this.host.log.debug(`${(0, utils_1.forLog)(this.displayName)}: could not apply an observation: ${(0, utils_1.describeError)(error)}`);
+            this.host.log.debug(`${(0, utils_1.forLog)(this.displayName)}: apply failed: ${(0, utils_1.describeError)(error)}`);
         }
     }
     /** Report that the appliance can no longer be heard from. */
@@ -115,8 +115,7 @@ class BaseAccessory {
         });
         const outcome = await (0, utils_1.raceTimeout)(started, settings_1.HOMEKIT_WRITE_BUDGET_MS);
         if (outcome === utils_1.TIMED_OUT) {
-            this.host.log.debug(`${(0, utils_1.forLog)(this.displayName)}: ${label} is taking longer than `
-                + `${settings_1.HOMEKIT_WRITE_BUDGET_MS}ms; answering HomeKit and finishing in the background`);
+            this.host.log.debug(`${(0, utils_1.forLog)(this.displayName)}: ${label} still in flight after ${settings_1.HOMEKIT_WRITE_BUDGET_MS}ms`);
             void settled;
         }
     }
@@ -155,16 +154,15 @@ class BaseAccessory {
      * True when the write must not happen, having said so at most once.
      *
      * Shared so a thermostat, a power switch and recirculation all use the same
-     * sentence when `options.readOnly` is on.
+     * line when `options.readOnly` is on.
      */
-    declineIfReadOnly(what) {
+    declineIfReadOnly() {
         if (!this.host.isReadOnly) {
             return false;
         }
         if (!this.hasExplainedReadOnly) {
             this.hasExplainedReadOnly = true;
-            this.host.log.info(`${(0, utils_1.forLog)(this.displayName)}: ignoring a request to ${what}; `
-                + 'options.readOnly is on in the plugin settings');
+            this.host.log.info(`${(0, utils_1.forLog)(this.displayName)}: readOnly; write ignored`);
         }
         return true;
     }

package/dist/devices/dhw-accessory.js

@@ -81,7 +81,7 @@ class DomesticHotWaterAccessory extends thermostat_accessory_1.ThermostatAccesso
                 this.explainPowerGuard(error);
                 return false;
             }
-            this.host.log.warn(`${(0, utils_1.forLog)(this.displayName)}: could not change the power state: ${(0, utils_1.describeError)(error)}`);
+            this.host.log.warn(`${(0, utils_1.forLog)(this.displayName)}: power failed: ${(0, utils_1.describeError)(error)}`);
             return false;
         }
     }

package/dist/devices/fault-accessory.js

@@ -61,13 +61,12 @@ class FaultAccessory extends base_accessory_1.BaseAccessory {
         if (errorCode === 0) {
             // First healthy frame is the resting state, not a transition.
             if (previous !== undefined) {
-                this.host.log.info(`${(0, utils_1.forLog)(this.displayName)}: the fault has cleared`);
+                this.host.log.info(`${(0, utils_1.forLog)(this.displayName)}: fault cleared`);
             }
             return;
         }
-        this.host.log.warn(`${(0, utils_1.forLog)(this.displayName)}: the appliance reports error ${errorCode}`
-            + `${subErrorCode === 0 ? '' : `.${subErrorCode}`}; `
-            + 'look the code up in the installation manual');
+        this.host.log.warn(`${(0, utils_1.forLog)(this.displayName)}: error ${errorCode}`
+            + `${subErrorCode === 0 ? '' : `.${subErrorCode}`}`);
     }
 }
 exports.FaultAccessory = FaultAccessory;

package/dist/devices/heating-accessory.js

@@ -62,9 +62,7 @@ class SpaceHeatingAccessory extends thermostat_accessory_1.ThermostatAccessory {
             return;
         }
         this.hasWarnedNoLoop = true;
-        this.host.log.warn(`${(0, utils_1.forLog)(this.displayName)}: this appliance reports no space-heating loop `
-            + '(heatControl is off, or the installer setpoint range is empty). Turn the heating '
-            + 'accessory off in the plugin settings.');
+        this.host.log.warn(`${(0, utils_1.forLog)(this.displayName)}: no heating loop`);
     }
     /** The flow probe: the water going out to the loop. */
     readTemperature(observation) {
@@ -99,8 +97,7 @@ class SpaceHeatingAccessory extends thermostat_accessory_1.ThermostatAccessory {
             return true;
         }
         catch (error) {
-            this.host.log.warn(`${(0, utils_1.forLog)(this.displayName)}: could not ${on ? 'enable' : 'disable'} heating: `
-                + (0, utils_1.describeError)(error));
+            this.host.log.warn(`${(0, utils_1.forLog)(this.displayName)}: heating ${on ? 'on' : 'off'} failed: ${(0, utils_1.describeError)(error)}`);
             return false;
         }
     }
@@ -118,7 +115,7 @@ class SpaceHeatingAccessory extends thermostat_accessory_1.ThermostatAccessory {
     requireHeatingLoop() {
         if (!this.hasHeatingLoop()) {
             this.warnNoLoop();
-            throw new utils_1.ControlRejectedError('this appliance reports no space-heating loop, so a heating command was not sent');
+            throw new utils_1.ControlRejectedError('no heating loop');
         }
     }
     optimisticSetpointPatch(native) {

package/dist/devices/power-accessory.js

@@ -38,7 +38,7 @@ class PowerAccessory extends base_accessory_1.BaseAccessory {
     }
     async writeOn(value) {
         const wantOn = value === true;
-        if (this.declineIfReadOnly('change the power')) {
+        if (this.declineIfReadOnly()) {
             this.restore();
             return;
         }
@@ -58,7 +58,7 @@ class PowerAccessory extends base_accessory_1.BaseAccessory {
                     this.explainGuard(error);
                 }
                 else {
-                    this.host.log.warn(`${(0, utils_1.forLog)(this.displayName)}: could not change power: ${(0, utils_1.describeError)(error)}`);
+                    this.host.log.warn(`${(0, utils_1.forLog)(this.displayName)}: power failed: ${(0, utils_1.describeError)(error)}`);
                 }
                 this.restore();
             }

package/dist/devices/probe-accessory.js

@@ -40,11 +40,11 @@ const FIELD_BY_KIND = {
 };
 /** What to say when a probe turns out not to exist. */
 const ABSENCE_HINT = {
-    dhwOutlet: 'the appliance is not reporting a hot water outlet temperature',
-    dhwInlet: 'the appliance is not reporting a hot water inlet temperature',
-    heatSupply: 'the appliance is not reporting a heating flow temperature',
-    heatReturn: 'the appliance is not reporting a heating return temperature',
-    outdoor: 'no outdoor sensor is fitted, so there is nothing to report',
+    dhwOutlet: 'no outlet temp',
+    dhwInlet: 'no inlet temp',
+    heatSupply: 'no flow temp',
+    heatReturn: 'no return temp',
+    outdoor: 'no outdoor sensor',
 };
 /** One appliance temperature probe, as a HomeKit sensor. */
 class ProbeAccessory extends base_accessory_1.BaseAccessory {

package/dist/devices/recirculation-accessory.js

@@ -61,16 +61,15 @@ class RecirculationAccessory extends base_accessory_1.BaseAccessory {
         const wantOn = value === true;
         const equipped = this.equippedState();
         if (equipped === undefined) {
-            this.host.log.debug(`${(0, utils_1.forLog)(this.displayName)}: recirculation is unknown until the appliance reports it`);
+            this.host.log.debug(`${(0, utils_1.forLog)(this.displayName)}: recirculation unknown`);
             throw this.communicationFailure();
         }
-        if (this.declineIfReadOnly('change recirculation')) {
+        if (this.declineIfReadOnly()) {
             this.restore();
             return;
         }
         if (equipped === false) {
-            this.host.log.info(`${(0, utils_1.forLog)(this.displayName)}: this appliance reports no recirculation pump; `
-                + 'nothing was sent');
+            this.host.log.info(`${(0, utils_1.forLog)(this.displayName)}: no recirculation pump`);
             this.service.updateCharacteristic(this.host.hap.Characteristic.On, false);
             return;
         }
@@ -81,7 +80,7 @@ class RecirculationAccessory extends base_accessory_1.BaseAccessory {
                 this.logAction(wantOn ? 'RECIRCULATE' : 'RECIRCULATE OFF');
             }
             catch (error) {
-                this.host.log.warn(`${(0, utils_1.forLog)(this.displayName)}: could not change recirculation: ${(0, utils_1.describeError)(error)}`);
+                this.host.log.warn(`${(0, utils_1.forLog)(this.displayName)}: recirculation failed: ${(0, utils_1.describeError)(error)}`);
                 this.restore();
             }
         });
@@ -114,9 +113,7 @@ class RecirculationAccessory extends base_accessory_1.BaseAccessory {
             return;
         }
         this.hasWarnedNotEquipped = true;
-        this.host.log.warn(`${(0, utils_1.forLog)(this.displayName)}: the appliance reports no recirculation pump `
-            + '(onDemandUse and recirculationUse are both off). Turn the recirculation accessory '
-            + 'off in the plugin settings, or enable the pump in the NaviLink app if one is fitted.');
+        this.host.log.warn(`${(0, utils_1.forLog)(this.displayName)}: no recirculation pump`);
     }
 }
 exports.RecirculationAccessory = RecirculationAccessory;

package/dist/devices/thermostat-accessory.js

@@ -192,7 +192,7 @@ class ThermostatAccessory extends base_accessory_1.BaseAccessory {
     async writeTargetState(value) {
         const { TargetHeatingCoolingState } = this.host.hap.Characteristic;
         const wantOn = value === TargetHeatingCoolingState.HEAT;
-        if (this.declineIfReadOnly('change the mode')) {
+        if (this.declineIfReadOnly()) {
             this.restoreTargetState();
             return;
         }
@@ -221,7 +221,7 @@ class ThermostatAccessory extends base_accessory_1.BaseAccessory {
         if (typeof value !== 'number') {
             return;
         }
-        if (this.declineIfReadOnly('change the setpoint')) {
+        if (this.declineIfReadOnly()) {
             this.revertTargetTemperature();
             return;
         }
@@ -255,8 +255,7 @@ class ThermostatAccessory extends base_accessory_1.BaseAccessory {
         const observation = this.host.observationFor(this.deviceId);
         const limits = observation === undefined ? undefined : this.readLimits(observation);
         if (observation === undefined || limits === undefined) {
-            this.host.log.warn(`${(0, utils_1.forLog)(this.displayName)}: cannot set a temperature before the appliance has `
-                + 'reported its limits');
+            this.host.log.warn(`${(0, utils_1.forLog)(this.displayName)}: no limits yet; setpoint ignored`);
             this.optimisticTargetCelsius = undefined;
             return;
         }
@@ -277,7 +276,7 @@ class ThermostatAccessory extends base_accessory_1.BaseAccessory {
         }
         catch (error) {
             this.optimisticTargetCelsius = undefined;
-            this.host.log.warn(`${(0, utils_1.forLog)(this.displayName)}: could not set the temperature: ${(0, utils_1.describeError)(error)}`);
+            this.host.log.warn(`${(0, utils_1.forLog)(this.displayName)}: setpoint failed: ${(0, utils_1.describeError)(error)}`);
             this.revertTargetTemperature();
         }
         finally {