iobroker.zigbee 2.0.5 → 3.0.0

package/lib/commands.js

@@ -1,12 +1,15 @@
 'use strict';
 
 const getZbId = require('./utils').getZbId;
+const getNetAddress = require('./utils').getNetAddress;
+const reverseByteString = require('./utils').reverseByteString;
 const fs = require('fs');
-const pathLib = require('path');
 const statesMapping = require('./devices');
 const utils = require('@iobroker/adapter-core'); // Get common adapter utils
 const colors = require('./colors.js');
-const { exec } = require('child_process');
+const dns = require('dns');
+const net = require('net');
+const { access, constants } =require('fs');
 
 const disallowedDashStates = [
     'link_quality', 'available', 'battery', 'groups', 'device_query',
@@ -50,13 +53,14 @@ class Commands {
      * @param {ioBroker.Message} obj
      */
     onMessage(obj) {
-        if (obj) {
-            if (typeof obj === 'object' && obj.command) {
+        if (typeof obj === 'object' && obj.command) {
+            if (obj) {
                 switch (obj.command) {
-                    case 'reset':
-                        if (obj.message && obj.message.mode == 'delNvbackup') {
-                            this.delNvBackup(obj.from, obj.command, obj.message, obj.callback);
-                        }
+                    case 'testConnect':
+                        this.adapter.testConnect(obj.from, obj.command, obj.message, obj.callback);
+                        break;
+                    case 'deleteNVBackup':
+                        this.delNvBackup(obj.from, obj.command, {}, obj.callback);
                         break;
                     case 'letsPairing':
                         if (obj.message && typeof obj.message === 'object') {
@@ -89,7 +93,7 @@ class Commands {
                         }
                         break;
                     case 'getCoordinatorInfo':
-                        if (obj && obj.message && typeof obj.message === 'object') {
+                        if (obj.message && typeof obj.message === 'object') {
                             this.getCoordinatorInfo(obj.from, obj.command, obj.callback);
                         }
                         break;
@@ -151,25 +155,81 @@ class Commands {
                         }
                         break;
                     case 'getDeviceCleanupRequired':
-                        if (obj) {
-                            this.adapter.sendTo(obj.from, obj.command, {clean:this.stController.CleanupRequired(), errors:this.stController.getStashedErrors()}, obj.callback);
-                        }
+                        if (this.stController) this.adapter.sendTo(obj.from, obj.command, {clean:this.stController.CleanupRequired(), errors:this.stController.getStashedErrors()}, obj.callback);
+                        // NO Break - returning the debug-data as well is intentional
                     case 'getDebugMessages':
-                        if (obj) {
-                            this.adapter.sendTo(obj.from, obj.command, {byId:this.adapter.deviceDebug.collectDebugData( obj.message.inlog)},obj.callback);
-                        }
+                        this.adapter.sendTo(obj.from, obj.command, {byId:this.adapter.deviceDebug.collectDebugData( obj.message.inlog)},obj.callback);
+                        break;
+                    case 'testConnection':
+                        this.testConnection(obj.from, obj.command, obj.message, obj.callback);
+                        break;
+                    case 'readNVRam':
+                        this.readNvBackup(obj.from, obj.command, obj.message, obj.callback);
+                    default:
+                        //this.warn(`Commands: Command ${obj.command} is unknown`);
+                        //this.adapter.sendTo(obj.from, obj.command, obj.message, obj.callback);
+                        break;
                 }
             }
         }
     }
 
-    delNvBackup(from, command, msg, callback) {
+    async readNvBackup(from, command, msg, callback) {
+        this.warn('readNvBackup called')
+        try {
+            const zo = this.adapter.getZigbeeOptions();
+            const name = require('path').join(zo.dbDir, zo.backupPath);
+            const nvbackup = fs.readFileSync(name, {encoding: 'utf8'}).toString();
+            const nvBackupJson = JSON.parse(nvbackup);
+            const rv = {};
+            rv.channel = nvBackupJson.channel;
+            rv.precfgkey = (nvBackupJson.network_key ? nvBackupJson.network_key.key : undefined);
+            rv.extPanID = nvBackupJson.extended_pan_id ? reverseByteString(nvBackupJson.extended_pan_id) : undefined;
+            rv.panID = parseInt('0x'+nvBackupJson.pan_id);
+            this.warn('readNvBackup returns ' + JSON.stringify(rv))
+            this.adapter.sendTo(from, command, rv, callback)
+        }
+        catch (error) {
+            const msg = `Unable to read nvBackup ${error && error.message ? error.message : 'no message given'}`;
+            this.error(msg);
+            this.adapter.sendTo(from, command, {error:msg}, callback)
+        }
+    }
+
+    async delNvBackup(from, command, msg, callback) {
         try {
-            if (this.zbController) {
+            if (this.zbController)
+            {
+                // stop the herdsman if needed
+                const wasRunning = this.zbController.herdsmanStarted;
+                if (wasRunning) await this.zbController.stop();
                 const name = this.zbController.herdsman.adapter.backupPath;
-                require('fs').unlinkSync(name);
+                fs.unlink(name, async (err) => {
+                    const rv={};
+                    if (err) {
+                        this.error(`Unable to remove ${name}: ${err}`);
+                        rv.error = `Unable to remove ${name}: ${err}`;
+                    }
+                    // start the herdsman again if it  was stopped before
+                    if (wasRunning) await this.zbController.start();
+                    this.adapter.sendTo(from, command, rv, callback)
+                });
+            }
+            else {
+                const zo = this.adapter.getZigbeeOptions();
+                const name = require('path').join(zo.dbDir, zo.backupPath);
+                fs.unlink(name, async (err) => {
+                    const rv={};
+                    if (err) {
+                        this.error(`Unable to remove ${name}: ${err}`);
+                        rv.error = `Unable to remove ${name}: ${err}`;
+                    }
+                    // start the herdsman again if it  was stopped before
+                    this.adapter.sendTo(from, command, rv, callback)
+                });
             }
         } catch (error) {
+            this.adapter.sendTo(from, command, {error: error.message}, callback)
             this.error(error);
         }
     }
@@ -231,7 +291,7 @@ class Commands {
     }
 
     touchlinkReset(from, command, message, callback) {
-        if (this.zbController) {
+        if (this.zbController && this.zbController.herdsmanStarted) {
             // allow devices to join the network within 60 secs
             this.adapter.logToPairing('Touchlink reset started ', true);
 
@@ -245,14 +305,14 @@ class Commands {
         } else {
             this.adapter.sendTo(
                 from, command,
-                {error: 'You need to setup serial port and start the adapter before pairing!'},
+                {error: 'No active connection to Zigbee Hardware!'},
                 callback
             );
         }
     }
 
     async getDevices(from, command, id, callback) {
-        if (this.zbController) {
+        if (this.zbController && this.zbController.herdsmanStarted) {
             this.debug(`getDevices called from  ${from} with command ${JSON.stringify(command)} and id ${JSON.stringify(id)}`);
             const pairedDevices = await this.zbController.getClients(true);
             const groups = {};
@@ -421,18 +481,27 @@ class Commands {
                     return devices;
                 })
                 .then(devices => {
-                    this.debug(`getDevices result: ${JSON.stringify(devices)}`);
-                    this.adapter.sendTo(from, command, devices, callback);
+                    this.debug(`getDevices contains ${devices.length} Devices`);
+                    const rv = { devices:devices, inLog:this.adapter.deviceDebug.logStatus, byId:this.adapter.deviceDebug.collectDebugData() }
+                    if (this.stController) {
+                        rv.clean = this.stController.CleanupRequired();
+                        rv.errors = this.stController.getStashedErrors();
+                        rv.debugDevices = this.stController.debugDevices;
+                    }
+                    this.adapter.sendTo(from, command, rv, callback);
                 })
-                .catch(err => this.error(`getDevices error: ${err.stack}`));
+                .catch(err => {
+                    this.error(`getDevices error: ${err.stack}`);
+                    this.adapter.sendTo(from, command, {error: `Error enumerating devices : ${err && err.message ? err.message : ''}`}, callback);
+                });
         } else {
-            this.adapter.sendTo(from, command, {error: 'You need save and run adapter before pairing!'}, callback);
+            this.adapter.sendTo(from, command, {error: 'No active connection to Zigbee Hardware!'}, callback);
         }
     }
 
 
     async getCoordinatorInfo(from, command, callback) {
-        if (this.zbController) {
+        if (this.zbController && this.zbController.herdsmanStarted) {
             const coordinatorinfo = {
                 installSource: 'IADefault_1',
                 channel: '-1',
@@ -500,7 +569,7 @@ class Commands {
                 this.adapter.sendTo(from, command, coordinatorinfo, callback);
             });
         } else {
-            this.adapter.sendTo(from, command, {error: 'You need save and run adapter before pairing!'}, callback);
+            this.adapter.sendTo(from, command, {error: 'No active connection to Zigbee Hardware!'}, callback);
         }
     }
 
@@ -515,7 +584,7 @@ class Commands {
     }
 
     deleteDevice(from, command, msg, callback) {
-        if (this.zbController && this.stController) {
+        if (this.zbController && this.zbController.herdsmanStarted && this.stController) {
             this.debug(`deleteDevice message: ${JSON.stringify(msg)}`);
             const id = msg.id;
             const force = msg.force;
@@ -540,7 +609,7 @@ class Commands {
                 }
             });
         } else {
-            this.adapter.sendTo(from, command, {error: 'You need to save and start the adapter!'}, callback);
+            this.adapter.sendTo(from, command, {error: 'No active connection to Zigbee Hardware!'}, callback);
         }
     }
 
@@ -564,14 +633,14 @@ class Commands {
     }
 
     async getChannels(from, command, message, callback) {
-        if (this.zbController) {
+        if (this.zbController && this.zbController.herdsmanStarted) {
             const result = await this.zbController.getChannelsEnergy();
             this.debug(`getChannels result: ${JSON.stringify(result)}`);
             this.adapter.sendTo(from, command, result, callback);
         } else {
             this.adapter.sendTo(
                 from, command,
-                {error: 'You need to setup serial port and start the adapter before pairing!'},
+                {error: 'No active connection to Zigbee Hardware!'},
                 callback
             );
         }
@@ -604,7 +673,7 @@ class Commands {
     async getLocalImages(from, command, msg, callback) {
         if (this.stController) {
             const id = msg.id;
-            const result = await this.stController.localConfig.enumerateImages(utils.getAbsoluteInstanceDataDir(this.adapter).replace('zigbee.','zigbee_'));
+            const result = await this.stController.localConfig.enumerateImages(this.adapter.getDataFolder());
             this.adapter.sendTo(from, command, {imageData:result}, callback)
         }
     }
@@ -663,7 +732,7 @@ class Commands {
 
 
     async reconfigure(from, command, msg, callback) {
-        if (this.zbController) {
+        if (this.zbController && this.zbController.herdsmanStarted) {
             const devid = getZbId(msg.id);
             this.debug(`Reconfigure ${devid}`);
             const entity = await this.zbController.resolveEntity(devid);
@@ -688,6 +757,69 @@ class Commands {
                 this.adapter.sendTo(from, command, {error: 'No device'}, callback);
             }
         }
+        else {
+            this.adapter.sendTo(from, command, {error: 'No active connection to Zigbee Hardware!'}, callback);
+        }
+    }
+
+    async testConnection(from, command, msg, callback) {
+        this.debug(`TestConnection with ${JSON.stringify(msg)}`);
+        if (msg && msg.address) {
+            const netAddress = getNetAddress(msg.address);
+            if (netAddress && netAddress.host) {
+                this.adapter.logToPairing(`attempting dns lookup for ${netAddress.host}`);
+                this.debug(`attempting dns lookup for ${netAddress.host}`);
+                dns.lookup(netAddress.host, (err, ip, _) => {
+                    if (err) {
+                        const msg = `Unable to resolve name: ${err && err.message ? err.message : 'no message'}`;
+                        this.error(msg);
+                        this.adapter.logToPairing(`Error: ${msg}`);
+                        this.adapter.sendTo(from, command, {error:msg}, callback);
+                        return;
+                    }
+                    this.debug(`dns lookup for ${msg.address} produced ${ip}`);
+                    this.adapter.logToPairing(`dns lookup for ${msg.address} produced ${ip}`);
+                    const client = new net.Socket();
+                    this.debug(`attempting to connect to ${ip} port ${netAddress.port ? netAddress.port : 80}`);
+                    client.connect(netAddress.port, ip, () => {
+                        client.destroy()
+                        this.adapter.logToPairing(`connected successfully to connect to ${ip} port ${netAddress.port ? netAddress.port : 80}`);
+                        this.debug(`connected successfully to connect to ${ip} port ${netAddress.port ? netAddress.port : 80}`);
+                        this.adapter.sendTo(from, command, {}, callback)
+                    })
+                    client.on('error', (error) => {
+                        const msg = `unable to connect to ${ip} port ${netAddress.port ? netAddress.port : 80} : ${error && error.message ? error.message : 'no message given'}`
+                        this.error(msg);
+                        this.adapter.logToPairing(`Error: ${msg}`);
+                        this.adapter.sendTo(from, command, {error:msg}, callback);
+                    });
+                })
+            }
+            else
+            {
+                try {
+                    const port = msg.address.trim();
+                    this.adapter.logToPairing(`reading access rights for ${port}`);
+                    access(port, constants.R_OK | constants.W_OK, (error) => {
+                        if (error) {
+                            const msg = `unable to access ${port} : ${error && error.message ? error.message : 'no message given'}`;
+                            this.error(msg);
+                            this.adapter.logToPairing(`Error: ${msg}`);
+                            this.adapter.sendTo(from, command, {error:msg}, callback);
+                            return;
+                        }
+                        this.adapter.logToPairing(`read and write access available for ${port}`);
+                        this.adapter.sendTo(from, command, {}, callback);
+                    });
+                }
+                catch (error) {
+                    const msg = `File access error: ${error && error.message ? error.message : 'no message given'}`;
+                    this.error(msg);
+                    this.adapter.logToPairing(`Error: ${msg}`);
+                    this.adapter.sendTo(from, command, {error:msg}, callback);
+                }
+            }
+        }
     }
 }
 

package/lib/devices.js

@@ -3104,9 +3104,9 @@ function fillStatesWithExposes(logger) {
 async function addExposeToDevices(device, logger, model) {
     const s = DevicesByModel.size;
     if (s < 1) getByModel();
-    await applyExposeForDevice(devices, DevicesByModel, device, logger, model);
+    const rv = await applyExposeForDevice(devices, DevicesByModel, device, logger, model);
     removeEmptyStates(devices);
-    return (DevicesByModel.size != s);
+    return rv;
 }
 
 // remove empty states

package/lib/exposes.js

@@ -251,8 +251,6 @@ function createFromExposes(model, def, device, log) {
         }
     }
 
-    const icon = utils.getDeviceIcon(def);
-
     if (typeof def.exposes == 'object') {
         for (const expose of def.exposes) {
             genStateFromExpose(expose);
@@ -266,11 +264,12 @@ function createFromExposes(model, def, device, log) {
             genStateFromExpose(expose);
         }
     }
+    const icon = utils.getDeviceIcon(def);
 
     const newDev = {
         models: [model],
-        icon,
         states,
+        icon,
         exposed: true,
     };
 
@@ -867,34 +866,12 @@ function createFromExposes(model, def, device, log) {
 
 }
 
-function applyExposes(mappedDevices, byModel) {
-    // create or device from exposes
-    for (const deviceDef of zigbeeHerdsmanConverters.definitions) {
-        applyDeviceDef(mappedDevices, byModel, deviceDef);
-
-        if (deviceDef.hasOwnProperty('whiteLabel')) {
-            for (const deviceWhiteLabel of deviceDef.whiteLabel) {
-                applyDeviceDef(mappedDevices, byModel, {
-                    ...deviceDef,
-                    model: deviceWhiteLabel.model,
-                    vendor: deviceWhiteLabel.vendor,
-                    description: deviceWhiteLabel.description || deviceDef.description,
-                });
-            }
-        }
-    }
-}
-
-async function applyExposeForDevice(mappedDevices, byModel, device, logger) {
-    const t = Date.now();
+async function applyExposeForDevice(mappedDevices, byModel, device) {
     const deviceDef = await zigbeeHerdsmanConverters.findByDevice(device);
     if (!deviceDef)  {
-        //logger.warn(`ZHC02,${Date.now()},${Date.now()-t},${device && device.ieeeAddr ? device.ieeeAddr : '0x0'}, failed`);
-        return false;
+        return undefined;
     }
-    //logger.warn(`ZHC02,${Date.now()},${Date.now()-t},${device && device.ieeeAddr ? device.ieeeAddr : '0x0'}, passed`);
-    applyDeviceDef(mappedDevices, byModel, deviceDef, device);
-    return true;
+    return applyDeviceDef(mappedDevices, byModel, deviceDef, device);
 }
 
 function applyDeviceDef(mappedDevices, byModel, deviceDef, device) {
@@ -905,14 +882,15 @@ function applyDeviceDef(mappedDevices, byModel, deviceDef, device) {
             const newDevice = createFromExposes(stripModel, deviceDef, device);
             mappedDevices.push(newDevice);
             byModel.set(stripModel, newDevice);
+            return newDevice;
 
         } catch (e) {
-            //this.debug('empty catch in exposes');
+            return undefined;
         }
     }
+    return existsMap;
 }
 
 module.exports = {
-    applyExposes: applyExposes,
     applyExposeForDevice: applyExposeForDevice,
 };

package/lib/localConfig.js

@@ -138,7 +138,7 @@ class localConfig extends EventEmitter {
         try {
             this.adapter.fileExists(namespace, rv, (err, result) => {
                 if (result) return;
-                const src = this.adapter.expandFileName(iconPath).replace('zigbee.','zigbee_');
+                const src = this.adapter.expandFileName(iconPath);
                 fs.readFile(src, (err, data) => {
                     if (err) {
                         this.error('unable to read ' + src + ' : '+ (err && err.message? err.message:' no message given'))
@@ -220,7 +220,7 @@ class localConfig extends EventEmitter {
     }
 
     async updateFromDeviceNames() {
-        const fn = this.adapter.expandFileName('dev_names').replace('zigbee.', 'zigbee_').concat('.json');
+        const fn = this.adapter.expandFileName('dev_names.json');
         fs.readFile(fn, (err, content) => {
             if (!err) {
                 let data_js = {};

package/lib/seriallist.js

@@ -22,10 +22,17 @@ class SerialList {
                             SerialPort.list()
                                 .then(ports => {
                                     this.adapter.log.info(`List of port: ${JSON.stringify(ports)}`);
-                                    this.adapter.sendTo(obj.from, obj.command, ports.map(item => ({
+                                    const candidates = ports.map(item => ({
                                         label: item.friendlyName || item.pnpId || item.manufacturer,
                                         comName: item.path
-                                    })), obj.callback);
+                                    }));
+                                    require('fs').readdir('/dev/serial/by-id', (err, files) => {
+                                        if (!err) {
+                                            for (const item of files)
+                                                candidates.push({comName: `/dev/serial/by-id/${item}`});
+                                        }
+                                        this.adapter.sendTo(obj.from, obj.command, candidates.reverse(), obj.callback);
+                                    })
                                 })
                                 .catch(e => {
                                     this.adapter.sendTo(obj.from, obj.command, [], obj.callback);