iobroker.zigbee2mqtt 3.0.9 → 3.0.13

package/lib/deviceController.js

@@ -5,7 +5,19 @@ const colors = require('./colors.js');
 const rgb = require('./rgb.js');
 const ImageController = require('./imageController').ImageController;
 
+/**
+ *
+ */
 class DeviceController {
+    /**
+     *
+     * @param adapter
+     * @param deviceCache
+     * @param groupCache
+     * @param config
+     * @param logCustomizations
+     * @param createCache
+     */
     constructor(adapter, deviceCache, groupCache, config, logCustomizations, createCache) {
         this.adapter = adapter;
         this.groupCache = groupCache;
@@ -16,6 +28,10 @@ class DeviceController {
         this.imageController = new ImageController(adapter);
     }
 
+    /**
+     *
+     * @param devicesMessage
+     */
     async createDeviceDefinitions(devicesMessage) {
         utils.clearArray(this.deviceCache);
         for (const devicesMessag of devicesMessage) {
@@ -44,6 +60,12 @@ class DeviceController {
         }
     }
 
+    /**
+     *
+     * @param groupID
+     * @param ieee_address
+     * @param scenes
+     */
     async defineGroupDevice(groupID, ieee_address, scenes) {
         const brmPropName =
 			this.adapter.config.brightnessMoveOnOff == true ? 'brightness_move_onoff' : 'brightness_move';
@@ -126,14 +148,14 @@ class DeviceController {
                         if (payload.color && payload.color.x && payload.color.y) {
                             const colorval = rgb.cie_to_rgb(payload.color.x, payload.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;
-                        }
+                        
                     },
                 },
                 {
@@ -159,9 +181,9 @@ class DeviceController {
                         }
                         if (this.config.useKelvin == true) {
                             return utils.miredKelvinConversion(payload.color_temp);
-                        } else {
+                        } 
                             return payload.color_temp;
-                        }
+                        
                     },
                 },
                 {
@@ -213,7 +235,7 @@ class DeviceController {
                 type: 'boolean',
                 setter: (value) => (value ? scene.id : undefined),
             };
-            // @ts-ignore
+            
             newDevice.states.push(sceneSate);
         }
 
@@ -222,6 +244,10 @@ class DeviceController {
         this.groupCache.push(newDevice);
     }
 
+    /**
+     *
+     * @param groupsMessage
+     */
     async createGroupDefinitions(groupsMessage) {
         utils.clearArray(this.groupCache);
         for (const groupMessage of groupsMessage) {
@@ -232,6 +258,9 @@ class DeviceController {
         }
     }
 
+    /**
+     *
+     */
     async createOrUpdateDevices() {
         for (const device of this.groupCache.concat(this.deviceCache)) {
             let deviceName = await this.getDeviceName(device);
@@ -270,17 +299,12 @@ class DeviceController {
                 if (device.ieee_address.includes('group_')) {
                     deviceObj.native.groupDevice = true;
                     deviceObj.common.statusStates.onlineId = `${this.adapter.name}.${this.adapter.instance}.${device.ieee_address}.available`;
-                }
-                // Disabled Device
-                else if (device.disabled || device.disabled == true) {
+                } else if (device.disabled || device.disabled == true) {  // // Disabled Device
                     // Placeholder for possible later logic
-                }
-                // Only the onlineId is set if the device is not disabled
-                else {
+                } else { // Only the onlineId is set if the device is not disabled
                     deviceObj.common.statusStates.onlineId = `${this.adapter.name}.${this.adapter.instance}.${device.ieee_address}.available`;
                 }
-
-                //@ts-ignore
+                
                 await this.adapter.extendObjectAsync(device.ieee_address, deviceObj);
                 this.createCache[device.ieee_address] = { name: deviceName, description: description };
             }
@@ -313,6 +337,10 @@ class DeviceController {
         }
     }
 
+    /**
+     *
+     * @param messageObj
+     */
     async renameDeviceInCache(messageObj) {
         const renamedDevice = this.groupCache
             .concat(this.deviceCache)
@@ -322,6 +350,9 @@ class DeviceController {
         }
     }
 
+    /**
+     *
+     */
     async checkAndProgressDeviceRemove() {
         let description = '';
         let deviceName = '';
@@ -359,6 +390,11 @@ class DeviceController {
         }
     }
 
+    /**
+     *
+     * @param devices
+     * @param ieee_address
+     */
     removeDeviceByIeee(devices, ieee_address) {
         const idx = devices.findIndex((x) => x.ieee_address == ieee_address);
         if (idx > -1) {
@@ -366,6 +402,10 @@ class DeviceController {
         }
     }
 
+    /**
+     *
+     * @param state
+     */
     async copyAndCleanStateObj(state) {
         const iobState = { ...state };
         const blacklistedKeys = [
@@ -387,14 +427,26 @@ class DeviceController {
         return iobState;
     }
 
+    /**
+     *
+     * @param device
+     */
     getDeviceName(device) {
         return device.id == device.ieee_address ? '' : device.id;
     }
 
+    /**
+     *
+     * @param device
+     */
     getDeviceDescription(device) {
         return device.description ? device.description : '';
     }
 
+    /**
+     *
+     * @param payload
+     */
     processCoordinatorCheck(payload) {
         if (payload && payload.data && payload.data.missing_routers) {
             const missingRoutersCount = payload.data.missing_routers.length;