iobroker.zigbee 1.8.3 → 1.8.7

package/lib/exposes.js

@@ -1,10 +1,10 @@
 'use strict';
 
 const zigbeeHerdsmanConverters = require('zigbee-herdsman-converters');
-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 statesDefs = require('./states.js').states;
+const rgb = require('./rgb.js');
+const utils = require('./utils.js');
+const colors = require('./colors.js');
 const ea = zigbeeHerdsmanConverters.exposes.access;
 
 function genState(expose, role, name, desc) {
@@ -29,10 +29,9 @@ function genState(expose, role, name, desc) {
                 type: 'boolean',
             };
             if (readable) {
-                state.getter = payload => (payload[propName] === (expose.value_on || 'ON'));
-            }
-            else {
-                state.getter = payload => ( undefined);
+                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');
@@ -72,7 +71,7 @@ function genState(expose, role, name, desc) {
                 write: writable,
                 read: true,
                 type: 'string',
-                states: expose.values.map((item) => `${item}:${item}`).join(';'),
+                states: expose.values.map(item => `${item}:${item}`).join(';'),
             };
             if (expose.endpoint) {
                 state.epname = expose.endpoint;
@@ -103,8 +102,6 @@ function genState(expose, role, name, desc) {
     return state;
 }
 
-
-
 function createFromExposes(model, def) {
     const states = [];
     // make the different (set and get) part of state is updatable if different exposes is used for get and set
@@ -121,30 +118,31 @@ function createFromExposes(model, def) {
         if (state === undefined) {
             return 0;
         }
-        if (access === undefined) access = ea.ALL;
+        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 ) {
+        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') ) {
+            if (!state.writable) {
+                if (state.hasOwnProperty('setter')) {
                     delete state.setter;
                 }
-                if ( state.hasOwnProperty('setattr') ) {
+                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 );
+            if (!state.readable) {
+                if (state.hasOwnProperty('getter')) {
+                    // to awoid some warnings on unprocessed data
+                    state.getter = payload => undefined;
                 }
             }
             return states.push(state);
-        }
-        else {
-            if ( (state.readable) && (! states[stateExists].readable ) ) {
+        } 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') {
@@ -154,69 +152,70 @@ function createFromExposes(model, def) {
                     delete states[stateExists].isEvent;
                 }
                 // we have to use the getter from "new" state
-                if ( state.hasOwnProperty('getter') ) {
+                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 ((state.hasOwnProperty('prop')) && (state.prop === state.id)) {
+                    if (states[stateExists].hasOwnProperty('prop')) {
                         if (states[stateExists].prop !== states[stateExists].id) {
-                            if (! states[stateExists].hasOwnProperty('setattr')) {
+                            if (!states[stateExists].hasOwnProperty('setattr')) {
                                 states[stateExists].setattr = states[stateExists].prop;
                             }
                         }
                         delete states[stateExists].prop;
                     }
-                }
-                else if ( state.hasOwnProperty('prop') ) {
+                } else if (state.hasOwnProperty('prop')) {
                     states[stateExists].prop = state.prop;
                 }
                 states[stateExists].readable = true;
             }
-            if ( (state.writable) && (! states[stateExists].writable ) ) {
+            if ((state.writable) && (!states[stateExists].writable)) {
                 states[stateExists].write = state.writable;
                 // use new state `setter`
-                if ( state.hasOwnProperty('setter') ) {
+                if (state.hasOwnProperty('setter')) {
                     states[stateExists].setter = state.setter;
                 }
                 // use new state `setterOpt`
-                if ( state.hasOwnProperty('setterOpt') ) {
+                if (state.hasOwnProperty('setterOpt')) {
                     states[stateExists].setterOpt = state.setterOpt;
                 }
                 // use new state `inOptions`
-                if ( state.hasOwnProperty('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'))) {
+                if (((!state.hasOwnProperty('isOption')) || (state.isOptions === false))
+                    && (states[stateExists].hasOwnProperty('isOption'))) {
                     delete states[stateExists].isOption;
-                }
-                else {
+                } else {
                     states[stateExists].isOption = state.isOption;
                 }
+
                 // use new `setattr` or `prop` as `setattr`
-                if ( state.hasOwnProperty('setattr') ) {
+                if (state.hasOwnProperty('setattr')) {
                     states[stateExists].setattr = state.setattr;
-                }
-                else if ( state.hasOwnProperty('prop') ) {
+                } 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) {
+                if (states[stateExists].prop === states[stateExists].id) {
                     delete states[stateExists].prop;
                 }
-                if ( state.hasOwnProperty('epname') ) {
+                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;
@@ -242,6 +241,7 @@ function createFromExposes(model, def) {
                             }, prop.access);
                             break;
                         }
+
                         case 'brightness': {
                             const stateNameB = expose.endpoint ? `brightness_${expose.endpoint}` : 'brightness';
                             pushToStates({
@@ -255,12 +255,8 @@ function createFromExposes(model, def) {
                                 min: 0, // ignore expose.value_min
                                 max: 100, // ignore expose.value_max
                                 inOptions: true,
-                                getter: payload => {
-                                    return utils.bulbLevelToAdapterLevel(payload[stateNameB]);
-                                },
-                                setter: (value) => {
-                                    return utils.adapterLevelToBulbLevel(value);
-                                },
+                                getter: payload => utils.bulbLevelToAdapterLevel(payload[stateNameB]),
+                                setter: value => utils.adapterLevelToBulbLevel(value),
                                 setterOpt: (value, options) => {
                                     const hasTransitionTime = options && options.hasOwnProperty('transition_time');
                                     const transitionTime = hasTransitionTime ? options.transition_time : 0;
@@ -268,7 +264,7 @@ function createFromExposes(model, def) {
                                     preparedOptions.brightness = utils.adapterLevelToBulbLevel(value);
                                     return preparedOptions;
                                 },
-                                readResponse: (resp) => {
+                                readResponse: resp => {
                                     const respObj = resp[0];
                                     if (respObj.status === 0 && respObj.attrData != undefined) {
                                         return utils.bulbLevelToAdapterLevel(respObj.attrData);
@@ -282,30 +278,30 @@ function createFromExposes(model, def) {
                         }
                         case 'color_temp': {
                             const stateNameT = expose.endpoint ? `colortemp_${expose.endpoint}` : 'colortemp';
-                            pushToStates({
-                                id: stateNameT,
-                                prop: expose.endpoint ? `color_temp_${expose.endpoint}` : 'color_temp',
-                                name: `Color temperature ${expose.endpoint ? expose.endpoint : ''}`.trim(),
-                                icon: undefined,
-                                role: 'level.color.temperature',
-                                write: true,
-                                read: true,
-                                type: 'number',
-                                // Ignore min and max value, so setting mireds and Kelvin with conversion to mireds works.
-                                // https://github.com/ioBroker/ioBroker.zigbee/pull/1433#issuecomment-1113837035
-                                min: undefined,
-                                max: undefined,
-                                setter: (value) => {
-                                    return utils.toMired(value);
-                                },
-                                setterOpt: (value, options) => {
-                                    const hasTransitionTime = options && options.hasOwnProperty('transition_time');
-                                    const transitionTime = hasTransitionTime ? options.transition_time : 0;
-                                    return {...options, transition: transitionTime};
+                            pushToStates(
+                                {
+                                    id: stateNameT,
+                                    prop: expose.endpoint ? `color_temp_${expose.endpoint}` : 'color_temp',
+                                    name: `Color temperature ${expose.endpoint ? expose.endpoint : ''}`.trim(),
+                                    icon: undefined,
+                                    role: 'level.color.temperature',
+                                    write: true,
+                                    read: true,
+                                    type: 'number',
+                                    // Ignore min and max value, so setting mireds and Kelvin with conversion to mireds works.
+                                    // https://github.com/ioBroker/ioBroker.zigbee/pull/1433#issuecomment-1113837035
+                                    min: undefined,
+                                    max: undefined,
+                                    setter: value => utils.toMired(value),
+                                    setterOpt: (value, options) => {
+                                        const hasTransitionTime = options && options.hasOwnProperty('transition_time');
+                                        const transitionTime = hasTransitionTime ? options.transition_time : 0;
+                                        return {...options, transition: transitionTime};
+                                    },
+                                    epname: expose.endpoint,
+                                    setattr: 'color_temp',
                                 },
-                                epname: expose.endpoint,
-								setattr: 'color_temp',
-                            }, prop.access);
+                                prop.access);
                             pushToStates(statesDefs.colortemp_move, prop.access);
                             break;
                         }
@@ -320,8 +316,8 @@ function createFromExposes(model, def) {
                                 write: true,
                                 read: true,
                                 type: 'string',
-                                setter: (value) => {
-                                // convert RGB to XY for set
+                                setter: value => {
+                                    // convert RGB to XY for set
                                     /*
                                     const result = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(value);
                                     let xy = [0, 0];
@@ -342,9 +338,8 @@ function createFromExposes(model, def) {
                                     xy = rgb.rgb_to_cie(rgbcolor.r, rgbcolor.g, rgbcolor.b);
                                     return {
                                         x: xy[0],
-                                        y: xy[1]
+                                        y: xy[1],
                                     };
-
                                 },
                                 setterOpt: (value, options) => {
                                     const hasTransitionTime = options && options.hasOwnProperty('transition_time');
@@ -354,7 +349,7 @@ function createFromExposes(model, def) {
                                 getter: payload => {
                                     if (payload.color && payload.color.hasOwnProperty('x') && payload.color.hasOwnProperty('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]);
+                                        return `#${utils.decimalToHex(colorval[0])}${utils.decimalToHex(colorval[1])}${utils.decimalToHex(colorval[2])}`;
                                     } else {
                                         return undefined;
                                     }
@@ -375,14 +370,13 @@ function createFromExposes(model, def) {
                                 write: true,
                                 read: true,
                                 type: 'string',
-                                setter: (value) => {
+                                setter: value => {
                                     const _rgb = colors.ParseColor(value);
                                     const hsv = rgb.rgbToHSV(_rgb.r, _rgb.g, _rgb.b, true);
                                     return {
-                                        hue: Math.min(Math.max(hsv.h,1),359),
+                                        hue: Math.min(Math.max(hsv.h, 1), 359),
                                         saturation: hsv.s,
                                         //                                        brightness: Math.floor(hsv.v * 2.55),
-
                                     };
                                 },
                                 setterOpt: (value, options) => {
@@ -396,7 +390,7 @@ function createFromExposes(model, def) {
                             pushToStates({
                                 id: expose.endpoint ? `hue_${expose.endpoint}` : 'hue',
                                 prop: expose.endpoint ? `color_${expose.endpoint}` : 'color',
-                                name: `Hue ${expose.endpoint ? expose.endpoint : ''}`.trim(),
+                                name: `Hue ${expose.endpoint || ''}`.trim(),
                                 icon: undefined,
                                 role: 'level.color.hue',
                                 write: true,
@@ -417,17 +411,28 @@ function createFromExposes(model, def) {
                                     const hasHueCalibrationTable = options && options.hasOwnProperty('hue_calibration');
                                     if (hasHueCalibrationTable)
                                         try {
-                                            return {...options, transition: transitionTime, hue_correction: JSON.parse(options.hue_calibration)};
-                                        }
-                                        catch {
+                                            return {
+                                                ...options,
+                                                transition: transitionTime,
+                                                hue_correction: JSON.parse(options.hue_calibration)
+                                            };
+                                        } catch {
                                             const hue_correction_table = [];
                                             options.hue_calibration.split(',').forEach(element => {
                                                 const match = /([0-9]+):([0-9]+)/.exec(element);
-                                                if (match && match.length ==3)
-                                                    hue_correction_table.push({ in: Number(match[1]), out: Number(match[2])});
+                                                if (match && match.length === 3)
+                                                    hue_correction_table.push({
+                                                        in: Number(match[1]),
+                                                        out: Number(match[2])
+                                                    });
                                             });
-                                            if (hue_correction_table.length > 0)
-                                                return {...options, transition: transitionTime, hue_correction: hue_correction_table};
+                                            if (hue_correction_table.length > 0) {
+                                                return {
+                                                    ...options,
+                                                    transition: transitionTime,
+                                                    hue_correction: hue_correction_table
+                                                };
+                                            }
                                         }
                                     return {...options, transition: transitionTime};
                                 },
@@ -445,29 +450,38 @@ function createFromExposes(model, def) {
                                 min: 0,
                                 max: 100,
                                 inOptions: true,
-                                setter: (value, options) => {
-                                    return {
-                                        hue: options.hue,
-                                        saturation: value,
-                                    };
-                                },
+                                setter: (value, options) => ({
+                                    hue: options.hue,
+                                    saturation: value,
+                                }),
                                 setterOpt: (value, options) => {
                                     const hasTransitionTime = options && options.hasOwnProperty('transition_time');
                                     const transitionTime = hasTransitionTime ? options.transition_time : 0;
                                     const hasHueCalibrationTable = options && options.hasOwnProperty('hue_calibration');
                                     if (hasHueCalibrationTable)
                                         try {
-                                            return {...options, transition: transitionTime, hue_correction: JSON.parse(options.hue_calibration)};
-                                        }
-                                        catch {
+                                            return {
+                                                ...options,
+                                                transition: transitionTime,
+                                                hue_correction: JSON.parse(options.hue_calibration)
+                                            };
+                                        } catch {
                                             const hue_correction_table = [];
                                             options.hue_calibration.split(',').forEach(element => {
                                                 const match = /([0-9]+):([0-9]+)/.exec(element);
-                                                if (match && match.length ==3)
-                                                    hue_correction_table.push({ in: Number(match[1]), out: Number(match[2])});
+                                                if (match && match.length === 3)
+                                                    hue_correction_table.push({
+                                                        in: Number(match[1]),
+                                                        out: Number(match[2])
+                                                    });
                                             });
-                                            if (hue_correction_table.length > 0)
-                                                return {...options, transition: transitionTime, hue_correction: hue_correction_table};
+                                            if (hue_correction_table.length > 0) {
+                                                return {
+                                                    ...options,
+                                                    transition: transitionTime,
+                                                    hue_correction: hue_correction_table
+                                                };
+                                            }
                                         }
                                     return {...options, transition: transitionTime};
                                 },
@@ -485,33 +499,42 @@ function createFromExposes(model, def) {
                                 read: false,
                                 type: 'string',
                                 inOptions: true,
-                                setter: (value, options) => {
-                                    return {
-                                        hue: options.hue,
-                                        saturation: options.saturation,
-                                    };
-                                },
+                                setter: (value, options) => ({
+                                    hue: options.hue,
+                                    saturation: options.saturation,
+                                }),
                                 setterOpt: (value, options) => {
                                     const hasTransitionTime = options && options.hasOwnProperty('transition_time');
                                     const transitionTime = hasTransitionTime ? options.transition_time : 0;
                                     const hasHueCalibrationTable = options && options.hasOwnProperty('hue_calibration');
                                     if (hasHueCalibrationTable)
                                         try {
-                                            return {...options, transition: transitionTime, hue_correction: JSON.parse(options.hue_calibration)};
-                                        }
-                                        catch {
+                                            return {
+                                                ...options,
+                                                transition: transitionTime,
+                                                hue_correction: JSON.parse(options.hue_calibration)
+                                            };
+                                        } catch {
                                             const hue_correction_table = [];
                                             options.hue_calibration.split(',').forEach(element => {
                                                 const match = /([0-9]+):([0-9]+)/.exec(element);
-                                                if (match && match.length ==3)
-                                                    hue_correction_table.push({ in: Number(match[1]), out: Number(match[2])});
+                                                if (match && match.length === 3) {
+                                                    hue_correction_table.push({
+                                                        in: Number(match[1]),
+                                                        out: Number(match[2])
+                                                    });
+                                                }
                                             });
-                                            if (hue_correction_table.length > 0)
-                                                return {...options, transition: transitionTime, hue_correction: hue_correction_table};
+                                            if (hue_correction_table.length > 0) {
+                                                return {
+                                                    ...options,
+                                                    transition: transitionTime,
+                                                    hue_correction: hue_correction_table
+                                                };
+                                            }
                                         }
                                     return {...options, transition: transitionTime};
                                 },
-
                             }, prop.access);
                             break;
                         }
@@ -582,19 +605,20 @@ function createFromExposes(model, def) {
                             break;
                     }
                 }
-                if (state) pushToStates(state, expose.access);
+                if (state) {
+                    pushToStates(state, expose.access);
+                }
                 break;
 
             case 'enum':
                 switch (expose.name) {
                     case 'action': {
-
                         // Ansatz:
 
-                    // Action aufspalten in 2 Blöcke:
-                    // Action (bekommt text ausser hold und release, auto reset nach 250 ms)
-                    // Hold: wird gesetzt bei hold, gelöscht bei passendem Release
-                    
+                        // Action aufspalten in 2 Blöcke:
+                        // Action (bekommt text ausser hold und release, auto reset nach 250 ms)
+                        // Hold: wird gesetzt bei hold, gelöscht bei passendem Release
+
                         if (!Array.isArray(expose.values)) break;
                         const hasHold = expose.values.find((actionName) => actionName.includes('hold'));
                         const hasRelease = expose.values.find((actionName) => actionName.includes('release'));
@@ -613,7 +637,7 @@ function createFromExposes(model, def) {
                                     write: false,
                                     read: true,
                                     type: 'boolean',
-                                    getter: payload => (payload.action === actionName) ? true : (payload.action === releaseActionName) ? false : undefined,
+                                    getter: payload => payload.action === actionName ? true : (payload.action === releaseActionName ? false : undefined),
                                 };
                             } else {
                                 state = {
@@ -625,7 +649,7 @@ function createFromExposes(model, def) {
                                     write: false,
                                     read: true,
                                     type: 'boolean',
-                                    getter: payload => (payload.action === actionName) ? true : undefined,
+                                    getter: payload => payload.action === actionName ? true : undefined,
                                     isEvent: true,
                                 };
                             }
@@ -676,7 +700,9 @@ function createFromExposes(model, def) {
                             break;
                     }
                 }
-                if (state) pushToStates(state, expose.access);
+                if (state) {
+                    pushToStates(state, expose.access);
+                }
                 break;
 
             case 'text':
@@ -739,22 +765,20 @@ function createFromExposes(model, def) {
                             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 {
+                            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;
                     }
-                    else {
-                        st.getter = payload => { return undefined };
-                    }
-                    ;
+
                     pushToStates(st, prop.access);
                 }
                 break;
@@ -764,8 +788,8 @@ function createFromExposes(model, def) {
     }
     const newDev = {
         models: [model],
-        icon: icon,
-        states: states,
+        icon,
+        states,
         exposed: true,
     };
     // make the function code printable in log
@@ -775,26 +799,27 @@ function createFromExposes(model, def) {
 }
 
 function applyExposes(mappedDevices, byModel, allExcludesObj) {
-    // for exlude search
+    // for exclude search
     const allExcludesStr = JSON.stringify(allExcludesObj);
     // create or update device from exposes
     for (const deviceDef of zigbeeHerdsmanConverters.definitions) {
-        const strippedModel = (deviceDef.model) ? deviceDef.model.replace(/\0.*$/g, '').trim() : '';
+
+        const stripModel = utils.getModelRegEx(deviceDef.model);
         // check if device is mapped
-        const existsMap = byModel.get(strippedModel);
+        const existsMap = byModel.get(stripModel);
 
-        if ((deviceDef.hasOwnProperty('exposes') && (!existsMap || !existsMap.hasOwnProperty('states'))) || allExcludesStr.indexOf(strippedModel) > 0) {
+        if ((deviceDef.hasOwnProperty('exposes') && (!existsMap || !existsMap.hasOwnProperty('states'))) || allExcludesStr.indexOf(stripModel) > 0) {
             try {
-                const newDevice = createFromExposes(strippedModel, deviceDef);
+                const newDevice = createFromExposes(stripModel, deviceDef);
                 if (!existsMap) {
                     mappedDevices.push(newDevice);
-                    byModel.set(strippedModel, newDevice);
+                    byModel.set(stripModel, newDevice);
                 } else {
                     existsMap.states = newDevice.states;
                     existsMap.exposed = true;
                 }
             } catch (e) {
-                console.log(`Wrong expose devicedefinition ${deviceDef.vendor} ${deviceDef.model}` );
+                console.log(`Wrong expose devicedefinition ${deviceDef.vendor} ${deviceDef.model}`);
             }
         }
     }