iobroker.zigbee 3.1.4 → 3.1.6

package/lib/commands.js

@@ -176,6 +176,9 @@ class Commands {
                     case 'downloadIcons':
                         this.triggerIconDownload(obj);
                         break;
+                    case 'aliveCheck':
+                        this.adapter.sendTo(obj.from, obj.command, {msg:'success'}, obj.callback);
+                        break;
                     default:
                         this.debug(`Commands: Command ${obj.command} is unknown`);
                         //this.adapter.sendTo(obj.from, obj.command, obj.message, obj.callback);
@@ -336,10 +339,6 @@ class Commands {
         }
     }
 
-
-    async handleDeviceforInfo(device, states) {
-    }
-
     async handleGroupforInfo(group, groups) {
         group.icon = 'img/group.png';
         group.vendor = 'ioBroker';
@@ -355,7 +354,13 @@ class Commands {
                     if (member && typeof member.ieee === 'string') {
                         const memberId = member.ieee.substr(2);
                         const device = await this.adapter.getObjectAsync(`${this.adapter.namespace}.${member.ieee.substr(2)}`);
-                        if (groups.hasOwnProperty(memberId)) { if (!groups[memberId].includes(groupID)) groups[memberId].push(groupID)} else groups[memberId] = [groupID]
+                        const item = groups[memberId] || { groups:[], gep: { }};
+                        const gep = item.gep[member.epid] || [];
+
+                        if (!item.groups.includes(groupID)) item.groups.push(groupID);
+                        if (!gep.includes(`${groupID}`)) gep.push(`${groupID}`);
+                        item.gep[member.epid] = gep;
+                        groups[memberId] = item;
                         if (device) {
                             member.device = device.common.name;
                         } else {
@@ -370,7 +375,7 @@ class Commands {
         }
     }
 
-    async fillInfo(device, device_stateDefs, all_states) {
+    async fillInfo(device, device_stateDefs, all_states, models) {
         device.statesDef = (device_stateDefs || []).filter(stateDef => {
             const sid = stateDef._id.replace(this.adapter.namespace + '.', '');
             const names = sid.split('.');
@@ -394,7 +399,23 @@ class Commands {
         });
 
         const id = getZbId(device._id);
-        device.info = this.buildDeviceInfo(await this.zbController.resolveEntity(id));
+        const entity = await this.zbController.resolveEntity(id)
+
+        device.info = this.buildDeviceInfo(entity);
+
+        const UID = models.UIDbyModel[device.info?.mapped?.model || 'unknown'] || `m_${Object.keys(models.UIDbyModel).length}`;
+        if (models.byUID.hasOwnProperty(UID)) {
+            models.byUID[UID].devices.push(device);
+        }
+        else {
+            models.byUID[UID] = {
+                model:device.info.mapped,
+                availableOptions : [...device.info?.mapped?.options || [], ...['use_legacy_model']],
+                setOptions: this.adapter.stController.localConfig.getByModel(device.info?.mapped?.model || 'unknown') || [],
+                devices: [device],
+            }
+            models.UIDbyModel[device.info?.mapped?.model || 'unknown'] = UID;
+        }
         // check configuration
         try {
             if (device.info) {
@@ -403,13 +424,11 @@ class Commands {
                     [device.info.device, device.info.mapped],
                 );
                 if (result.length > 0) device.isConfigured = !result[0];
-            }
+                device.paired = true;
+            } else device.paired = false;
         } catch (error) {
             this.warn('error calling shouldConfigure: ' + error && error.message ? error.message : 'no error message');
         }
-        device.paired = !!device.info;
-
-
     }
 
     buildDeviceInfo(device) {
@@ -418,11 +437,11 @@ class Commands {
             rv.device = {
                 modelZigbee:device.device.modelID,
                 type:device.device.type,
-                ieee:device.device.ieeeAddr,
-                nwk:device.device.networkAddress,
+                ieee:device.device.ieeeAddr || device.device.groupID,
+                nwk:device.device.networkAddress || 0,
                 manuf_id:device.device.maufacturerID,
                 manuf_name:device.device.manufacturerName,
-                manufacturer:device.mapped.vendor,
+                manufacturer:device.mapped?.vendor,
                 power:device.device.powerSource,
                 app_version:device.device.applicationVersion,
                 hard_version:device.device.hardwareVersion,
@@ -442,25 +461,40 @@ class Commands {
                     output_clusters:ep.outputClusters,
                 })
             }
-            rv.mapped = {
-                model:device.mapped.model,
-                description:device.mapped.description,
-                //fingerprint:JSON.stringify(device.mapped.fingerprint),
-                vendor:device.mapped.vendor,
-                hasOnEvent:device.mapped.onEvent != undefined,
-                hasConfigure:device.mapped.configure != undefined,
-                options:[],
-            }
-            if (device.mapped.options && typeof (device.mapped.options == 'object')) {
-                const optionDesc = [];
-                for (const option of device.mapped.options) {
-                    if (option.name)
-                        rv.mapped.options.push(option.name);
+            if (device.mapped) {
+                rv.mapped = {
+                    model:device.mapped.model,
+                    description:device.mapped.description,
+                    //fingerprint:JSON.stringify(device.mapped.fingerprint),
+                    vendor:device.mapped.vendor,
+                    hasOnEvent:device.mapped.onEvent != undefined,
+                    hasConfigure:device.mapped.configure != undefined,
+                    options:[],
+                }
+                if (device.mapped.options && typeof (device.mapped.options == 'object')) {
+                    for (const option of device.mapped.options) {
+                        if (option.name) {
+                            rv.mapped.options.push(option.name);
+                        }
+                    }
+                }
+            }
+            else {
+                rv.mapped = {
+                    model:device.name,
+                    description:device.name,
+                    vendor:'not set',
+                    hasOnEvent: false,
+                    hasConfigure: false,
+                    options:[],
                 }
             }
         }
         catch (error) {
-            this.warn(`Error ${error && error.message + ' ' ? error.message : ''}building device info for ${JSON.stringify(device)}`);
+            if (device && device.name === 'Coordinator') return rv;
+            const dev = device ? device.device || {} : {}
+            const msg = device ? `device ${device.name} (${dev.ieeeAddr}, NWK ${dev.networkAddres}, ID: ${dev.ID})` : 'undefined device';
+            this.warn(`Error ${error && error.message ? error.message + ' ' : ''}building device info for ${msg}`);
         }
         return rv;
     }
@@ -472,19 +506,23 @@ class Commands {
         }
         const exists = devices.find((dev) => (dev._id && device.device.ieeeAddr === getZbId(dev._id)));
         if (!exists) {
-            devices.push({
-                _id: device.device.ieeeAddr,
-                icon: 'img/unknown.png',
+            const coordinatorData = {
+                _id : `${this.adapter.namespace}.${device.device.ieeeAddr.substring(2)}`,
                 paired: true,
                 info: this.buildDeviceInfo(device),
-                common: {
-                    name: undefined,
-                    type: undefined,
-                },
-                native: {}
-            });
+                native: { id: device.device.ieeeAddr.substring(2) },
+                mapped : { model:'Coordinator' },
+                statesDev: [],
+            }
+            if (device.device.name === 'Coordinator') {
+                coordinatorData.icon = 'zigbee.png';
+                coordinatorData.common = { name: undefined, type: undefined  };
+            } else {
+                coordinatorData.common = { name: 'Coordinator', type: 'Coordinator'  };
+                coordinatorData.icon= 'img/unknown.png';
+            }
+            devices.push(coordinatorData);
         }
-
     }
 
     async getDevices(from, command, id, callback) {
@@ -493,13 +531,14 @@ class Commands {
             this.adapter.sendTo(from, command, {error: 'No active connection to Zigbee Hardware!'}, callback);
             return;
         }
-        const rooms = await this.adapter.getEnumsAsync('enum.rooms') || {};
+        const roomsEnum = await this.adapter.getEnumsAsync('enum.rooms') || {};
         const deviceObjects = (id ? [await this.adapter.getObjectAsync(id)] : await this.adapter.getDevicesAsync());
         const all_states = id ? await this.adapter.getStatesAsync(id + '.*') : await this.adapter.getStatesAsync('*');
         const all_stateDefs = id ? await this.adapter.getStatesOfAsync(id) : await this.adapter.getStatesOfAsync();
         const illegalDevices = [];
         const groups = {};
         const PromiseChain = [];
+        const models = { byUID : {}, UIDbyModel: {} };
         for (const devInfo of deviceObjects) {
             if (devInfo._id.indexOf('group') > -1) {
                 PromiseChain.push(this.handleGroupforInfo(devInfo, groups));
@@ -515,25 +554,26 @@ class Commands {
                 devInfo.link_quality_lc = lq_state ? lq_state.lc : undefined;
                 const battery_state = all_states[`${devInfo._id}.battery`];
                 devInfo.battery = battery_state ? battery_state.val : undefined;
-                devInfo.rooms = [];
-                for (const room in rooms) {
-                    if (!rooms.hasOwnProperty(room) ||
-                        !rooms[room] ||
-                        !rooms[room].common ||
-                        !rooms[room].common.members
-                    ) {
-                        continue;
-                    }
-                    if (rooms[room].common.members.includes(devInfo._id)) {
-                        devInfo.rooms.push(rooms[room].common.name);
-                    }
-                }
 
             }
-            PromiseChain.push(this.fillInfo(devInfo, all_stateDefs.filter(item => item._id.startsWith(devInfo._id)),all_states));
+            devInfo.rooms = [];
+            const rooms = roomsEnum['enum.rooms'] || {};
+            for (const room of Object.keys(rooms)) {
+                if (!rooms.hasOwnProperty(room) ||
+                    !rooms[room] ||
+                    !rooms[room].common ||
+                    !rooms[room].common.members
+                ) {
+                    continue;
+                }
+                if (rooms[room].common.members.includes(devInfo._id)) {
+                    devInfo.rooms.push(rooms[room].common.name);
+                }
+            }
+            PromiseChain.push(this.fillInfo(devInfo, all_stateDefs.filter(item => item._id.startsWith(devInfo._id)),all_states, models));
         }
         if (!id) {
-            for (const client of this.zbController.getClientIterator(false)) {
+            for (const client of this.zbController.getClientIterator(true)) {
                 PromiseChain.push(this.appendDevicesWithoutObjects(deviceObjects,client))
             }
         }
@@ -543,14 +583,20 @@ class Commands {
         for (const groupmember in groups) {
             const device = deviceObjects.find(dev => (groupmember === dev.native.id));
             if (device) {
-                device.groups = groups[groupmember];
+                device.groups = groups[groupmember].groups;
+                device.groups_by_ep = groups[groupmember].gep;
             }
         }
 
 
         this.debug(`getDevices contains ${deviceObjects.length} Devices`);
         const rv = { devices:deviceObjects, inLog:this.adapter.deviceDebug.logStatus, }
-        if (!id) rv.byId = this.adapter.deviceDebug.collectDebugData();
+        if (!id) {
+            rv.deviceDebugData = this.adapter.deviceDebug.collectDebugData();
+            rv.localOverrides = this.adapter.stController.localConfig.localData;
+            rv.models = models.byUID;
+        }
+
         if (this.stController) {
             rv.clean = this.stController.CleanupRequired();
             rv.errors = this.stController.getStashedErrors();
@@ -777,7 +823,6 @@ class Commands {
             this.debug(`updateLocalConfigItems : ${JSON.stringify(msg)}`);
             const target = msg.target.replace(`${this.adapter.namespace}.`, '');
             const entity = await this.zbController.resolveEntity(target);
-            //this.warn('entity for ' + target + ' is '+ JSON.stringify(entity))
             if (entity && !entity.mapped) {
                 this.warn('unable to set local Override for device whithout mapped model');
                 return;
@@ -811,13 +856,18 @@ class Commands {
                     await this.stController.localConfig.updateLocalOverride(target, (entity ? entity.mapped.model : 'group'), prop, msg.data[prop], msg.global);
                 }
             }
-            if (entity) {
-                this.debug('updateLocalConfigItems with Entity');
-                this.stController.updateDev(target, entity.mapped.model, entity.mapped.model, () => {this.adapter.sendTo(from, command, {}, callback)});
+            try {
+                if (entity) {
+                    this.debug('updateLocalConfigItems with Entity');
+                    this.stController.updateDev(target, entity.mapped.model, entity.mapped.model, () => {this.adapter.sendTo(from, command, {}, callback)});
+                }
+                else {
+                    this.debug('updateLocalConfigItems without Entity');
+                    this.stController.updateDev(target, undefined, 'group',() => {this.adapter.sendTo(from, command, {}, callback)});
+                }
             }
-            else {
-                this.debug('updateLocalConfigItems without Entity');
-                this.stController.updateDev(target, undefined, 'group',() => {this.adapter.sendTo(from, command, {}, callback)});
+            catch (error) {
+                this.adapter.sendTo(from, command, {err: error.message}, callback);
             }
         }
     }
@@ -841,6 +891,9 @@ class Commands {
                 //const targetModel = msg.model ? msg.model : '';
             }
             else {
+                if (msg.getAllData) {
+                    this.adapter.sendTo(from, command, this.stController.localConfig.localData, callback);
+                }
                 rv.error = `missing data in message ${JSON.stringify(msg)}`;
             }
         }

package/lib/exposes.js

@@ -801,7 +801,7 @@ function createFromExposes(model, def, device, log) {
 
             case 'climate':
                 for (const prop of expose.features) {
-                    switch (prop.name) {
+                    /* switch (prop.name) {
                         case 'away_mode':
                             pushToStates(statesDefs.climate_away_mode, prop.access);
                             break;
@@ -814,7 +814,8 @@ function createFromExposes(model, def, device, log) {
                         default:
                             pushToStates(genState(prop), prop.access);
                             break;
-                    }
+                    }*/
+                    pushToStates(genState(prop), prop.access);
                 }
                 break;
 

package/lib/localConfig.js

@@ -329,6 +329,14 @@ class localConfig extends EventEmitter {
         return rv;
     }
 
+    getByModel(id) {
+        return this.localData.by_model[id] || {};
+    }
+
+    getByDevice(id) {
+        return this.localData.by_id[id] || {};
+    }
+
 }
 
 module.exports = localConfig;

package/lib/statescontroller.js

@@ -458,7 +458,7 @@ class StatesController extends EventEmitter {
         if (stateDesc.id === 'send_payload') {
             try {
                 const json_value = JSON.parse(value);
-                const payload = {device: deviceId.replace('0x', ''), payload: json_value, model:model, stateModel:stateModel};
+                const payload = {device: deviceId.replace('0x', ''), payload: json_value, model:model, stateModel:stateModel, acknowledge:true};
                 if (has_elevated_debug) this.emit('device_debug', { ID:debugID, data: { flag: '04' ,payload:value ,states:[{id:stateDesc.id, value:json_value, payload:'none'}], IO:false }});
 
                 this.emit('send_payload', payload, debugID, has_elevated_debug);

package/lib/zbDeviceEvent.js

@@ -67,7 +67,6 @@ class DeviceEvent extends BaseExtension {
 
 
         if (mappedDevice && mappedDevice.onEvent && eventData.data) {
-            this.warn(`calling onEvent for ${eventData.type} on ${device.ieeeAddr}`);
             try {
                 mappedDevice.onEvent(eventData);
             }

package/lib/zigbeecontroller.js

@@ -618,6 +618,7 @@ class ZigbeeController extends EventEmitter {
                     device: coordinator,
                     endpoint: coordinator.getEndpoint(1),
                     name: 'Coordinator',
+                    mapped: { model: 'Coordinator'},
                     options:{}
                 };
             }
@@ -657,6 +658,7 @@ class ZigbeeController extends EventEmitter {
                         return {
                             type: 'device',
                             device: device,
+                            mapped: { model: 'Coordinator'},
                             endpoint: device.getEndpoint(1),
                             name: 'Coordinator',
                         };
@@ -676,7 +678,7 @@ class ZigbeeController extends EventEmitter {
                         endpoint = device.endpoints[0];
                     }
                 }
-                const options = this.adapter.stController.localConfig.getOptions(device.ieeeAddr, mapped.model);
+                const options = mapped ? this.adapter.stController.localConfig.getOptions(device.ieeeAddr, mapped.model) : {};
                 return {
                     type: 'device',
                     device,
@@ -731,13 +733,14 @@ class ZigbeeController extends EventEmitter {
         }
 
         try {
-            if (this.HerdsmanStarted) {
+            if (this.herdsmanStarted) {
                 await this.permitJoin(0);
                 await this.herdsman.stop();
-                this.HerdsmanStarted = false;
+                this.herdsmanStarted = false;
                 this.info('zigbecontroller stopped successfully');
+                return;
             }
-            this.info('zigbecontroller stopped successfully - ZH was not running');
+            else this.info('zigbecontroller stopped successfully - ZH was not running');
         } catch (error) {
             this.sendError(error);
             if (this.herdsmanStarted) {
@@ -759,6 +762,7 @@ class ZigbeeController extends EventEmitter {
 
     // Permit join
     async permitJoin(permitTime, devid) {
+        if (!this.herdsmanStarted) return false;
         try {
             this._permitJoinTime = permitTime;
             await this.herdsman.permitJoin(permitTime);
@@ -876,10 +880,11 @@ class ZigbeeController extends EventEmitter {
     async handleDeviceAnnounce(message) {
         if (this.debugActive) this.debug('handleDeviceAnnounce', message);
         const entity = await this.resolveEntity(message.device || message.ieeeAddr);
-        const friendlyName = entity.name;
-
+        const friendlyName = entity ? entity.name : message.ieeeAddr ? message.ieeeAddr : message.device && message.device.ieeeAddr ? message.device.ieeeAddr : 'without data';
 
         this.emit('pairing', `Device '${friendlyName}' announced itself`);
+        if (!entity) return;
+
         if (this.adapter.stController.checkDebugDevice(friendlyName)) {
             this.emit('device_debug', {ID: Date.now(), data: {flag:'da', states:[{id: '--', value:'--', payload:message}] , IO:true} ,message:`Device '${friendlyName}' announced itself`});
         }
@@ -1386,7 +1391,7 @@ class ZigbeeController extends EventEmitter {
     // device: name of the device. For a device zigbee.0.0011223344556677 this would be 0011223344556677
     // payload: The data to send to the device as JSON object (key/Value pairs)
     // endpoint: optional: the endpoint to send the data to, if supported.
-    //
+    // acknowledge: optional: if to update the devices 'send_payload' DP (if present) after successful publish
     async publishPayload(payload, debugID, has_elevated_debug) {
         let payloadObj = {};
         if (typeof payload === 'string') {
@@ -1450,6 +1455,9 @@ class ZigbeeController extends EventEmitter {
                 }
                 try {
                     await this.publishFromState(`0x${payload.device}`, payload.model, payload.stateModel, stateList, payload.options, debugID, has_elevated_debug);
+                    if (payload.acknowledge) {
+                        this.emit('acknowledge_state', payload.device, payload.model, { id:'send_payload' }, undefined);
+                    }
                     return {success: true};
                 } catch (error) {
                     this.log.error(`Error ${error.code} on send command to ${payload.device}.` + ` Error: ${error.stack} ` + `Send command to ${payload.device} failed with ` + error);

package/main.js

@@ -274,7 +274,6 @@ class Zigbee extends utils.Adapter {
 
     SandboxRequire(sandbox, items) {
         if (!items) return true;
-        //let converterLoaded = true;
         for (const item of items) {
             const modulePath = item[2].replace(/['"]/gm, '');
 
@@ -350,9 +349,6 @@ class Zigbee extends utils.Adapter {
                     converterLoaded = false;
                     this.log.error(`converter does not export any converter array, please add 'module.exports' statement to ${mN}`);
                 }
-
-                //fs.writeFileSync(mN+'.tmp', modifiedCode)
-
                 if (converterLoaded) {
                     try {
                         this.log.warn('Trying to run sandbox for ' + mN);
@@ -422,7 +418,6 @@ class Zigbee extends utils.Adapter {
         }
         else try {
             await this.zbController.stopHerdsman();
-            //this.logToPairing('herdsman stopped !');
             this.sendTo(from, command, { status:true }, callback);
         } catch (error) {
             this.sendTo(from, command, { status:true, error }, callback);
@@ -458,12 +453,6 @@ class Zigbee extends utils.Adapter {
             this.setState('info.connection', false, true);
             this.logToPairing(`Failed to start Zigbee: ${error && error.message ? error.message : 'no message given'}`)
             this.log.error(`Failed to start Zigbee: ${error && error.message ? error.message : 'no message given'}`);
-            /* if (error.stack) {
-                this.log.error(error.stack);
-            } else {
-                this.log.error(error);
-            }
-            */
             this.sendError(error, `Failed to start Zigbee`);
             if (noReconnect) return false;
 
@@ -668,12 +657,18 @@ class Zigbee extends utils.Adapter {
     }
 
     acknowledgeState(deviceId, model, stateDesc, value) {
-        if (model === 'group') {
-            const stateId = `${this.namespace}.group_${deviceId}.${stateDesc.id}`;
-            this.setState(stateId, value, true);
-        } else {
-            const stateId = `${this.namespace}.${deviceId.replace('0x', '')}.${stateDesc.id}`;
-            this.setState(stateId, value, true);
+        const stateId = (model === 'group' ?
+            `${this.namespace}.group_${deviceId}.${stateDesc.id}` :
+            `${this.namespace}.${deviceId.replace('0x', '')}.${stateDesc.id}`);
+        if (value === undefined) try {
+            this.getState(stateId, (err, state) => { if (!err && state.hasOwnProperty('val')) this.setState(stateId,  state.val, true)});
+        }
+        catch (error) {
+            this.log.warn(`Error acknowledging ${stateId} without value: ${error && error.message ? error.message : 'no reason given'}`);
+        }
+        else try { this.setState(stateId, value, true); }
+        catch (error) {
+            this.log.warn(`Error acknowledging ${stateId} with value ${JSON.stringify(value)}: ${error && error.message ? error.message : 'no reason given'}`);
         }
     }
 
@@ -754,10 +749,8 @@ class Zigbee extends utils.Adapter {
             this.log.info('cleaning everything up');
             await this.callPluginMethod('stop');
             if (this.stController) chain.push(this.stController.stop());
-            if (this.zbController) {
-                chain.push(this.zbController.stop());
-            }
-            Promise.all(chain);
+            if (this.zbController) chain.push(this.zbController.stop());
+            await Promise.all(chain);
             this.log.info('cleanup successful');
             callback();
         } catch (error) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "iobroker.zigbee",
-  "version": "3.1.4",
+  "version": "3.1.6",
   "author": {
     "name": "Kirov Ilya",
     "email": "kirovilya@gmail.com"
@@ -29,7 +29,7 @@
     "uri-js": "^4.4.1",
     "typescript": "^5.9.2",
     "zigbee-herdsman": "^6.0.0",
-    "zigbee-herdsman-converters": "25.31.0"
+    "zigbee-herdsman-converters": "^25.37.0"
   },
   "description": "Zigbee devices",
   "devDependencies": {
@@ -37,10 +37,10 @@
     "@alcalzone/release-script-plugin-iobroker": "^3.7.2",
     "@alcalzone/release-script-plugin-license": "^3.7.0",
     "@alcalzone/release-script-plugin-manual-review": "^3.7.0",
-    "@iobroker/testing": "^5.1.0",
+    "@iobroker/testing": "^5.1.1",
     "chai": "^5.2.1",
     "chai-as-promised": "^7.1.1",
-    "eslint": "^9.30.0",
+    "eslint": "^9.36.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.5.4",
     "mixin-deep": "^2.0.1",