iobroker.zigbee2mqtt 3.0.9 → 3.0.13

package/lib/imageController.js

@@ -1,23 +1,42 @@
 const axios = require('axios').default;
 const sharp = require('sharp');
 
+/**
+ *
+ */
 class ImageController {
+    /**
+     *
+     * @param adapter
+     */
     constructor(adapter) {
         this.adapter = adapter;
     }
 
+    /**
+     *
+     * @param modelName
+     */
     sanitizeModelIDForImageUrl(modelName) {
         const modelNameString = modelName.replace('/', '_');
         // eslint-disable-next-line no-control-regex
         return modelNameString.replace(/\u0000/g, '');
     }
 
+    /**
+     *
+     * @param deviceName
+     */
     sanitizeZ2MDeviceName(deviceName) {
         const deviceNameString = deviceName.replace(/:|\s|\//g, '-');
         // eslint-disable-next-line no-control-regex
         return deviceName ? deviceNameString.replace(/\u0000/g, '') : 'NA';
     }
 
+    /**
+     *
+     * @param device
+     */
     getZ2mDeviceImageModelJPG(device) {
         if (device && device.definition && device.definition.model) {
             const icoString = `https://www.zigbee2mqtt.io/images/devices/${this.sanitizeZ2MDeviceName(device.definition.model)}.jpg`;
@@ -26,6 +45,10 @@ class ImageController {
         }
     }
 
+    /**
+     *
+     * @param device
+     */
     getZ2mDeviceImageModelPNG(device) {
         if (device && device.definition && device.definition.model) {
             const icoString = `https://www.zigbee2mqtt.io/images/devices/${this.sanitizeZ2MDeviceName(device.definition.model)}.png`;
@@ -35,6 +58,10 @@ class ImageController {
     }
 
 
+    /**
+     *
+     * @param device
+     */
     getSlsDeviceImage(device) {
         if (device && device.model_id) {
             const icoString = `https://www.zigbee2mqtt.io/images/devices/${this.sanitizeModelIDForImageUrl(device.model_id)}.png`;
@@ -43,8 +70,14 @@ class ImageController {
         }
     }
 
+    /**
+     *
+     * @param device
+     */
     async getDeviceIcon(device) {
-        if (!this.adapter.config.useDeviceIcons) return '';
+        if (!this.adapter.config.useDeviceIcons) {
+return '';
+}
 
         const imageSize         = this.adapter.config.deviceIconsSize;
 
@@ -78,7 +111,7 @@ class ImageController {
         if (!iconFound) {
             this.adapter.log.warn(`Failed to download image for device model: ${device.definition.model} - ${device.definition.description}`);
             return '';
-        } else {
+        } 
             // Load image from the Meta-Store
             const icon = await this.adapter.readFileAsync(this.adapter.namespace, iconFileName);
             // Load Image Metadata
@@ -106,8 +139,12 @@ class ImageController {
 
             // Create and output Base64
             return `data:image/png;base64,${icon.file.toString('base64')}`;
-        }
+        
     }
+    /**
+     *
+     * @param url
+     */
     getFileNameWithExtension(url) {
         const path = new URL(url).pathname;
         const filename = path.split('/').pop();
@@ -115,6 +152,12 @@ class ImageController {
         return filename.replace(/\u0000/g, '');
     }
 
+    /**
+     *
+     * @param adapter
+     * @param url
+     * @param namespace
+     */
     async downloadIcon(adapter, url, namespace) {
         try {
             const res = await axios.get(url, { responseType: 'arraybuffer' });
@@ -125,6 +168,12 @@ class ImageController {
             return false;
         }
     }
+    /**
+     *
+     * @param z2mIconFileNameJPG
+     * @param z2mIconFileNamePNG
+     * @param slsIconFileName
+     */
     async getExistingIconFileName(z2mIconFileNameJPG, z2mIconFileNamePNG, slsIconFileName) {
         if (await this.adapter.fileExistsAsync(this.adapter.namespace, z2mIconFileNameJPG)) {
             return z2mIconFileNameJPG;

package/lib/messages.js

@@ -1,3 +1,8 @@
+/**
+ *
+ * @param config
+ * @param log
+ */
 async function adapterInfo(config, log) {
     log.info('================================= Adapter Config =================================');
     log.info(`|| Zigbee2MQTT Frontend Scheme: ${config.webUIScheme}`);
@@ -41,6 +46,11 @@ async function adapterInfo(config, log) {
     log.info('==================================================================================');
 }
 
+/**
+ *
+ * @param payload
+ * @param log
+ */
 async function zigbee2mqttInfo(payload, log) {
     log.info('============================ Zigbee2MQTT Information =============================');
     log.info(`|| Zigbee2MQTT Version: ${payload.version} `);

package/lib/mqttServerController.js

@@ -3,11 +3,21 @@ const Aedes = require('aedes');
 const net = require('net');
 let mqttServer;
 
+/**
+ *
+ */
 class MqttServerController {
+    /**
+     *
+     * @param adapter
+     */
     constructor(adapter) {
         this.adapter = adapter;
     }
 
+    /**
+     *
+     */
     async createMQTTServer() {
         try {
             const NedbPersistence = require('aedes-persistence-nedb');
@@ -15,12 +25,12 @@ class MqttServerController {
                 path: `${core.getAbsoluteInstanceDataDir(this.adapter)}/mqttData`,
                 prefix: '',
             });
-            // @ts-ignore
+            
             const aedes = Aedes({ persistence: db });
             mqttServer = net.createServer(aedes.handle);
             mqttServer.listen(this.adapter.config.mqttServerPort, this.adapter.config.mqttServerIPBind, () => {
                 this.adapter.log.info(
-                    `Statring MQTT-Server on IP ${this.adapter.config.mqttServerIPBind} and Port ${this.adapter.config.mqttServerPort}`
+                    `Starting MQTT-Server on IP ${this.adapter.config.mqttServerIPBind} and Port ${this.adapter.config.mqttServerPort}`
                 );
             });
         } catch (err) {
@@ -28,14 +38,17 @@ class MqttServerController {
         }
     }
 
+    /**
+     *
+     */
     async createDummyMQTTServer() {
         try {
-            // @ts-ignore
+            
             const aedes = Aedes();
             mqttServer = net.createServer(aedes.handle);
             mqttServer.listen(this.adapter.config.mqttServerPort, this.adapter.config.mqttServerIPBind, () => {
                 this.adapter.log.info(
-                    `Statring DummyMQTT-Server on IP ${this.adapter.config.mqttServerIPBind} and Port ${this.adapter.config.mqttServerPort}`
+                    `Starting DummyMQTT-Server on IP ${this.adapter.config.mqttServerIPBind} and Port ${this.adapter.config.mqttServerPort}`
                 );
             });
         } catch (err) {
@@ -43,8 +56,11 @@ class MqttServerController {
         }
     }
 
+    /**
+     *
+     */
     closeServer() {
-        if (mqttServer && !mqttServer.closed()) {
+        if (mqttServer && !mqttServer.close()) {
             mqttServer.close();
         }
     }

package/lib/nonGenericDevicesExtension.js

@@ -32,13 +32,17 @@ const nonGenDevStatesDefs = {
     ],
 };
 
+/**
+ *
+ * @param model
+ */
 function getStateDefinition(model) {
     const stateDef = nonGenDevStatesDefs[model];
     if (stateDef) {
         return stateDef;
-    } else {
+    } 
         return [];
-    }
+    
 }
 
 module.exports = {

package/lib/rgb.js

@@ -1,4 +1,4 @@
-/* eslint-disable no-prototype-builtins */
+ 
 /*
 With these functions you can convert the CIE color space to the RGB color space and vice versa.
 
@@ -44,7 +44,11 @@ const colors = require('./colors.js');
 
 /**
  * Converts CIE color space to RGB color space
- * @return {Array} Array that contains the color values for red, green and blue
+ *
+ * @param x
+ * @param y
+ * @param brightness
+ * @returns {Array} Array that contains the color values for red, green and blue
  */
 function cie_to_rgb(x, y, brightness) {
     //Set to maximum brightness if no custom value was given (Not the slick ECMAScript 6 way for compatibility reasons)
@@ -54,17 +58,17 @@ function cie_to_rgb(x, y, brightness) {
 
     const z = 1.0 - x - y;
     const Y = (brightness / 254).toFixed(2);
-    // @ts-ignore
+    
     const X = (Y / y) * x;
-    // @ts-ignore
+    
     const Z = (Y / y) * z;
 
     //Convert to RGB using Wide RGB D65 conversion
-    // @ts-ignore
+    
     let red = X * 1.656492 - Y * 0.354851 - Z * 0.255038;
-    // @ts-ignore
+    
     let green = -X * 0.707196 + Y * 1.655397 + Z * 0.036152;
-    // @ts-ignore
+    
     let blue = X * 0.051713 - Y * 0.121364 + Z * 1.01153;
 
     //If red, green or blue is larger than 1.0 set it back to the maximum of 1.0
@@ -109,10 +113,11 @@ function cie_to_rgb(x, y, brightness) {
 
 /**
  * Converts RGB color space to CIE color space
- * @param {Number} red
- * @param {Number} green
- * @param {Number} blue
- * @return {Array} Array that contains the CIE color values for x and y
+ *
+ * @param {number} red
+ * @param {number} green
+ * @param {number} blue
+ * @returns {Array} Array that contains the CIE color values for x and y
  */
 function rgb_to_cie(red, green, blue) {
     // Apply a gamma correction to the RGB values, which makes the color more vivid and more the like the color displayed on the screen of your device
@@ -129,21 +134,27 @@ function rgb_to_cie(red, green, blue) {
     let x = (X / (X + Y + Z)).toFixed(4);
     let y = (Y / (X + Y + Z)).toFixed(4);
 
-    // @ts-ignore
+    
     if (isNaN(x)) {
-        // @ts-ignore
+        
         x = 0;
     }
 
-    // @ts-ignore
+    
     if (isNaN(y)) {
-        // @ts-ignore
+        
         y = 0;
     }
 
     return [x, y];
 }
 
+/**
+ *
+ * @param h
+ * @param s
+ * @param v
+ */
 function hsvToRGB(h, s, v) {
     h = (h % 360) / 360;
     s = s / 100;
@@ -187,6 +198,13 @@ function hsvToRGB(h, s, v) {
     };
 }
 
+/**
+ *
+ * @param r
+ * @param g
+ * @param b
+ * @param numeric
+ */
 function rgbToHSV(r, g, b, numeric) {
     if (arguments.length === 1) {
         (g = r.g), (b = r.b), (r = r.r);
@@ -215,21 +233,26 @@ function rgbToHSV(r, g, b, numeric) {
             h /= 6 * d;
             break;
     }
-    if (numeric)
-        return {
-            // @ts-ignore
+    if (numeric) {
+return {
+            
             h: Math.round(h * 360),
             s: Math.round(s * 100),
             v: Math.round(v * 100),
         };
+}
     return {
-        // @ts-ignore
+        
         h: (h * 360).toFixed(3),
         s: (s * 100).toFixed(3),
         v: (v * 100).toFixed(3),
     };
 }
 
+/**
+ *
+ * @param value
+ */
 function colorArrayFromString(value) {
     if (typeof value === 'string') {
         const rv = [];
@@ -241,6 +264,10 @@ function colorArrayFromString(value) {
     return [{ r: 0, g: 128, b: 255 }];
 }
 
+/**
+ *
+ * @param payload
+ */
 function colorStringFromRGBArray(payload) {
     const rv = [];
     payload.forEach((element) => {
@@ -249,6 +276,12 @@ function colorStringFromRGBArray(payload) {
     return rv.toString();
 }
 
+/**
+ *
+ * @param h
+ * @param s
+ * @param v
+ */
 function hsv_to_cie(h, s, v) {
     const rgb = hsvToRGB(h, s, v);
     return rgb_to_cie(rgb.r, rgb.g, rgb.b);
@@ -256,20 +289,35 @@ function hsv_to_cie(h, s, v) {
 
 function rgb_to_rgbstring(element) {
     let col = '#';
-    if (element && element.hasOwnProperty('r')) col = col + element.r.toString(16).padStart(2, '0');
-    else col = col + '00';
-    if (element && element.hasOwnProperty('g')) col = col + element.g.toString(16).padStart(2, '0');
-    else col = col + '00';
-    if (element && element.hasOwnProperty('b')) col = col + element.b.toString(16).padStart(2, '0');
-    else col = col + '00';
+    if (element && element.hasOwnProperty('r')) {
+col = col + element.r.toString(16).padStart(2, '0');
+} else {
+col = `${col  }00`;
+}
+    if (element && element.hasOwnProperty('g')) {
+col = col + element.g.toString(16).padStart(2, '0');
+} else {
+col = `${col  }00`;
+}
+    if (element && element.hasOwnProperty('b')) {
+col = col + element.b.toString(16).padStart(2, '0');
+} else {
+col = `${col  }00`;
+}
     return col;
 }
 
+/**
+ *
+ * @param h
+ * @param s
+ * @param b
+ */
 function hsbToRGB(h, s, b) {
     const br = Math.round(b * 2.55);
     if (s == 0) {
         return [br, br, br];
-    } else {
+    } 
         const hue = h % 360;
         const f = hue % 60;
         const p = Math.round(b * (100 - s) * 0.0255);
@@ -289,10 +337,16 @@ function hsbToRGB(h, s, b) {
             case 5:
                 return [br, p, q];
         }
-    }
+    
     return false;
 }
 
+/**
+ *
+ * @param h
+ * @param s
+ * @param v
+ */
 function hsvToRGBString(h, s, v) {
     return rgb_to_rgbstring(hsvToRGB(h, s, v));
 }

package/lib/statesController.js

@@ -2,7 +2,18 @@ const utils = require('./utils');
 const incStatsQueue = [];
 const timeOutCache = {};
 
+/**
+ *
+ */
 class StatesController {
+    /**
+     *
+     * @param adapter
+     * @param deviceCache
+     * @param groupCache
+     * @param logCustomizations
+     * @param createCache
+     */
     constructor(adapter, deviceCache, groupCache, logCustomizations, createCache) {
         this.adapter = adapter;
         this.groupCache = groupCache;
@@ -11,6 +22,10 @@ class StatesController {
         this.createCache = createCache;
     }
 
+    /**
+     *
+     * @param messageObj
+     */
     processDeviceMessage(messageObj) {
         // Is payload present?
         if (messageObj.payload == '') {
@@ -30,6 +45,11 @@ class StatesController {
         }
     }
 
+    /**
+     *
+     * @param messageObj
+     * @param device
+     */
     async setDeviceStateSafely(messageObj, device) {
         if (this.logCustomizations.debugDevices.includes(device.ieee_address)) {
             this.adapter.log.warn(`--->>> fromZ2M -> ${device.ieee_address} states: ${JSON.stringify(messageObj)}`);
@@ -103,19 +123,15 @@ class StatesController {
                     //  Is an action
                     if (state.prop && state.prop == 'action') {
                         actionStates.push(state);
-                    }
-                    // Is not an action
+                    } else if (
+                     // Is not an action
                     // check if its a motion sensor (occupancy state) and if configuration is set to update state every time
                     // if yes, use setStateSafelyAsync instead of setStateChangedSafelyAsync
-                    else if (
-                        this.adapter.config.allwaysUpdateOccupancyState === true &&
-						state.id === 'occupancy' &&
-						value === true
+                        this.adapter.config.allwaysUpdateOccupancyState === true &&	state.id === 'occupancy' &&	value === true
                     ) {
                         await this.setStateSafelyAsync(stateName, value);
-                    }
-                    // end section for motion sensor update
-                    else {
+                    } else {
+                     // end section for motion sensor update
                         if (state.getter) {
                             await this.setStateChangedSafelyAsync(stateName, state.getter(messageObj.payload));
                         } else {
@@ -134,11 +150,17 @@ class StatesController {
 
             try {
                 if (state.isEvent && state.isEvent == true) {
+                    const gettr = state.getter(messageObj.payload);
                     if (state.type == 'boolean') {
-                        await this.setStateWithTimeoutAsync(stateName, state.getter(messageObj.payload), 450);
+                        await this.setStateWithTimeoutAsync(stateName, gettr, 450);
                     } else {
-                        await this.setStateSafelyAsync(stateName, state.getter(messageObj.payload));
+                        await this.setStateSafelyAsync(stateName, gettr);
                     }
+                    // publish the action into action dp
+                    if (state.prop && state.prop == 'action') {
+                        await this.setStateSafelyAsync(`${device.ieee_address}.action`, messageObj.payload.action);
+                    }
+
                 } else {
                     await this.setStateChangedSafelyAsync(stateName, state.getter(messageObj.payload));
                 }
@@ -149,6 +171,11 @@ class StatesController {
         }
     }
 
+    /**
+     *
+     * @param stateName
+     * @param value
+     */
     async setStateSafelyAsync(stateName, value) {
         if (value === undefined || value === null) {
             return;
@@ -156,6 +183,11 @@ class StatesController {
         await this.adapter.setStateAsync(stateName, value, true);
     }
 
+    /**
+     *
+     * @param stateName
+     * @param value
+     */
     async setStateChangedSafelyAsync(stateName, value) {
         if (value === undefined || value === null) {
             return;
@@ -163,6 +195,12 @@ class StatesController {
         await this.adapter.setStateChangedAsync(stateName, value, true);
     }
 
+    /**
+     *
+     * @param stateName
+     * @param value
+     * @param timeout
+     */
     async setStateWithTimeoutAsync(stateName, value, timeout) {
         if (value === undefined || value === null) {
             return;
@@ -174,9 +212,13 @@ class StatesController {
         }
         timeOutCache[stateName] = setTimeout(() => {
             this.adapter.setStateAsync(stateName, !value, true);
+
         }, timeout);
     }
 
+    /**
+     *
+     */
     processQueue() {
         const oldIncStatsQueue = [];
         utils.moveArray(incStatsQueue, oldIncStatsQueue);
@@ -185,6 +227,9 @@ class StatesController {
         }
     }
 
+    /**
+     *
+     */
     async subscribeWritableStates() {
         await this.adapter.unsubscribeObjectsAsync('*');
         for (const device of this.groupCache.concat(this.deviceCache)) {
@@ -199,6 +244,9 @@ class StatesController {
         this.adapter.subscribeStates('info.coordinator_check');
     }
 
+    /**
+     *
+     */
     async setAllAvailableToFalse() {
         const availableStates = await this.adapter.getStatesAsync('*.available');
         for (const availableState in availableStates) {
@@ -206,6 +254,9 @@ class StatesController {
         }
     }
 
+    /**
+     *
+     */
     async allTimerClear() {
         for (const timer in timeOutCache) {
             clearTimeout(timeOutCache[timer]);