iobroker.zigbee2mqtt 3.1.1 → 3.1.5

package/lib/z2mController.js

@@ -1,13 +1,15 @@
 /**
- *
+ * Übersetzt ioBroker-State-Änderungen in Zigbee2MQTT-MQTT-Nachrichten
+ * und leitet Z2M-Log-Nachrichten in den ioBroker-Logger weiter.
  */
 class Z2mController {
     /**
+     * Erstellt eine neue Z2mController-Instanz.
      *
-     * @param adapter
-     * @param deviceCache
-     * @param groupCache
-     * @param logCustomizations
+     * @param {object} adapter           Die ioBroker-Adapter-Instanz
+     * @param {Array}  deviceCache       Gemeinsamer Cache aller bekannten Geräte
+     * @param {Array}  groupCache        Gemeinsamer Cache aller bekannten Gruppen
+     * @param {object} logCustomizations Debug/Filter-Einstellungen (debugDevices, logfilter)
      */
     constructor(adapter, deviceCache, groupCache, logCustomizations) {
         this.adapter = adapter;
@@ -17,9 +19,12 @@ class Z2mController {
     }
 
     /**
+     * Erzeugt aus einer ioBroker-State-Änderung eine Zigbee2MQTT-Nachricht.
+     * Gibt null zurück wenn kein Gerät/State gefunden wurde oder der Setter undefined liefert.
      *
-     * @param id
-     * @param state
+     * @param {string}         id    Vollständige State-ID (z.B. "zigbee2mqtt.0.0xAABB.state")
+     * @param {ioBroker.State} state Das neue State-Objekt mit val und ack
+     * @returns {Promise<{topic: string, payload: object}|undefined>} Die Z2M-Nachricht oder undefined
      */
     async createZ2MMessage(id, state) {
         const splitedID = id.split('.');
@@ -82,7 +87,7 @@ class Z2mController {
         if (stateID === 'send_payload') {
             try {
                 controlObj.payload = JSON.parse(stateVal);
-                this.adapter.setState(id, state, true);
+                await this.adapter.setStateAsync(id, state.val, true);
             } catch (error) {
                 // Fix 9: rawStr als String direkt als payload – wird in main.js via
                 // JSON.stringify() nochmals gewrappt → würde doppelt quoten.
@@ -98,9 +103,8 @@ class Z2mController {
         // if available read option and set payload
         if (deviceState.options) {
             for (const option of deviceState.options) {
-                // Fix 2: Cache-Check mit === undefined statt !value
-                // Falsy-Check schlägt bei 0, false, null fehl (z.B. transition=0 = sofort)
-                if (device.optionsValues[option] === undefined) {
+                // Fix: "in"-Prüfung statt === undefined, damit null als gültiger gecachter Wert behandelt wird
+                if (!(option in device.optionsValues)) {
                     const optState = await this.adapter.getStateAsync(`${splitedID[0]}.${splitedID[1]}.${splitedID[2]}.${option}`);
                     device.optionsValues[option] = optState ? optState.val : null;
                 }
@@ -118,7 +122,7 @@ class Z2mController {
         if (deviceState.isOption) {
             // set optionsValues 'Cache'
             device.optionsValues[stateName] = state.val;
-            this.adapter.setState(id, state, true);
+            await this.adapter.setStateAsync(id, state.val, true);
             return;
         }
 
@@ -126,18 +130,23 @@ class Z2mController {
         const immediateAckRole = ['button'].includes(deviceState.role);
         const immediateAckId = ['brightness_move', 'colortemp_move', 'brightness_step', 'effect'].includes(deviceState.id);
         if (immediateAckRole || immediateAckId) {
-            this.adapter.setState(id, state, true);
+            await this.adapter.setStateAsync(id, state.val, true);
         }
 
-        if (this.logCustomizations.debugDevices.includes(device.ieee_address)) {
-            this.adapter.log.warn(`<<<--- toZ2M -> ${device.ieee_address} states: ${JSON.stringify(controlObj)}`);
+        if (this.logCustomizations.debugDevices) {
+            const debugList = String(this.logCustomizations.debugDevices).split(',').map((s) => s.trim());
+            if (debugList.includes(device.ieee_address)) {
+                this.adapter.log.warn(`<<<--- toZ2M -> ${device.ieee_address} states: ${JSON.stringify(controlObj)}`);
+            }
         }
         return controlObj;
     }
 
     /**
+     * Leitet eine Z2M-Log-Nachricht (bridge/logging) an den ioBroker-Logger weiter.
+     * Nachrichten die dem konfigurierten Logfilter entsprechen werden unterdrückt.
      *
-     * @param messageObj
+     * @param {{ payload: { message: string, level: string } }} messageObj Die Log-Nachricht
      */
     async proxyZ2MLogs(messageObj) {
         const logMessage = messageObj.payload && messageObj.payload.message;
@@ -158,6 +167,9 @@ class Z2mController {
             case 'warning':
                 this.adapter.log.warn(logMessage);
                 break;
+            default:
+                this.adapter.log.debug(`Z2M [${logLevel}]: ${logMessage}`);
+                break;
         }
     }
 }

package/main.js

@@ -16,6 +16,11 @@ const WebsocketController = require('./lib/websocketController').WebsocketContro
 const MqttServerController = require('./lib/mqttServerController').MqttServerController;
 
 class Zigbee2mqtt extends core.Adapter {
+    /**
+     * Erstellt eine neue Instanz des Zigbee2MQTT-Adapters.
+     *
+     * @param {object} [options] Optionale Adapter-Konfiguration (AdapterOptions)
+     */
     constructor(options) {
         super({
             ...options,
@@ -36,12 +41,22 @@ class Zigbee2mqtt extends core.Adapter {
         this.mqttServerController = null;
         this.messageParseMutex = Promise.resolve();
 
-        this.on('ready', this.onReady.bind(this));
-        this.on('stateChange', this.onStateChange.bind(this));
-        this.on('message', this.onMessage.bind(this));
+        this.on('ready', () => {
+            this.onReady().catch((e) => this.log.error(`onReady error: ${e}`));
+        });
+        this.on('stateChange', (id, state) => {
+            this.onStateChange(id, state).catch((e) => this.log.error(`onStateChange error: ${e}`));
+        });
+        this.on('message', (obj) => {
+            this.onMessage(obj).catch((e) => this.log.error(`onMessage error: ${e}`));
+        });
         this.on('unload', this.onUnload.bind(this));
     }
 
+    /**
+     * Wird aufgerufen sobald der Adapter bereit ist (alle Objekte initialisiert).
+     * Initialisiert alle Controller und baut die Verbindung zu Zigbee2MQTT auf.
+     */
     async onReady() {
         this.statesController = new StatesController(this, this.deviceCache, this.groupCache, this.logCustomizations, this.createCache);
         this.deviceController = new DeviceController(
@@ -54,10 +69,9 @@ class Zigbee2mqtt extends core.Adapter {
         );
         this.z2mController = new Z2mController(this, this.deviceCache, this.groupCache, this.logCustomizations);
 
-        // Fix 2: adapterInfo ist async → awaiten
-        await adapterInfo(this.config, this.log);
+        adapterInfo(this.config, this.log);
 
-        this.setState('info.connection', false, true);
+        await this.setStateAsync('info.connection', false, true);
 
         const debugDevicesState = await this.getStateAsync('info.debugmessages');
         if (debugDevicesState && debugDevicesState.val) {
@@ -110,7 +124,8 @@ class Zigbee2mqtt extends core.Adapter {
                 // Internal MQTT-Server
                 this.mqttServerController = new MqttServerController(this);
                 await this.mqttServerController.createMQTTServer();
-                await this.delay(1500);
+                // Kurze Pause damit der OS-Socket tatsächlich bereit ist (createMQTTServer wartet bereits auf listen)
+                await this.delay(200);
                 this.mqttClient = mqtt.connect(`mqtt://${this.config.mqttServerIPBind}:${this.config.mqttServerPort}`, {
                     clientId: `ioBroker.zigbee2mqtt_${Math.random().toString(16).slice(2, 8)}`,
                     clean: true,
@@ -123,7 +138,13 @@ class Zigbee2mqtt extends core.Adapter {
                 this.log.info(
                     `Connect to Zigbee2MQTT over ${this.config.connectionType === 'exmqtt' ? 'external mqtt' : 'internal mqtt'} connection.`
                 );
-                this.setStateChanged('info.connection', true, true);
+                this.setStateChangedAsync('info.connection', true, true).catch((e) =>
+                    this.log.error(`MQTT connect setStateChangedAsync error: ${e}`)
+                );
+                if (!this.config.baseTopic) {
+                    this.log.error('baseTopic is not configured – cannot subscribe to MQTT topics!');
+                    return;
+                }
                 this.mqttClient.subscribe(`${this.config.baseTopic}/#`, (err) => {
                     if (err) {
                         this.log.error(`MQTT subscribe error: ${err && err.message ? err.message : String(err)}`);
@@ -135,16 +156,18 @@ class Zigbee2mqtt extends core.Adapter {
                 this.log.info('MQTT client reconnecting to Zigbee2MQTT...');
             });
 
-            this.mqttClient.on('offline', async () => {
-                this.log.warn('MQTT client offline – connection to Zigbee2MQTT lost.');
-                this.setStateChanged('info.connection', false, true);
-                try {
-                    if (this.statesController) {
-                        await this.statesController.setAllAvailableToFalse();
+            this.mqttClient.on('offline', () => {
+                (async () => {
+                    this.log.warn('MQTT client offline – connection to Zigbee2MQTT lost.');
+                    await this.setStateChangedAsync('info.connection', false, true);
+                    try {
+                        if (this.statesController) {
+                            await this.statesController.setAllAvailableToFalse();
+                        }
+                    } catch (e) {
+                        this.log.error(`MQTT offline setAllAvailableToFalse error: ${e}`);
                     }
-                } catch (e) {
-                    this.log.error(`MQTT offline setAllAvailableToFalse error: ${e}`);
-                }
+                })().catch((e) => this.log.error(`MQTT offline handler error: ${e}`));
             });
 
             this.mqttClient.on('error', (err) => {
@@ -152,9 +175,9 @@ class Zigbee2mqtt extends core.Adapter {
             });
 
             this.mqttClient.on('message', (topic, payload) => {
-                // baseTopic aus dem Topic entfernen – Guard falls kein '/' vorhanden
-                const sepIdx = topic.indexOf('/');
-                if (sepIdx === -1) {
+                // baseTopic-Prefix vollständig entfernen – funktioniert auch bei mehrstufigem baseTopic (z.B. home/zigbee2mqtt)
+                const basePrefix = this.config.baseTopic ? `${this.config.baseTopic}/` : null;
+                if (!basePrefix || !topic.startsWith(basePrefix)) {
                     this.log.debug(`MQTT message with unexpected topic format: ${topic}`);
                     return;
                 }
@@ -167,7 +190,7 @@ class Zigbee2mqtt extends core.Adapter {
                 }
                 const messageObj = {
                     payload: parsedPayload,
-                    topic: topic.slice(sepIdx + 1),
+                    topic: topic.slice(basePrefix.length),
                 };
                 this.messageParse(messageObj).catch((err) => {
                     this.log.error(`messageParse error: ${err}`);
@@ -183,13 +206,17 @@ class Zigbee2mqtt extends core.Adapter {
             if (this.config.dummyMqtt === true) {
                 this.mqttServerController = new MqttServerController(this);
                 await this.mqttServerController.createDummyMQTTServer();
-                await this.delay(1500);
+                await this.delay(200);
             }
 
             this.startWebsocket();
         }
     }
 
+    /**
+     * Erstellt (einmalig) den WebsocketController und initiiert die WS-Verbindung.
+     * Wird beim Start und nach einem Verbindungsabbruch aufgerufen.
+     */
     startWebsocket() {
         // Controller nur einmal erstellen – bei Reconnect wird derselbe wiederverwendet
         if (!this.websocketController) {
@@ -198,6 +225,13 @@ class Zigbee2mqtt extends core.Adapter {
         this.websocketController.initWsClient();
     }
 
+    /**
+     * Parst eine eingehende MQTT- oder WebSocket-Nachricht von Zigbee2MQTT
+     * und leitet sie an den zuständigen Controller weiter.
+     * Alle Aufrufe werden serialisiert (Mutex), um Race-Conditions zu vermeiden.
+     *
+     * @param {{ topic: string, payload: any }} messageObj Die zu verarbeitende Nachricht
+     */
     async messageParse(messageObj) {
         // Mutex: serialisiert alle messageParse-Aufrufe
         // Wichtig: lock muss IMMER wieder freigegeben werden, auch bei early return / Fehler.
@@ -227,7 +261,7 @@ class Zigbee2mqtt extends core.Adapter {
                     const coordState = typeof messageObj.payload === 'object' && messageObj.payload !== null
                         ? messageObj.payload.state
                         : messageObj.payload;
-                    this.setStateChanged('info.coordinator_status', coordState, true);
+                    await this.setStateChangedAsync('info.coordinator_status', coordState, true);
                     break;
                 }
                 case 'bridge/info':
@@ -247,7 +281,7 @@ class Zigbee2mqtt extends core.Adapter {
                         await this.statesController.setAllAvailableToFalse();
                         this.showInfo = true;
                     }
-                    this.setStateChanged('info.connection', bridgeState === 'online', true);
+                    await this.setStateChangedAsync('info.connection', bridgeState === 'online', true);
                     break;
                 }
                 case 'bridge/devices':
@@ -318,12 +352,16 @@ class Zigbee2mqtt extends core.Adapter {
                         if (messageObj.payload === null || messageObj.payload === undefined) {
                             break;
                         }
+                        const deviceTopic = messageObj.topic.replace('/availability', '');
+                        if (!deviceTopic) {
+                            break;
+                        }
                         const availState = typeof messageObj.payload === 'object'
                             ? messageObj.payload.state
                             : messageObj.payload;
                         const newMessage = {
                             payload: { available: availState === 'online' },
-                            topic: messageObj.topic.replace('/availability', ''),
+                            topic: deviceTopic,
                         };
                         await this.statesController.processDeviceMessage(newMessage);
                     } else {
@@ -344,6 +382,11 @@ class Zigbee2mqtt extends core.Adapter {
         }
     }
 
+    /**
+     * Verarbeitet interne ioBroker-Nachrichten (z.B. Admin-UI-Kommandos).
+     *
+     * @param {ioBroker.Message} obj Das eingehende Nachrichtenobjekt
+     */
     async onMessage(obj) {
         if (!obj || !obj.command) {
             return;
@@ -384,6 +427,14 @@ class Zigbee2mqtt extends core.Adapter {
 
                 // Alle vorhandenen Adapter-Objekte laden
                 const allObjects = await this.getAdapterObjectsAsync();
+                if (!allObjects) {
+                    const warn = 'deleteOldStates: getAdapterObjectsAsync returned null – aborting.';
+                    this.log.error(warn);
+                    if (obj.callback) {
+                        this.sendTo(obj.from, obj.command, { error: warn }, obj.callback);
+                    }
+                    return;
+                }
                 for (const id of Object.keys(allObjects)) {
                     const iobObj = allObjects[id];
 
@@ -453,6 +504,12 @@ class Zigbee2mqtt extends core.Adapter {
         }
     }
 
+    /**
+     * Wird beim Stoppen des Adapters aufgerufen.
+     * Trennt alle Verbindungen, stoppt Timer und ruft abschließend callback() auf.
+     *
+     * @param {() => void} callback Muss am Ende zwingend aufgerufen werden
+     */
     async onUnload(callback) {
         try {
             if (['exmqtt', 'intmqtt'].includes(this.config.connectionType)) {
@@ -491,20 +548,20 @@ class Zigbee2mqtt extends core.Adapter {
             }
             try {
                 if (this.websocketController) {
-                    await this.websocketController.allTimerClear();
+                    this.websocketController.allTimerClear();
                 }
             } catch (e) {
                 this.log.error(e);
             }
             try {
                 if (this.statesController) {
-                    await this.statesController.allTimerClear();
+                    this.statesController.allTimerClear();
                 }
             } catch (e) {
                 this.log.error(e);
             }
 
-            this.setState('info.connection', false, true);
+            await this.setStateAsync('info.connection', false, true);
 
             // Schedule-Job beenden
             const job = schedule.scheduledJobs['coordinatorCheck'];
@@ -518,16 +575,25 @@ class Zigbee2mqtt extends core.Adapter {
         }
     }
 
+    /**
+     * Reagiert auf Änderungen von ioBroker-States.
+     * Wandelt den State-Change in eine Zigbee2MQTT-Nachricht um und sendet sie.
+     *
+     * @param {string} id        Vollständige State-ID (z.B. zigbee2mqtt.0.0xAABB.state)
+     * @param {ioBroker.State | null | undefined} state Das neue State-Objekt
+     */
     async onStateChange(id, state) {
         if (state && state.ack === false) {
             if (id.endsWith('info.debugmessages')) {
-                this.logCustomizations.debugDevices = String(state.val || '');
-                this.setState(id, state.val, true);
+                this.logCustomizations.debugDevices = state.val != null ? String(state.val) : '';
+                await this.setStateAsync(id, state.val, true);
                 return;
             }
             if (id.endsWith('info.logfilter')) {
-                this.logCustomizations.logfilter = String(state.val || '').split(';').filter((x) => x);
-                this.setState(id, state.val, true);
+                this.logCustomizations.logfilter = state.val != null
+                    ? String(state.val).split(';').filter((x) => x)
+                    : [];
+                await this.setStateAsync(id, state.val, true);
                 return;
             }
 
@@ -546,6 +612,10 @@ class Zigbee2mqtt extends core.Adapter {
                     this.log.warn(`Cannot publish state, MQTT client not connected. (${id})`);
                     return;
                 }
+                if (!this.config.baseTopic) {
+                    this.log.error('baseTopic is not configured – cannot publish state!');
+                    return;
+                }
                 try {
                     this.mqttClient.publish(
                         `${this.config.baseTopic}/${message.topic}`,
@@ -572,7 +642,7 @@ class Zigbee2mqtt extends core.Adapter {
 
 if (require.main !== module) {
     /**
-     * @param {Partial<core.AdapterOptions>} [options]
+     * @param {object} [options] Optionale Adapter-Konfiguration (AdapterOptions)
      */
     module.exports = (options) => new Zigbee2mqtt(options);
 } else {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.zigbee2mqtt",
-  "version": "3.1.1",
+  "version": "3.1.5",
   "description": "Zigbee2MQTT adapter for ioBroker",
   "author": {
     "name": "Dennis Rathjen and Arthur Rupp",