matterbridge-zigbee2mqtt 2.3.0-dev.4 → 2.3.0

package/dist/zigbee2mqtt.js

@@ -1,3 +1,25 @@
+/**
+ * This file contains the class Zigbee2MQTT and all the interfaces to communicate with zigbee2MQTT.
+ *
+ * @file zigbee2mqtt.ts
+ * @author Luca Liguori
+ * @date 2023-06-30
+ * @version 2.3.3
+ *
+ * Copyright 2023, 2024, 2025 Luca Liguori.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License. *
+ */
 import fs from 'fs';
 import path from 'path';
 import * as util from 'util';
@@ -8,7 +30,9 @@ import { AnsiLogger, rs, db, dn, gn, er, zb, hk, id, idn, ign, REVERSE, REVERSEO
 import { mkdir } from 'fs/promises';
 const writeFile = util.promisify(fs.writeFile);
 export class Zigbee2MQTT extends EventEmitter {
+    // Logger
     log;
+    // Instance properties
     mqttHost;
     mqttPort;
     mqttTopic;
@@ -31,17 +55,19 @@ export class Zigbee2MQTT extends EventEmitter {
     z2mDevices;
     z2mGroups;
     loggedEntries = 0;
+    // Define our MQTT options
     options = {
         clientId: 'classZigbee2MQTT_' + crypto.randomBytes(8).toString('hex'),
         keepalive: 60,
         protocolId: 'MQTT',
         protocolVersion: 5,
-        reconnectPeriod: 5000,
-        connectTimeout: 60 * 1000,
+        reconnectPeriod: 5000, // 1000
+        connectTimeout: 60 * 1000, // 30 * 1000
         username: undefined,
         password: undefined,
         clean: true,
     };
+    // Constructor
     constructor(mqttHost, mqttPort, mqttTopic, mqttUsername = undefined, mqttPassword = undefined, protocolVersion = 5, debug = false) {
         super();
         this.mqttHost = mqttHost;
@@ -59,11 +85,11 @@ export class Zigbee2MQTT extends EventEmitter {
         this.z2mVersion = '';
         this.z2mDevices = [];
         this.z2mGroups = [];
-        this.log = new AnsiLogger({ logName: 'Zigbee2MQTT', logTimestampFormat: 4, logLevel: debug ? "debug" : "info" });
+        this.log = new AnsiLogger({ logName: 'Zigbee2MQTT', logTimestampFormat: 4 /* TimestampFormat.TIME_MILLIS */, logLevel: debug ? "debug" /* LogLevel.DEBUG */ : "info" /* LogLevel.INFO */ });
         this.log.debug(`Created new instance with host: ${mqttHost} port: ${mqttPort} protocol ${protocolVersion} topic: ${mqttTopic} username: ${mqttUsername !== undefined && mqttUsername !== '' ? mqttUsername : 'undefined'} password: ${mqttPassword !== undefined && mqttPassword !== '' ? '*****' : 'undefined'}`);
     }
     setLogDebug(logDebug) {
-        this.log.logLevel = logDebug ? "debug" : "info";
+        this.log.logLevel = logDebug ? "debug" /* LogLevel.DEBUG */ : "info" /* LogLevel.INFO */;
     }
     async setDataPath(dataPath) {
         try {
@@ -81,6 +107,7 @@ export class Zigbee2MQTT extends EventEmitter {
             }
         }
     }
+    // Get the URL for connect
     getUrl() {
         return 'mqtt://' + this.mqttHost + ':' + this.mqttPort.toString();
     }
@@ -90,12 +117,13 @@ export class Zigbee2MQTT extends EventEmitter {
             .then((client) => {
             this.log.debug('Connection established');
             this.mqttClient = client;
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
             this.mqttClient.on('connect', (packet) => {
-                this.log.debug(`MQTT client connect to ${this.getUrl()}${rs}`);
+                this.log.debug(`MQTT client connect to ${this.getUrl()}${rs}` /* , connack*/);
                 this.mqttIsConnected = true;
                 this.mqttIsReconnecting = false;
                 this.mqttIsEnding = false;
-                this.emit('mqtt_connect');
+                this.emit('mqtt_connect'); // Never emitted at the start cause we connect async
             });
             this.mqttClient.on('reconnect', () => {
                 this.log.debug(`MQTT client reconnect to ${this.getUrl()}${rs}`);
@@ -126,11 +154,17 @@ export class Zigbee2MQTT extends EventEmitter {
                 this.log.debug('MQTT client error', error);
                 this.emit('mqtt_error', error);
             });
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
             this.mqttClient.on('packetsend', (packet) => {
+                // this.log.debug('classZigbee2MQTT=>Event packetsend');
             });
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
             this.mqttClient.on('packetreceive', (packet) => {
+                // this.log.debug('classZigbee2MQTT=>Event packetreceive');
             });
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
             this.mqttClient.on('message', (topic, payload, packet) => {
+                // this.log.debug(`classZigbee2MQTT=>Event message topic: ${topic} payload: ${payload.toString()} packet: ${debugStringify(packet)}`);
                 this.messageHandler(topic, payload);
             });
             this.log.debug('Started');
@@ -138,6 +172,7 @@ export class Zigbee2MQTT extends EventEmitter {
             this.mqttIsReconnecting = false;
             this.mqttIsEnding = false;
             this.emit('mqtt_connect');
+            // Send a heartbeat every 60 seconds
             this.mqttKeepaliveInterval = setInterval(async () => {
                 this.log.debug('Publishing keepalive MQTT message');
                 try {
@@ -182,6 +217,7 @@ export class Zigbee2MQTT extends EventEmitter {
     async subscribe(topic) {
         if (this.mqttClient && this.mqttIsConnected) {
             this.log.debug(`Subscribing topic: ${topic}`);
+            // Use subscribeAsync for promise-based handling
             this.mqttClient
                 .subscribeAsync(topic, { qos: 2 })
                 .then(() => {
@@ -205,6 +241,7 @@ export class Zigbee2MQTT extends EventEmitter {
             this.mqttPublishQueueTimeout = setInterval(async () => {
                 if (this.mqttClient && this.mqttPublishQueue.length > 0) {
                     this.log.debug(`**Publish ${REVERSE}[${this.mqttPublishQueue.length}-${this.mqttPublishInflights}]${REVERSEOFF} topic: ${this.mqttPublishQueue[0].topic} message: ${this.mqttPublishQueue[0].message}${rs}`);
+                    // this.publish(this.mqttPublishQueue[0].topic, this.mqttPublishQueue[0].message);
                     try {
                         this.mqttPublishInflights++;
                         await this.mqttClient.publishAsync(this.mqttPublishQueue[0].topic, this.mqttPublishQueue[0].message, { qos: 2 });
@@ -257,13 +294,15 @@ export class Zigbee2MQTT extends EventEmitter {
     async writeBufferJSON(file, buffer) {
         const filePath = path.join(this.mqttDataPath, file);
         let jsonData;
+        // Parse the buffer to JSON
         try {
             jsonData = this.tryJsonParse(buffer.toString());
         }
         catch (error) {
             this.log.error('writeBufferJSON: parsing error:', error);
-            return;
+            return; // Stop execution if parsing fails
         }
+        // Write the JSON data to a file
         writeFile(`${filePath}.json`, JSON.stringify(jsonData, null, 2))
             .then(() => {
             this.log.debug(`Successfully wrote to ${filePath}.json`);
@@ -274,6 +313,7 @@ export class Zigbee2MQTT extends EventEmitter {
     }
     async writeFile(file, data) {
         const filePath = path.join(this.mqttDataPath, file);
+        // Write the data to a file
         writeFile(`${filePath}`, data)
             .then(() => {
             this.log.debug(`Successfully wrote to ${filePath}`);
@@ -282,6 +322,7 @@ export class Zigbee2MQTT extends EventEmitter {
             this.log.error(`Error writing to ${filePath}:`, error);
         });
     }
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     tryJsonParse(text) {
         try {
             return JSON.parse(text);
@@ -302,6 +343,7 @@ export class Zigbee2MQTT extends EventEmitter {
             else {
                 data = { state: payloadString };
             }
+            // this.log.debug('classZigbee2MQTT=>Message bridge/state', data);
             if (data.state === 'online') {
                 this.z2mIsOnline = true;
                 this.emit('online');
@@ -314,6 +356,7 @@ export class Zigbee2MQTT extends EventEmitter {
         }
         else if (topic.startsWith(this.mqttTopic + '/bridge/info')) {
             const data = this.tryJsonParse(payload.toString());
+            // this.log.info('classZigbee2MQTT=>Message bridge/info', data);
             this.z2mPermitJoin = data.permit_join ? data.permit_join : false;
             this.z2mPermitJoinTimeout = data.permit_join_timeout ? data.permit_join_timeout : 0;
             this.z2mVersion = data.version ? data.version : '';
@@ -332,14 +375,14 @@ export class Zigbee2MQTT extends EventEmitter {
                 this.log.info(`Message bridge/info advanced.legacy_availability_payload is ${data.config.advanced.legacy_availability_payload}`);
             this.emit('info', this.z2mVersion, this.z2mIsAvailabilityEnabled, this.z2mPermitJoin, this.z2mPermitJoinTimeout);
             this.emit('bridge-info', data);
-            if (this.log.logLevel === "debug")
+            if (this.log.logLevel === "debug" /* LogLevel.DEBUG */)
                 this.writeBufferJSON('bridge-info', payload);
         }
         else if (topic.startsWith(this.mqttTopic + '/bridge/devices')) {
             this.z2mDevices.splice(0, this.z2mDevices.length);
             const devices = this.tryJsonParse(payload.toString());
             const data = this.tryJsonParse(payload.toString());
-            if (this.log.logLevel === "debug")
+            if (this.log.logLevel === "debug" /* LogLevel.DEBUG */)
                 this.writeBufferJSON('bridge-devices', payload);
             this.emit('bridge-devices', data);
             let index = 1;
@@ -394,10 +437,13 @@ export class Zigbee2MQTT extends EventEmitter {
                     };
                     for (const expose of device.definition.exposes) {
                         if (!expose.property && !expose.name && expose.features && expose.type) {
+                            // Specific expose https://www.zigbee2mqtt.io/guide/usage/exposes.html
                             if (z2m.category === '') {
+                                // Only the first type: light, switch ...
                                 z2m.category = expose.type;
                             }
                             for (const feature of expose.features) {
+                                // Exposes nested inside features
                                 feature.category = expose.type;
                                 z2m.exposes.push(feature);
                                 if (feature.endpoint) {
@@ -406,6 +452,7 @@ export class Zigbee2MQTT extends EventEmitter {
                             }
                         }
                         else {
+                            // Generic expose https://www.zigbee2mqtt.io/guide/usage/exposes.html
                             expose.category = '';
                             z2m.exposes.push(expose);
                         }
@@ -421,18 +468,20 @@ export class Zigbee2MQTT extends EventEmitter {
                             endpoint: key,
                         };
                         z2m.endpoints.push(endpointWithKey);
+                        // this.log.debug('classZigbee2MQTT=>Message bridge/devices endpoints=>', device.friendly_name, key, endpoint);
                     }
                     this.z2mDevices.push(z2m);
                 }
             }
             this.log.debug(`Received ${this.z2mDevices.length} devices`);
             this.emit('devices');
+            // this.printDevices();
         }
         else if (topic.startsWith(this.mqttTopic + '/bridge/groups')) {
             this.z2mGroups.splice(0, this.z2mGroups.length);
             const groups = this.tryJsonParse(payload.toString());
             const data = this.tryJsonParse(payload.toString());
-            if (this.log.logLevel === "debug")
+            if (this.log.logLevel === "debug" /* LogLevel.DEBUG */)
                 this.writeBufferJSON('bridge-groups', payload);
             this.emit('bridge-groups', data);
             let index = 1;
@@ -458,6 +507,7 @@ export class Zigbee2MQTT extends EventEmitter {
             }
             this.log.debug(`Received ${this.z2mGroups.length} groups`);
             this.emit('groups');
+            // this.printGroups();
         }
         else if (topic.startsWith(this.mqttTopic + '/bridge/extensions')) {
             const extensions = this.tryJsonParse(payload.toString());
@@ -515,28 +565,49 @@ export class Zigbee2MQTT extends EventEmitter {
             }
             const data = this.tryJsonParse(payload.toString());
             this.log.debug(`Message topic: ${topic} payload:${rs}`, data);
+            /*
+            [05/09/2023, 20:35:26] [z2m] classZigbee2MQTT=>Message bridge/response zigbee2mqtt/bridge/response/group/add {
+              data: { friendly_name: 'Guest', id: 1 },
+              status: 'ok',
+              transaction: '1nqux-2'
+            }
+            [11/09/2023, 15:13:54] [z2m] classZigbee2MQTT=>Message bridge/response zigbee2mqtt/bridge/response/group/members/add {
+              data: { device: '0x84fd27fffe83066f/1', group: 'Master Guest room' },
+              status: 'ok',
+              transaction: '2ww7l-5'
+            }
+            */
         }
         else if (topic.startsWith(this.mqttTopic + '/bridge/logging')) {
+            // const data = JSON.parse(payload.toString());
+            // this.log.debug('classZigbee2MQTT=>Message bridge/logging', data);
         }
         else if (topic.startsWith(this.mqttTopic + '/bridge/config')) {
             this.log.debug(`Message topic: ${topic}`);
+            // const data = JSON.parse(payload.toString());
+            // this.log.debug('classZigbee2MQTT=>Message bridge/config', data);
         }
         else if (topic.startsWith(this.mqttTopic + '/bridge/definitions')) {
             this.log.debug(`Message topic: ${topic}`);
+            // const data = JSON.parse(payload.toString());
+            // this.log.debug('classZigbee2MQTT=>Message bridge/definitions', data);
         }
         else if (topic.startsWith(this.mqttTopic + '/bridge')) {
             this.log.debug(`Message topic: ${topic}`);
+            // const data = JSON.parse(payload.toString());
+            // this.log.debug('classZigbee2MQTT=>Message bridge/definitions', data);
         }
         else {
             let entity = topic.replace(this.mqttTopic + '/', '');
             let service = '';
             if (entity.search('/')) {
+                // set get availability or unknown TODO
                 const parts = entity.split('/');
                 entity = parts[0];
                 service = parts[1];
             }
             if (entity === 'Coordinator') {
-                const data = this.tryJsonParse(payload.toString());
+                const data = this.tryJsonParse(payload.toString()); // TODO crash on device rename
                 if (service === 'availability') {
                     if (data.state === 'online') {
                         this.log.debug(`Received ONLINE for ${id}Coordinator${rs}`, data);
@@ -547,7 +618,8 @@ export class Zigbee2MQTT extends EventEmitter {
                 }
                 return;
             }
-            if (this.log.logLevel === "debug" && this.loggedEntries < 1000) {
+            // Log the first 1000 payloads
+            if (this.log.logLevel === "debug" /* LogLevel.DEBUG */ && this.loggedEntries < 1000) {
                 const logEntry = {
                     entity,
                     service,
@@ -584,7 +656,9 @@ export class Zigbee2MQTT extends EventEmitter {
         return this.z2mGroups.find((group) => group.friendly_name === name);
     }
     handleDeviceMessage(deviceIndex, entity, service, payload) {
+        // this.log.info(`classZigbee2MQTT=>handleDeviceMessage ${id}#${deviceIndex + 1}${rs} entity ${dn}${entity}${rs} service ${zb}${service}${rs} payload ${pl}${payload}${rs}`);
         if (payload.length === 0 || payload === null) {
+            // this.log.warn(`handleDeviceMessage ${id}#${deviceIndex + 1}${rs} entity ${dn}${entity}${rs} service ${zb}${service}${rs} payload null`);
             return;
         }
         const payloadString = payload.toString();
@@ -593,33 +667,41 @@ export class Zigbee2MQTT extends EventEmitter {
             data = this.tryJsonParse(payload.toString());
         }
         else {
-            data = { state: payloadString };
+            data = { state: payloadString }; // Only state for availability
         }
         if (service === 'availability') {
             if (data.state === 'online') {
                 this.z2mDevices[deviceIndex].isAvailabilityEnabled = true;
                 this.z2mDevices[deviceIndex].isOnline = true;
+                // this.log.warn('handleDeviceMessage availability payload: ', data);
                 this.emit('availability', entity, true);
                 this.emit('ONLINE-' + entity);
             }
             else if (data.state === 'offline') {
                 this.z2mDevices[deviceIndex].isOnline = false;
+                // this.log.warn('handleDeviceMessage availability payload: ', data);
                 this.emit('availability', entity, false);
                 this.emit('OFFLINE-' + entity);
             }
         }
         else if (service === 'get') {
+            // Do nothing
         }
         else if (service === 'set') {
+            // Do nothing
         }
         else if (service === undefined) {
+            // this.log.debug(`classZigbee2MQTT=>emitting message for device ${dn}${entity}${rs} payload ${pl}${payload}${rs}`);
             this.emit('MESSAGE-' + entity, data);
         }
         else {
+            // MQTT output attribute type
         }
     }
     handleGroupMessage(groupIndex, entity, service, payload) {
+        // this.log.info(`classZigbee2MQTT=>handleGroupMessage ${id}#${groupIndex + 1}${rs} entity ${gn}${entity}${rs} service ${zb}${service}${rs} payload ${pl}${payload}${rs}`);
         if (payload.length === 0 || payload === null) {
+            // this.log.warn(`handleGroupMessage ${id}#${groupIndex + 1}${rs} entity ${gn}${entity}${rs} service ${zb}${service}${rs} payload null`);
             return;
         }
         const payloadString = payload.toString();
@@ -628,7 +710,7 @@ export class Zigbee2MQTT extends EventEmitter {
             data = this.tryJsonParse(payload.toString());
         }
         else {
-            data = { state: payloadString };
+            data = { state: payloadString }; // Only state for availability
         }
         data['last_seen'] = new Date().toISOString();
         if (service === 'availability') {
@@ -645,16 +727,29 @@ export class Zigbee2MQTT extends EventEmitter {
             }
         }
         else if (service === 'get') {
+            // Do nothing
         }
         else if (service === 'set') {
+            // Do nothing
         }
         else if (service === undefined) {
+            // this.log.debug(`classZigbee2MQTT=>emitting message for group ${gn}${entity}${rs} payload ${pl}${payload}${rs}`);
             this.emit('MESSAGE-' + entity, data);
         }
         else {
+            // MQTT output attribute type
         }
     }
     handleResponseNetworkmap(payload) {
+        /*
+            "routes": [
+                {
+                  "destinationAddress": 31833,
+                  "nextHop": 31833,
+                  "status": "ACTIVE"
+                }
+              ],
+            */
         const data = this.tryJsonParse(payload.toString());
         const topology = data.data.value;
         const lqi = (lqi) => {
@@ -704,7 +799,7 @@ export class Zigbee2MQTT extends EventEmitter {
         };
         const timePassedSince = (lastSeen) => {
             const now = Date.now();
-            const difference = now - lastSeen;
+            const difference = now - lastSeen; // difference in milliseconds
             const days = Math.floor(difference / (1000 * 60 * 60 * 24));
             if (days > 0) {
                 return `${days} days ago`;
@@ -720,51 +815,116 @@ export class Zigbee2MQTT extends EventEmitter {
             const seconds = Math.floor((difference % (1000 * 60)) / 1000);
             return `${seconds} seconds ago`;
         };
-        if (this.log.logLevel === "debug")
+        if (this.log.logLevel === "debug" /* LogLevel.DEBUG */)
             this.writeBufferJSON('networkmap_' + data.data.type, payload);
         if (data.data.type === 'graphviz') {
-            if (this.log.logLevel === "debug")
+            if (this.log.logLevel === "debug" /* LogLevel.DEBUG */)
                 this.writeFile('networkmap_' + data.data.type + '.txt', data.data.value);
         }
         if (data.data.type === 'plantuml') {
-            if (this.log.logLevel === "debug")
+            if (this.log.logLevel === "debug" /* LogLevel.DEBUG */)
                 this.writeFile('networkmap_' + data.data.type + '.txt', data.data.value);
         }
         if (data.data.type === 'raw') {
+            // Log nodes with links
             this.log.warn('Network map nodes:');
             topology.nodes.sort((a, b) => a.friendlyName.localeCompare(b.friendlyName));
             topology.nodes.forEach((node, index) => {
                 this.log.debug(`Node [${index.toString().padStart(3, ' ')}] ${node.type === 'EndDevice' ? ign : node.type === 'Router' ? idn : '\x1b[48;5;1m\x1b[38;5;255m'}${node.friendlyName}${rs}${db} addr: ${node.ieeeAddr}-0x${node.networkAddress.toString(16)} type: ${node.type} lastseen: ${timePassedSince(node.lastSeen)}`);
-                const sourceLinks = topology.links.filter((link) => link.sourceIeeeAddr === node.ieeeAddr);
-                sourceLinks.sort((a, b) => a.lqi - b.lqi);
+                // SourceAddr
+                const sourceLinks = topology.links.filter((link) => link.sourceIeeeAddr === node.ieeeAddr); // Filter
+                sourceLinks.sort((a, b) => a.lqi - b.lqi); // Sort by lqi
                 sourceLinks.forEach((link, index) => {
+                    // const targetNode = topology.nodes.find((node) => node.ieeeAddr === link.target.ieeeAddr);
                     this.log.debug(`  link [${index.toString().padStart(4, ' ')}] lqi: ${lqi(link.lqi)} depth: ${depth(link.depth)} relation: ${relationship(link.relationship)} > > > ${friendlyName(link.target.ieeeAddr)}`);
                 });
-                const targetLinks = topology.links.filter((link) => link.targetIeeeAddr === node.ieeeAddr);
-                targetLinks.sort((a, b) => a.lqi - b.lqi);
+                // TargetAddr
+                const targetLinks = topology.links.filter((link) => link.targetIeeeAddr === node.ieeeAddr); // Filter
+                targetLinks.sort((a, b) => a.lqi - b.lqi); // Sort by lqi
                 targetLinks.forEach((link, index) => {
+                    // const sourceNode = topology.nodes.find((node) => node.ieeeAddr === link.source.ieeeAddr);
                     this.log.debug(`  link [${index.toString().padStart(4, ' ')}] lqi: ${lqi(link.lqi)} depth: ${depth(link.depth)} relation: ${relationship(link.relationship)} < < < ${friendlyName(link.source.ieeeAddr)}`);
                 });
             });
+            // Log links
+            /*
+            this.log.warn('Network map links:');
+            map.links.sort((a, b) => a.sourceIeeeAddr.localeCompare(b.sourceIeeeAddr));
+            map.links.forEach( (link, index) => {
+              const sourceNode = map.nodes.find(node => node.ieeeAddr === link.source.ieeeAddr);
+              assert(sourceNode, `${wr}NwkAddr error node ${link.sourceIeeeAddr} not found${db}`);
+              const targetNode = map.nodes.find(node => node.ieeeAddr === link.target.ieeeAddr);
+              assert(targetNode, `${wr}NwkAddr error node ${link.targetIeeeAddr} not found${db}`);
+              this.log.debug(`- link[${index}]: ${link.source.ieeeAddr}-${link.source.networkAddress.toString(16)} (${sourceNode?.friendlyName})
+              Lqi: ${link.lqi} Depth: ${link.depth} Relation: ${link.relationship} => ${link.target.ieeeAddr}-${link.target.networkAddress.toString(16)} (${targetNode?.friendlyName})`);
+            } );
+            */
         }
     }
     handleResponseDeviceRename(payload) {
+        /*
+        {
+          data: {
+            from: '0xcc86ecfffe4e9d25',
+            homeassistant_rename: false,
+            to: 'Double switch'
+          },
+          status: 'ok',
+          transaction: 'smeo0-8'
+        }
+        */
         const json = this.tryJsonParse(payload.toString());
         this.log.debug(`handleResponseDeviceRename from ${json.data.from} to ${json.data.to} status ${json.status}`);
         const device = this.z2mDevices.find((device) => device.friendly_name === json.data.to);
         this.emit('device_rename', device?.ieee_address, json.data.from, json.data.to);
     }
     handleResponseDeviceRemove(payload) {
+        /*
+        {
+          data: { block: false, force: false, id: 'Presence sensor' },
+          status: 'ok',
+          transaction: 'bet01-20'
+        }
+        */
         const json = this.tryJsonParse(payload.toString());
         this.log.debug(`handleResponseDeviceRemove name ${json.data.id} status ${json.status} block ${json.data.block} force ${json.data.force}`);
         this.emit('device_remove', json.data.id, json.status, json.data.block, json.data.force);
     }
     handleResponseDeviceOptions(payload) {
+        /*
+        {
+          data: {
+            from: {
+              color_sync: false,
+              legacy: false,
+              state_action: false,
+              transition: 0
+            },
+            id: '0xa4c1388ad0ebb0a6',
+            restart_required: false,
+            to: {
+              color_sync: false,
+              legacy: false,
+              state_action: false,
+              transition: 0
+            }
+          },
+          status: 'ok',
+          transaction: '8j6s7-3'
+        }
+        */
         const json = this.tryJsonParse(payload.toString());
         this.log.debug(`handleResponseDeviceOptions ieee_address ${json.data.id} status ${json.status} from ${json.data.from} to ${json.data.to}`);
         this.emit('device_options', json.data.id, json.status, json.data.from, json.data.to);
     }
     handleResponseGroupAdd(payload) {
+        /*
+        {
+          data: { friendly_name: 'Test', id: 7 },
+          status: 'ok',
+          transaction: '8j6s7-9'
+        }
+        */
         const json = this.tryJsonParse(payload.toString());
         this.log.debug(`handleResponseGroupAdd() friendly_name ${json.data.friendly_name} id ${json.data.id} status ${json.status}`);
         if (json.status === 'ok') {
@@ -772,6 +932,13 @@ export class Zigbee2MQTT extends EventEmitter {
         }
     }
     handleResponseGroupRemove(payload) {
+        /*
+        {
+          data: { force: false, id: 'Test' },
+          status: 'ok',
+          transaction: '8j6s7-10'
+        }
+        */
         const json = this.tryJsonParse(payload.toString());
         this.log.debug(`handleResponseGroupRemove() friendly_name ${json.data.id} status ${json.status}`);
         if (json.status === 'ok') {
@@ -779,6 +946,13 @@ export class Zigbee2MQTT extends EventEmitter {
         }
     }
     handleResponseGroupRename(payload) {
+        /*
+        {
+          data: { from: 'Test2', homeassistant_rename: false, to: 'Test' },
+          status: 'ok',
+          transaction: '0r51l-15'
+        }
+        */
         const json = this.tryJsonParse(payload.toString());
         this.log.debug(`handleResponseGroupRename() from ${json.data.from} to ${json.data.to} status ${json.status}`);
         if (json.status === 'ok') {
@@ -786,6 +960,13 @@ export class Zigbee2MQTT extends EventEmitter {
         }
     }
     handleResponseGroupAddMember(payload) {
+        /*
+        {
+          data: { device: '0xa4c1388ad0ebb0a6/1', group: 'Test2' },
+          status: 'ok',
+          transaction: '0r51l-7'
+        }
+        */
         const json = this.tryJsonParse(payload.toString());
         this.log.debug(`handleResponseGroupAddMembers() add to group friendly_name ${json.data.group} device ieee_address ${json.data.device} status ${json.status}`);
         if (json.status === 'ok' && json.data.device && json.data.device.includes('/')) {
@@ -793,6 +974,13 @@ export class Zigbee2MQTT extends EventEmitter {
         }
     }
     handleResponseGroupRemoveMember(payload) {
+        /*
+        {
+          data: { device: 'Gledopto RGBCTT light', group: 'Test2' },
+          status: 'ok',
+          transaction: '0r51l-10'
+        }
+        */
         const json = this.tryJsonParse(payload.toString());
         this.log.debug(`handleResponseGroupRemoveMember() remove from group friendly_name ${json.data.group} device friendly_name ${json.data.device} status ${json.status}`);
         if (json.status === 'ok') {
@@ -800,6 +988,13 @@ export class Zigbee2MQTT extends EventEmitter {
         }
     }
     handleResponsePermitJoin(payload) {
+        /*
+        {
+          data: { device?: 'Coordinator', time: 254, value: true },
+          status: 'ok',
+          transaction: 'adeis-5'
+        }
+        */
         const json = this.tryJsonParse(payload.toString());
         this.log.debug(`handleResponsePermitJoin() device: ${json.data.device ? json.data.device : 'All'} time: ${json.data.time} value: ${json.data.value} status: ${json.status}`);
         if (json.status === 'ok') {
@@ -813,23 +1008,75 @@ export class Zigbee2MQTT extends EventEmitter {
                 this.log.error('handleEvent() undefined type', json);
                 break;
             case 'device_leave':
+                /*
+                {
+                  data: { friendly_name: 'Light sensor', ieee_address: '0x54ef44100085c321' },
+                  type: 'device_leave'
+                }
+                */
                 this.log.debug(`handleEvent() type: device_leave name: ${json.data.friendly_name} address: ${json.data.ieee_address}`);
                 this.emit('device_leave', json.data.friendly_name, json.data.ieee_address);
                 break;
             case 'device_joined':
+                /*
+                {
+                  data: {
+                    friendly_name: 'Kitchen Dishwasher water leak sensor',
+                    ieee_address: '0x00158d0007c2b057'
+                  },
+                  type: 'device_joined'
+                }
+                */
                 this.log.debug(`handleEvent() type: device_joined name: ${json.data.friendly_name} address: ${json.data.ieee_address}`);
                 this.emit('device_joined', json.data.friendly_name, json.data.ieee_address);
                 break;
             case 'device_announce':
+                /*
+                {
+                  data: {
+                    friendly_name: 'Kitchen Sink water leak sensor',
+                    ieee_address: '0x00158d0008f1099b'
+                  },
+                  type: 'device_announce'
+                }
+                */
                 this.log.debug(`handleEvent() type: device_announce name: ${json.data.friendly_name} address: ${json.data.ieee_address}`);
                 this.emit('device_announce', json.data.friendly_name, json.data.ieee_address);
                 break;
             case 'device_interview':
+                /*
+                {
+                  data: {
+                    friendly_name: 'Kitchen Sink water leak sensor',
+                    ieee_address: '0x00158d0008f1099b',
+                    status: 'started'
+                  },
+                  type: 'device_interview'
+                }
+                {
+                  data: {
+                    definition: {
+                      description: 'Aqara water leak sensor',
+                      exposes: [Array],
+                      model: 'SJCGQ11LM',
+                      options: [Array],
+                      supports_ota: false,
+                      vendor: 'Xiaomi'
+                    },
+                    friendly_name: 'Kitchen Sink water leak sensor',
+                    ieee_address: '0x00158d0008f1099b',
+                    status: 'successful',
+                    supported: true
+                  },
+                  type: 'device_interview'
+                }
+                */
                 this.log.debug(`handleEvent() type: device_interview name: ${json.data.friendly_name} address: ${json.data.ieee_address} status: ${json.data.status} supported: ${json.data.supported}`);
                 this.emit('device_interview', json.data.friendly_name, json.data.ieee_address, json.data.status, json.data.supported);
                 break;
         }
     }
+    // Function to read JSON config from a file
     readConfig(filename) {
         this.log.debug(`Reading config from ${filename}`);
         try {
@@ -842,6 +1089,8 @@ export class Zigbee2MQTT extends EventEmitter {
             return null;
         }
     }
+    // Function to write JSON config to a file
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
     writeConfig(filename, data) {
         this.log.debug(`Writing config to ${filename}`);
         try {
@@ -969,3 +1218,4 @@ export class Zigbee2MQTT extends EventEmitter {
         });
     }
 }
+//# sourceMappingURL=zigbee2mqtt.js.map