iobroker.zigbee 3.3.1-alpha.0 → 3.3.2

package/lib/models.js

@@ -7,7 +7,7 @@ const { findByDevice } = require('zigbee-herdsman-converters');
 const herdsmanModelInfo = new Map();
 const UUIDbyDevice = new Map();
 
-const { ParseColor } = require('./colors');
+const { ParseColor, complexColor, CC_DEFS } = require('./colors');
 const { rgb_to_cie, cie_to_rgb } = require('./rgb');
 const { decimalToHex, adapterLevelToBulbLevel, bulbLevelToAdapterLevel , toMired } = require('./utils');
 
@@ -245,6 +245,8 @@ const states = {
         setter: (value) => {
 
             // convert RGB to XY for set
+            const objColor = complexColor(value, true);
+            if (objColor) return objColor;
             let xy = [0, 0];
             const rgbcolor = ParseColor(value);
             xy = rgb_to_cie(rgbcolor.r, rgbcolor.g, rgbcolor.b);
@@ -259,14 +261,100 @@ const states = {
             return {...options, transition: transitionTime};
         },
         getter: payload => {
-            if (payload.color && payload.color.hasOwnProperty('x') && payload.color.hasOwnProperty('y')) {
-                const colorval = cie_to_rgb(payload.color.x, payload.color.y);
-                return '#' + decimalToHex(colorval[0],2) + decimalToHex(colorval[1],2) + decimalToHex(colorval[2],2);
-            } else {
-                return undefined;
+            const value = payload.color;
+            if (value && typeof value === 'object') {
+                return complexColor(value, false);
             }
+            if (typeof value === 'string') return value;
+            return undefined;
         },
     },
+    color_hue: {
+        id: `color_hs.hue`,
+        prop:'color',
+        name: `Hue`,
+        icon: undefined,
+        role: 'level.color.hue',
+        write: true,
+        read: true,
+        type: 'number',
+        min: 0,
+        max: 360,
+        compositeKey: 'color_hs',
+        compositeTimeout: 500,
+        compositeState: 'color',
+        getter: (payload) => {
+            if (typeof payload.color == 'object') {
+                if (payload.color?.hue) {
+                    return payload.color.hue;
+                }
+            }
+        }
+    },
+    color_saturation: {
+        id: `color_hs.saturation`,
+        prop:'color',
+        name: `Saturation`,
+        icon: undefined,
+        role: 'level.color.saturation',
+        write: true,
+        read: true,
+        type: 'number',
+        min: 0,
+        max: 100,
+        compositeKey: 'color_hs',
+        compositeTimeout: 500,
+        compositeState: 'color',
+        getter: (payload) => {
+            if (typeof payload.color == 'object') {
+                if (payload.color?.saturation) {
+                    return payload.color.saturation;
+                }
+            }
+        }
+    },
+    color_red: {
+        id: `color_rgb.r`,
+        name: `Red`,
+        icon: undefined,
+        role: 'level.color.red',
+        write: true,
+        read: true,
+        type: 'number',
+        min: 0,
+        max: 255,
+        compositeKey: 'color_rgb',
+        compositeTimeout: 500,
+        compositeState: 'color',
+    },
+    color_green: {
+        id: `color_rgb.g`,
+        name: `Green`,
+        icon: undefined,
+        role: 'level.color.green',
+        write: true,
+        read: true,
+        type: 'number',
+        min: 0,
+        max: 255,
+        compositeKey: 'color_rgb',
+        compositeTimeout: 500,
+        compositeState: 'color',
+    },
+    color_blue: {
+        id: `color_rgb.b`,
+        name: `Blue`,
+        icon: undefined,
+        role: 'level.color.blue',
+        write: true,
+        read: true,
+        type: 'number',
+        min: 0,
+        max: 255,
+        compositeKey: 'color_rgb',
+        compositeTimeout: 500,
+        compositeState: 'color'
+    },
     hex_color: {
         id:`hex_color`,
         name: `Hex Color`,
@@ -489,14 +577,14 @@ const states = {
 
 
 const lightStates = [states.state, states.brightness, states.brightness_move, states.transition_time, states.brightness_step],
-    lightStatesWithColor=[...lightStates, states.color, states.hex_color, states.colortemp, states.colortemp_move],
+    lightStatesWithColor=[...lightStates, states.color, states.hex_color, states.colortemp, states.colortemp_move,states.color_red, states.color_green, states.color_blue],
     onOffStates=[states.state],
     lightStatesWithColortemp = [...lightStates, states.colortemp, states.colortemp_move],
-    lightStatesWithColor_hue= [...lightStatesWithColor, states.hue_move, states.transition_time, states.effect_type_hue],
-    lightStatesWithColorNoTemp= [...lightStates, states.color],
+    lightStatesWithColor_hue= [...lightStatesWithColor, states.hue_move, states.transition_time, /*states.effect_type_hue,*/ states.color_hue, states.color_saturation],
+    lightStatesWithColorNoTemp= [...lightStates, states.color, states.color_hue, states.color_saturation],
     commonStates=Object.values(states).filter((candidate) => candidate.isCommonState),
     commonGroupStates=[states.groupstateupdate, states.groupmemberupdate],
-    groupStates=[states.groupstateupdate, states.groupmemberupdate, ...lightStatesWithColor, ...onOffStates];
+    groupStates=[states.groupstateupdate, states.groupmemberupdate, ...lightStatesWithColor_hue, ...onOffStates];
 
 /**
  * Returns a model description, if one exists
@@ -557,7 +645,7 @@ async function addExposeToDevices(device, model, logger) {
         adapterModelDefinition.states = commonStates;
         const adapterModel = await findModel(model, device.ieeeAddr, false);
         if (adapterModel) return adapterModel;
-        const { newModel, message, error } = await applyHerdsmanModel(adapterModelDefinition);
+        const { newModel, message, error } = await applyHerdsmanModel(adapterModelDefinition, { newCompositeMethod: true });
         if (error) {
             if (logger) logger.warn(`${message} : ${error?.message}`);
         }
@@ -580,8 +668,9 @@ async function clearModelDefinitions() {
 
 function getStateDefinition(name, type, prop) {
     if (typeof name != 'string') return getStateDefinition('ilstate', type, prop);
+    if (states.hasOwnProperty(name)) return states[name];
     if (legacyStates.hasOwnProperty(name)) return legacyStates[name];
-    return states[name] || {
+    return {
         id: name,
         prop: prop || name,
         name: name.replace('_',' '),

package/lib/statescontroller.js

@@ -99,87 +99,92 @@ class StatesController extends EventEmitter {
         const srcIcon = (modelDesc && modelDesc.icon ? modelDesc.icon : '');
         const model_modif = model.replace(/\//g, '-');
         const pathToAdminIcon = `img/${model_modif}.png`;
-        // source is a web address
-        if (srcIcon.startsWith('http')) {
-            try {
-                //if (modelDesc) modelDesc.icon = pathToAdminIcon;
-                this.downloadIconToAdmin(srcIcon, pathToAdminIcon)
-            } catch (err) {
-                this.warn(`ERROR : unable to download ${srcIcon}: ${err && err.message ? err.message : 'no reason given'}`);
-            }
-            return;
-        }
-        // source is inline basee64F
-        const base64Match = srcIcon.match(/data:image\/(.+);base64,/);
-        if (base64Match) {
-            this.warn(`base 64 Icon matched, trying to save it to disk as ${pathToAdminIcon}`);
-            if (modelDesc) modelDesc.icon = pathToAdminIcon;
-            this.adapter.fileExists(namespace, pathToAdminIcon, async (err,result) => {
-                if (result) {
-                    this.info(`no need to save icon to ${pathToAdminIcon}`);
-                    return;
-                }
-                const msg = `Saving base64 Data to ${pathToAdminIcon}`
+
+        if (srcIcon != '') {
+            // source is a web address
+            if (srcIcon.startsWith('http')) {
                 try {
-                    const buffer = Buffer.from(srcIcon.replace(base64Match[0],''), 'base64');
-                    this.adapter.writeFile(namespace, pathToAdminIcon, buffer, (err) => {
-                        if (err) {
-                            this.warn(`${msg} -- failed: ${err?.message || 'no reason given'}`);
-                            return;
-                        }
-                        this.debug(`${msg} -- success`);
-                    });
+                    //if (modelDesc) modelDesc.icon = pathToAdminIcon;
+                    this.downloadIconToAdmin(srcIcon, pathToAdminIcon);
+                } catch (err) {
+                    this.warn(`ERROR : unable to download ${srcIcon}: ${err && err.message ? err.message : 'no reason given'}`);
                 }
-                catch (err) {
-                    this.warn(`${msg} -- failed: ${err?.message || 'no reason given'}`)
-                }
-            });
-            return;
-        }
-        // path is absolute
-        if (modelDesc) modelDesc.icon = pathToAdminIcon;
-        this.adapter.fileExists(namespace, pathToAdminIcon, async(err, result) => {
-            if (result) {
-                this.debug(`icon ${modelDesc?.icon || 'unknown icon'} found - no copy needed`);
                 return;
             }
-            // try 3 options for source file
-            let src = srcIcon; // as given
-            const locations=[];
-            if (!fs.existsSync(src)) {
-                src = path.normalize(this.adapter.expandFileName(src));
-                locations.push(src);
-            } // assumed relative to data folder
-            if (!fs.existsSync(src)) {
-                locations.push(src);
-                src = path.normalize(this.adapter.expandFileName(path.basename(src)));
-            } // filename relative to data folder
-            if (!fs.existsSync(src)) {
-                locations.push(src);
-                src = path.normalize(this.adapter.expandFileName(path.join('img',path.basename(src))));
-            } // img/<filename> relative to data folder
-            if (!fs.existsSync(src)) {
-                this.warn(`Unable to copy icon from device definition, looked at ${locations.join(', ')} and ${src}`);
+            // source is inline basee64F
+            const base64Match = srcIcon.match(/data:image\/(.+);base64,/);
+            if (base64Match) {
+                this.warn(`base 64 Icon matched, trying to save it to disk as ${pathToAdminIcon}`);
+                if (modelDesc) modelDesc.icon = pathToAdminIcon;
+                this.adapter.fileExists(namespace, pathToAdminIcon, async (err,result) => {
+                    if (result) {
+                        this.info(`no need to save icon to ${pathToAdminIcon}`);
+                        return;
+                    }
+                    const msg = `Saving base64 Data to ${pathToAdminIcon}`
+                    try {
+                        const buffer = Buffer.from(srcIcon.replace(base64Match[0],''), 'base64');
+                        this.adapter.writeFile(namespace, pathToAdminIcon, buffer, (err) => {
+                            if (err) {
+                                this.warn(`${msg} -- failed: ${err?.message || 'no reason given'}`);
+                                return;
+                            }
+                            this.debug(`${msg} -- success`);
+                        });
+                    }
+                    catch (err) {
+                        this.warn(`${msg} -- failed: ${err?.message || 'no reason given'}`)
+                    }
+                });
                 return;
             }
-            fs.readFile(src, (err, data) => {
-                if (err) {
-                    this.warn(`unable to read ${src}: ${(err.message? err.message:' no message given')}`);
+            // path is absolute
+            if (modelDesc) modelDesc.icon = pathToAdminIcon;
+            this.adapter.fileExists(namespace, pathToAdminIcon, async(err, result) => {
+                if (result) {
+                    this.debug(`icon ${modelDesc?.icon || 'unknown icon'} found - no copy needed`);
                     return;
                 }
-                if (data) {
-                    this.adapter.writeFile(namespace, pathToAdminIcon, data, (err) => {
-                        if (err) {
-                            this.error(`error writing file ${path}: ${err.message ? err.message : 'no reason given'}`);
-                            return;
-                        }
-                        this.debug('Updated image file ' + pathToAdminIcon);
-                    });
+                // try 3 options for source file
+                let src = srcIcon; // as given
+                const locations=[];
+                if (!fs.existsSync(src)) {
+                    src = path.normalize(this.adapter.expandFileName(src));
+                    locations.push(src);
+                } // assumed relative to data folder
+                if (!fs.existsSync(src)) {
+                    locations.push(src);
+                    src = path.normalize(this.adapter.expandFileName(path.basename(src)));
+                } // filename relative to data folder
+                if (!fs.existsSync(src)) {
+                    locations.push(src);
+                    src = path.normalize(this.adapter.expandFileName(path.join('img',path.basename(src))));
+                } // img/<filename> relative to data folder
+                if (!fs.existsSync(src)) {
+                    this.warn(`Unable to copy icon from device definition, looked at ${locations.join(', ')} and ${src}`);
                     return;
                 }
-                this.error(`fs.readFile failed - neither error nor data is returned!`);
+                fs.readFile(src, (err, data) => {
+                    if (err) {
+                        this.warn(`unable to read icon from ${src}: ${(err.message? err.message:' no message given')}`);
+                        return;
+                    }
+                    if (data) {
+                        this.adapter.writeFile(namespace, pathToAdminIcon, data, (err) => {
+                            if (err) {
+                                this.error(`error writing file ${path}: ${err.message ? err.message : 'no reason given'}`);
+                                return;
+                            }
+                            this.debug('Updated image file ' + pathToAdminIcon);
+                        });
+                        return;
+                    }
+                    this.error(`fs.readFile failed - neither error nor data is returned!`);
+                });
             });
-        });
+
+        }
+
         return modelDesc;
 
     }
@@ -430,13 +435,19 @@ class StatesController extends EventEmitter {
     }
 
     async triggerComposite(_deviceId, stateDesc, interactive) {
-        const deviceId = (_deviceId.replace('0x', ''));
+        const deviceId = typeof _deviceId === 'string' ? _deviceId.replace('0x', '') : `group_${_deviceId}`;
         const idParts = stateDesc.id.split('.').slice(-2);
         const key = `${deviceId}.${idParts[0]}`;
-        const handle = this.compositeData[key]
+        if (this.compositeData[key] == undefined)
+            this.compositeData[key] = {triggers: [stateDesc.id]};
+        else this.compositeData[key].triggers.push(stateDesc.id);
+        const handle = this.compositeData[key].handle;
         const factor = (interactive ? 10 : 1);
         if (handle) this.adapter.clearTimeout(handle);
-        this.compositeData[key] = this.adapter.setTimeout(async () => {
+        this.compositeData[key].handle = this.adapter.setTimeout(async () => {
+            for (const trigger of this.compositeData[key].triggers) {
+                this.emit('acknowledge_state', deviceId, undefined, { id:trigger} , undefined );
+            }
             delete this.compositeData[key];
             const parts = stateDesc.id.split('.');
             parts.pop();
@@ -699,7 +710,7 @@ class StatesController extends EventEmitter {
                         statename = arr[1];
                     }
                     if (commonStates.find(statedesc => statename === statedesc.id) === undefined &&
-                        devStates.states.find(statedesc => statename === statedesc.id) === undefined
+                        devStates.states.find(statedesc => statename === statedesc?.id) === undefined
                     ) {
                         this.cleanupRequired |= markOnly;
                         if (state.common.hasOwnProperty('custom') && !force && !markOnly) {
@@ -740,43 +751,70 @@ class StatesController extends EventEmitter {
         setTimeout(() => this.updateState(dev_id, name, outValue, common), timeout);
     }
 
-    async updateState(devId, name, value, common, force) {
+    deepCompare(item1, item2) {
+        if (typeof item1 != typeof item2) return false; // different object, definitely different.
+        switch (typeof item1) {
+            case 'boolean':
+            case 'number':
+            case 'string': return item1 === item2;
+            case 'object':
+                if (!item1 || !item2) {
+                    if (!item1 && !item2) return true;
+                    return false;
+                }
+                for (const key of Object.keys(item1)) {
+                    if (!this.deepCompare(item1[key],item2[key])) return false;
+                }
+                return true;
+            case 'function':
+                return true; // functions are always considere equal
+        }
+    }
+
+    async updateState(devId, name, value, common) {
         const new_common = {name: name, color:null};
         const stateId = devId + '.' + name;
-        if (common) {
+        if (common && typeof common === 'object') {
             for (const key in common) {
                 if (common[key] !== undefined) new_common[key] = common[key];
             }
         }
-        // check if state exist
+
         const stobj = await this.adapter.getObjectAsync(stateId);
-        let hasChanges = Boolean(force); // if force is set we always update the state.
-        if (stobj) {
-            // update state - not change name and role (user can it changed)
-            if (!force) {
-                if (stobj.common.name) {
-                    delete new_common.name;
-                }
+        const type = (stobj?.common?.type) ? stobj.common.type : new_common.type;
+        // first check value
+        if (value !== undefined && type === 'number') {
+            const minval = parseFloat(stobj?.common ? stobj.common.min : new_common.min);
+            const maxval = parseFloat(stobj?.common ? stobj.common.max : new_common.max);
+            let nval = (typeof value == 'number' ? value : parseFloat(value));
+            if (isNaN(nval)) {
+                if (minval !== undefined && typeof minval === 'number')
+                    nval = minval;
+                else
+                    nval = 0;
             }
-            // always force allow change of level.color roles.
-            if ((name.includes('color') || force) && (stobj.common.role != new_common.role)) {
-                console.info(`${force ? 'forc' : 'allow'}ing role change for ${name}`)
-            } else delete new_common.role;
-
-            // check whether any common property is different
-            if (!force) {
-                if (stobj.common) {
-                    for (const property in new_common) {
-                        if (stobj.common.hasOwnProperty(property)) {
-                            if (stobj.common[property] === new_common[property]) {
-                                delete new_common[property];
-                            } else {
-                                hasChanges = true;
-                            }
+            if (nval < minval) {
+                new_common.color = '#FF0000'
+                value = minval
+                this.stashErrors(`${stateId}.min`,`State value for ${stateId} has value "${nval}" less than min "${minval}".`, false );
+            } else if (nval > maxval) {
+                new_common.color = '#FF0000'
+                value = maxval;
+                this.stashErrors(`${stateId}.max`,`State value for ${stateId} has value "${nval}" greater than max "${maxval}".`, false );
+            }
+            else new_common.color = new_common.color ? new_common.color : null;
+        }
+
+        if (stobj) {
+            // always update common if common is provided
+            if (stobj.common) {
+                for (const property in new_common) {
+                    if (stobj.common[property] != undefined) {
+                        if (this.deepCompare(stobj.common[property],new_common[property])) {
+                            delete new_common[property];
                         }
                     }
                 }
-                else hasChanges = true; // we dont have common => we need common
             }
         } else {
             const matches = stateId.match((/\./g));
@@ -790,42 +828,14 @@ class StatesController extends EventEmitter {
                     await this.adapter.extendObjectAsync(id, {type: 'channel', common: { name:channel}, native:{}})
                 }
             }
-            hasChanges = true;
         }
 
-        // first check value
-        if (value !== undefined) {
-            const type = stobj ? stobj.common.type : new_common.type;
-            if (type === 'number') {
-                const minval = (stobj ? stobj.common.min : new_common.min);
-                const maxval = (stobj ? stobj.common.max : new_common.max);
-                let nval = (typeof value == 'number' ? value : parseFloat(value));
-                if (isNaN(nval)) {
-                    if (minval !== undefined && typeof minval === 'number')
-                        nval = minval;
-                    else
-                        nval = 0;
-                }
-                if (typeof minval == 'number' && nval < minval) {
-                    hasChanges = true;
-                    new_common.color = '#FF0000'
-                    value = minval
-                    this.stashErrors(`${stateId}.min`,`State value for ${stateId} has value "${nval}" less than min "${minval}".`, false );
-                }
-                if (typeof maxval == 'number' && nval > maxval) {
-                    hasChanges = true;
-                    new_common.color = '#FF0000'
-                    value = maxval;
-                    this.stashErrors(`${stateId}.max`,`State value for ${stateId} has value "${nval}" greater than max "${maxval}".`, false );
-                }
-            }
-        }
-        //
+        if (new_common.color=== null && (stobj?.common?.color === undefined || stobj?.common.color === null)) delete new_common.color;
         // only change object when any common property has changed
-        if (hasChanges) {
+        if (Object.keys(new_common).length) {
             this.adapter.extendObject(stateId, {type: 'state', common: new_common, native: {}}, () =>
                 value !== undefined && this.setState_typed(stateId, value, true, stobj ? stobj.common.type : new_common.type));
-        } else if (value !== undefined) {
+        } else if (value !== undefined && stobj) {
             this.setState_typed(stateId, value, true, stobj.common.type);
         }
     }
@@ -1088,7 +1098,7 @@ class StatesController extends EventEmitter {
         }
     }
 
-    async syncDevStates(dev, model, force) {
+    async syncDevStates(dev, model) {
         if (this.debugActive) this.debug('synchronizing device states for ' + dev.ieeeAddr + ' (' + model + ')');
         const devId = utils.zbIdorIeeetoAdId(this.adapter, dev.ieeeAddr, false);
         // devId - iobroker device id
@@ -1131,8 +1141,9 @@ class StatesController extends EventEmitter {
                 min: statedesc.min,
                 max: statedesc.max,
                 states: statedesc.states,
+                color: null,
             };
-            this.updateState(devId, statedesc.id, undefined, common, force);
+            this.updateState(devId, statedesc.id, undefined, common);
         }
         this.deleteOrphanedDeviceStates(dev.ieeeAddr, model, false, undefined, true);
     }
@@ -1185,6 +1196,7 @@ class StatesController extends EventEmitter {
             role: statedesc.role,
             min: statedesc.min,
             max: statedesc.max,
+            color: null,
         };
 
         if (typeof value === 'object' && value.hasOwnProperty('stateid')) {
@@ -1210,7 +1222,7 @@ class StatesController extends EventEmitter {
                 );
                 if (has_elevated_debug) this.emit('device_debug', { ID:debugId, data: { flag:'SUCCESS', IO:true }});
             } else {
-                this.updateState(devId, stateID, value, common, debugId);
+                this.updateState(devId, stateID, value, common, false);
                 if (has_elevated_debug) this.emit('device_debug', { ID:debugId, data: { flag:'SUCCESS', IO:true }});
             }
         }
@@ -1226,6 +1238,7 @@ class StatesController extends EventEmitter {
             const has_elevated_debug = (this.checkDebugDevice(devId) && !payload.hasOwnProperty('msg_from_zigbee'));
 
             const message = `message received '${JSON.stringify(payload)}' from device ${devId} type '${model}'`;
+
             if (has_elevated_debug)
                 this.emit('device_debug', { ID:debugId, data: { deviceID: devId, flag:'03', IO:true }, message:message});
             else