iobroker.zigbee 3.3.1-alpha.0 → 3.3.2

package/lib/exposes.js

@@ -6,12 +6,16 @@ const utils = require('./utils');
 const colors = require('./colors');
 const ea = require('zigbee-herdsman-converters/lib/exposes').access;
 
-const LocalData = { options:{} };
+//const LocalData = { options:{ newCompositeMethod: true } };
+//const LocalData = { options:{  } };
 const __logger = undefined;
 
-function genState(expose, role, name, desc) {
+function genState(expose, overrides) {
+    const role = overrides?.role;
+    const name = overrides?.name;
+    const desc = overrides?.desc;
     let state;
-    const readable = (expose.access & ea.STATE) > 0;
+    const readable = (expose.access & (ea.STATE_GET)) > 0;
     const writable = (expose.access & ea.SET) > 0;
     const stname = (name || expose.property);
     if (typeof stname !== 'string') return;
@@ -26,10 +30,10 @@ function genState(expose, role, name, desc) {
                 prop: propName,
                 name: stateName,
                 icon: undefined,
-                role: role || 'state',
+                role: role || (readable ? 'state' : 'button'),
                 write: writable,
-                read: true,
-                type: 'boolean',
+                read: readable,
+                type: `boolean`,
             };
             if (readable) {
                 state.getter = payload => payload[propName] === (typeof expose.value_on == 'boolean' ? expose.value_on : expose.value_on || 'ON');
@@ -55,7 +59,7 @@ function genState(expose, role, name, desc) {
                 write: writable,
                 read: true,
                 type: 'number',
-                min: expose.value_min || 0,
+                min: expose.value_min,
                 max: expose.value_max,
                 unit: expose.unit,
             };
@@ -130,13 +134,96 @@ function genState(expose, role, name, desc) {
             break;
 
         default:
-            break;
+            return state;
+    }
+    if (overrides?.fromComposite) {
+        if (overrides?.channelID) {
+            state.compositeKey = overrides.channelID;
+            state.compositeTimeout = 250;
+            state.compositeState = overrides.channelID;
+        }
+        else {
+            state.inOptions = true;
+            state.setterOpt = (value, options) => {
+                const result = {};
+                options[expose.property] = value;
+                result[expose.property] = options;
+                return result;
+            };
+            if (expose.access & ea.SET) {
+                state.setter = (value, options) => {
+                    const result = {};
+                    options[expose.property] = value;
+                    result[expose.property] = options;
+                    return result;
+                };
+                state.setattr = expose.property;
+            };
+            if (expose.access & ea.STATE) {
+                expose.getter = payload => {
+                    if ((payload.hasOwnProperty(expose.property)) && (payload[expose.property] !== null) && payload[expose.property].hasOwnProperty(expose.property)) {
+                        return !isNaN(payload[expose.property][expose.property]) ? payload[expose.property][expose.property] : undefined;
+                    } else {
+                        return undefined;
+                    }
+                };
+            } else {
+                expose.getter = payload => undefined;
+            }
+        }
     }
 
+
     return state;
 }
 
-function createFromExposes(model, def, device, log) {
+
+function generateCompositeStates(expose, _channelID, options)
+{
+    const states = [];
+    const stname = `${_channelID}${expose.property}`;
+    const stateId = stname.replace(/\*/g, '');
+    const stateName = (expose.description || expose.name);
+    const channelID = options.newCompositeMethod ? `c_${stateId}.` : '';
+    if (options.newCompositeMethod) {
+
+        if (typeof stname !== 'string') return undefined;;
+        states.push({
+            id: stateId,
+            name: stateName,
+            icon: undefined,
+            role: 'state',
+            write: Boolean (expose.access & ea.SET),
+            read: Boolean(expose.access & ea.GET),
+            type: 'string',
+            getter: (value) => {
+                const myval = value[stateId];
+                if (myval != undefined && typeof myval === 'object') return JSON.stringify(myval);
+                return myval;
+            },
+            setter: (value) => {
+                try {
+                    return JSON.parse(value);
+                }
+                catch (error) {
+                    return { error: error.message }
+                }
+            }
+        })
+
+    }
+    if (expose?.features?.[Symbol.iterator]) for (const prop of expose.features) {
+        if (prop.type === 'composite' || prop.type === 'list') {
+            states.push(...generateCompositeStates(prop, channelID, options))
+        }
+        else
+            states.push(genState(prop, options.newCompositeMethod ? { fromComposite: true, name: `${channelID}${prop.name}` , channelID: stateId }: { fromComposite: true }))
+    }
+
+    return states;
+
+}
+function createFromExposes(model, def, device, options, log) {
     const { getStateDefinition } = require('./models');
     const states = [];
     // make the different (set and get) part of state is updatable if different exposes is used for get and set
@@ -298,7 +385,7 @@ function createFromExposes(model, def, device, log) {
     function definitionHasTZHandler(definition, id) {
         const tz = definition?.herdsmanModel?.toZigbee;
         for (const converter of tz) {
-            if (converter.key.includes(id))
+            if (converter?.key?.includes(id))
                 return true;
         }
         return false;
@@ -313,7 +400,7 @@ function createFromExposes(model, def, device, log) {
                 let colorXYprop = undefined;
                 let colorHSprop = undefined;
 
-                for (const prop of expose.features) {
+                if (expose?.features?.[Symbol.iterator]) for (const prop of expose.features) {
                     switch (prop.name) {
                         case 'state': {
                             const stateNameS = expose.endpoint ? `state_${expose.endpoint}` : 'state';
@@ -521,26 +608,8 @@ function createFromExposes(model, def, device, log) {
                         read: true,
                         type: 'string',
                         setter: value => {
-                            try {
-                                // JSON
-                                const colorJSON = JSON.parse(value.replaceAll("'",'"'));
-                                const numProp = Object.keys(colorJSON).length;
-                                if (hasMultipleProperties(colorJSON, ['hsb'], numProp)) return colorJSON;
-                                if (hasMultipleProperties(colorJSON, ['hsl'], numProp)) return colorJSON;
-                                if (hasMultipleProperties(colorJSON, ['hsv'], numProp)) return colorJSON;
-                                if (hasMultipleProperties(colorJSON, ['h','s','b'], numProp)) return colorJSON;
-                                if (hasMultipleProperties(colorJSON, ['h','s','v'], numProp)) return colorJSON;
-                                if (hasMultipleProperties(colorJSON, ['h','s','l'], numProp)) return colorJSON;
-                                if (hasMultipleProperties(colorJSON, ['hue', 'saturation'], numProp)) return colorJSON;
-                                if (hasMultipleProperties(colorJSON, ['hex'], numProp)) return colorJSON;
-                                if (hasMultipleProperties(colorJSON, ['rgb'], numProp)) return colorJSON;
-                                if (hasMultipleProperties(colorJSON, ['x', 'y'], numProp)) return colorJSON;
-                                if (hasMultipleProperties(colorJSON, ['r', 'g', 'b'], numProp)) return colorJSON;
-                                //return { json:colorJSON, numProp:numProp, value:value };
-                            }
-                            catch (error) {
-                                //return { error: error.message };
-                            };
+                            const rv = colors.complexColor(value, true);
+                            if (rv) return rv;
                             // hex or named color
                             const rgbcolor = colors.ParseColor(value);
                             return rgbcolor;
@@ -551,24 +620,7 @@ function createFromExposes(model, def, device, log) {
                             return {...options, transition: transitionTime};
                         },
                         getter: payload => {
-                            if (typeof payload.color == 'object') {
-                                const colorJSON = payload.color;
-                                const color = JSON.stringify(colorJSON)
-                                //const numProp = Object.keys(colorJSON).length;
-                                if (hasMultipleProperties(colorJSON, ['hsb'])) return color;
-                                if (hasMultipleProperties(colorJSON, ['hsl'])) return color;
-                                if (hasMultipleProperties(colorJSON, ['hsv'])) return color;
-                                if (hasMultipleProperties(colorJSON, ['h','s','b'])) return color;
-                                if (hasMultipleProperties(colorJSON, ['h','s','v'])) return color;
-                                if (hasMultipleProperties(colorJSON, ['h','s','l'])) return color;
-                                if (hasMultipleProperties(colorJSON, ['hue', 'saturation'])) return color;
-                                if (hasMultipleProperties(colorJSON, ['h', 's'])) return color;
-                                if (hasMultipleProperties(colorJSON, ['hex'])) return color;
-                                if (hasMultipleProperties(colorJSON, ['rgb'])) return color;
-                                if (hasMultipleProperties(colorJSON, ['x', 'y'])) return color;
-                                if (hasMultipleProperties(colorJSON, ['r', 'g', 'b'])) return color;
-                            }
-                            return undefined;
+                            return colors.complexColor(payload, false);
                         },
                         epname: expose.endpoint,
                         setattr: 'color',
@@ -617,7 +669,6 @@ function createFromExposes(model, def, device, log) {
                             compositeKey: channelWithEp,
                             compositeTimeout: 500,
                             compositeState: 'color',
-                            composites: [`${channelWithEp}.r`,`${channelWithEp}.g`]
                         }, colorXYprop.access);
                         pushToStates({
                             id: `${channelWithEp}.g`,
@@ -632,7 +683,6 @@ function createFromExposes(model, def, device, log) {
                             compositeKey: channelWithEp,
                             compositeTimeout: 500,
                             compositeState: 'color',
-                            composites: [`${channelWithEp}.x`,`${channelWithEp}.y`]
                         });
                         pushToStates({
                             id: `${channelWithEp}.b`,
@@ -703,10 +753,10 @@ function createFromExposes(model, def, device, log) {
                 break;
             }
             case 'switch':
-                for (const prop of expose.features) {
+                if (expose?.features?.[Symbol.iterator]) for (const prop of expose.features) {
                     switch (prop.name) {
                         case 'state':
-                            pushToStates(genState(prop, 'switch'), prop.access);
+                            pushToStates(genState(prop, { role:'switch' }), prop.access);
                             break;
                         default:
                             pushToStates(genState(prop), prop.access);
@@ -725,44 +775,44 @@ function createFromExposes(model, def, device, log) {
                             break;
 
                         case 'battery':
-                            state = modifyState(genState(expose, 'value.battery'), {
+                            state = modifyState(genState(expose, {role:'value.battery'}), {
                                 icon:'img/battery_p.png',
                             });
                             //state = getStateDefinition('battery');
                             break;
 
                         case 'voltage':
-                            state = genState(expose, 'level.voltage');
+                            state = genState(expose, {role:'level.voltage'});
                             // state = getStateDefinition('voltage')
                             break;
 
                         case 'temperature':
-                            state = genState(expose, 'value.temperature');
+                            state = genState(expose, {role:'value.temperature'});
                             //state = getStateDefinition('temperature');
                             break;
 
                         case 'humidity':
-                            state = genState(expose, 'value.humidity');
+                            state = genState(expose, {role:'value.humidity'});
                             //state = getStateDefinition('humidity');
                             break;
 
                         case 'pressure':
-                            state = genState(expose, 'value.pressure');
+                            state = genState(expose, {role:'value.pressure'});
                             //state = getStateDefinition('pressure');
                             break;
 
                         case 'illuminance':
-                            state = genState(expose, 'value.brightness', 'illuminance_raw' )
+                            state = genState(expose, {role:'value.brightness', name: 'illuminance_raw'} );
                             //state = getStateDefinition('illuminance_raw');
                             break;
 
                         case 'illuminance_lux':
-                            state = genState(expose, 'value.brightness', 'illuminance');
+                            state = genState(expose, {role:'value.brightness', name:'illuminance'});
                             //state = getStateDefinition('illuminance');
                             break;
 
                         case 'power':
-                            state = genState(expose, 'value.power', 'load_power');
+                            state = genState(expose, {role:'value.power', name:'load_power'});
                             //state = getStateDefinition('load_power');
                             break;
 
@@ -848,9 +898,9 @@ function createFromExposes(model, def, device, log) {
                 } else {
                     switch (expose.name) {
                         case 'contact': {
-                            state = modifyState(genState(expose, 'sensor'), { getter: payload => payload.contact });
+                            state = modifyState(genState(expose, {role:'sensor'}), { getter: payload => payload.contact });
                             // state = getStateDefinition('contact');
-                            pushToStates(modifyState(genState(expose, 'sensor'), {
+                            pushToStates(modifyState(genState(expose,{role: 'sensor'}), {
                                 id:'opened',
                                 name:'Is open',
                                 role:'sensor.contact',
@@ -860,18 +910,18 @@ function createFromExposes(model, def, device, log) {
                             break;
                         }
                         case 'battery_low':
-                            state = genState(expose,'indicator.lowbat', expose.name, 'Battery Status Low');
+                            state = genState(expose, {role:'indicator.lowbat', name:expose.name, desc:'Battery Status Low'});
                             break;
 
                         case 'tamper':
-                            state = modifyState(genState(expose, 'indicator', 'tampered'), {
+                            state = modifyState(genState(expose, {role: 'indicator',name: 'tampered'}), {
                                 prop:'tamper',
                                 name:'Is tampered'
                             });
                             break;
 
                         case 'water_leak':
-                            state = modifyState(genState(expose, 'indicator', 'detected'), {
+                            state = modifyState(genState(expose, {role:'indicator', name:'detected'}), {
                                 prop:'water_leak',
                                 name:'Water leak detected'
                             })
@@ -879,7 +929,7 @@ function createFromExposes(model, def, device, log) {
                             break;
 
                         case 'lock':
-                            state = modifyState(genState(expose, 'switch.lock'), {
+                            state = modifyState(genState(expose, {role:'switch.lock'}), {
                                 prop: 'child_lock',
                                 name: 'Locked',
                                 getter: payload => (payload.child_lock === 'LOCKED'),
@@ -889,7 +939,7 @@ function createFromExposes(model, def, device, log) {
                             break;
 
                         case 'occupancy':
-                            state = genState(expose, 'sensor.motion');
+                            state = genState(expose, {role:'sensor.motion'});
                             //state = getStateDefinition('occupancy');
                             break;
 
@@ -911,10 +961,10 @@ function createFromExposes(model, def, device, log) {
             case 'lock':
             case 'fan':
             case 'cover':
-                for (const prop of expose.features) {
+                if (expose?.features?.[Symbol.iterator]) for (const prop of expose.features) {
                     switch (prop.name) {
                         case 'state':
-                            pushToStates(genState(prop, 'switch'), prop.access);
+                            pushToStates(genState(prop, {role:'switch'}), prop.access);
                             break;
                         default:
                             pushToStates(genState(prop), prop.access);
@@ -924,112 +974,16 @@ function createFromExposes(model, def, device, log) {
                 break;
 
             case 'climate':
-                for (const prop of expose.features) {
+                if (expose?.features?.[Symbol.iterator]) for (const prop of expose.features) {
                     pushToStates(genState(prop), prop.access);
                 }
                 break;
 
             case 'composite':
             {
-                const stname = (expose.property);
-                const stateId = stname.replace(/\*/g, '');
-                const stateName = (expose.description || expose.name);
-                const channelID = LocalData.options.newCompositeMethod ? `${stateId}.` : '';
-                if (LocalData.options.newCompositeMethod) {
-
-                    if (typeof stname !== 'string') break;
-                    pushToStates({
-                        id: stateId,
-                        name: stateName,
-                        icon: undefined,
-                        role: 'state',
-                        write: expose.access & ea.SET,
-                        read: expose.access & ea.GET,
-                        type: 'string',
-                    }, expose.access)
-
-                }
-                for (const prop of expose.features) {
-                    if (prop.type == 'numeric') {
-                        const st = genState(prop, 'state', `${channelID}${prop.name}`);
-                        st.prop = expose.property;
-                        st.inOptions = true;
-                        // I'm not fully sure, as it really needed, but
-                        st.setterOpt = (value, options) => {
-                            const result = {};
-                            options[prop.property] = value;
-                            result[expose.property] = options;
-                            return result;
-                        };
-                        if (LocalData.options.newCompositeMethod) {
-                            st.compositeKey = stateId;
-                            st.compositeTimeout = 250;
-                            st.compositeState = stateId;
-                        } else
-                        {
-                            // if we have a composite expose, the value have to be an object {expose.property : {prop.property: value}}
-                            if (prop.access & ea.SET) {
-                                st.setter = (value, options) => {
-                                    const result = {};
-                                    options[prop.property] = value;
-                                    result[expose.property] = options;
-                                    return result;
-                                };
-                                st.setattr = expose.property;
-                            }
-                            // if we have a composite expose, the payload will be an object {expose.property : {prop.property: value}}
-                            if (prop.access & ea.STATE) {
-                                st.getter = payload => {
-                                    if ((payload.hasOwnProperty(expose.property)) && (payload[expose.property] !== null) && payload[expose.property].hasOwnProperty(prop.property)) {
-                                        return !isNaN(payload[expose.property][prop.property]) ? payload[expose.property][prop.property] : undefined;
-                                    } else {
-                                        return undefined;
-                                    }
-                                };
-                            } else {
-                                st.getter = payload => undefined;
-                            }
-                        }
-                        pushToStates(st, prop.access);
-                    }
-
-                    if (prop.type == 'list') {
-                        for (const propList of prop.item_type.features) {
-                            const st = genState(propList);
-                            st.prop = expose.property;
-                            st.inOptions = true;
-                            st.setterOpt = (value, options) => {
-                                const result = {};
-                                options[propList.property] = value;
-                                result[expose.property] = options;
-                                return result;
-                            };
-                            if (propList.access & ea.SET) {
-                                st.setter = (value, options) => {
-                                    const result = {};
-                                    options[propList.property] = value;
-                                    result[expose.property] = options;
-                                    return result;
-                                };
-                                st.setattr = expose.property;
-                            }
-                            if (propList.access & ea.STATE) {
-                                st.getter = payload => {
-                                    if ((payload.hasOwnProperty(expose.property)) && (payload[expose.property] !== null) && payload[expose.property].hasOwnProperty(propList.property)) {
-                                        return !isNaN(payload[expose.property][propList.property]) ? payload[expose.property][propList.property] : undefined;
-                                    } else {
-                                        return undefined;
-                                    }
-                                };
-                            } else {
-                                st.getter = payload => undefined;
-                            }
-
-                            st.id = st.prop + '_' + st.id;
-                            pushToStates(st, propList.access);
-                        }
-                    }
-                }
+                const cStates = generateCompositeStates(expose, '', options);
+                for (const state of cStates)
+                    pushToStates(state, expose.access);
                 break;
             }
             case 'list':
@@ -1047,20 +1001,9 @@ function createFromExposes(model, def, device, log) {
 
 }
 
-async function applyExposeForDevice(mappedDevices, byModel, device, options) {
-    if (options && typeof options == 'object') {
-        LocalData.options = options;
-    }
-    const deviceDef = await zigbeeHerdsmanConverters.findByDevice(device);
-    if (!deviceDef)  {
-        return undefined;
-    }
-    return applyDeviceDef(mappedDevices, byModel, deviceDef, device);
-}
-
-async function applyHerdsmanModel(modelDesc) {
+async function applyHerdsmanModel(modelDesc, options) {
     try {
-        const newModel = createFromExposes(modelDesc.key, modelDesc, modelDesc.device)
+        const newModel = createFromExposes(modelDesc.key, modelDesc, modelDesc.device, options)
         if (newModel) {
             if (modelDesc.UUID) newModel.UUID = modelDesc.UUID;
         }
@@ -1071,25 +1014,6 @@ async function applyHerdsmanModel(modelDesc) {
     }
 }
 
-
-function applyDeviceDef(mappedDevices, byModel, deviceDef, device) {
-    const stripModel = utils.getModelRegEx(deviceDef.model);
-    const existsMap = byModel.get(stripModel);
-    if (deviceDef.hasOwnProperty('exposes') && (!existsMap || !existsMap.hasOwnProperty('states'))) {
-        try {
-            const newDevice = createFromExposes(stripModel, deviceDef, device);
-            mappedDevices.push(newDevice);
-            byModel.set(stripModel, newDevice);
-            return newDevice;
-
-        } catch (e) {
-            return undefined;
-        }
-    }
-    return existsMap;
-}
-
 module.exports = {
-    applyExposeForDevice: applyExposeForDevice,
     applyHerdsmanModel: applyHerdsmanModel,
 };

package/lib/groups.js

@@ -676,11 +676,8 @@ class Groups {
                     }, () => {
                         this.adapter.extendObject(id, {common: {name: name, type: 'group', icon: icon}});
                         // create writable states for groups from their devices
-                        for (const stateInd in stateDefinitions.groupStates) {
-                            if (!stateDefinitions.groupStates.hasOwnProperty(stateInd)) {
-                                continue;
-                            }
-                            const statedesc = stateDefinitions.groupStates[stateInd];
+                        for (const statedesc of stateDefinitions.groupStates) {
+                            if (!statedesc) continue;
                             const common = {};
                             for (const prop in statedesc)
                                 if (typeof statedesc[prop] != 'function')

package/lib/legacy/devices.js

@@ -3,7 +3,7 @@
 const states = require('./states.js').states;
 const utils = require('../utils.js');
 const rgb = require('../rgb.js');
-const { applyExposeForDevice} = require('../exposes.js');
+//const { applyExposeForDevice} = require('../exposes.js');
 
 
 // return list of changing states when incoming state is changed
@@ -3119,6 +3119,7 @@ function getByModel() {
 
 removeEmptyStates(devices);
 
+/*
 function fillStatesWithExposes(logger) {
     if (DevicesByModel.size <1) getByModel();
     return;
@@ -3133,7 +3134,7 @@ async function addExposeToDevices(device, logger, model) {
     removeEmptyStates(devices);
     return rv;
 }
-
+*/
 // remove empty states
 function removeEmptyStates(devices) {
     for (const device of devices) {
@@ -3200,6 +3201,7 @@ function hasLegacyDevice(model) {
 }
 
 module.exports = {
+/*
     devices,
     legacy_devices,
     commonStates,
@@ -3211,10 +3213,11 @@ module.exports = {
     fillStatesWithExposes,
     addExposeToDevices,
     getByModel,
+*/
     findModel,
-    fillDevicesForLegacy,
-    pairedLegacyDevices,
-    setLegacyDevices,
+    //fillDevicesForLegacy,
+    //pairedLegacyDevices,
+    //setLegacyDevices,
     hasLegacyDevice,
     getIconforLegacyModel,
 };