iobroker.zigbee2mqtt 2.2.0 → 2.2.1

package/README.md

@@ -30,6 +30,12 @@ This adapter allows to control the data points of the devices of a Zigbee2MQTT i
 	Placeholder for the next version (at the beginning of the line):
 	### **WORK IN PROGRESS**
 -->
+### 2.2.1 (2022-10-25)
+
+-   (o0shojo0o) fix state roles and access
+-   (o0shojo0o) fix state handling
+-   (o0shojo0o) fix createZ2MMessage
+
 ### 2.2.0 (2022-10-20)
 
 -   (o0shojo0o) added support for [Lidl HG06467 effects](https://www.zigbee2mqtt.io/devices/HG06467.html#trigger-effects)

package/admin/i18n/de/translations.json

@@ -13,7 +13,7 @@
     "External MQTT-Server Port": "Externer MQTT-Server Port",
     "MQTT-Server IP-Address bind": "MQTT-Server IP-Adresse binden",
     "MQTT-Server Port": "MQTT-Server-Port",
-    "Configure your Zigbee2MQTT WebUi connection": "Zigbee2MQTT WebUi Verbindung Konfiguration",
+    "Configure your Zigbee2MQTT WebUi connection": "Konfiguration der Zigbee2MQTT WebUi Verbindung",
     "WebUi Address": "WebUi Adresse",
     "WebUi Port": "WebUi Port",
     "Color configurations": "Farbkonfigurationen",

package/io-package.json

@@ -1,8 +1,21 @@
 {
   "common": {
     "name": "zigbee2mqtt",
-    "version": "2.2.0",
+    "version": "2.2.1",
     "news": {
+      "2.2.1": {
+        "en": "fix state roles and access\nfix state handling\nfix createZ2MMessage",
+        "de": "zustandsrollen und zugriff beheben\nmanuelle zustandsbearbeitung\nfix erstellenZ2MMessage",
+        "ru": "исправить государственные роли и доступ\nисправить государственную обработку\nисправить CreateZ2MMessage",
+        "pt": "corrigir funções estaduais e acesso\ncorrigir o manuseio do estado\ncorrigir createZ2MMessage",
+        "nl": "vertaling:\nvertaling:\nvertaling:",
+        "fr": "fixer les rôles de l'état et l'accès\nmaniement de l ' état\nfix createZ2MMessage",
+        "it": "fissare i ruoli dello stato e l'accesso\ncorretta gestione dello stato\nfix createZ2MMessage",
+        "es": "fijar funciones estatales y acceso\ncorrección del estado\nfix createZ2MMessage",
+        "pl": "uchwała rola państwowa i dostęp\nnaprawa\ntworzenie Z2MM",
+        "uk": "фіксувати державні ролі і доступ\nфіксувати стан обробки\nфіксатор творуZ2MMessage",
+        "zh-cn": "fix 国家作用和准入\nfix 国家处理\nfix 建立Z2MMessage"
+      },
       "2.2.0": {
         "en": "added support for [Lidl HG06467 effects](https://www.zigbee2mqtt.io/devices/HG06467.html#trigger-effects)\nadded support for hs color\nsimulated_brightness data point is added only for supported devices",
         "de": "unterstützung für [Lidl HG06467-Effekte](https://www.zigbee2mqt.io/devices/HG06467.html#trigger-Effekte)\nunterstützung für hs farbe\nsimuld_brightness-datenpunkt wird nur für unterstützte geräte hinzugefügt",
@@ -78,18 +91,6 @@
         "es": "estados del grupo corregidos\nopción agregada 'Use Kelvin en lugar de mired para el color temps '\neliminar la lógica disponible, ahora utilizará la información de z2m\nnoLogDevices to logfilter\nmuchos bugfixes\nnoLogDevices funcionalidad\ndebugmesage añadido para la funcionalidad específica del dispositivo\nañadido algunos estados son falsos\nsoporte añadido para escenas definidas en un dispositivo\nfijar la función estatal disponible\nfijar suscriptosEstados disponibles",
         "pl": "państwa grupowe poprawiły\ndodał opcję 'Use Kelvin' zamiast śmiać kolorowe tempo. '\nzdejmowanie dostępnej logiki wykorzystuje obecnie informacje z 2 m\nnazwa NoLogDevices (ang.)\nwiele błędów\ndodano obsługę NoLogDevices\ndodanie debugmessage dla konkretnej funkcjonalności\ndodanie niektórych stanów jest fałszywe\ndodano wsparcie dla scen zdefiniowanych na urządzenie\nfunkcja stanowa\nrecovery",
         "zh-cn": "更正\n加上“Use Kelvin”的备选办法,而不是对色彩的诱惑。 评 注\n删除现有逻辑,现在将使用兹2m的信息。\n目 录\n批发\n增加无车辆功能\n增加特定装置功能的碎片\n另有一些国家的违约情况\n对一个装置所界定的场地的更多支持\nf 现有国家作用\nfix 有线性的国家"
-      },
-      "0.1.0": {
-        "en": "first release",
-        "de": "erste veröffentlichung",
-        "ru": "первый релиз",
-        "pt": "primeiro lançamento",
-        "nl": "eerste vrijlating",
-        "fr": "première version",
-        "it": "primo rilascio",
-        "es": "primera liberación",
-        "pl": "pierwsze wydanie",
-        "zh-cn": "首次释放"
       }
     },
     "titleLang": {

package/lib/deviceController.js

@@ -3,14 +3,15 @@ const defineDeviceFromExposes = require('./exposes').defineDeviceFromExposes;
 const utils = require('./utils');
 const colors = require('./colors.js');
 const rgb = require('./rgb.js');
-const createCache = {};
+//const createCache = {};
 
 class DeviceController {
-    constructor(adapter, deviceCache, groupCache, config) {
+    constructor(adapter, deviceCache, groupCache, config, createCache) {
         this.adapter = adapter;
         this.groupCache = groupCache;
         this.deviceCache = deviceCache;
         this.config = config;
+        this.createCache = createCache;
     }
 
     async createDeviceDefinitions(exposes) {
@@ -142,7 +143,7 @@ class DeviceController {
     async createOrUpdateDevices() {
         for (const device of this.groupCache.concat(this.deviceCache)) {
             const deviceName = device.id == device.ieee_address ? '' : device.id;
-            if (!createCache[device.ieee_address] || createCache[device.ieee_address].common.name != deviceName) {
+            if (!this.createCache[device.ieee_address] || this.createCache[device.ieee_address].name != deviceName) {
                 const deviceObj = {
                     type: 'device',
                     common: {
@@ -160,7 +161,7 @@ class DeviceController {
 
                 //@ts-ignore
                 await this.adapter.extendObjectAsync(device.ieee_address, deviceObj);
-                createCache[device.ieee_address] = deviceObj;
+                this.createCache[device.ieee_address] = { name: deviceName };
             }
 
             // Here it is checked whether the scenes match the current data from z2m.
@@ -175,14 +176,15 @@ class DeviceController {
             }
 
             for (const state of device.states) {
-                if (!createCache[device.ieee_address][state.id] || createCache[device.ieee_address][state.id].name != state.name) {
-                    const iobState = await this.copyAndCleanStateObj(state);
-                    await this.adapter.extendObjectAsync(`${device.ieee_address}.${state.id}`, {
+                if (!this.createCache[device.ieee_address][state.id] || this.createCache[device.ieee_address][state.id].name != state.name) {
+                    const iobState = {
                         type: 'state',
-                        common: iobState,
+                        common: await this.copyAndCleanStateObj(state),
                         native: {},
-                    });
-                    createCache[device.ieee_address][state.id] = state.name;
+                    };
+
+                    await this.adapter.extendObjectAsync(`${device.ieee_address}.${state.id}`, iobState);
+                    this.createCache[device.ieee_address][state.id] = { name: state.name, created: true };
                 }
             }
         }
@@ -212,6 +214,7 @@ class DeviceController {
         if (ieee_address != undefined) {
             this.adapter.setStateAsync(`${ieee_address}.available`, false, true);
             this.adapter.extendObject(`${ieee_address}`, { common: { name: 'Device removed!', } });
+            delete this.createCache[ieee_address];
         }
     }
 

package/lib/exposes.js

@@ -8,10 +8,38 @@ const utils = require('./utils');
 const colors = require('./colors');
 const getNonGenDevStatesDefs = require('./nonGenericDevicesExtension').getStateDefinition;
 
+// https://www.zigbee2mqtt.io/guide/usage/exposes.html#access
+const z2mAccess = {
+    /**
+     * Bit 0: The property can be found in the published state of this device
+     */
+    STATE: 1,
+    /**
+     * Bit 1: The property can be set with a /set command
+     */
+    SET: 2,
+    /**
+     * Bit 2: The property can be retrieved with a /get command
+     */
+    GET: 4,
+    /**
+     * Bitwise inclusive OR of STATE and SET : 0b001 | 0b010
+     */
+    STATE_SET: 3,
+    /**
+     * Bitwise inclusive OR of STATE and GET : 0b001 | 0b100
+     */
+    STATE_GET: 5,
+    /**
+     * Bitwise inclusive OR of STATE and GET and SET : 0b001 | 0b100 | 0b010
+     */
+    ALL: 7,
+};
+
 function genState(expose, role, name, desc) {
     let state;
-    const readable = true; //expose.access > 0;
-    const writable = expose.access > 1;
+    const readable = (expose.access & z2mAccess.STATE) > 0;
+    const writable = (expose.access & z2mAccess.SET) > 0;
     const stname = (name || expose.property);
 
     if (typeof stname !== 'string') {
@@ -134,9 +162,9 @@ function createFromExposes(deviceID, ieee_address, definitions, power_source, sc
         if (state === undefined) {
             return 0;
         }
-
-        state.readable = true;
-        state.writable = access > 1;
+        if (access === undefined) access = z2mAccess.ALL;
+        state.readable = (access & z2mAccess.STATE) > 0;
+        state.writable = (access & z2mAccess.SET) > 0;
         const stateExists = states.findIndex((x, _index, _array) => (x.id === state.id));
 
         if (stateExists < 0) {
@@ -379,7 +407,7 @@ function createFromExposes(deviceID, ieee_address, definitions, power_source, sc
                                 },
                                 epname: expose.endpoint,
                                 setattr: 'color',
-                            }, 2);
+                            }, prop.access);
                             break;
                         }
                         case 'color_hs': {
@@ -415,7 +443,7 @@ function createFromExposes(deviceID, ieee_address, definitions, power_source, sc
                                 },
                                 epname: expose.endpoint,
                                 setattr: 'color',
-                            }, 2);
+                            }, prop.access);
                             // pushToStates({
                             // 	id: expose.endpoint ? `hue_${expose.endpoint}` : 'hue',
                             // 	prop: expose.endpoint ? `color_${expose.endpoint}` : 'color',
@@ -539,7 +567,7 @@ function createFromExposes(deviceID, ieee_address, definitions, power_source, sc
                             break;
                         }
                         default:
-                            pushToStates(genState(prop), 2);
+                            pushToStates(genState(prop), prop.access);
                             break;
                     }
                 }
@@ -701,7 +729,7 @@ function createFromExposes(deviceID, ieee_address, definitions, power_source, sc
                                 getter: payload => {
                                     return utils.bulbLevelToAdapterLevel(payload.brightness);
                                 },
-                            }, 1);
+                            }, expose.access);
                         }
                         state = null;
                         break;
@@ -720,7 +748,7 @@ function createFromExposes(deviceID, ieee_address, definitions, power_source, sc
                     switch (expose.name) {
                         case 'contact':
                             state = statesDefs.contact;
-                            pushToStates(statesDefs.opened, 1);
+                            pushToStates(statesDefs.opened, expose.access);
                             break;
 
                         case 'battery_low':
@@ -783,6 +811,12 @@ function createFromExposes(deviceID, ieee_address, definitions, power_source, sc
                         case 'running_mode':
                             pushToStates(statesDefs.climate_running_mode, prop.access);
                             break;
+                        case 'local_temperature':
+                            pushToStates(statesDefs.hvacThermostat_local_temp, prop.access);
+                            break;
+                        case 'local_temperature_calibration':
+                            pushToStates(statesDefs.hvacThermostat_local_temp_calibration, prop.access);
+                            break;
                         default:
                             {
                                 if (prop.name.includes('heating_setpoint')) {
@@ -809,7 +843,7 @@ function createFromExposes(deviceID, ieee_address, definitions, power_source, sc
                         return result;
                     };
                     // if we have a composite expose, the value have to be an object {expose.property : {prop.property: value}}
-                    if (prop.access & 2) {
+                    if (prop.access & z2mAccess.SET) {
                         st.setter = (value, options) => {
                             const result = {};
                             options[prop.property] = value;
@@ -819,7 +853,7 @@ function createFromExposes(deviceID, ieee_address, definitions, power_source, sc
                         st.setattr = expose.property;
                     }
                     // if we have a composite expose, the payload will be an object {expose.property : {prop.property: value}}
-                    if (prop.access & 1) {
+                    if (prop.access & z2mAccess.STATE) {
                         st.getter = payload => {
                             if ((payload.hasOwnProperty(expose.property)) && (payload[expose.property] !== null) && payload[expose.property].hasOwnProperty(prop.property)) {
                                 return !isNaN(payload[expose.property][prop.property]) ? payload[expose.property][prop.property] : undefined;
@@ -841,11 +875,11 @@ function createFromExposes(deviceID, ieee_address, definitions, power_source, sc
     // If necessary, add states defined for this device model.
     // Unfortunately this is necessary for some device models because they do not adhere to the standard
     for (const state of getNonGenDevStatesDefs(definitions.model)) {
-        pushToStates(state, state.write ? 2 : 1);
+        pushToStates(state, state.write ? z2mAccess.SET : z2mAccess.STATE);
     }
 
     // Add default states
-    pushToStates(statesDefs.available, 1);
+    pushToStates(statesDefs.available, z2mAccess.STATE);
 
     const newDevice = {
         id: deviceID,

package/lib/states.js

@@ -2153,7 +2153,7 @@ const states = {
 
     // hvac Thermostat cluster - generic states
     hvacThermostat_local_temp: {
-        id: 'local_temp',
+        id: 'local_temperature',
         prop: 'local_temperature',
         name: 'Local Temperature',
         icon: undefined,
@@ -2164,7 +2164,7 @@ const states = {
         unit: '°C',
     },
     hvacThermostat_local_temp_calibration: {
-        id: 'local_temp_calibration',
+        id: 'local_temperature_calibration',
         prop: 'local_temperature_calibration',
         name: 'Temperature Calibration',
         icon: undefined,
@@ -2173,6 +2173,7 @@ const states = {
         read: true,
         type: 'number',
         unit: '°C',
+        def: 0
     },
     hvacThermostat_remote_sensing: {
         id: 'remote_sensing',

package/lib/statesController.js

@@ -3,11 +3,12 @@ const incStatsQueue = [];
 const timeOutCache = {};
 
 class StatesController {
-    constructor(adapter, deviceCache, groupCache, logCustomizations) {
+    constructor(adapter, deviceCache, groupCache, logCustomizations, createCache) {
         this.adapter = adapter;
         this.groupCache = groupCache;
         this.deviceCache = deviceCache;
         this.logCustomizations = logCustomizations;
+        this.createCache = createCache;
     }
 
     processDeviceMessage(messageObj) {
@@ -49,6 +50,13 @@ class StatesController {
 
                 const stateName = `${device.ieee_address}.${state.id}`;
 
+                // It may be that the state has not yet been created!
+                if (!this.createCache[device.ieee_address] || !this.createCache[device.ieee_address][state.id] || !this.createCache[device.ieee_address][state.id].created) {
+                    incStatsQueue[incStatsQueue.length] = messageObj;
+                    //this.adapter.log.debug(`State ${stateName} is not yet created, queue state in incStatsQueue!`);
+                    continue;
+                }
+
                 try {
                     if (state.isEvent) {
                         if (state.getter) {

package/lib/z2mController.js

@@ -36,16 +36,11 @@ class Z2mController {
             stateID = deviceState.prop;
         }
 
-        let topic = `${device.ieee_address}/set`;
-        if (device.ieee_address.includes('group_')) {
-            topic = `${device.id}/set`;
-        }
-
         const controlObj = {
             payload: {
                 [stateID]: stateVal
             },
-            topic: topic
+            topic: `${device.id}/set`
         };
 
         // set stats with the mentioned role or ids always immediately to ack = true, because these are not reported back by Zigbee2MQTT

package/main.js

@@ -23,6 +23,7 @@ let mqttClient;
 let deviceCache = [];
 // eslint-disable-next-line prefer-const
 let groupCache = [];
+const createCache = {};
 const logCustomizations = { debugDevices: '', logfilter: [] };
 let showInfo = true;
 let statesController;
@@ -44,8 +45,8 @@ class Zigbee2mqtt extends core.Adapter {
     }
 
     async onReady() {
-        statesController = new StatesController(this, deviceCache, groupCache, logCustomizations);
-        deviceController = new DeviceController(this, deviceCache, groupCache, this.config);
+        statesController = new StatesController(this, deviceCache, groupCache, logCustomizations, createCache);
+        deviceController = new DeviceController(this, deviceCache, groupCache, this.config, createCache);
         z2mController = new Z2mController(this, deviceCache, groupCache, logCustomizations);
 
         // Initialize your adapter here

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.zigbee2mqtt",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "description": "Zigbee2MQTT adapter for ioBroker",
   "author": {
     "name": "Dennis Rathjen",
@@ -36,13 +36,13 @@
     "@types/chai": "^4.3.3",
     "@types/chai-as-promised": "^7.1.5",
     "@types/mocha": "^10.0.0",
-    "@types/node": "^18.11.0",
+    "@types/node": "^18.11.3",
     "@types/proxyquire": "^1.3.28",
     "@types/sinon": "^10.0.13",
     "@types/sinon-chai": "^3.2.8",
     "chai": "^4.3.6",
     "chai-as-promised": "^7.1.1",
-    "eslint": "^8.25.0",
+    "eslint": "^8.26.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-prettier": "^4.2.1",
     "mocha": "^10.1.0",