iobroker.zigbee 1.5.6 → 1.6.8

package/lib/exposes.js

@@ -5,12 +5,15 @@ const statesDefs = require(__dirname + '/states.js').states;
 const rgb = require(__dirname + '/rgb.js');
 const utils = require(__dirname + '/utils.js');
 const colors = require(__dirname + '/colors.js');
+const ea = zigbeeHerdsmanConverters.exposes.access;
 
 function genState(expose, role, name, desc) {
     let state;
-    // write if access.SET or access.STATE_SET or access.ALL
-    const write = [2, 3, 7].includes(expose.access);
-    const stateId = (name || expose.property).replace(/\*/g, '');
+    const readable = (expose.access & ea.STATE) > 0;
+    const writable = (expose.access & ea.SET) > 0;
+    const stname = (name || expose.property);
+    if (typeof stname !== 'string') return;
+    const stateId = stname.replace(/\*/g, '');
     const stateName = (desc || expose.description || expose.name);
     const propName = expose.property;
     switch (expose.type) {
@@ -21,13 +24,20 @@ function genState(expose, role, name, desc) {
                 name: stateName,
                 icon: undefined,
                 role: role || 'state',
-                write: write,
+                write: writable,
                 read: true,
                 type: 'boolean',
-                getter: payload => (payload[propName] === (expose.value_on || 'ON')),
-                setter: (value) => (value) ? (expose.value_on || 'ON') : ((expose.value_off != undefined) ? expose.value_off : 'OFF'),
-                setattr: expose.name,
             };
+            if (readable) {
+                state.getter = payload => (payload[propName] === (expose.value_on || 'ON'));
+            }
+            else {
+                state.getter = payload => ( undefined);
+            }
+            if (writable) {
+                state.setter = (value) => (value) ? (expose.value_on || 'ON') : ((expose.value_off != undefined) ? expose.value_off : 'OFF');
+                state.setattr = expose.name;
+            }
             if (expose.endpoint) {
                 state.epname = expose.endpoint;
             }
@@ -40,7 +50,7 @@ function genState(expose, role, name, desc) {
                 name: stateName,
                 icon: undefined,
                 role: role || 'state',
-                write: write,
+                write: writable,
                 read: true,
                 type: 'number',
                 min: expose.value_min || 0,
@@ -59,13 +69,14 @@ function genState(expose, role, name, desc) {
                 name: stateName,
                 icon: undefined,
                 role: role || 'state',
-                write: write,
+                write: writable,
                 read: true,
                 type: 'string',
                 states: expose.values.map((item) => `${item}:${item}`).join(';'),
             };
             if (expose.endpoint) {
                 state.epname = expose.endpoint;
+                state.setattr = expose.name;
             }
             break;
 
@@ -76,7 +87,7 @@ function genState(expose, role, name, desc) {
                 name: stateName,
                 icon: undefined,
                 role: role || 'state',
-                write: write,
+                write: writable,
                 read: true,
                 type: 'string',
             };
@@ -92,9 +103,121 @@ function genState(expose, role, name, desc) {
     return state;
 }
 
+
+
 function createFromExposes(model, def) {
     const states = [];
-    const icon = `https://www.zigbee2mqtt.io/images/devices/${model.replace('/','-')}.jpg`;
+    // make the different (set and get) part of state is updatable if different exposes is used for get and set
+    // as example:
+    //  ...
+    //  exposes.binary('some_option', ea.STATE, true, false).withDescription('Some Option'),
+    //  exposes.composite('options', 'options')
+    //      .withDescription('Some composite Options')
+    //      .withFeature(exposes.binary('some_option', ea.SET, true, false).withDescription('Some Option'))
+    //in this case one state - `some_option` has two different exposes for set an get, we have to combine it ...
+    //
+
+    function pushToStates(state, access) {
+        if (state === undefined) {
+            return 0;
+        }
+        if (access === undefined) access = ea.ALL;
+        state.readable = (access & ea.STATE) > 0;
+        state.writable = (access & ea.SET) > 0;
+        const stateExists = states.findIndex( (element, index, array) => (element.id === state.id ));
+        if (stateExists < 0 ) {
+            state.write = state.writable;
+            if (! state.writable) {
+                if ( state.hasOwnProperty('setter') ) {
+                    delete state.setter;
+                }
+                if ( state.hasOwnProperty('setattr') ) {
+                    delete state.setattr;
+                }
+            }
+            if (! state.readable) {
+                if (state.hasOwnProperty('getter') ) {
+                    //to awid some worning on unprocessed data
+                    state.getter = payload => ( undefined );
+                }
+            }
+            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
+                if (states[stateExists].role === 'button') {
+                    states[stateExists].role = state.role;
+                }
+                if (states[stateExists].hasOwnProperty('isEvent')) {
+                    delete states[stateExists].isEvent;
+                }
+                // we have to use the getter from "new" state
+                if ( state.hasOwnProperty('getter') ) {
+                    states[stateExists].getter = state.getter;
+                }
+                // trying to remove the `prop` property, as main key for get and set,
+                // as it can be different in new and old states, and leave only:
+                // setattr for old and id for new
+                if (( state.hasOwnProperty('prop') ) && (state.prop === state.id)) {
+                    if ( states[stateExists].hasOwnProperty('prop') ) {
+                        if (states[stateExists].prop !== states[stateExists].id) {
+                            if (! states[stateExists].hasOwnProperty('setattr')) {
+                                states[stateExists].setattr = states[stateExists].prop;
+                            }
+                        }
+                        delete states[stateExists].prop;
+                    }
+                }
+                else if ( state.hasOwnProperty('prop') ) {
+                    states[stateExists].prop = state.prop;
+                }
+                states[stateExists].readable = true;
+            }
+            if ( (state.writable) && (! states[stateExists].writable ) ) {
+                states[stateExists].write = state.writable;
+                // use new state `setter`
+                if ( state.hasOwnProperty('setter') ) {
+                    states[stateExists].setter = state.setter;
+                }
+                // use new state `setterOpt`
+                if ( state.hasOwnProperty('setterOpt') ) {
+                    states[stateExists].setterOpt = state.setterOpt;
+                }
+                // use new state `inOptions`
+                if ( state.hasOwnProperty('inOptions') ) {
+                    states[stateExists].inOptions = state.inOptions;
+                }
+                // as we have new state, responsible for set, we have to use new `isOption`
+                // or remove it
+                if (((! state.hasOwnProperty('isOption') ) || (state.isOptions === false))
+                     && (states[stateExists].hasOwnProperty('isOption'))) {
+                    delete states[stateExists].isOption;
+                }
+                else {
+                    states[stateExists].isOption = state.isOption;
+                }
+                // use new `setattr` or `prop` as `setattr`
+                if ( state.hasOwnProperty('setattr') ) {
+                    states[stateExists].setattr = state.setattr;
+                }
+                else if ( state.hasOwnProperty('prop') ) {
+                    states[stateExists].setattr = state.prop;
+                }
+                // remove `prop` equal to if, due to prop is uses as key in set and get
+                if ( states[stateExists].prop === states[stateExists].id) {
+                    delete states[stateExists].prop;
+                }
+                if ( state.hasOwnProperty('epname') ) {
+                    states[stateExists].epname = state.epname;
+                }
+                states[stateExists].writable = true;
+            }
+            return states.length;
+        }
+    }
+    const icon = utils.getDeviceIcon(def);
     for (const expose of def.exposes) {
         let state;
 
@@ -104,7 +227,7 @@ function createFromExposes(model, def) {
                     switch (prop.name) {
                         case 'state': {
                             const stateNameS = expose.endpoint ? `state_${expose.endpoint}` : 'state';
-                            states.push({
+                            pushToStates({
                                 id: stateNameS,
                                 name: `Switch state ${expose.endpoint ? expose.endpoint : ''}`.trim(),
                                 icon: undefined,
@@ -116,12 +239,12 @@ function createFromExposes(model, def) {
                                 setter: (value) => (value) ? prop.value_on || 'ON' : ((prop.value_off != undefined) ? prop.value_off : 'OFF'),
                                 epname: expose.endpoint,
                                 setattr: 'state',
-                            });
+                            }, prop.access);
                             break;
                         }
                         case 'brightness': {
                             const stateNameB = expose.endpoint ? `brightness_${expose.endpoint}` : 'brightness';
-                            states.push({
+                            pushToStates({
                                 id: stateNameB,
                                 name: `Brightness ${expose.endpoint ? expose.endpoint : ''}`.trim(),
                                 icon: undefined,
@@ -153,13 +276,13 @@ function createFromExposes(model, def) {
                                 },
                                 epname: expose.endpoint,
                                 setattr: 'brightness',
-                            });
-                            states.push(statesDefs.brightness_move);
+                            }, prop.access);
+                            pushToStates(statesDefs.brightness_move, prop.access);
                             break;
                         }
                         case 'color_temp': {
                             const stateNameT = expose.endpoint ? `colortemp_${expose.endpoint}` : 'colortemp';
-                            states.push({
+                            pushToStates({
                                 id: stateNameT,
                                 prop: expose.endpoint ? `color_temp_${expose.endpoint}` : 'color_temp',
                                 name: `Color temperature ${expose.endpoint ? expose.endpoint : ''}`.trim(),
@@ -179,13 +302,13 @@ function createFromExposes(model, def) {
                                     return {...options, transition: transitionTime};
                                 },
                                 epname: expose.endpoint,
-                            });
-                            states.push(statesDefs.colortemp_move);
+                            }, prop.access);
+                            pushToStates(statesDefs.colortemp_move, prop.access);
                             break;
                         }
                         case 'color_xy': {
                             const stateNameC = expose.endpoint ? `color_${expose.endpoint}` : 'color';
-                            states.push({
+                            pushToStates({
                                 id: stateNameC,
                                 prop: expose.endpoint ? `color_${expose.endpoint}` : 'color',
                                 name: `Color ${expose.endpoint ? expose.endpoint : ''}`.trim(),
@@ -235,12 +358,12 @@ function createFromExposes(model, def) {
                                 },
                                 epname: expose.endpoint,
                                 setattr: 'color',
-                            });
+                            }, prop.access);
                             break;
                         }
                         case 'color_hs': {
                             const stateNameH = expose.endpoint ? `color_${expose.endpoint}` : 'color';
-                            states.push({
+                            pushToStates({
                                 id: stateNameH,
                                 prop: expose.endpoint ? `color_${expose.endpoint}` : 'color',
                                 name: `Color ${expose.endpoint ? expose.endpoint : ''}`.trim(),
@@ -266,8 +389,8 @@ function createFromExposes(model, def) {
                                 },
                                 epname: expose.endpoint,
                                 setattr: 'color',
-                            });
-                            states.push({
+                            }, prop.access);
+                            pushToStates({
                                 id: expose.endpoint ? `hue_${expose.endpoint}` : 'hue',
                                 prop: expose.endpoint ? `color_${expose.endpoint}` : 'color',
                                 name: `Hue ${expose.endpoint ? expose.endpoint : ''}`.trim(),
@@ -306,8 +429,8 @@ function createFromExposes(model, def) {
                                     return {...options, transition: transitionTime};
                                 },
 
-                            });
-                            states.push({
+                            }, prop.access);
+                            pushToStates({
                                 id: expose.endpoint ? `saturation_${expose.endpoint}` : 'saturation',
                                 prop: expose.endpoint ? `color_${expose.endpoint}` : 'color',
                                 name: `Saturation ${expose.endpoint ? expose.endpoint : ''}`.trim(),
@@ -346,10 +469,10 @@ function createFromExposes(model, def) {
                                     return {...options, transition: transitionTime};
                                 },
 
-                            });
-                            states.push(statesDefs.hue_move);
-                            states.push(statesDefs.saturation_move);
-                            states.push({
+                            }, prop.access);
+                            pushToStates(statesDefs.hue_move, prop.access);
+                            pushToStates(statesDefs.saturation_move, prop.access);
+                            pushToStates({
                                 id: 'hue_calibration',
                                 prop: 'color',
                                 name: 'Hue color calibration table',
@@ -386,25 +509,25 @@ function createFromExposes(model, def) {
                                     return {...options, transition: transitionTime};
                                 },
 
-                            });
+                            }, prop.access);
                             break;
                         }
                         default:
-                            states.push(genState(prop));
+                            pushToStates(genState(prop), prop.access);
                             break;
                     }
                 }
-                states.push(statesDefs.transition_time);
+                pushToStates(statesDefs.transition_time, ea.STATE_SET);
                 break;
 
             case 'switch':
                 for (const prop of expose.features) {
                     switch (prop.name) {
                         case 'state':
-                            states.push(genState(prop, 'switch'));
+                            pushToStates(genState(prop, 'switch'), prop.access);
                             break;
                         default:
-                            states.push(genState(prop));
+                            pushToStates(genState(prop), prop.access);
                             break;
                     }
                 }
@@ -456,7 +579,7 @@ function createFromExposes(model, def) {
                             break;
                     }
                 }
-                if (state) states.push(state);
+                if (state) pushToStates(state, expose.access);
                 break;
 
             case 'enum':
@@ -496,7 +619,7 @@ function createFromExposes(model, def) {
                                     isEvent: true,
                                 };
                             }
-                            states.push(state);
+                            pushToStates(state, expose.access);
                         }
                         state = null;
                         break;
@@ -505,7 +628,7 @@ function createFromExposes(model, def) {
                         state = genState(expose);
                         break;
                 }
-                if (state) states.push(state);
+                if (state) pushToStates(state, expose.access);
                 break;
 
             case 'binary':
@@ -515,7 +638,7 @@ function createFromExposes(model, def) {
                     switch (expose.name) {
                         case 'contact':
                             state = statesDefs.contact;
-                            states.push(statesDefs.opened);
+                            pushToStates(statesDefs.opened, ea.STATE);
                             break;
 
                         case 'battery_low':
@@ -543,12 +666,12 @@ function createFromExposes(model, def) {
                             break;
                     }
                 }
-                if (state) states.push(state);
+                if (state) pushToStates(state, expose.access);
                 break;
 
             case 'text':
                 state = genState(expose);
-                states.push(state);
+                pushToStates(state, expose.access);
                 break;
 
             case 'lock':
@@ -557,10 +680,10 @@ function createFromExposes(model, def) {
                 for (const prop of expose.features) {
                     switch (prop.name) {
                         case 'state':
-                            states.push(genState(prop, 'switch'));
+                            pushToStates(genState(prop, 'switch'), prop.access);
                             break;
                         default:
-                            states.push(genState(prop));
+                            pushToStates(genState(prop), prop.access);
                             break;
                     }
                 }
@@ -570,16 +693,16 @@ function createFromExposes(model, def) {
                 for (const prop of expose.features) {
                     switch (prop.name) {
                         case 'away_mode':
-                            states.push(statesDefs.climate_away_mode);
+                            pushToStates(statesDefs.climate_away_mode, prop.access);
                             break;
                         case 'system_mode':
-                            states.push(statesDefs.climate_system_mode);
+                            pushToStates(statesDefs.climate_system_mode, prop.access);
                             break;
                         case 'running_mode':
-                            states.push(statesDefs.climate_running_mode);
+                            pushToStates(statesDefs.climate_running_mode, prop.access);
                             break;
                         default:
-                            states.push(genState(prop));
+                            pushToStates(genState(prop), prop.access);
                             break;
                     }
                 }
@@ -588,14 +711,41 @@ function createFromExposes(model, def) {
             case 'composite':
                 for (const prop of expose.features) {
                     const st = genState(prop);
+                    st.prop = expose.property;
                     st.inOptions = true;
+                    // I'm not fully sure, as it really needed, but
                     st.setterOpt = (value, options) => {
                         const result = {};
-                        result[expose.property] = {...options};
+                        options[prop.property] = value;
+                        result[expose.property] = options;
                         return result;
                     };
-                    st.setattr = expose.property;
-                    states.push(st);
+                    // 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 => { return undefined };
+                    }
+                    ;
+                    pushToStates(st, prop.access);
                 }
                 break;
             default:
@@ -608,7 +758,9 @@ function createFromExposes(model, def) {
         states: states,
         exposed: true,
     };
-    //console.log(`Created mapping for device ${model}: ${safeJsonStringify(newDev, null, ' ')}`);
+    // make the function code printable in log
+    //console.log(`Created mapping for device ${model}: ${JSON.stringify(newDev, function(key, value) {
+    //  if (typeof value === 'function') {return value.toString() } else { return value } }, ' ')}`);
     return newDev;
 }
 
@@ -620,6 +772,7 @@ function applyExposes(mappedDevices, byModel, allExcludesObj) {
         const strippedModel = (deviceDef.model) ? deviceDef.model.replace(/\0.*$/g, '').trim() : '';
         // check if device is mapped
         const existsMap = byModel.get(strippedModel);
+
         if ((deviceDef.hasOwnProperty('exposes') && (!existsMap || !existsMap.hasOwnProperty('states'))) || allExcludesStr.indexOf(strippedModel) > 0) {
             const newDevice = createFromExposes(strippedModel, deviceDef);
             if (!existsMap) {