homebridge-easy-mqtt 1.0.0-beta.0 → 1.0.0-beta.1

package/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 All notable changes to homebridge-dummy will be documented in this file.
 
-## 1.0.0 (####-##-##)
+## 1.0.0-beta.1 (2025-06-26)
 
-- Initial public release
+### ⚠️ BREAKING
+- Several topics were renamed for consistency so some accessories may have to be reconfigured
+
+### Added
+- Username/password can now be set in the UI or supplied via config
+- Outlet accessory type
+
+### Fixed
+- Unnecessary idle timer in mqtt library 
+
+## 1.0.0-beta.0 (2025-06-25)
+
+- Initial beta release

package/README.md

@@ -23,7 +23,7 @@ Any issues or damage resulting from use of this plugin are not the fault of the
 
 This plugin is designed to be a simple replacement for the fantastic [homebridge-mqttthing](https://github.com/arachnetech/homebridge-mqttthing) plugin which appears as though it's [no longer](https://github.com/arachnetech/homebridge-mqttthing/commits/master/) being actively developed.
 
-**HomebridgeEasyMQTT** currently supports just two types of accessories, `LockMechanism` and `Switch`, but will be expanded over time as more use cases are discovered. If there is an accessory type you'd like to see supported, please feel free to [create an issue in GitHub](https://github.com/mpatfield/homebridge-easy-mqtt/issues).
+**HomebridgeEasyMQTT** currently supports `Lightbulb`, `LockMechanism`, `Outlet`, and `Switch`, but will be expanded over time as more use cases are discovered. If there is an accessory type you'd like to see supported, please feel free to [create an issue in GitHub](https://github.com/mpatfield/homebridge-easy-mqtt/issues/new/choose).
 
 ## Configuration
 
@@ -44,18 +44,20 @@ Using the Homebridge Config UI is the easiest way to set up this plugin. However
       },
       "mqtt": {
         "broker": "string",
+        "username": "string",
+        "password": "string",
         "options": "string"
       },
-      "topicGetActive": "string",
-      "topicGetCurrent": "string",
-      "topicGetTarget": "string",
-      "topicSetTarget": "string",
+      "topicGetStatusActive": "string",
+      "topicGetLockCurrentState": "string",
+      "topicGetLockTargetState": "string",
+      "topicSetTargetState": "string",
       "topicGetOn": "string",
       "topicSetOn": "string",
-      "valueActive": "string",
-      "valueSecured": "string",
-      "valueUnsecured": "string",
-      "valueJammed": "string",
+      "valueStatusActive": "string",
+      "valueLockStateSecured": "string",
+      "valueLockStateUnsecured": "string",
+      "valueLockStateJammed": "string",
       "valueOn": "string",
       "valueOff": "string",
       "disableLogging": false
@@ -71,7 +73,7 @@ All fields are required unless noted as "(Optional)"
 
 Info:
 - `name` - The display name for the accessory in HomeKit
-- `type` - The type of accessory, currently only LockMechanism and Switch are supported
+- `type` - The type of accessory, currently Lightbulb, LockMechanism, Outlet, and Switch are supported
 - `manufacturer` - (Optional) The accessory manufacturer which will display in HomeKit device details
 - `model` - (Optional) The accessory model which will display in HomeKit device details
 - `serialNumber` - (Optional) The accessory serial number which will display in HomeKit device details
@@ -79,37 +81,65 @@ Info:
 
 MQTT:
 - `broker` - The URL and port to use for communicating with your MQTT device
-- `options` - (Optional) See [MQTT Options](https://github.com/mpatfield/homebridge-easy-mqtt#mqtt-options) below
+- `username` - (Optional) Username
+- `password` - (Optional) Password
+- `options` - (Optional) See [MQTT Options](#mqtt-options) below
 
 Topics:
 
 You will need to make sure to populate the appropriate topics based on the type.
 
-You may define topics using a JSONPath dot notation to assist the parser in finding the right value within the message. See [JSONPaths](https://github.com/mpatfield/homebridge-easy-mqtt#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. See [JSONPaths](#jsonpaths) below for more details.
 
 - General Purpose
-  - `topicGetActive` - (Optional) Whether or not the accessory is connected/reachable
+  - `topicGetStatusActive` - (Optional) Whether or not the accessory is connected/reachable
+
+- Lightbulb
+  - `topicGetBrightness` - The current brightness as a percent
+  - `topicSetBrightness` - For setting the brightness
+  - `topicGetHue` - The lightbulb's current hue
+  - `topicSetHue` - For setting the lightbulb's current hue
+  - `topicGetColorTemperature` - The current color temperature of the lightbulb
+  - `topicSetColorTemperature` - For setting the color temperature of the lightbulb
+  - `topicGetSaturation` - The current saturation setting of the lightbulb
+  - `topicSetSaturation` - For setting the saturation setting of the lightbulb
 
 - LockMechanism
-  - `topicGetCurrent` - The current state of the lock, i.e. locked/unlocked
-  - `topicGetTarget` - The target (i.e. desired) state of the lock
-  - `topicSetTarget` - For setting the target (i.e. desired) state of the lock
+  - `topicGetLockCurrentState` - The current state of the lock, i.e. locked/unlocked
+  - `topicGetLockTargetState` - The target (i.e. desired) state of the lock
+  - `topicSetTargetState` - For setting the target (i.e. desired) state of the lock
+
+- 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 currently being used
+  - `topicSetOutletInUse` - For setting whether the outlet is currently being used
 
 - Switch
   - `topicGetOn` - The current state of the switch, i.e. on/off
-  - `topicSetOn` - For setting the desired state of the switch
+  - `topicSetOn` - For setting the state of the switch
 
 Values:
 
 As with Topics, you will 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.
 
 - General Purpose
-  - `valueActive` - Accessory is connected/reachable, e.g. "true", "1", or "Alive"
+  - `valueStatusActive` - Accessory is connected/reachable, e.g. "true", "1", or "Alive"
+
+- Lightbulb
+  - `valueOn` - Turned on, e.g. "true", or "1", or "On" 
+  - `valueOff` - Turned off, e.g. "false", or "0", or "Off" 
 
 - LockMechanism
-  - `valueSecured` - Locked state, e.g. "true", "255", or "Locked"
-  - `valueUnsecured` - Unlocked state, e.g. "false", "0", or "Unlocked"
-  - `valueJammed` - (Optional) Lock is jammed, e.g. "254" or "Jammed"
+  - `valueLockStateSecured` - Locked state, e.g. "true", "255", or "Locked"
+  - `valueLockStateUnsecured` - Unlocked state, e.g. "false", "0", or "Unlocked"
+  - `valueLockStateJammed` - (Optional) Lock is jammed, e.g. "254" or "Jammed"
+
+- Outlet
+  - `valueOn` - Turned on, e.g. "true", or "1", or "On" 
+  - `valueOff` - Turned off, e.g. "false", or "0", or "Off" 
+  - `valueOutletInUse` - Currently being used, e.g. "true", or "1", or "On" 
+  - `valueOutletNotInUse` - Currently not being used, e.g. "false", or "0", or "Off" 
 
 - Switch
   - `valueOn` - Turned on, e.g. "true", or "1", or "On" 
@@ -129,10 +159,10 @@ You may also turn on additional logging if you'd like to see the MQTT messages p
 
 ## MQTT Options
 
-You are able to pass in any arbitrary MQTT options via `mqtt.options` in the config. This can include, among other things, username/password, keepalive, rejectUnauthorized, etc. Just make sure the value provided is valid JSON. For example:
+You are able to pass in any arbitrary MQTT options via `mqtt.options` in the config. This can include, for example, such as clientId, protocolVersion, etc. Just make sure the value provided is valid JSON. For example:
 
 ```
-"options": "{ \"username\": \"fake@email.com\", \"password\": \"password123\", \"rejectUnauthorized\": true }"
+"options": "{ \"protocolVersion\": \"4\", \"clientId\": \"my-client-id\", \"rejectUnauthorized\": true }"
 ```
 
 ## JSONPaths
@@ -172,5 +202,4 @@ would use the topic
 
 [@arachnetech](https://github.com/arachnetech) for the fantastic [homebridge-mqttthing](https://github.com/arachnetech/homebridge-mqttthing) plugin which serves as the main inspiration for this project
 
-And to the amazing creators/contributors of [Homebridge](https://homebridge.io) who made this plugin possible!
-And to the amazing creators/contributors of [Homebridge](https://homebridge.io) who made this plugin possible!
+And to the amazing creators/contributors of [Homebridge](https://homebridge.io) who made this plugin possible!

package/config.schema.json

@@ -4,7 +4,6 @@
   "singular": true,
   "customUi": true,
   "customUiPath": "./dist/homebridge-ui",
-  "strictValidation": true,
   "schema": {
     "type": "object",
     "definitions": {
@@ -13,14 +12,16 @@
         "properties": {
           "name": {
               "type": "string",
-              "title": "${config.title.name}",
+              "title": "${config.title.name}" ,         
               "required": true
-          },
+            },
           "type": {
             "type": "string",
             "title": "${config.title.type}",
             "enum": [
+              "Lightbulb",
               "LockMechanism",
+              "Outlet",
               "Switch"
             ],
             "required": true
@@ -52,11 +53,19 @@
             "placeholder": "mqtts://192.168.0.1:1883",
             "required": true
           },
+          "username": {
+            "type": "string",
+            "title": "${config.title.username}"
+          },
+          "password": {
+            "type": "string",
+            "title": "${config.title.password}"
+          },
           "options": {
             "type": "string",
             "title": "${config.title.options}",
             "description": "${config.description.options}",
-            "placeholder": "{ \"username\": \"fake@email.com\", \"password\": \"password123\" , \"rejectUnauthorized\": true }"
+            "placeholder": "{ \"protocolVersion\": \"4\", \"clientId\": \"my-client-id\", \"rejectUnauthorized\": true }"
           }
         }
       }
@@ -73,52 +82,86 @@
           "properties": {
             "info": { "$ref": "#/definitions/info" },
             "mqtt": { "$ref": "#/definitions/mqtt" },
-            "topicGetActive": {
+            "topicGetStatusActive": {
+              "type": "string",
+              "title": "${config.title.topicGetStatusActive}"
+            },
+            "topicGetBrightness": {
+              "type": "string",
+              "title": "${config.title.topicGetBrightness}"
+            },
+            "topicSetBrightness": {
+              "type": "string",
+              "title": "${config.title.topicSetBrightness}"
+            },
+            "topicGetHue": {
               "type": "string",
-              "title": "${config.title.topicGetActive}",
-              "placeholder": "zwave/door_lock/front_door/status"
+              "title": "${config.title.topicGetHue}"
             },
-            "topicGetCurrent": {
+            "topicSetHue": {
               "type": "string",
-              "title": "${config.title.topicGetCurrent}",
-              "placeholder": "zwave/door_lock/front_door/currentMode"
+              "title": "${config.title.topicSetHue}"
             },
-            "topicGetTarget": {
+            "topicGetColorTemperature": {
               "type": "string",
-              "title": "${config.title.topicGetTarget}",
-              "placeholder": "zwave/door_lock/front_door/targetMode"
+              "title": "${config.title.topicGetColorTemperature}"
             },
-            "topicSetTarget": {
+            "topicSetColorTemperature": {
               "type": "string",
-              "title": "${config.title.topicSetTarget}",
-              "placeholder": "zwave/door_lock/front_door/targetMode/set"
+              "title": "${config.title.topicSetColorTemperature}"
+            },
+            "topicGetSaturation": {
+              "type": "string",
+              "title": "${config.title.topicGetSaturation}"
+            },
+            "topicSetSaturation": {
+              "type": "string",
+              "title": "${config.title.topicSetSaturation}"
+            },
+            "topicGetLockCurrentState": {
+              "type": "string",
+              "title": "${config.title.topicGetLockCurrentState}"
+            },
+            "topicGetLockTargetState": {
+              "type": "string",
+              "title": "${config.title.topicGetLockTargetState}"
+            },
+            "topicSetTargetState": {
+              "type": "string",
+              "title": "${config.title.topicSetTargetState}"
             },
             "topicGetOn": {
               "type": "string",
-              "title": "${config.title.topicGetOn}",
-              "placeholder": "home/living_room/lamp/state"
+              "title": "${config.title.topicGetOn}"
             },
             "topicSetOn": {
               "type": "string",
-              "title": "${config.title.topicSetOn}",
-              "placeholder": "home/living_room/lamp/state/set"
+              "title": "${config.title.topicSetOn}"
+            },
+            "topicGetOutletInUse": {
+              "type": "string",
+              "title": "${config.title.topicGetOutletInUse}"
             },
-            "valueActive": {
+            "topicSetOutletInUse": {
               "type": "string",
-              "title": "${config.title.valueActive}",
-              "description": "${config.description.valueActive}"
+              "title": "${config.title.topicSetOutletInUse}"
             },
-            "valueSecured": {
+            "valueStatusActive": {
               "type": "string",
-              "title": "${config.title.valueSecured}"
+              "title": "${config.title.valueStatusActive}",
+              "description": "${config.description.valueStatusActive}"
             },
-            "valueUnsecured": {
+            "valueLockStateSecured": {
               "type": "string",
-              "title": "${config.title.valueUnsecured}"
+              "title": "${config.title.valueLockStateSecured}"
             },
-            "valueJammed": {
+            "valueLockStateUnsecured": {
               "type": "string",
-              "title": "${config.title.valueJammed}"
+              "title": "${config.title.valueLockStateUnsecured}"
+            },
+            "valueLockStateJammed": {
+              "type": "string",
+              "title": "${config.title.valueLockStateJammed}"
             },
             "valueOn": {
               "type": "string",
@@ -128,6 +171,14 @@
               "type": "string",
               "title": "${config.title.valueOff}"
             },
+            "valueOutletInUse": {
+              "type": "string",
+              "title": "${config.title.valueOutletInUse}"
+            },
+            "valueOutletNotInUse": {
+              "type": "string",
+              "title": "${config.title.valueOutletNotInUse}"
+            },
             "disableLogging": {
               "type": "boolean",
               "title": "${config.title.disableLogging}",
@@ -212,6 +263,21 @@
               "title": "${config.title.mqtt}",
               "items": [
                 "accessories[].mqtt.broker",
+                {
+                  "type": "div",
+                  "displayFlex": true,
+                  "flex-direction": "row",
+                  "items": [
+                    {
+                      "key": "accessories[].mqtt.username",
+                      "flex": "1 1 0"
+                    },
+                    {
+                      "key": "accessories[].mqtt.password",
+                      "flex": "1 1 0"
+                    }
+                  ]
+                },
                 "accessories[].mqtt.options"
               ]
             },
@@ -221,36 +287,96 @@
               "title": "${config.title.topics}",
               "items": [
                 {
-                  "key": "accessories[].topicGetCurrent",
+                  "key": "accessories[].topicGetLockCurrentState",
                   "condition": {
-                    "functionBody": "const index = arguments[1]; return model.accessories[index]?.info.type === 'LockMechanism';"
+                    "functionBody": "return model.accessories?.[arguments[1]]?.info?.type === 'LockMechanism';"
                   }
                 },
                 {
-                  "key": "accessories[].topicGetTarget",
+                  "key": "accessories[].topicGetLockTargetState",
                   "condition": {
-                    "functionBody": "const index = arguments[1]; return model.accessories[index]?.info.type === 'LockMechanism';"
+                    "functionBody": "return model.accessories?.[arguments[1]]?.info?.type === 'LockMechanism';"
                   }
                 },
                 {
-                  "key": "accessories[].topicSetTarget",
+                  "key": "accessories[].topicSetTargetState",
                   "condition": {
-                    "functionBody": "const index = arguments[1]; return model.accessories[index]?.info.type === 'LockMechanism';"
+                    "functionBody": "return model.accessories?.[arguments[1]]?.info?.type === 'LockMechanism';"
                   }
                 },
                 {
                   "key": "accessories[].topicGetOn",
                   "condition": {
-                    "functionBody": "const index = arguments[1]; return model.accessories[index]?.info.type === 'Switch';"
+                    "functionBody": "return ['Lightbulb', 'Outlet', 'Switch'].includes(model.accessories?.[arguments[1]]?.info?.type);"
                   }
                 },
                 {
                   "key": "accessories[].topicSetOn",
                   "condition": {
-                    "functionBody": "const index = arguments[1]; return model.accessories[index]?.info.type === 'Switch';"
+                    "functionBody": "return ['Lightbulb', 'Outlet', 'Switch'].includes(model.accessories?.[arguments[1]]?.info?.type);"
+                  }
+                },
+                {
+                  "key": "accessories[].topicGetBrightness",
+                  "condition": {
+                    "functionBody": "return model.accessories?.[arguments[1]]?.info?.type === 'Lightbulb';"
+                  }
+                },
+                {
+                  "key": "accessories[].topicSetBrightness",
+                  "condition": {
+                    "functionBody": "return model.accessories?.[arguments[1]]?.info?.type === 'Lightbulb';"
+                  }
+                },
+                {
+                  "key": "accessories[].topicGetHue",
+                  "condition": {
+                    "functionBody": "return model.accessories?.[arguments[1]]?.info?.type === 'Lightbulb';"
+                  }
+                },
+                {
+                  "key": "accessories[].topicSetHue",
+                  "condition": {
+                    "functionBody": "return model.accessories?.[arguments[1]]?.info?.type === 'Lightbulb';"
+                  }
+                },
+                {
+                  "key": "accessories[].topicGetColorTemperature",
+                  "condition": {
+                    "functionBody": "return model.accessories?.[arguments[1]]?.info?.type === 'Lightbulb';"
+                  }
+                },
+                {
+                  "key": "accessories[].topicSetColorTemperature",
+                  "condition": {
+                    "functionBody": "return model.accessories?.[arguments[1]]?.info?.type === 'Lightbulb';"
+                  }
+                },
+                {
+                  "key": "accessories[].topicGetSaturation",
+                  "condition": {
+                    "functionBody": "return model.accessories?.[arguments[1]]?.info?.type === 'Lightbulb';"
+                  }
+                },
+                {
+                  "key": "accessories[].topicSetSaturation",
+                  "condition": {
+                    "functionBody": "return model.accessories?.[arguments[1]]?.info?.type === 'Lightbulb';"
+                  }
+                },
+                {
+                  "key": "accessories[].topicGetOutletInUse",
+                  "condition": {
+                    "functionBody": "return model.accessories?.[arguments[1]]?.info?.type === 'Outlet';"
+                  }
+                },
+                {
+                  "key": "accessories[].topicSetOutletInUse",
+                  "condition": {
+                    "functionBody": "return model.accessories?.[arguments[1]]?.info?.type === 'Outlet';"
                   }
                 },
-                "accessories[].topicGetActive"
+                "accessories[].topicGetStatusActive"
               ]
             },
             {
@@ -262,17 +388,21 @@
                   "displayFlex": true,
                   "flex-direction": "row",
                   "condition": {
-                    "functionBody": "const index = arguments[1]; return model.accessories[index]?.info.type === 'LockMechanism';"
+                    "functionBody": "return model.accessories?.[arguments[1]]?.info?.type === 'LockMechanism';"
                   },
                   "items": [
                     {
-                      "key": "accessories[].valueSecured",
+                      "key": "accessories[].valueLockStateSecured",
                       "flex": "1 1 0"
                     },
                     {
-                      "key": "accessories[].valueUnsecured",
+                      "key": "accessories[].valueLockStateUnsecured",
                       "flex": "1 1 0"
-                    }
+                    },
+                    {
+                      "key": "accessories[].valueLockStateJammed",
+                      "flex": "1 1 0"
+                    }                    
                   ]
                 },
                 {
@@ -280,15 +410,15 @@
                   "displayFlex": true,
                   "flex-direction": "row",
                   "condition": {
-                    "functionBody": "const index = arguments[1]; return model.accessories[index]?.info.type === 'LockMechanism';"
+                    "functionBody": "return ['Lightbulb', 'Outlet', 'Switch'].includes(model.accessories?.[arguments[1]]?.info?.type);"
                   },
                   "items": [
                     {
-                      "key": "accessories[].valueJammed",
+                      "key": "accessories[].valueOn",
                       "flex": "1 1 0"
                     },
                     {
-                      "key": "accessories[].valueActive",
+                      "key": "accessories[].valueOff",
                       "flex": "1 1 0"
                     }
                   ]
@@ -298,23 +428,20 @@
                   "displayFlex": true,
                   "flex-direction": "row",
                   "condition": {
-                    "functionBody": "const index = arguments[1]; return model.accessories[index]?.info.type === 'Switch';"
+                    "functionBody": "return model.accessories?.[arguments[1]]?.info?.type === 'Outlet';"
                   },
                   "items": [
                     {
-                      "key": "accessories[].valueOn",
-                      "flex": "1 1 0"
-                    },
-                    {
-                      "key": "accessories[].valueOff",
+                      "key": "accessories[].valueOutletInUse",
                       "flex": "1 1 0"
                     },
                     {
-                      "key": "accessories[].valueActive",
+                      "key": "accessories[].valueOutletNotInUse",
                       "flex": "1 1 0"
                     }
                   ]
-                }
+                },
+                "accessories[].valueStatusActive"
               ]
             }          
           ]

package/dist/accessory/base.d.ts

@@ -1,5 +1,5 @@
 import { PlatformAccessory } from 'homebridge';
-import { AccessoryConfig, Primitive } from '../model/types.js';
+import { AccessoryConfig, CharacteristicType, Primitive, ServiceType } from '../model/types.js';
 import { Log } from '../tools/log.js';
 export type TopicHandler = {
     topic: string;
@@ -7,15 +7,17 @@ export type TopicHandler = {
 };
 export declare function makeHandler(topic: string, handler: (topic: string, value: Primitive) => Promise<void>): TopicHandler;
 export declare abstract class MQTTAccessory {
-    protected readonly Service: typeof import('homebridge').Service;
-    protected readonly Characteristic: typeof import('homebridge').Characteristic;
-    private readonly _config;
+    protected readonly Service: ServiceType;
+    protected readonly Characteristic: CharacteristicType;
+    protected readonly accessory: PlatformAccessory;
+    protected readonly config: AccessoryConfig;
     protected readonly log: Log;
     private readonly mqttClient;
-    constructor(Service: typeof import('homebridge').Service, Characteristic: typeof import('homebridge').Characteristic, accessory: PlatformAccessory, _config: AccessoryConfig, log: Log, caller: string);
+    constructor(Service: ServiceType, Characteristic: CharacteristicType, accessory: PlatformAccessory, config: AccessoryConfig, log: Log, caller: string);
     private onMQTTConnect;
     protected abstract get topicHandlers(): TopicHandler[];
     protected publish(topic: string, value: Primitive): void;
     teardown(): void;
     protected assert(...keys: (keyof any)[]): boolean;
+    protected logIfDesired(message: string, ...parameters: string[]): void;
 }

package/dist/accessory/base.js

@@ -8,25 +8,27 @@ export function makeHandler(topic, handler) {
 export class MQTTAccessory {
     Service;
     Characteristic;
-    _config;
+    accessory;
+    config;
     log;
     mqttClient;
-    constructor(Service, Characteristic, accessory, _config, log, caller) {
+    constructor(Service, Characteristic, accessory, config, log, caller) {
         this.Service = Service;
         this.Characteristic = Characteristic;
-        this._config = _config;
+        this.accessory = accessory;
+        this.config = config;
         this.log = log;
         if (this.assert('mqtt')) {
-            this.mqttClient = new MQTT(log, _config.mqtt, this.onMQTTConnect.bind(this), _config.info.name);
+            this.mqttClient = new MQTT(log, config.mqtt, this.onMQTTConnect.bind(this), config.info.name);
             this.mqttClient.connect();
         }
         accessory.getService(Service.AccessoryInformation)
-            .setCharacteristic(Characteristic.Name, _config.info.name)
-            .setCharacteristic(Characteristic.ConfiguredName, _config.info.name)
-            .setCharacteristic(Characteristic.Manufacturer, _config.info.manufacturer ?? 'Homebridge')
-            .setCharacteristic(Characteristic.SerialNumber, _config.info.serialNumber ?? `${PLATFORM_NAME}:${_config.info.name}`)
-            .setCharacteristic(Characteristic.Model, _config.info.model ?? caller)
-            .setCharacteristic(Characteristic.FirmwareRevision, _config.info.version ?? getVersion());
+            .setCharacteristic(Characteristic.Name, config.info.name)
+            .setCharacteristic(Characteristic.ConfiguredName, config.info.name)
+            .setCharacteristic(Characteristic.Manufacturer, config.info.manufacturer ?? 'Homebridge')
+            .setCharacteristic(Characteristic.SerialNumber, config.info.serialNumber ?? `${PLATFORM_NAME}:${config.info.name}`)
+            .setCharacteristic(Characteristic.Model, config.info.model ?? caller)
+            .setCharacteristic(Characteristic.FirmwareRevision, config.info.version ?? getVersion());
     }
     async onMQTTConnect() {
         this.topicHandlers.forEach(topicHandler => {
@@ -41,7 +43,13 @@ export class MQTTAccessory {
     }
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     assert(...keys) {
-        return assert(this.log, this._config.info.name, this._config, ...keys);
+        return assert(this.log, this.config.info.name, this.config, ...keys);
+    }
+    logIfDesired(message, ...parameters) {
+        if (this.config.disableLogging) {
+            return;
+        }
+        this.log.always(message, ...parameters);
     }
 }
 //# sourceMappingURL=base.js.map

package/dist/accessory/base.js.map

@@ -1 +1 @@
-{"version":3,"file":"base.js","sourceRoot":"","sources":["../../src/accessory/base.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE1D,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAIxC,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAIhD,MAAM,UAAU,WAAW,CAAC,KAAa,EAAE,OAA2D;IACpG,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;AAC5B,CAAC;AAED,MAAM,OAAgB,aAAa;IAKZ;IACA;IAEF;IACE;IAPJ,UAAU,CAAmB;IAE9C,YACqB,OAA4C,EAC5C,cAA0D,EAC7E,SAA4B,EACX,OAAwB,EACtB,GAAQ,EAC3B,MAAc;QALK,YAAO,GAAP,OAAO,CAAqC;QAC5C,mBAAc,GAAd,cAAc,CAA4C;QAE5D,YAAO,GAAP,OAAO,CAAiB;QACtB,QAAG,GAAH,GAAG,CAAK;QAI3B,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;YACxB,IAAI,CAAC,UAAU,GAAG,IAAI,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAChG,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;QAC5B,CAAC;QAED,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,oBAAoB,CAAE;aAChD,iBAAiB,CAAC,cAAc,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;aACzD,iBAAiB,CAAC,cAAc,CAAC,cAAc,EAAE,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;aACnE,iBAAiB,CAAC,cAAc,CAAC,YAAY,EAAE,OAAO,CAAC,IAAI,CAAC,YAAY,IAAI,YAAY,CAAC;aACzF,iBAAiB,CAAC,cAAc,CAAC,YAAY,EAAE,OAAO,CAAC,IAAI,CAAC,YAAY,IAAI,GAAG,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;aACpH,iBAAiB,CAAC,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,IAAI,MAAM,CAAC;aACrE,iBAAiB,CAAC,cAAc,CAAC,gBAAgB,EAAE,OAAO,CAAC,IAAI,CAAC,OAAO,IAAI,UAAU,EAAE,CAAC,CAAC;IAC9F,CAAC;IAEO,KAAK,CAAC,aAAa;QACzB,IAAI,CAAC,aAAa,CAAC,OAAO,CAAE,YAAY,CAAC,EAAE;YACzC,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;IACL,CAAC;IAIS,OAAO,CAAC,KAAa,EAAE,KAAgB;QAC/C,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACzC,CAAC;IAEM,QAAQ;QACb,IAAI,CAAC,UAAU,EAAE,QAAQ,EAAE,CAAC;IAC9B,CAAC;IAED,8DAA8D;IACpD,MAAM,CAAC,GAAG,IAAmB;QACrC,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;IACzE,CAAC;CACF"}
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../src/accessory/base.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAE1D,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAIxC,OAAO,UAAU,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,MAAM,EAAE,MAAM,wBAAwB,CAAC;AAIhD,MAAM,UAAU,WAAW,CAAC,KAAa,EAAE,OAA2D;IACpG,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC;AAC5B,CAAC;AAED,MAAM,OAAgB,aAAa;IAKZ;IACA;IACA;IACA;IACA;IAPJ,UAAU,CAAmB;IAE9C,YACqB,OAAoB,EACpB,cAAkC,EAClC,SAA4B,EAC5B,MAAuB,EACvB,GAAQ,EAC3B,MAAc;QALK,YAAO,GAAP,OAAO,CAAa;QACpB,mBAAc,GAAd,cAAc,CAAoB;QAClC,cAAS,GAAT,SAAS,CAAmB;QAC5B,WAAM,GAAN,MAAM,CAAiB;QACvB,QAAG,GAAH,GAAG,CAAK;QAI3B,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;YACxB,IAAI,CAAC,UAAU,GAAG,IAAI,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9F,IAAI,CAAC,UAAU,CAAC,OAAO,EAAE,CAAC;QAC5B,CAAC;QAED,SAAS,CAAC,UAAU,CAAC,OAAO,CAAC,oBAAoB,CAAE;aAChD,iBAAiB,CAAC,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;aACxD,iBAAiB,CAAC,cAAc,CAAC,cAAc,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;aAClE,iBAAiB,CAAC,cAAc,CAAC,YAAY,EAAE,MAAM,CAAC,IAAI,CAAC,YAAY,IAAI,YAAY,CAAC;aACxF,iBAAiB,CAAC,cAAc,CAAC,YAAY,EAAE,MAAM,CAAC,IAAI,CAAC,YAAY,IAAI,GAAG,aAAa,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;aAClH,iBAAiB,CAAC,cAAc,CAAC,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,IAAI,MAAM,CAAC;aACpE,iBAAiB,CAAC,cAAc,CAAC,gBAAgB,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,UAAU,EAAE,CAAC,CAAC;IAC7F,CAAC;IAEO,KAAK,CAAC,aAAa;QACzB,IAAI,CAAC,aAAa,CAAC,OAAO,CAAE,YAAY,CAAC,EAAE;YACzC,IAAI,CAAC,UAAU,EAAE,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,YAAY,CAAC,OAAO,CAAC,CAAC;QACvE,CAAC,CAAC,CAAC;IACL,CAAC;IAIS,OAAO,CAAC,KAAa,EAAE,KAAgB;QAC/C,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACzC,CAAC;IAEM,QAAQ;QACb,IAAI,CAAC,UAAU,EAAE,QAAQ,EAAE,CAAC;IAC9B,CAAC;IAED,8DAA8D;IACpD,MAAM,CAAC,GAAG,IAAmB;QACrC,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC;IACvE,CAAC;IAES,YAAY,CAAC,OAAe,EAAE,GAAG,UAAoB;QAE7D,IAAI,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC;YAC/B,OAAO;QACT,CAAC;QAED,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,EAAE,GAAG,UAAU,CAAC,CAAC;IAC1C,CAAC;CACF"}