homebridge-easy-mqtt 1.4.1-beta.1 → 1.5.0-beta.0

package/CHANGELOG.md

@@ -2,10 +2,17 @@
 
 All notable changes to homebridge-dummy will be documented in this file.
 
-## 1.4.1-beta.1 (2025-10-10)
+## 1.5.0-beta.0 (2025-10-20)
 
 ### Added
+- [Value Transformers](https://github.com/mpatfield/homebridge-easy-mqtt#history) (Thank you [@nehmeroumani](https://github.com/sponsors/nehmeroumani) for the code contribution!)
 - `Doorbell` accessory type
+- History and additional characteristics for for [Eve app](https://apps.apple.com/us/app/eve-for-matter-homekit/id917695792) users ([documentation](https://github.com/mpatfield/homebridge-easy-mqtt#history))
+    - Opened/closed history, and times opened count with option to reset for `ContactSensor`
+    - `MotionSensor` history
+    - Temperature history for `HeaterCooler`, `TemperatureSensor`, and `Thermostat`
+    - Humidity history for `HumiditySensor` and `Thermostat`
+    - On/off history and watts/amps/volts/kWh history for `Lightbulb`, `Outlet`, and `Switch`
 - Traduzioni in italiano. Grazie, [@Shikaban](https://github.com/sponsors/Shikaban)!
 
 ### Notes

package/README.md

@@ -83,6 +83,11 @@ Using the Homebridge Config UI is the easiest way to set up this plugin. However
           …
         ]
       },
+      "history": {
+        "enabled": true,
+        "disableRepeatLastData": false,
+        "size": 4032,
+      },
       "customCharacteristics": [
         {
           "uuid": "string",
@@ -135,7 +140,7 @@ Note that setting the this information in the JSON config will override the envi
 
 You will need to make sure to populate the appropriate topics based on the accessory type defined below.
 
-You may define topics using a JSONPath dot notation to assist the parser in finding the right value within the message. See [JSONPaths](#jsonpaths) below for more details.
+You may define topics using a JSONPath dot notation to assist the parser in finding the right value within the message. You can also add a value transformer to alter the incoming or outgoing value. See [Advanced Topic Notation](#advanced-topic-notation) below for more details.
 
 As with topics, you will also need to populate the appropriate values based on the type. Note that while they are defined as strings, they will be auto-converted to the appropriate primitives (e.g. boolean or number) where appropriate.
 
@@ -164,18 +169,30 @@ These values are used for both determining current state and, where appropriate,
 - `topicSetHue` - For setting the lightbulb's current hue
 - `topicGetSaturation` - The current saturation setting of the lightbulb
 - `topicSetSaturation` - For setting the saturation setting of the lightbulb
+- `topicGetCurrentConsumption` - Get the current power rate in watts ([Eve only](#eve-app-support))
+- `topicGetElectricCurrent` - Get the electrical current in amps ([Eve only](#eve-app-support))
+- `topicGetTotalConsumption` - Get the total energy use in kWh ([Eve only](#eve-app-support))
+- `topicGetVoltage` - Get the current voltage ([Eve only](#eve-app-support))
 
 #### Outlet
 - `topicGetOn*` - The current state of the outlet, i.e. on/off
 - `topicSetOn*` - For setting the state of the outlet
+- `topicGetOutletInUse` - Whether or not the outlet is
 - `valueOn*` - Turned on, e.g. "true", or "1", or "On"
 - `valueOff*` - Turned off, e.g. "false", or "0", or "Off"
-- `topicGetOutletInUse` - Whether or not the outlet is currently being used
 - `valueOutletInUse` - Currently being used, e.g. "true", or "1", or "On"
+- `topicGetCurrentConsumption` - Get the current power rate in watts ([Eve only](#eve-app-support))
+- `topicGetElectricCurrent` - Get the electrical current in amps ([Eve only](#eve-app-support))
+- `topicGetTotalConsumption` - Get the total energy use in kWh ([Eve only](#eve-app-support))
+- `topicGetVoltage` - Get the current voltage ([Eve only](#eve-app-support))
 
 #### Switch
 - `topicGetOn*` - The current state of the outlet, i.e. on/off
 - `topicSetOn*` - For setting the state of the outlet
+- `topicGetCurrentConsumption` - Get the current power rate in watts ([Eve only](#eve-app-support))
+- `topicGetElectricCurrent` - Get the electrical current in amps ([Eve only](#eve-app-support))
+- `topicGetTotalConsumption` - Get the total energy use in kWh ([Eve only](#eve-app-support))
+- `topicGetVoltage` - Get the current voltage ([Eve only](#eve-app-support))
 - `valueOn*` - Turned on, e.g. "true", or "1", or "On"
 - `valueOff*` - Turned off, e.g. "false", or "0", or "Off"
 
@@ -545,7 +562,9 @@ Each entry should have a topic and a message:
 ]
 ```
 
-## JSONPaths
+## Advanced Topic Notation
+
+### JSONPaths
 
 For some devices, the desired values in the MQTT messages are embedded within a JSON object. For example, here is the MQTT message for my door lock that is received when the door is locked:
 
@@ -610,9 +629,69 @@ then you would use the topic
 
 `zwave/4/security/set$.target.mode.value`
 
-## Custom Characteristics
+### Value Transformers
+
+There are other situations where the value needs to be adjusted or altered entirely.
+
+For example, you may have an Air Quality Sensor that measures Nitrogen Dioxide in ppm (parts per million) instead of µg/m³ (micrograms per cubic meter) which HomeKit expects. In this case, you need to multiply by the arbitrary number 1883 to get the correct result.
+
+Using the pipe (`|`) notation, you may add a transformer:
+
+`airquality/no2|value * 1883`
+
+This will multiply the value by `1883` to get the desired result.
+
+Note that `value` is a reserved keyword here to indicate the incoming value you'd like to transform.
+
+You can also do the same thing on the publish side to transfer it back to ppm. In this case, you would need to divide by 1883.
+
+`airquality/no2|value / 1883`
+
+### Both JSONPath + Transformer
+
+You can also combine JSONPath and Transformer notation into a single entity
+
+`airquality$.no2|value * 1883`
+
+## Eve App Support
+
+If you use [Eve](https://apps.apple.com/us/app/eve-for-matter-homekit/id917695792), then there are some additional features available:
+- Opened/closed history, and times opened count with option to reset for `ContactSensor`
+- `MotionSensor` history
+- Temperature history for `HeaterCooler`, `TemperatureSensor`, and `Thermostat`
+- Humidity history for `HumiditySensor` and `Thermostat`
+- On/off history for `Lightbulb`, `Outlet`, and `Switch`
+
+You can also add get topics for watts/amps/volts/kWh for `Lightbulb`, `Outlet`, and `Switch`:
+- `topicGetCurrentConsumption` - Get the current power rate in watts
+- `topicGetElectricCurrent` - Get the electrical current in amps
+- `topicGetTotalConsumption` - Get the total energy use in kWh
+- `topicGetVoltage` - Get the current voltage
+
+To enable history, choose the `History Enabled` option in the config UI.
+
+There are a couple of advanced options if configuring via JSON:
+
+```json
+{
+  "info": …
+  "mqtt": …
+  "history": {
+    "enabled": true,
+    "disableRepeatLastData": false,
+    "size": 4032,
+  },
+  … // Topic & Values
+}
+```
+
+- `enabled` — used to enable/disable history
+- `disableRepeatLastData` — See [fakegato-history](https://github.com/simont77/fakegato-history?tab=readme-ov-file#fakegato-history) for info
+- `size` - The maximum number of history entries. Default is 4032 (1 entry every 10 minutes for 28 days)
+
+### Custom Characteristics
 
-If you use a more advanced HomeKit app like [Eve](https://apps.apple.com/us/app/eve-for-matter-homekit/id917695792) or [Controller for Homekit](https://apps.apple.com/us/app/controller-for-homekit/id1198176727), you can add custom characteristics to display any arbitrary numeric information. Unfortunately, Apple currently doesn't offer a way to display this in the Home app.
+Eve users can also add custom characteristics to display any arbitrary numeric information.
 
 <img src="https://raw.githubusercontent.com/mpatfield/homebridge-easy-mqtt/refs/heads/latest/img/screenshot_1.png">
 

package/config.schema.json

@@ -88,6 +88,15 @@
           }
         }
       },
+      "history": {
+        "type": "object",
+        "properties": {
+          "enabled": {
+            "type": "boolean",
+            "title": "${config.title.historyEnabled}"
+          }
+        }
+      },
       "customCharacteristic": {
         "type": "object",
         "properties": {
@@ -118,6 +127,7 @@
           "properties": {
             "info": { "$ref": "#/definitions/info" },
             "mqtt": { "$ref": "#/definitions/mqtt" },
+            "history": { "$ref": "#/definitions/history" },
             "customCharacteristics": {
               "type": "array",
               "items": { "$ref": "#/definitions/customCharacteristic" }
@@ -566,6 +576,22 @@
               "type": "string",
               "title": "${config.title.topicSetVolume}"
             },
+            "topicGetCurrentConsumption": {
+              "type": "string",
+              "title": "${config.title.topicGetCurrentConsumption}"
+            },
+            "topicGetElectricCurrent": {
+              "type": "string",
+              "title": "${config.title.topicGetElectricCurrent}"
+            },
+            "topicGetTotalConsumption": {
+              "type": "string",
+              "title": "${config.title.topicGetTotalConsumption}"
+            },
+            "topicGetVoltage": {
+              "type": "string",
+              "title": "${config.title.topicGetVoltage}"
+            },
             "valueBatteryLow": {
               "type": "string",
               "title": "${config.title.valueBatteryLow}"
@@ -1603,7 +1629,10 @@
                 "required": ["topicGetObstructionDetected"]
               },
               "then": {
-                "required": ["valuePositionObstructed"]
+                "anyOf": [
+                  { "required": ["valuePositionObstructed"] },
+                  { "required": ["valueDoorObstructed"] }
+                ]
               }
             },
             {
@@ -1773,6 +1802,13 @@
                 {
                   "key": "accessories[].disableLogging",
                   "flex": "0 0 25%"
+                },
+                {
+                  "key": "accessories[].history.enabled",
+                  "flex": "0 0 25%",
+                  "condition": {
+                    "functionBody": "return ['ContactSensor', 'HeaterCooler', 'HumiditySensor', 'Lightbulb', 'MotionSensor', 'Outlet', 'Switch', 'TemperatureSensor', 'Thermostat'].includes(model.accessories?.[arguments[1]]?.info?.type);"
+                  }
                 }
               ]
             },
@@ -2173,6 +2209,45 @@
                     }
                   ]
                 },
+                {
+                  "type": "fieldset",
+                  "notitle": true,
+                  "condition": {
+                    "functionBody": "return ['Lightbulb', 'Outlet', 'Switch'].includes(model.accessories?.[arguments[1]]?.info?.type);"
+                  },
+                  "items": [
+                    {
+                      "type": "div",
+                      "displayFlex": true,
+                      "flex-direction": "row",
+                      "items": [
+                        {
+                          "key": "accessories[].topicGetCurrentConsumption",
+                          "flex": "0 0 50%"
+                        },
+                        {
+                          "key": "accessories[].topicGetTotalConsumption",
+                          "flex": "0 0 50%"
+                        }
+                      ]
+                    },
+                    {
+                      "type": "div",
+                      "displayFlex": true,
+                      "flex-direction": "row",
+                      "items": [
+                        {
+                          "key": "accessories[].topicGetElectricCurrent",
+                          "flex": "0 0 50%"
+                        },
+                        {
+                          "key": "accessories[].topicGetVoltage",
+                          "flex": "0 0 50%"
+                        }
+                      ]
+                    }
+                  ]
+                },
                 {
                   "type": "fieldset",
                   "notitle": true,

package/dist/accessory/abstract/base.d.ts

@@ -1,7 +1,7 @@
 import { MQTTAccessory } from './mqtt.js';
+import { CharacteristicKey } from '../../model/enums.js';
 import { BaseAccessoryConfig, MQTTAccessoryDependency } from '../../model/types.js';
 export declare abstract class BaseAccessory<C extends BaseAccessoryConfig = BaseAccessoryConfig> extends MQTTAccessory<C> {
     constructor(dependency: MQTTAccessoryDependency<C>);
-    private onBatteryLowUpdate;
-    private onStatusActiveUpdate;
+    isOptionalCharacteristic(key: CharacteristicKey): boolean;
 }

package/dist/accessory/abstract/base.js

@@ -1,5 +1,6 @@
 import { MQTTAccessory } from './mqtt.js';
 import { PLATFORM_NAME } from '../../homebridge/settings.js';
+import { isOptionalHKCharacteristic } from '../characteristic/characteristic.js';
 import { strings } from '../../i18n/i18n.js';
 import { HKCharacteristicKey } from '../../model/enums.js';
 import { LogType } from '../../tools/log.js';
@@ -17,32 +18,11 @@ export class BaseAccessory extends MQTTAccessory {
                 .setCharacteristic(dependency.Characteristic.FirmwareRevision, dependency.config.info.version ?? getVersion());
         }
         this.setup(HKCharacteristicKey.BatteryLevel, 100, 'topicGetBatteryLevel', this.bindOnUpdateNumeric(HKCharacteristicKey.BatteryLevel, strings.accessory.batteryLevel), false);
-        this.setup(HKCharacteristicKey.StatusLowBattery, dependency.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL, 'topicGetBatteryLow', this.onBatteryLowUpdate.bind(this), false);
-        this.setup(HKCharacteristicKey.StatusActive, true, 'topicGetStatusActive', this.onStatusActiveUpdate.bind(this), false);
+        this.setup(HKCharacteristicKey.StatusLowBattery, dependency.Characteristic.StatusLowBattery.BATTERY_LEVEL_NORMAL, 'topicGetBatteryLow', this.bindOnUpdateBooleanSingle(HKCharacteristicKey.StatusLowBattery, 'valueBatteryLow', strings.accessory.batteryLow, strings.accessory.batteryNotLow, LogType.WARNING), false);
+        this.setup(HKCharacteristicKey.StatusActive, true, 'topicGetStatusActive', this.bindOnUpdateBooleanSingle(HKCharacteristicKey.StatusActive, 'valueStatusActive', strings.accessory.statusActive, strings.accessory.statusInactive, LogType.ALWAYS, LogType.WARNING), false);
     }
-    async onBatteryLowUpdate(topic, value) {
-        const batteryLow = value === this.getPrimitiveValue('valueBatteryLow') ? 1 : 0;
-        if (!this.onUpdate(HKCharacteristicKey.StatusLowBattery, batteryLow)) {
-            return;
-        }
-        if (batteryLow) {
-            this.logIfDesired(LogType.WARNING, strings.accessory.batteryLow);
-        }
-        else {
-            this.logIfDesired(strings.accessory.batteryNotLow);
-        }
-    }
-    async onStatusActiveUpdate(topic, value) {
-        const statusActive = value === this.getPrimitiveValue('valueStatusActive');
-        if (!this.onUpdate(HKCharacteristicKey.StatusActive, statusActive)) {
-            return;
-        }
-        if (statusActive) {
-            this.logIfDesired(strings.accessory.statusActive);
-        }
-        else {
-            this.logIfDesired(LogType.WARNING, strings.accessory.statusInactive);
-        }
+    isOptionalCharacteristic(key) {
+        return super.isOptionalCharacteristic(key) || isOptionalHKCharacteristic(key, this.config.info.type);
     }
 }
 //# sourceMappingURL=base.js.map

package/dist/accessory/abstract/base.js.map

@@ -1 +1 @@
-{"version":3,"file":"base.js","sourceRoot":"","sources":["../../../src/accessory/abstract/base.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAE1C,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAE7D,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAG3D,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,UAAU,MAAM,wBAAwB,CAAC;AAEhD,MAAM,OAAgB,aAAmE,SAAQ,aAAgB;IAE/G,YAAY,UAAsC;QAChD,KAAK,CAAC,UAAU,CAAC,CAAC;QAElB,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC;YAC5B,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,oBAAoB,CAAE;iBACxE,iBAAiB,CAAC,UAAU,CAAC,cAAc,CAAC,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;iBAC9E,iBAAiB,CAAC,UAAU,CAAC,cAAc,CAAC,cAAc,EAAE,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;iBACxF,iBAAiB,CAAC,UAAU,CAAC,cAAc,CAAC,YAAY,EAAE,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,IAAI,aAAa,CAAC;iBAC/G,iBAAiB,CAAC,UAAU,CAAC,cAAc,CAAC,KAAK,EAAE,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;iBAC/G,iBAAiB,CAAC,UAAU,CAAC,cAAc,CAAC,YAAY,EAAE,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,UAAU,CAAC;iBACjH,iBAAiB,CAAC,UAAU,CAAC,cAAc,CAAC,gBAAgB,EAAE,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,UAAU,EAAE,CAAC,CAAC;QACjH,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,YAAY,EAAE,GAAG,EAC9C,sBAAsB,EAAE,IAAI,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,YAAY,EAAE,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,KAAK,CAAC,CAAC;QAE7H,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,UAAU,CAAC,cAAc,CAAC,gBAAgB,CAAC,oBAAoB,EAC9G,oBAAoB,EAAE,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;QAEnE,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,YAAY,EAAE,IAAI,EAC/C,sBAAsB,EAAE,IAAI,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;IACzE,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAAC,KAAa,EAAE,KAAqB;QAEnE,MAAM,UAAU,GAAG,KAAK,KAAK,IAAI,CAAC,iBAAiB,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/E,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,UAAU,CAAC,EAAE,CAAC;YACrE,OAAO;QACT,CAAC;QAED,IAAI,UAAU,EAAE,CAAC;YACf,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QACnE,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,oBAAoB,CAAC,KAAa,EAAE,KAAqB;QAErE,MAAM,YAAY,GAAG,KAAK,KAAK,IAAI,CAAC,iBAAiB,CAAC,mBAAmB,CAAC,CAAC;QAC3E,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CAAC,YAAY,EAAE,YAAY,CAAC,EAAE,CAAC;YACnE,OAAO;QACT,CAAC;QAED,IAAI,YAAY,EAAE,CAAC;YACjB,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QACpD,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;QACvE,CAAC;IACH,CAAC;CACF"}
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../../src/accessory/abstract/base.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAE1C,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAE7D,OAAO,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAC;AAEjF,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAqB,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAG9E,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,UAAU,MAAM,wBAAwB,CAAC;AAEhD,MAAM,OAAgB,aAAmE,SAAQ,aAAgB;IAE/G,YAAY,UAAsC;QAChD,KAAK,CAAC,UAAU,CAAC,CAAC;QAElB,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC;YAC5B,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC,oBAAoB,CAAE;iBACxE,iBAAiB,CAAC,UAAU,CAAC,cAAc,CAAC,IAAI,EAAE,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;iBAC9E,iBAAiB,CAAC,UAAU,CAAC,cAAc,CAAC,cAAc,EAAE,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;iBACxF,iBAAiB,CAAC,UAAU,CAAC,cAAc,CAAC,YAAY,EAAE,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,IAAI,aAAa,CAAC;iBAC/G,iBAAiB,CAAC,UAAU,CAAC,cAAc,CAAC,KAAK,EAAE,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;iBAC/G,iBAAiB,CAAC,UAAU,CAAC,cAAc,CAAC,YAAY,EAAE,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,UAAU,CAAC;iBACjH,iBAAiB,CAAC,UAAU,CAAC,cAAc,CAAC,gBAAgB,EAAE,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,UAAU,EAAE,CAAC,CAAC;QACjH,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,YAAY,EAAE,GAAG,EAC9C,sBAAsB,EAAE,IAAI,CAAC,mBAAmB,CAAC,mBAAmB,CAAC,YAAY,EAAE,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,EAAE,KAAK,CAAC,CAAC;QAE7H,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,UAAU,CAAC,cAAc,CAAC,gBAAgB,CAAC,oBAAoB,EAC9G,oBAAoB,EACpB,IAAI,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,gBAAgB,EAAE,iBAAiB,EACpF,OAAO,CAAC,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC,SAAS,CAAC,aAAa,EAAE,OAAO,CAAC,OAAO,CAAC,EACjF,KAAK,CACN,CAAC;QAEF,IAAI,CAAC,KAAK,CAAC,mBAAmB,CAAC,YAAY,EAAE,IAAI,EAC/C,sBAAsB,EACtB,IAAI,CAAC,yBAAyB,CAAC,mBAAmB,CAAC,YAAY,EAAE,mBAAmB,EAClF,OAAO,CAAC,SAAS,CAAC,YAAY,EAAE,OAAO,CAAC,SAAS,CAAC,cAAc,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,EACpG,KAAK,CAAC,CAAC;IACX,CAAC;IAEQ,wBAAwB,CAAC,GAAsB;QACtD,OAAO,KAAK,CAAC,wBAAwB,CAAC,GAAG,CAAC,IAAI,0BAA0B,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvG,CAAC;CACF"}

package/dist/accessory/abstract/common.d.ts

@@ -10,6 +10,8 @@ export type TopicHandler = {
     handler: OnUpdateHandler;
 };
 export type PublishHandler = (topic: string, value: PrimitiveTypes) => void;
+type NumberCallback = (value: number) => void;
+type BooleanCallback = (value: boolean) => void;
 export declare abstract class Common<C extends Assertable> {
     readonly name: string;
     private _properties;
@@ -23,23 +25,32 @@ export declare abstract class Common<C extends Assertable> {
     protected abstract get identifier(): string;
     protected abstract get useStoredProperties(): boolean;
     protected abstract publish(rawTopic: string, value: PrimitiveTypes): void;
-    protected get properties(): Properties;
+    get properties(): Properties;
     protected assert(...keys: (keyof C)[]): boolean;
     protected assertType(expectedType: Type, ...keys: (keyof C)[]): boolean;
     protected getRawValue(property: keyof C, assert?: boolean): string | undefined;
     protected getPrimitiveValue(property: keyof C, assert?: boolean): PrimitiveTypes | undefined;
     protected addTopicHandlers(topicHandlers: TopicHandler[]): void;
+    protected isOptionalCharacteristic(key: CharacteristicKey): boolean;
     protected setup(characteristicKey: CharacteristicKey, defaultValue: CharacteristicValue, getTopicKey: keyof C, onUpdateHandler: OnUpdateHandler, assertGetTopic: boolean, setTopicKey?: keyof C | undefined, onSetHandler?: CharacteristicSetHandler | undefined): Characteristic | undefined;
     private setupGet;
     protected setupSet(characteristicKey: CharacteristicKey, setTopicKey?: keyof C | undefined, onSetHandler?: CharacteristicSetHandler | undefined): void;
-    protected bindOnUpdateNumeric(key: CharacteristicKey, logTemplate: string): OnUpdateHandler;
-    protected bindOnUpdateBoolean(key: CharacteristicKey, positiveKey: keyof C, negativeKey: keyof C, logTrue: string, logFalse: string): OnUpdateHandler;
-    protected bindOnUpdateNumericBoolean(charKey: CharacteristicKey, valueKey: keyof C, logTrue: string, logFalse: string): OnUpdateHandler;
-    protected bindOnUpdateTemperature<C extends TemperatureConfig>(config: C, charKey: CharacteristicKey, logTemplate: string): OnUpdateHandler;
+    protected setupTopicless(characteristicKey: CharacteristicKey, defaultValue: CharacteristicValue, onSetCallback?: (value: CharacteristicValue) => (void)): Characteristic | undefined;
+    protected bindOnUpdateNumeric(key: CharacteristicKey, logTemplate: string, callback?: NumberCallback): OnUpdateHandler;
+    protected bindOnUpdateBoolean(key: CharacteristicKey, trueKey: keyof C, falseKey: keyof C, logTrue: string, logFalse: string, callback?: BooleanCallback): OnUpdateHandler;
+    protected bindOnUpdateBooleanSingle(key: CharacteristicKey, valueKey: keyof C, trueLog: string, falseLog: string, trueLogType?: LogType, falseLogType?: LogType): (_topic: string, value: PrimitiveTypes) => Promise<void>;
+    protected bindOnUpdateNumericBoolean(charKey: CharacteristicKey, valueKey: keyof C, logTrue: string, logFalse: string, callback?: NumberCallback): OnUpdateHandler;
+    protected bindOnUpdateTemperature<C extends TemperatureConfig>(config: C, charKey: CharacteristicKey, logTemplate: string, callback?: NumberCallback): OnUpdateHandler;
+    protected bindOnUpdateState(key: CharacteristicKey, states: Map<keyof C, CharacteristicValue>, strings: Map<CharacteristicValue, string>, unknownLog: string): (_topic: string, value: PrimitiveTypes) => Promise<void>;
+    private onSetNumeric;
     protected bindOnSetNumeric(key: CharacteristicKey, topic: keyof C, logTemplate: string): (value: CharacteristicValue) => Promise<void>;
-    protected bindOnSetBoolean(key: CharacteristicKey, setTopicKey: keyof C, positiveKey: keyof C, negativeKey: keyof C, positiveValue: CharacteristicValue, positiveLogString: string, negativeLogString: string): (value: CharacteristicValue) => Promise<void>;
+    protected bindOnSetPercentOrValue(key: CharacteristicKey, topic: keyof C, maximum: number | undefined, logPercent: string, logValue: string): (value: CharacteristicValue) => Promise<void>;
+    protected bindOnSetBoolean(key: CharacteristicKey, setTopicKey: keyof C, trueValueKey: keyof C, falseValueKey: keyof C, trueValue: CharacteristicValue, trueLog: string, falseLog: string, callback?: BooleanCallback): (value: CharacteristicValue) => Promise<void>;
+    protected bindOnSetState(key: CharacteristicKey, setTopicKey: keyof C, states: Map<keyof C, CharacteristicValue>, strings: Map<CharacteristicValue, string>, badValueLog: string): (value: CharacteristicValue) => Promise<void>;
     protected onUpdate(key: CharacteristicKey, value: CharacteristicValue, logString?: string | undefined): boolean;
     protected onSet(key: CharacteristicKey, value: CharacteristicValue, publish: PrimitiveTypes, topic: keyof C, logString: string | undefined): void;
+    protected updateNumericValue(key: CharacteristicKey, delta: number): void;
+    protected characteristicFromKey(key: CharacteristicKey): any;
     protected logIfDesired(message: string, ...parameters: string[]): void;
     protected logIfDesired(level: LogType, message: string, ...parameters: string[]): void;
 }