zigbee-herdsman-converters 15.0.0 → 15.0.2

package/README.md

@@ -23,6 +23,8 @@ If any of those commands finish with an error your PR won't pass the tests and w
 
 ## Documentation of definition meta property
 - `multiEndpoint`: enables the multi endpoint functionallity in e.g. fromZigbee.on_off, example: normally this converter would return {"state": "OFF"}, when multiEndpoint is enabled the 'endpoint' method of the device definition will be called to determine the endpoint name which is then used as key e.g. {"state_left": "OFF"}. Only needed when device sends the same attribute from multiple endpoints. (default: false)
+- `multiEndpointSkip`: array of attributes to not suffix with the endpoint name
+- `multiEndpointEnforce`: enforce a certain endpoint for an attribute, e.g. {"power": 4} see utils.enforceEndpoint()
 - `disableDefaultResponse`: used by toZigbee converters to disable the default response of some devices as they don't provide one. (default: false)
 - `applyRedFix`: see toZigbee.light_color (default: false)
 - `enhancedHue`: see toZigbee.light_color (default: true)

package/converters/toZigbee.js

@@ -1526,13 +1526,13 @@ const converters = {
     metering_power: {
         key: ['power'],
         convertGet: async (entity, key, meta) => {
-            await entity.read('seMetering', ['instantaneousDemand']);
+            await utils.enforceEndpoint(entity, key, meta).read('seMetering', ['instantaneousDemand']);
         },
     },
     currentsummdelivered: {
         key: ['energy'],
         convertGet: async (entity, key, meta) => {
-            await entity.read('seMetering', ['currentSummDelivered']);
+            await utils.enforceEndpoint(entity, key, meta).read('seMetering', ['currentSummDelivered']);
         },
     },
     frequency: {
@@ -5515,6 +5515,9 @@ const converters = {
                 } else if (attribute === 'brightness') {
                     extensionfieldsets.push({'clstId': 8, 'len': 1, 'extField': [val]});
                     state['brightness'] = val;
+                } else if (attribute === 'position') {
+                    extensionfieldsets.push({'clstId': 258, 'len': 1, 'extField': [val]});
+                    state['position'] = val;
                 } else if (attribute === 'color_temp') {
                     /*
                      * ZCL version 7 added support for ColorTemperatureMireds

package/devices/danfoss.js

@@ -56,14 +56,28 @@ module.exports = [
                   'to occupied_heating_setpoint it does not trigger an aggressive response from the actuator. ' +
                   '(more suitable for scheduled changes)'),
             exposes.numeric('external_measured_room_sensor', ea.ALL)
-                .withDescription('If `radiator_covered` is `true`: Set at maximum 30 minutes interval but not more often than every ' +
-                '5 minutes and 0.1 degrees difference. Resets every 35 minutes to standard. If `radiator_covered` is `false`: ' +
-                'Set at maximum 3 hours interval but not more often than every 30 minutes and 0.1 degrees difference. ' +
-                'Resets every 3 hours to standard. Value 21C = 2100 (-8000=undefined).')
+                .withDescription('The temperature sensor of the TRV is — due to its design — relatively close to the heat source ' +
+                    '(i.e. the hot water in the radiator). Thus there are situations where the `local_temperature` measured by the ' +
+                    'TRV is not accurate enough: If the radiator is covered behind curtains or furniture, if the room is rather big, or ' +
+                    'if the radiator itself is big and the flow temperature is high, then the temperature in the room may easily diverge ' +
+                    'from the `local_temperature` measured by the TRV by 5°C to 8°C. In this case you might choose to use an external ' +
+                    'room sensor and send the measured value of the external room sensor to the `External_measured_room_sensor` property.' +
+                    'The way the TRV operates on the `External_measured_room_sensor` depends on the setting of the `Radiator_covered` ' +
+                    'property: If `Radiator_covered` is `true` (Auto Offset Mode): You *must* set the `External_measured_room_sensor` ' +
+                    'property *at least* every 3 hours. After 3 hours the TRV disables this function and resets the value of the ' +
+                    '`External_measured_room_sensor` property to -8000 (disabled). You *should* set the `External_measured_room_sensor` ' +
+                    'property *at most* every 30 minutes or every 0.1K change in measured room temperature.' +
+                    'If `Radiator_covered` is `false` (Room Sensor Mode): You *must* set the `External_measured_room_sensor` property at ' +
+                    'least every 30 minutes. After 35 minutes the TRV disables this function and resets the value of the ' +
+                    '`External_measured_room_sensor` property to -8000 (disabled). You *should* set the `External_measured_room_sensor` ' +
+                    'property *at most* every 5 minutes or every 0.1K change in measured room temperature.')
                 .withValueMin(-8000).withValueMax(3500),
             exposes.binary('radiator_covered', ea.ALL, true, false)
-                .withDescription('Set if the TRV should solely rely on external_measured_room_sensor or operate in offset mode. ' +
-                    '`false` = Auto Offset Mode or `true` = Room Sensor Mode'),
+                .withDescription('Controls whether the TRV should solely rely on an external room sensor or operate in offset mode. ' +
+                '`false` = Auto Offset Mode (use this e.g. for exposed radiators) or `true` = Room Sensor Mode (use this e.g. for ' +
+                'covered radiators). Please note that this flag only controls how the TRV operates on the value of ' +
+                '`External_measured_room_sensor`; only setting this flag without setting the `External_measured_room_sensor` ' +
+                'has no (noticable?) effect.'),
             exposes.binary('window_open_feature', ea.ALL, true, false)
                 .withDescription('Whether or not the window open feature is enabled'),
             exposes.numeric('window_open_internal', ea.STATE_GET).withValueMin(0).withValueMax(4)

package/devices/ewelink.js

@@ -20,6 +20,21 @@ module.exports = [
             device.skipDefaultResponse = true;
         },
     },
+    {
+        zigbeeModel: ['SA-030-1'],
+        model: 'SA-030-1',
+        vendor: 'eWeLink',
+        description: 'Zigbee 3.0 smart plug 13A (3120W)(UK version)',
+        extend: extend.switch(),
+        fromZigbee: [fz.on_off_skip_duplicate_transaction],
+        configure: async (device, coordinatorEndpoint, logger) => {
+            const endpoint = device.getEndpoint(1);
+            await reporting.bind(endpoint, coordinatorEndpoint, ['genOnOff']);
+        },
+        onEvent: async (type, data, device) => {
+            device.skipDefaultResponse = true;
+        },
+    },
     {
         zigbeeModel: ['SWITCH-ZR02'],
         model: 'SWITCH-ZR02',

package/devices/nue_3a.js

@@ -257,7 +257,7 @@ module.exports = [
         model: 'HGZB-02A',
         vendor: 'Nue / 3A',
         description: 'Smart light controller',
-        extend: extend.light_onoff_brightness(),
+        extend: extend.light_onoff_brightness({disablePowerOnBehavior: true}),
     },
     {
         zigbeeModel: ['FNB56-ZSW01LX2.0'],

package/devices/philips.js

@@ -404,6 +404,13 @@ module.exports = [
         description: 'Hue Iris copper special edition (generation 4) ',
         extend: hueExtend.light_onoff_brightness_colortemp_color({colorTempRange: [153, 500]}),
     },
+    {
+        zigbeeModel: ['929002376803'],
+        model: '929002376803',
+        vendor: 'Philips',
+        description: 'Hue Iris copper special edition (generation 4)',
+        extend: hueExtend.light_onoff_brightness_colortemp_color({colorTempRange: [153, 500]}),
+    },
     {
         zigbeeModel: ['5063130P7'],
         model: '5063130P7',
@@ -565,6 +572,13 @@ module.exports = [
         description: 'Hue Go portable light',
         extend: hueExtend.light_onoff_brightness_colortemp({colorTempRange: [153, 500]}),
     },
+    {
+        zigbeeModel: ['7602031K6'],
+        model: '7602031K6',
+        vendor: 'Philips',
+        description: 'Hue Go portable light',
+        extend: hueExtend.light_onoff_brightness_colortemp({colorTempRange: [153, 500]}),
+    },
     {
         zigbeeModel: ['LLC020'],
         model: '7146060PH',

package/devices/tuya.js

@@ -2047,6 +2047,8 @@ module.exports = [
             {modelID: 'TS0601', manufacturerName: '_TZE200_cpmgn2cf'},
             {modelID: 'TS0601', manufacturerName: '_TZE200_4eeyebrt'}, // Immax 07732B
             {modelID: 'TS0601', manufacturerName: '_TZE200_8whxpsiw'}, // EVOLVEO
+            {modelID: 'TS0601', manufacturerName: '_TZE200_xby0s3ta'}, // Sandy Beach HY367
+            {modelID: 'TS0601', manufacturerName: '_TZE200_7fqkphoq'}, // AFINTEK
         ],
         model: 'TS0601_thermostat',
         vendor: 'TuYa',

package/devices/ubisys.js

@@ -536,18 +536,23 @@ module.exports = [
         model: 'S1',
         vendor: 'Ubisys',
         description: 'Power switch S1',
-        exposes: [e.switch(), e.power().withAccess(ea.STATE_GET).withEndpoint('meter').withProperty('power'),
+        exposes: [
+            e.switch(),
             e.action([
                 'toggle', 'on', 'off', 'recall_*',
                 'brightness_move_up', 'brightness_move_down', 'brightness_stop',
             ]),
-            e.power_on_behavior(), e.energy()],
+            e.power_on_behavior(),
+            e.power().withAccess(ea.STATE_GET),
+            e.energy().withAccess(ea.STATE_GET),
+        ],
         fromZigbee: [fz.on_off, fz.metering, fz.command_toggle, fz.command_on, fz.command_off, fz.command_recall, fz.command_move,
             fz.command_stop, fz.power_on_behavior, ubisys.fz.configure_device_setup],
-        toZigbee: [tz.on_off, tz.metering_power, ubisys.tz.configure_device_setup, tz.power_on_behavior],
+        toZigbee: [tz.on_off, tz.metering_power, tz.currentsummdelivered, ubisys.tz.configure_device_setup, tz.power_on_behavior],
         endpoint: (device) => {
             return {'l1': 1, 's1': 2, 'meter': 3};
         },
+        meta: {multiEndpointEnforce: {'power': 3, 'energy': 3}},
         configure: async (device, coordinatorEndpoint, logger) => {
             const endpoint = device.getEndpoint(3);
             await reporting.bind(endpoint, coordinatorEndpoint, ['seMetering']);
@@ -580,15 +585,20 @@ module.exports = [
         model: 'S1-R',
         vendor: 'Ubisys',
         description: 'Power switch S1-R',
-        exposes: [e.switch(), e.power().withAccess(ea.STATE_GET).withEndpoint('meter').withProperty('power'),
+        exposes: [
+            e.switch(),
             e.action([
                 'toggle', 'on', 'off', 'recall_*',
                 'brightness_move_up', 'brightness_move_down', 'brightness_stop',
             ]),
-            e.power_on_behavior(), e.energy()],
+            e.power_on_behavior(),
+            e.power().withAccess(ea.STATE_GET),
+            e.energy().withAccess(ea.STATE_GET),
+        ],
         fromZigbee: [fz.on_off, fz.metering, fz.command_toggle, fz.command_on, fz.command_off, fz.command_recall, fz.command_move,
             fz.command_stop, fz.power_on_behavior, ubisys.fz.configure_device_setup],
-        toZigbee: [tz.on_off, tz.metering_power, ubisys.tz.configure_device_setup, tz.power_on_behavior],
+        toZigbee: [tz.on_off, tz.metering_power, tz.currentsummdelivered, ubisys.tz.configure_device_setup, tz.power_on_behavior],
+        meta: {multiEndpointEnforce: {'power': 4, 'energy': 4}},
         endpoint: (device) => {
             return {'l1': 1, 's1': 2, 'meter': 4};
         },
@@ -625,20 +635,23 @@ module.exports = [
         vendor: 'Ubisys',
         description: 'Power switch S2',
         exposes: [
-            e.switch().withEndpoint('l1'), e.switch().withEndpoint('l2'),
-            e.power().withAccess(ea.STATE_GET).withEndpoint('meter').withProperty('power'),
-            e.energy(),
+            e.switch().withEndpoint('l1'),
+            e.switch().withEndpoint('l2'),
             e.action(['toggle_s1', 'toggle_s2', 'on_s1', 'on_s2', 'off_s1', 'off_s2', 'recall_*_s1', 'recal_*_s2', 'brightness_move_up_s1',
                 'brightness_move_up_s2', 'brightness_move_down_s1', 'brightness_move_down_s2', 'brightness_stop_s1',
                 'brightness_stop_s2']),
-            e.power_on_behavior().withEndpoint('l1'), e.power_on_behavior().withEndpoint('l2')],
+            e.power_on_behavior().withEndpoint('l1'),
+            e.power_on_behavior().withEndpoint('l2'),
+            e.power().withAccess(ea.STATE_GET),
+            e.energy().withAccess(ea.STATE_GET),
+        ],
         fromZigbee: [fz.on_off, fz.metering, fz.command_toggle, fz.command_on, fz.command_off, fz.command_recall, fz.command_move,
             fz.command_stop, fz.power_on_behavior, ubisys.fz.configure_device_setup],
-        toZigbee: [tz.on_off, tz.metering_power, ubisys.tz.configure_device_setup, tz.power_on_behavior],
+        toZigbee: [tz.on_off, tz.metering_power, ubisys.tz.configure_device_setup, tz.power_on_behavior, tz.currentsummdelivered],
         endpoint: (device) => {
             return {'l1': 1, 'l2': 2, 's1': 3, 's2': 4, 'meter': 5};
         },
-        meta: {multiEndpoint: true},
+        meta: {multiEndpoint: true, multiEndpointEnforce: {'power': 5, 'energy': 5}},
         configure: async (device, coordinatorEndpoint, logger) => {
             const endpoint = device.getEndpoint(5);
             await reporting.bind(endpoint, coordinatorEndpoint, ['seMetering']);
@@ -684,7 +697,7 @@ module.exports = [
             ubisys.fz.dimmer_setup_genLevelCtrl, ubisys.fz.configure_device_setup],
         toZigbee: [tz.light_onoff_brightness, tz.ballast_config, tz.level_config, ubisys.tz.dimmer_setup,
             ubisys.tz.dimmer_setup_genLevelCtrl, ubisys.tz.configure_device_setup, tz.ignore_transition, tz.light_brightness_move,
-            tz.light_brightness_step],
+            tz.light_brightness_step, tz.metering_power, tz.currentsummdelivered],
         exposes: [
             e.action(['toggle_s1', 'toggle_s2', 'on_s1', 'on_s2', 'off_s1', 'off_s2', 'recall_*_s1', 'recal_*_s2', 'brightness_move_up_s1',
                 'brightness_move_up_s2', 'brightness_move_down_s1', 'brightness_move_down_s2', 'brightness_stop_s1',
@@ -704,7 +717,8 @@ module.exports = [
                     .withValueMin(1).withValueMax(254)
                     .withPreset('previous', 255, 'Use previous value')
                     .withDescription('Specifies the initial level to be applied after the device is supplied with power')),
-            e.power(), e.energy(),
+            e.power().withAccess(ea.STATE_GET),
+            e.energy().withAccess(ea.STATE_GET),
             exposes.numeric('ballast_minimum_level', ea.ALL).withValueMin(1).withValueMax(254)
                 .withDescription('Specifies the minimum light output of the ballast'),
             exposes.numeric('ballast_maximum_level', ea.ALL).withValueMin(1).withValueMax(254)
@@ -748,7 +762,7 @@ module.exports = [
             await reporting.readMeteringMultiplierDivisor(endpoint);
             await reporting.instantaneousDemand(endpoint);
         },
-        meta: {multiEndpoint: true, multiEndpointSkip: ['state', 'brightness']},
+        meta: {multiEndpoint: true, multiEndpointSkip: ['state', 'brightness'], multiEndpointEnforce: {'power': 4, 'energy': 4}},
         endpoint: (device) => {
             return {'default': 1, 's1': 2, 's2': 3, 'meter': 4};
         },
@@ -777,9 +791,13 @@ module.exports = [
         description: 'Shutter control J1',
         fromZigbee: [fz.cover_position_tilt, fz.metering, ubisys.fz.configure_device_setup],
         toZigbee: [tz.cover_state, tz.cover_position_tilt, tz.metering_power,
-            ubisys.tz.configure_j1, ubisys.tz.configure_device_setup],
-        exposes: [e.cover_position_tilt(),
-            e.power().withAccess(ea.STATE_GET).withEndpoint('meter').withProperty('power'), e.energy()],
+            ubisys.tz.configure_j1, ubisys.tz.configure_device_setup,
+            tz.currentsummdelivered],
+        exposes: [
+            e.cover_position_tilt(),
+            e.power().withAccess(ea.STATE_GET),
+            e.energy().withAccess(ea.STATE_GET),
+        ],
         configure: async (device, coordinatorEndpoint, logger) => {
             const endpoint1 = device.getEndpoint(1);
             const endpoint3 = device.getEndpoint(3);
@@ -792,6 +810,7 @@ module.exports = [
         endpoint: (device) => {
             return {'default': 1, 'meter': 3};
         },
+        meta: {multiEndpointEnforce: {'power': 3, 'energy': 3}},
         onEvent: async (type, data, device) => {
             /*
              * As per technical doc page 21 section 7.3.4

package/devices/woolley.js

@@ -14,16 +14,4 @@ module.exports = [
             await reporting.onOff(endpoint);
         },
     },
-    {
-        zigbeeModel: ['SA-030-1'],
-        model: 'SA-030',
-        vendor: 'Woolley',
-        description: 'Smart plug',
-        extend: extend.switch(),
-        configure: async (device, coordinatorEndpoint, logger) => {
-            const endpoint = device.getEndpoint(1);
-            await reporting.bind(endpoint, coordinatorEndpoint, ['genOnOff']);
-            await reporting.onOff(endpoint);
-        },
-    },
 ];

package/lib/utils.js

@@ -125,6 +125,7 @@ function postfixWithEndpointName(value, msg, definition, meta) {
         meta.logger.warn(`No meta passed to postfixWithEndpointName, update your external converter!`);
         meta = {device: null};
     }
+
     if (definition.meta && definition.meta.multiEndpoint &&
             (!definition.meta.multiEndpointSkip || !definition.meta.multiEndpointSkip.includes(value))) {
         const endpointName = definition.hasOwnProperty('endpoint') ?
@@ -137,6 +138,15 @@ function postfixWithEndpointName(value, msg, definition, meta) {
     return value;
 }
 
+function enforceEndpoint(entity, key, meta) {
+    const multiEndpointEnforce = getMetaValue(entity, meta.mapped, 'multiEndpointEnforce', 'allEqual', []);
+    if (multiEndpointEnforce && multiEndpointEnforce.hasOwnProperty(key)) {
+        const endpoint = entity.getDevice().getEndpoint(multiEndpointEnforce[key]);
+        if (endpoint) return endpoint;
+    }
+    return entity;
+}
+
 function getKey(object, value, fallback, convertTo) {
     for (const key in object) {
         if (object[key]===value) {
@@ -448,6 +458,7 @@ module.exports = {
     toPercentage,
     addActionGroup,
     postfixWithEndpointName,
+    enforceEndpoint,
     getKey,
     getObjectProperty,
     batteryVoltageToPercentage,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zigbee-herdsman-converters",
-  "version": "15.0.0",
+  "version": "15.0.2",
   "description": "Collection of device converters to be used with zigbee-herdsman",
   "main": "index.js",
   "files": [