Added topicGetAvailable for LWT

Author: mpatfield

CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to homebridge-dummy will be documented in this file.
 
+## 1.5.16-beta.0 ()
+
+### Added
+- Added `topicGetAvailable` for "Last Will and Testament" (LWT) before an accessory goes offline
+    - If value does not match `valueAvailable`, then accessory will show "No Response" in HomeKit until the next successful get event
+
+### Changed
+- Renamed "Get Availability" to "Get Active Status" in config UI to avoid confusion with the new `topicGetAvailable` (see above)
+
 ## 1.5.15 (2026-05-12)
 
 ### Fixed

config.schema.template.json

@@ -240,6 +240,10 @@
                 }
               ]
             },
+            "topicGetAvailable": {
+              "type": "string",
+              "title": "${config.title.topicGetAvailable}"
+            },
             "topicGetBatteryLevel": {
               "type": "string",
               "title": "${config.title.topicGetBatteryLevel}"
@@ -688,6 +692,10 @@
               "type": "string",
               "title": "${config.title.topicGetVoltage}"
             },
+            "valueAvailable": {
+              "type": "string",
+              "title": "${config.title.valueAvailable}"
+            },
             "valueBatteryLow": {
               "type": "string",
               "title": "${config.title.valueBatteryLow}"
@@ -1460,6 +1468,19 @@
                 "required": ["valueSwingEnabled", "valueSwingDisabled"]
               }
             },
+            {
+              "if": {
+                "properties": {
+                  "topicGetAvailable": {
+                    "minLength": 1
+                  }
+                },
+                "required": ["topicGetAvailable"]
+              },
+              "then": {
+                "required": ["valueAvailable"]
+              }
+            },
             {
               "if": {
                 "properties": {
@@ -3303,11 +3324,11 @@
                   "flex-direction": "row",
                   "items": [
                     {
-                      "key": "accessories[].topicGetBatteryLevel",
+                      "key": "accessories[].topicGetAvailable",
                       "flex": "0 0 50%"
                     },
                     {
-                      "key": "accessories[].topicGetBatteryLow",
+                      "key": "accessories[].topicGetStatusActive",
                       "flex": "0 0 50%"
                     }
                   ]
@@ -3318,7 +3339,11 @@
                   "flex-direction": "row",
                   "items": [
                     {
-                      "key": "accessories[].topicGetStatusActive",
+                      "key": "accessories[].topicGetBatteryLevel",
+                      "flex": "0 0 50%"
+                    },
+                    {
+                      "key": "accessories[].topicGetBatteryLow",
                       "flex": "0 0 50%"
                     }
                   ]
@@ -4044,12 +4069,16 @@
                   "flex-direction": "row",
                   "items": [
                     {
-                      "key": "accessories[].valueBatteryLow",
+                      "key": "accessories[].valueAvailable",
                       "flex": "0 0 25%"
                     },
                     {
                       "key": "accessories[].valueStatusActive",
                       "flex": "0 0 25%"
+                    },
+                    {
+                      "key": "accessories[].valueBatteryLow",
+                      "flex": "0 0 25%"
                     }
                   ]
                 }

package-lock.json

@@ -4,7 +4,7 @@
   "displayName": "Homebridge Easy MQTT",
   "description": "Homebridge plugin for MQTT devices",
   "type": "module",
-  "version": "1.5.15",
+  "version": "1.5.16-beta.0",
   "homepage": "https://github.com/mpatfield/homebridge-easy-mqtt#readme",
   "repository": {
     "type": "git",

package.json

@@ -11,7 +11,6 @@ import { strings } from '../../i18n/i18n.js';
 import { CharacteristicKey, HKCharacteristicKey } from '../../model/enums.js';
 import { BaseAccessoryConfig, MQTTAccessoryDependency } from '../../model/types.js';
 
-import { LogType } from '../../tools/log.js';
 import getVersion from '../../tools/version.js';
 
 export abstract class BaseAccessory<C extends BaseAccessoryConfig = BaseAccessoryConfig> extends MQTTAccessory<C> {
@@ -33,7 +32,7 @@ export abstract class BaseAccessory<C extends BaseAccessoryConfig = BaseAccessor
     this.setup(HKCharacteristicKey.StatusActive, true,
       'topicGetStatusActive',
       this.bindOnUpdateBooleanSingle(HKCharacteristicKey.StatusActive, 'valueStatusActive',
-        strings.accessory.statusActive, strings.accessory.statusInactive, LogType.ALWAYS, LogType.WARNING),
+        strings.accessory.statusActive, strings.accessory.statusInactive),
       false);
 
     this.addTopicHandlers(Battery.topicHandlers(dependency.Service, this, dependency.config));

src/accessory/abstract/base.ts

@@ -5,7 +5,7 @@ import { EveCharacteristic, isEveCharacteristic } from '../characteristic/eve.js
 import { strings } from '../../i18n/i18n.js';
 
 import { CharacteristicKey, TimeUnits } from '../../model/enums.js';
-import { CharacteristicType, TemperatureConfig, TimeoutConfig } from '../../model/types.js';
+import { CharacteristicType, HapStatusErrorType, TemperatureConfig, TimeoutConfig } from '../../model/types.js';
 
 import { debounce } from '../../tools/debounce.js';
 import { Log, LogType } from '../../tools/log.js';
@@ -23,6 +23,9 @@ export type PublishHandler = (topic: string, value: PrimitiveTypes) => void;
 type NumberCallback = (value: number) => void;
 type BooleanCallback = (value: boolean) => void
 
+const AVAILABILITY_KEY = 'Available';
+const HAP_COMMUNICATION_FAILURE = -70402;
+
 export abstract class Common<C extends Assertable> {
 
   public readonly topicHandlers: TopicHandler[] = [];
@@ -33,6 +36,7 @@ export abstract class Common<C extends Assertable> {
 
   protected abstract get service(): Service;
   protected abstract get Characteristic(): CharacteristicType;
+  protected abstract get HapStatusError(): HapStatusErrorType;
 
   protected abstract get log(): Log;
   protected abstract get disableLogging(): boolean;
@@ -93,6 +97,23 @@ export abstract class Common<C extends Assertable> {
     Properties.set(this.identifier, key, value);
   }
 
+  protected get isAvailable(): boolean {
+    return Properties.get(this.identifier, AVAILABILITY_KEY) !== false;
+  }
+
+  protected set isAvailable(value: boolean) {
+
+    if (!Properties.set(this.identifier, AVAILABILITY_KEY, value)) {
+      return;
+    }
+
+    if (value) {
+      this.logIfDesired(LogType.ALWAYS, strings.accessory.available);
+    } else {
+      this.logIfDesired(LogType.WARNING, strings.accessory.unavailable);
+    }
+  }
+
   protected setup(
     characteristicKey: CharacteristicKey, defaultValue: CharacteristicValue,
     getTopicKey: keyof C, onUpdateHandler: OnUpdateHandler, assertGetTopic: boolean,
@@ -143,10 +164,18 @@ export abstract class Common<C extends Assertable> {
     this.setProperty(characteristicKey, startingValue);
 
     characteristic.onGet( async (): Promise<Nullable<CharacteristicValue>> => {
+      if (!this.isAvailable) {
+        throw new this.HapStatusError(HAP_COMMUNICATION_FAILURE);
+      }
       return this.getProperty(characteristicKey) ?? null;
     });
 
-    this.topicHandlers.push({ topic: this.config[getTopicKey] as string, handler: onUpdateHandler });
+    const onUpdateHandlerWrapper: OnUpdateHandler = async (topic, value) => {
+      this.isAvailable = true;
+      await onUpdateHandler(topic, value);
+    };
+
+    this.topicHandlers.push({ topic: this.config[getTopicKey] as string, handler: onUpdateHandlerWrapper });
 
     return characteristic;
   }

src/accessory/abstract/common.ts

@@ -7,10 +7,10 @@ import { CharacteristicKeys } from '../characteristic/characteristic.js';
 import { CustomCharacteristic } from '../characteristic/custom.js';
 
 import { AccessoryType, HKCharacteristicKey } from '../../model/enums.js';
+import { HistoryEntry, HistoryType } from '../../model/history.js';
 import { MQTT } from '../../model/mqtt.js';
-import { CharacteristicType, MQTTAccessoryConfig, MQTTAccessoryDependency } from '../../model/types.js';
+import { CharacteristicType, HapStatusErrorType, MQTTAccessoryConfig, MQTTAccessoryDependency } from '../../model/types.js';
 
-import { HistoryEntry, HistoryType } from '../../model/history.js';
 import { Log } from '../../tools/log.js';
 
 export abstract class MQTTAccessory<C extends MQTTAccessoryConfig> extends Common<C> {
@@ -56,12 +56,17 @@ export abstract class MQTTAccessory<C extends MQTTAccessoryConfig> extends Commo
     }
 
     this.setupCustomCharacteristics();
+    this.setupAvailabilityHandler();
   }
 
   public get Characteristic(): CharacteristicType {
     return this.dependency.Characteristic;
   }
 
+  public get HapStatusError(): HapStatusErrorType {
+    return this.dependency.HapStatusError;
+  }
+
   public get platformAccessory(): PlatformAccessory {
     return this.dependency.platformAccessory;
   }
@@ -116,6 +121,17 @@ export abstract class MQTTAccessory<C extends MQTTAccessoryConfig> extends Commo
     }
   }
 
+  private setupAvailabilityHandler() {
+
+    if (this.config.topicGetAvailable === undefined) {
+      return;
+    }
+
+    this.addTopicHandlers([{ topic: this.config.topicGetAvailable, handler: (async (_topic: string, value: PrimitiveTypes) => {
+      this.isAvailable = value === this.getPrimitiveValue('valueAvailable', true);
+    }).bind(this) }]);
+  }
+
   public publish(topic: string, value: PrimitiveTypes) {
     this.mqttClient?.publish(this.identifier, topic, value);
   }

src/accessory/abstract/mqtt.ts

@@ -4,7 +4,7 @@ import { Common } from '../abstract/common.js';
 import { MQTTAccessory } from '../abstract/mqtt.js';
 
 import { AddonType } from '../../model/enums.js';
-import { AddonConfig, CharacteristicType, MQTTAccessoryConfig } from '../../model/types.js';
+import { AddonConfig, CharacteristicType, HapStatusErrorType, MQTTAccessoryConfig } from '../../model/types.js';
 
 import { Log } from '../../tools/log.js';
 
@@ -61,6 +61,10 @@ export abstract class Addon<C extends AddonConfig> extends Common<C> {
     return this.parentAccessory.Characteristic;
   }
 
+  public get HapStatusError(): HapStatusErrorType {
+    return this.parentAccessory.HapStatusError;
+  }
+
   protected get log(): Log {
     return this.parentAccessory.log;
   }

src/accessory/addons/addon.ts

@@ -79,6 +79,7 @@ export class HomebridgeEasyMQTT implements DynamicPlatformPlugin {
 
     const Service = this.api.hap.Service;
     const Characteristic = this.api.hap.Characteristic;
+    const HapStatusError = this.api.hap.HapStatusError;
 
     const history = new History(this.api, this.log);
 
@@ -103,7 +104,7 @@ export class HomebridgeEasyMQTT implements DynamicPlatformPlugin {
       const uuid = this.api.hap.uuid.generate(id);
 
       const platformAccessory = this.createPlatformAccessory(accessoryConfig.info.name, uuid);
-      const dependency: AccessoryDependency = { Service, Characteristic, platformAccessory, log: this.log, history: history };
+      const dependency: AccessoryDependency = { Service, Characteristic, HapStatusError, platformAccessory, log: this.log, history: history };
 
       const accessory = createAccessory(dependency, accessoryConfig);
 
@@ -119,7 +120,7 @@ export class HomebridgeEasyMQTT implements DynamicPlatformPlugin {
 
       const uuid = this.api.hap.uuid.generate(groupName);
       const platformAccessory = this.createPlatformAccessory(groupName, uuid);
-      const dependency: AccessoryDependency = { Service, Characteristic, platformAccessory, log: this.log, history: history };
+      const dependency: AccessoryDependency = { Service, Characteristic, HapStatusError, platformAccessory, log: this.log, history: history };
 
       const configs = groups.get(groupName)!;
 

src/homebridge/platform.ts

@@ -6,8 +6,6 @@ const da = {
     batteryLow: '%s batteri er lavt',
     batteryNotLow: '%s batteri er okay',
     missingRequired: '%s mangler påkrævet konfigurationsvariabel %s',
-    statusActive: '%s er nu tilgængelig',
-    statusInactive: '%s er utilgængelig',
   },
 
   active: {
@@ -190,7 +188,6 @@ const da = {
       topicGetRotationSpeed: 'Hent Rotationshastighed',
       topicGetSaturation: 'Hent Mætning',
       topicGetSmokeDetected: 'Hent Røg Registreret*',
-      topicGetStatusActive: 'Hent Tilgængelighed',
       topicGetStatusFault: 'Hent Fejl',
       topicGetStatusTampered: 'Hent Manipuleret',
       topicGetSulphurDioxideDensity: 'Hent Svovldioxid',
@@ -267,6 +264,7 @@ const da = {
       valueArmAway: 'Tilkobl Ude',
       valueArmNight: 'Tilkobl Nat',
       valueArmStay: 'Tilkobl Hjemme',
+      valueAvailable: 'Tilgængelig/Opnåelig',
       valueBatteryLow: 'Lavt Batteri',
       valueCarbonDioxideDetected: 'CO2 Registreret*',
       valueCarbonMonoxideDetected: 'CO Registreret*',
@@ -323,7 +321,6 @@ const da = {
       valueSmokeDetected: 'Røg Registreret*',
       valueStateActive: 'Tilstand Aktiv*',
       valueStateInactive: 'Tilstand Inaktiv*',
-      valueStatusActive: 'Tilgængelig/Opnåelig',
       valueSwingDisabled: 'Svingning Deaktiveret',
       valueSwingEnabled: 'Svingning Aktiveret',
       valueTampered: 'Manipuleret',