iobroker.zigbee2mqtt 3.0.10 → 3.0.14

package/lib/exposes.js

@@ -1,5 +1,3 @@
-/* eslint-disable no-prototype-builtins */
-// @ts-nocheck
 'use strict';
 
 const statesDefs = require('./states').states;
@@ -11,28 +9,28 @@ const getNonGenDevStatesDefs = require('./nonGenericDevicesExtension').getStateD
 // 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
-	 */
+     * 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
-	 */
+     * Bit 1: The property can be set with a /set command
+     */
     SET: 2,
     /**
-	 * Bit 2: The property can be retrieved with a /get command
-	 */
+     * Bit 2: The property can be retrieved with a /get command
+     */
     GET: 4,
     /**
-	 * Bitwise inclusive OR of STATE and SET : 0b001 | 0b010
-	 */
+     * Bitwise inclusive OR of STATE and SET : 0b001 | 0b010
+     */
     STATE_SET: 3,
     /**
-	 * Bitwise inclusive OR of STATE and GET : 0b001 | 0b100
-	 */
+     * Bitwise inclusive OR of STATE and GET : 0b001 | 0b100
+     */
     STATE_GET: 5,
     /**
-	 * Bitwise inclusive OR of STATE and GET and SET : 0b001 | 0b100 | 0b010
-	 */
+     * Bitwise inclusive OR of STATE and GET and SET : 0b001 | 0b100 | 0b010
+     */
     ALL: 7,
 };
 
@@ -174,6 +172,11 @@ function genState(expose, role, name, desc) {
     return state;
 }
 
+/**
+ *
+ * @param devicesMessag
+ * @param adapter
+ */
 async function createDeviceFromExposes(devicesMessag, adapter) {
     const states = [];
     let scenes = [];
@@ -189,7 +192,9 @@ async function createDeviceFromExposes(devicesMessag, adapter) {
         if (state === undefined) {
             return 0;
         }
-        if (access === undefined) access = z2mAccess.ALL;
+        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);
@@ -214,7 +219,7 @@ async function createDeviceFromExposes(devicesMessag, adapter) {
             }
 
             return states.push(state);
-        } else {
+        } 
             if (state.readable && !states[stateExists].readable) {
                 states[stateExists].read = state.read;
                 // as state is readable, it can't be button or event
@@ -294,7 +299,7 @@ async function createDeviceFromExposes(devicesMessag, adapter) {
             }
 
             return states.length;
-        }
+        
     }
 
     // search for scenes in the endpoints and build them into an array
@@ -461,9 +466,9 @@ async function createDeviceFromExposes(devicesMessag, adapter) {
                                             }
                                             if (config.useKelvin == true) {
                                                 return utils.miredKelvinConversion(payload[propName]);
-                                            } else {
+                                            } 
                                                 return payload[propName];
-                                            }
+                                            
                                         },
                                     },
                                     prop.access
@@ -519,9 +524,9 @@ async function createDeviceFromExposes(devicesMessag, adapter) {
                                             //}
                                             if (config.useKelvin == true) {
                                                 return utils.miredKelvinConversion(payload[propName]);
-                                            } else {
+                                            } 
                                                 return payload[propName];
-                                            }
+                                            
                                         },
                                     },
                                     prop.access
@@ -566,14 +571,14 @@ async function createDeviceFromExposes(devicesMessag, adapter) {
                                                     payload[stateName].y
                                                 );
                                                 return (
-                                                    '#' +
-                          													utils.decimalToHex(colorval[0]) +
-                          													utils.decimalToHex(colorval[1]) +
-                          													utils.decimalToHex(colorval[2])
+                                                    `#${ 
+                          													utils.decimalToHex(colorval[0]) 
+                          													}${utils.decimalToHex(colorval[1]) 
+                          													}${utils.decimalToHex(colorval[2])}`
                                                 );
-                                            } else {
+                                            } 
                                                 return undefined;
-                                            }
+                                            
                                         },
                                         epname: expose.endpoint,
                                     },
@@ -635,10 +640,10 @@ async function createDeviceFromExposes(devicesMessag, adapter) {
                                                     payload[stateName].y
                                                 );
                                                 return (
-                                                    '#' +
-													utils.decimalToHex(colorval[0]) +
-													utils.decimalToHex(colorval[1]) +
-													utils.decimalToHex(colorval[2])
+                                                    `#${ 
+													utils.decimalToHex(colorval[0]) 
+													}${utils.decimalToHex(colorval[1]) 
+													}${utils.decimalToHex(colorval[2])}`
                                                 );
                                             }
                                             return undefined;
@@ -749,7 +754,9 @@ async function createDeviceFromExposes(devicesMessag, adapter) {
                                 break;
                         }
                     }
-                    if (state) pushToStates(state, expose.access);
+                    if (state) {
+pushToStates(state, expose.access);
+}
                     break;
 
                 case 'enum':
@@ -934,9 +941,9 @@ async function createDeviceFromExposes(devicesMessag, adapter) {
                                                         return utils.miredKelvinConversion(
                                                             payload.action_color_temperature
                                                         );
-                                                    } else {
+                                                    } 
                                                         return payload.action_color_temperature;
-                                                    }
+                                                    
                                                 }
                                             },
                                         },
@@ -970,14 +977,14 @@ async function createDeviceFromExposes(devicesMessag, adapter) {
                                                         payload.action_color.y
                                                     );
                                                     return (
-                                                        '#' +
-														utils.decimalToHex(colorval[0]) +
-														utils.decimalToHex(colorval[1]) +
-														utils.decimalToHex(colorval[2])
+                                                        `#${ 
+														utils.decimalToHex(colorval[0]) 
+														}${utils.decimalToHex(colorval[1]) 
+														}${utils.decimalToHex(colorval[2])}`
                                                     );
-                                                } else {
+                                                } 
                                                     return undefined;
-                                                }
+                                                
                                             },
                                         },
                                         expose.access
@@ -1004,9 +1011,9 @@ async function createDeviceFromExposes(devicesMessag, adapter) {
 
                                                 if (payload.action_level) {
                                                     return utils.bulbLevelToAdapterLevel(payload.action_level);
-                                                } else {
+                                                } 
                                                     return undefined;
-                                                }
+                                                
                                             },
                                         },
                                         expose.access
@@ -1032,9 +1039,9 @@ async function createDeviceFromExposes(devicesMessag, adapter) {
 
                                                 if (payload.action_level) {
                                                     return payload.action_saturation;
-                                                } else {
+                                                } 
                                                     return undefined;
-                                                }
+                                                
                                             },
                                         },
                                         expose.access
@@ -1061,9 +1068,9 @@ async function createDeviceFromExposes(devicesMessag, adapter) {
 
                                                 if (payload.action_enhanced_hue) {
                                                     return payload.action_enhanced_hue;
-                                                } else {
+                                                } 
                                                     return undefined;
-                                                }
+                                                
                                             },
                                         },
                                         expose.access
@@ -1128,7 +1135,9 @@ async function createDeviceFromExposes(devicesMessag, adapter) {
                             state = genState(expose);
                             break;
                     }
-                    if (state) pushToStates(state, expose.access);
+                    if (state) {
+pushToStates(state, expose.access);
+}
                     break;
 
                 case 'binary':
@@ -1166,7 +1175,9 @@ async function createDeviceFromExposes(devicesMessag, adapter) {
                                 break;
                         }
                     }
-                    if (state) pushToStates(state, expose.access);
+                    if (state) {
+pushToStates(state, expose.access);
+}
                     break;
 
                 case 'text':
@@ -1261,9 +1272,9 @@ async function createDeviceFromExposes(devicesMessag, adapter) {
                                     return !isNaN(payload[expose.property][prop.property])
                                         ? payload[expose.property][prop.property]
                                         : undefined;
-                                } else {
+                                } 
                                     return undefined;
-                                }
+                                
                             };
                         } else {
                             state.getter = (payload) => {

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,24 +3,33 @@ 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');
             const db = new NedbPersistence({
                 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 +37,16 @@ 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 +54,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 = {