iobroker.zigbee 1.5.5 → 1.6.6

package/lib/states.js

@@ -80,7 +80,7 @@ const states = {
         read: true,
         type: 'number',
         min: 0,
-        max: 254
+        max: 255
     },
     available: {
         id: 'available',
@@ -103,6 +103,15 @@ const states = {
         type: 'boolean',
         isOption: true,
     },
+    from_zigbee: {
+        id: 'msg_from_zigbee',
+        name: 'Message from Zigbee',
+        icon: undefined,
+        role: 'state',
+        write: false,
+        read: true,
+        type: 'string',
+    },
     checking: { // press button for checking
         id: 'checking',
         name: 'Start checking process',
@@ -287,7 +296,7 @@ const states = {
         prop: 'battery',
         name: 'Battery percent',
         icon: 'img/battery_p.png',
-        role: 'battery.percent',
+        role: 'value.battery',
         write: false,
         read: true,
         type: 'number',
@@ -738,7 +747,7 @@ const states = {
         prop: 'battery_low',
         name: 'Battery Status Low',
         icon: undefined,
-        role: 'state',
+        role: 'indicator.lowbat',
         write: false,
         read: true,
         type: 'boolean'
@@ -2130,7 +2139,7 @@ const states = {
         prop: 'local_temperature_calibration',
         name: 'Temperature Calibration',
         icon: undefined,
-        role: 'value.temperature',
+        role: 'level',
         write: true,
         read: true,
         type: 'number',
@@ -2343,7 +2352,7 @@ const states = {
         prop: 'pi_heating_demand',
         name: 'Auto Valve position',
         icon: undefined,
-        role: 'state',
+        role: 'value.valve',
         write: false,
         read: true,
         type: 'number',
@@ -2355,7 +2364,7 @@ const states = {
         prop: 'eurotronic_valve_position',
         name: 'Manual Valve position',
         icon: undefined,
-        role: 'state',
+        role: 'level.valve',
         write: true,
         read: true,
         type: 'number',
@@ -2370,7 +2379,7 @@ const states = {
         prop: 'current_heating_setpoint',
         name: 'Current Target Temperature',
         icon: undefined,
-        role: 'value.temperature',
+        role: 'level.temperature',
         write: true,
         read: true,
         type: 'number',
@@ -2382,10 +2391,10 @@ const states = {
         // 1 = manual valve control
         // 2 = auto (default)
         id: 'spz_trv_mode',
-        name: 'TRV Mode',
+        name: 'TRV Mode (1 = manual | 2 = auto)',
         prop: 'eurotronic_trv_mode',
         icon: undefined,
-        role: 'state',
+        role: 'level',
         write: true,
         read: true,
         type: 'number',
@@ -2402,7 +2411,7 @@ const states = {
         name: 'Thermostat Mode',
         prop: 'eurotronic_system_mode',
         icon: undefined,
-        role: 'state',
+        role: 'level',
         write: true,
         read: true,
         type: 'number',
@@ -2412,7 +2421,7 @@ const states = {
         name: 'Thermostat Error',
         prop: 'eurotronic_error_status',
         icon: undefined,
-        role: 'state',
+        role: 'value',
         write: false,
         read: true,
         type: 'number',
@@ -2422,7 +2431,7 @@ const states = {
         name: 'Window Open / Off',
         prop: 'eurotronic_host_flags',
         icon: undefined,
-        role: 'state',
+        role: 'switch',
         write: true,
         read: true,
         type: 'boolean',
@@ -2441,7 +2450,7 @@ const states = {
         name: 'Boost Mode',
         prop: 'eurotronic_host_flags',
         icon: undefined,
-        role: 'state',
+        role: 'switch.mode.boost',
         write: true,
         read: true,
         type: 'boolean',
@@ -2460,7 +2469,7 @@ const states = {
         name: 'Child Protection',
         prop: 'eurotronic_host_flags',
         icon: undefined,
-        role: 'state',
+        role: 'switch.lock',
         write: true,
         read: true,
         type: 'boolean',
@@ -2479,7 +2488,7 @@ const states = {
         name: 'Mirror Display',
         prop: 'eurotronic_host_flags',
         icon: undefined,
-        role: 'state',
+        role: 'switch',
         write: true,
         read: true,
         type: 'boolean',
@@ -2932,6 +2941,56 @@ const states = {
             return {...options, reverse_direction: value};
         },
     },
+    curtain_xiaomi_reverse_direction: {
+        id: 'reverse_direction',
+        prop: 'options',
+        name: 'Reverse direction',
+        icon: undefined,
+        role: 'state',
+        write: true,
+        read: true,
+        type: 'boolean',
+        inOptions: true,
+        getter: payload => (payload.options !== null) && payload.options.hasOwnProperty('reverse_direction') && !isNaN(payload.options.reverse_direction) ? payload.options.reverse_direction : undefined,
+        setterOpt: (value, options) => {
+            return {...options, reverse_direction: value};
+        },
+        setter: (value, options) => {
+            return {...options, reverse_direction: value};
+        },
+    },
+    curtain_xiaomi_hand_open: {
+        id: 'hand_open',
+        prop: 'options',
+        name: 'Hand open',
+        icon: undefined,
+        role: 'state',
+        write: true,
+        read: true,
+        type: 'boolean',
+        inOptions: true,
+        getter: payload => (payload.options !== null) && payload.options.hasOwnProperty('hand_open') && !isNaN(payload.options.hand_open) ? payload.options.hand_open : undefined,
+        setterOpt: (value, options) => {
+            return {...options, hand_open: value};
+        },
+        setter: (value, options) => {
+            return {...options, hand_open: value};
+        },
+    },
+    curtain_xiaomi_reset_limits: {
+        id: 'reset_limits',
+        prop: 'options',
+        name: 'Reset limits',
+        icon: undefined,
+        write: true,
+        read: true,
+        type: 'boolean',
+        getter: payload => (undefined),
+        inOptions: true,
+        setter: (value, options) => {
+            return {...options, reset_limits: value};
+        },
+    },
     blind_position: {
         id: 'position',
         prop: 'position',
@@ -4011,7 +4070,7 @@ const states = {
         prop: 'current_heating_setpoint',
         name: 'Current Target Temperature',
         icon: undefined,
-        role: 'value.temperature',
+        role: 'level.temperature',
         write: true,
         read: true,
         type: 'number',
@@ -4024,7 +4083,7 @@ const states = {
         name: 'Locked',
         prop: 'child_lock',
         icon: undefined,
-        role: 'state',
+        role: 'switch.lock',
         write: true,
         read: true,
         type: 'boolean',
@@ -4036,7 +4095,7 @@ const states = {
         name: 'Window detected',
         prop: 'window_detection',
         icon: undefined,
-        role: 'state',
+        role: 'value',
         write: false,
         read: true,
         type: 'boolean',
@@ -4047,7 +4106,7 @@ const states = {
         name: 'Valve detected',
         prop: 'valve_detection',
         icon: undefined,
-        role: 'state',
+        role: 'value',
         write: false,
         read: true,
         type: 'boolean',
@@ -4058,7 +4117,7 @@ const states = {
         name: 'Auto lock',
         prop: 'auto_lock',
         icon: undefined,
-        role: 'state',
+        role: 'value',
         write: false,
         read: true,
         type: 'boolean',
@@ -4069,7 +4128,7 @@ const states = {
         prop: 'min_temperature',
         name: 'Minimal Temperature',
         icon: undefined,
-        role: 'value.temperature',
+        role: 'level',
         write: true,
         read: true,
         type: 'number',
@@ -4082,7 +4141,7 @@ const states = {
         prop: 'max_temperature',
         name: 'Maximal Temperature',
         icon: undefined,
-        role: 'value.temperature',
+        role: 'level',
         write: true,
         read: true,
         type: 'number',
@@ -4095,7 +4154,7 @@ const states = {
         prop: 'boost_time',
         name: 'Boost time',
         icon: undefined,
-        role: 'state',
+        role: 'level',
         write: true,
         read: true,
         type: 'number',
@@ -4108,7 +4167,7 @@ const states = {
         prop: 'comfort_temperature',
         name: 'Comfort Temperature',
         icon: undefined,
-        role: 'value.temperature',
+        role: 'level',
         write: true,
         read: true,
         type: 'number',
@@ -4121,7 +4180,7 @@ const states = {
         prop: 'eco_temperature',
         name: 'ECO Temperature',
         icon: undefined,
-        role: 'value.temperature',
+        role: 'level',
         write: true,
         read: true,
         type: 'number',
@@ -4134,7 +4193,7 @@ const states = {
         name: 'Mode',
         prop: 'system_mode',
         icon: undefined,
-        role: 'state',
+        role: 'level.mode.thermostat',
         write: true,
         read: true,
         type: 'string', // valid: low, medium, high
@@ -4201,7 +4260,7 @@ const states = {
         prop: 'position',
         name: 'Valve position',
         icon: undefined,
-        role: 'state',
+        role: 'value.valve',
         write: false,
         read: true,
         type: 'number',

package/lib/statescontroller.js

@@ -31,6 +31,10 @@ class StatesController extends EventEmitter {
         this.emit('log', 'warn', message, data);
     }
 
+    sendError(error, message) {
+        this.adapter.sendError(error, message);
+    }
+
     getDebugDevices() {
         this.debugDevices = [];
         this.adapter.getState(this.adapter.namespace + '.info.debugmessages', (err, state) => {
@@ -54,6 +58,7 @@ class StatesController extends EventEmitter {
 
     }
     onStateChange(id, state){
+        if (!this.adapter.zbController || !this.adapter.zbController.connected()) return;
         if (this.debugDevices === undefined) this.getDebugDevices();
         if (state && !state.ack) {
             if (id.endsWith('pairingCountdown') || id.endsWith('pairingMessage') || id.endsWith('connection')) return;
@@ -137,9 +142,10 @@ class StatesController extends EventEmitter {
                 stateModel = statesMapping.findModel(model);
                 if (!stateModel) {
                     this.error('Device ' + deviceId + ' "' + model + '" not described in statesMapping.');
-                    return;
+                    states = statesMapping.commonStates;
+                } else {
+                    states = stateModel.states;
                 }
-                states = stateModel.states;
                 if (typeof states === 'function' && !states.prototype) {
                     const entity = await this.adapter.zbController.resolveEntity(deviceId);
                     if (entity)
@@ -148,6 +154,7 @@ class StatesController extends EventEmitter {
             }
             return {states: states, stateModel: stateModel};
         } catch (error) {
+            this.sendError(error);
             this.error(`Error getDevStates for ${deviceId}. Error: ${error.stack}`);
         }
     }
@@ -191,6 +198,7 @@ class StatesController extends EventEmitter {
                         this.warn('publish from State - LinkedState is not a function ' + JSON.stringify(linkedFunct));
                     }
                 } catch (e) {
+                    this.sendError(e);
                     this.error('Exception caught in publishfromstate');
                 }
 

package/lib/utils.js

@@ -114,6 +114,24 @@ const forceEndDevice = flatten(
 const xiaomiManufacturerID = [4151, 4447];
 const ikeaTradfriManufacturerID = [4476];
 
+function sanitizeImageParameter(parameter) {
+    const replaceByDash = [/\?/g, /&/g, /[^a-z\d\-_./:]/gi, /[/]/gi];
+    let sanitized = parameter;
+    replaceByDash.forEach((r) => sanitized = sanitized.replace(r, '-'));
+    return sanitized;
+}
+
+function getDeviceIcon(definition) {
+    let icon = definition.icon;
+    if (icon) {
+        icon = icon.replace('${model}', sanitizeImageParameter(definition.model));
+    }
+    if (!icon) {
+        icon = `https://www.zigbee2mqtt.io/images/devices/${sanitizeImageParameter(definition.model)}.jpg`;
+    }
+    return icon;
+}
+
 exports.secondsToMilliseconds   = (seconds) => seconds * 1000;
 exports.bulbLevelToAdapterLevel = bulbLevelToAdapterLevel;
 exports.adapterLevelToBulbLevel = adapterLevelToBulbLevel;
@@ -130,3 +148,4 @@ exports.isXiaomiDevice          = (device) => {
             (!device.manufacturerName || !device.manufacturerName.startsWith('Trust'));
 };
 exports.isIkeaTradfriDevice     = (device) => ikeaTradfriManufacturerID.includes(device.manufacturerID);
+exports.getDeviceIcon            = getDeviceIcon;

package/lib/zbBaseExtension.js

@@ -22,6 +22,10 @@ class BaseExtension {
     debug(message, data) {
         this.zigbee.debug(message, data);
     }
+
+    sendError(error, message) {
+        this.zigbee.sendError(error, message);
+    }
 }
 
 module.exports = BaseExtension;

package/lib/zbDelayedAction.js

@@ -49,6 +49,7 @@ class DelayedAction extends BaseExtension {
             //     }
             // }
         } catch (error) {
+            this.sendError(error);
             this.error(
                 `Failed to DelayedAction.onZigbeeStarted (${error.stack})`,
             );
@@ -62,6 +63,7 @@ class DelayedAction extends BaseExtension {
             this.doActions(device);
             // }
         } catch (error) {
+            this.sendError(error);
             this.error(
                 `Failed to DelayedAction.onZigbeeEvent (${error.stack})`,
             );
@@ -80,6 +82,7 @@ class DelayedAction extends BaseExtension {
             this.debug(`Succesfully delay action for ${device.ieeeAddr} ${device.modelID}`);
             this.doActions(device);
         } catch (error) {
+            this.sendError(error);
             this.error(
                 `Failed to DelayedAction.delayAction ${device.ieeeAddr} ${device.modelID} (${error.stack})`,
             );
@@ -119,6 +122,7 @@ class DelayedAction extends BaseExtension {
                     this.info(`Do action succesfully ${device.ieeeAddr} ${device.modelID}`);
                     toDelete.push(actionDef);
                 } catch (error) {
+                    this.sendError(error);
                     this.error(
                         `Failed to do action ${device.ieeeAddr} ${device.modelID}, ` +
                         `attempt ${actionDef.attempts + 1} (${error.stack})`,
@@ -136,6 +140,7 @@ class DelayedAction extends BaseExtension {
                 delete this.actions[device.ieeeAddr];
             }
         } catch (error) {
+            this.sendError(error);
             this.error(
                 `Failed to DelayedAction.doAction ${device.ieeeAddr} ${device.modelID} (${error.stack})`,
             );

package/lib/zbDeviceAvailability.js

@@ -159,6 +159,7 @@ class DeviceAvailability extends BaseExtension {
                 }
             }
             catch (error) {
+                this.sendError(error);
                 this.debug(`Exception in readState of '${device.ieeeAddr}' - error : '${error}'`);
                 // intentionally empty: Just present to ensure we cause no harm
                 // when reading the state fails. => fall back on standard Ping function
@@ -236,6 +237,7 @@ class DeviceAvailability extends BaseExtension {
                     }
                 }
             } catch (error) {
+                this.sendError(error);
                 this.debug(`Failed to read state of '${entity.device.ieeeAddr}' after reconnect`);
             }
         }

package/lib/zbDeviceConfigure.js

@@ -29,15 +29,13 @@ class DeviceConfigure extends BaseExtension {
         if (!device || !mappedDevice) {
             return false;
         }
-        if (device.meta.hasOwnProperty('configured') &&
-            zigbeeHerdsmanConverters.getConfigureKey(mappedDevice)) {
+        if (!mappedDevice || !mappedDevice.configure) {
             return false;
         }
-
-        if (!mappedDevice || !mappedDevice.configure) {
+        if (device.meta.hasOwnProperty('configured') &&
+            zigbeeHerdsmanConverters.getConfigureKey(mappedDevice)) {
             return false;
         }
-
         if (device.interviewing === true) {
             return false;
         }
@@ -64,6 +62,7 @@ class DeviceConfigure extends BaseExtension {
                 }
             }
         } catch (error) {
+            this.sendError(error);
             this.error(
                 `Failed to DeviceConfigure.onZigbeeStarted (${error.stack})`,
             );
@@ -77,6 +76,7 @@ class DeviceConfigure extends BaseExtension {
                 this.configure(device, mappedDevice);
             }
         } catch (error) {
+            this.sendError(error);
             this.error(
                 `Failed to DeviceConfigure.onZigbeeEvent (${error.stack})`,
             );
@@ -93,6 +93,7 @@ class DeviceConfigure extends BaseExtension {
                 delete this.attempts[device.ieeeAddr];
             }
         } catch (error) {
+            this.sendError(error);
             this.error(
                 `Failed to DeviceConfigure.onDeviceRemove (${error.stack})`,
             );
@@ -126,6 +127,7 @@ class DeviceConfigure extends BaseExtension {
                 device.meta.configured = zigbeeHerdsmanConverters.getConfigureKey(mappedDevice);
                 device.save();
             } catch (error) {
+                this.sendError(error);
                 this.warn(
                     `DeviceConfigure failed ${device.ieeeAddr} ${device.modelID}, ` +
                     `attempt ${this.attempts[device.ieeeAddr] + 1} (${error.stack})`,
@@ -135,6 +137,7 @@ class DeviceConfigure extends BaseExtension {
 
             this.configuring.delete(device.ieeeAddr);
         } catch (error) {
+            this.sendError(error);
             this.error(
                 `Failed to DeviceConfigure.configure ${device.ieeeAddr} ${device.modelID} (${error.stack})`,
             );