zigbee-herdsman-converters 14.0.633 → 14.0.635

package/devices/tuya.js

@@ -908,7 +908,8 @@ module.exports = [
             {modelID: 'TS0505B', manufacturerName: '_TZ3210_6amjviba'},
             {modelID: 'TS0505B', manufacturerName: '_TZ3000_xr5m6kfg'},
             {modelID: 'TS0505B', manufacturerName: '_TZ3210_xr5m6kfg'},
-            {modelID: 'TS0505B', manufacturerName: '_TZ3210_bf175wi4'}],
+            {modelID: 'TS0505B', manufacturerName: '_TZ3210_bf175wi4'},
+            {modelID: 'TS0505B', manufacturerName: '_TZB210_3zfp8mki'}],
         model: 'TS0505B',
         vendor: 'TuYa',
         description: 'Zigbee RGB+CCT light',
@@ -1138,8 +1139,6 @@ module.exports = [
             {modelID: 'TS0601', manufacturerName: '_TZE200_ojzhk75b'},
             {modelID: 'TS0601', manufacturerName: '_TZE200_swaamsoy'},
             {modelID: 'TS0601', manufacturerName: '_TZE200_3p5ydos3'},
-            {modelID: 'TS0601', manufacturerName: '_TZE200_1agwnems'},
-            {modelID: 'TS0601', manufacturerName: '_TZE200_ip2akl4w'},
         ],
         model: 'TS0601_dimmer',
         vendor: 'TuYa',
@@ -1163,6 +1162,27 @@ module.exports = [
             {vendor: 'Moes', model: 'EDM-1ZBB-EU'},
         ],
     },
+    {
+        fingerprint: tuya.fingerprint('TS0601', ['_TZE200_ip2akl4w', '_TZE200_1agwnems']),
+        model: 'TS0601_dimmer_1',
+        vendor: 'TuYa',
+        description: 'Zigbee smart dimmer',
+        fromZigbee: [tuya.fzDataPoints],
+        toZigbee: [tuya.tzDataPoints],
+        configure: tuya.configureMagicPacket,
+        exposes: [tuya.exposes.lightBrightnessWithMinMax, tuya.exposes.powerOnBehavior, tuya.exposes.countdown, tuya.exposes.lightType],
+        meta: {
+            tuyaDatapoints: [
+                [1, 'state', tuya.valueConverter.onOff, {skip: tuya.skip.stateOnAndBrightnessPresent}],
+                [2, 'brightness', tuya.valueConverter.scale0_254to0_1000],
+                [3, 'min_brightness', tuya.valueConverter.scale0_254to0_1000],
+                [4, 'light_type', tuya.valueConverter.lightType],
+                [5, 'max_brightness', tuya.valueConverter.scale0_254to0_1000],
+                [6, 'countdown', tuya.valueConverter.countdown],
+                [14, 'power_on_behavior', tuya.valueConverter.powerOnBehavior],
+            ],
+        },
+    },
     {
         fingerprint: [{modelID: 'TS011F', manufacturerName: '_TZ3000_oiymh3qu'}],
         model: 'TS011F_socket_module',

package/lib/tuya.js

@@ -2,6 +2,10 @@
 
 const constants = require('./constants');
 const globalStore = require('./store');
+const exposes = require('./exposes');
+const utils = require('./utils');
+const e = exposes.presets;
+const ea = exposes.access;
 
 const dataTypes = {
     raw: 0, // [ bytes ]
@@ -1131,7 +1135,132 @@ async function sendDataPointStringBuffer(entity, dp, value, cmd, seq=undefined)
     );
 }
 
+const tuyaExposes = {
+    powerOnBehavior: exposes.enum('power_on_behavior', ea.STATE_SET, ['off', 'on', 'previous'])
+        .withDescription('Controls the behavior when the device is powered on'),
+    lightType: exposes.enum('light_type', ea.STATE_SET, ['led', 'incandescent', 'halogen'])
+        .withDescription('Type of light attached to the device'),
+    lightBrightnessWithMinMax: e.light_brightness().withMinBrightness().withMaxBrightness().setAccess(
+        'state', ea.STATE_SET).setAccess('brightness', ea.STATE_SET).setAccess(
+        'min_brightness', ea.STATE_SET).setAccess('max_brightness', ea.STATE_SET),
+    countdown: exposes.numeric('countdown', ea.STATE_SET).withValueMin(0).withValueMax(43200).withValueStep(1).withUnit('s')
+        .withDescription('Countdown to turn device off after a certain time'),
+};
+
+const skip = {
+    // Prevent state from being published when already ON and brightness is also published.
+    // This prevents 100% -> X% brightness jumps when the switch is already on
+    // https://github.com/Koenkk/zigbee2mqtt/issues/13800#issuecomment-1263592783
+    stateOnAndBrightnessPresent: (meta) => meta.message.hasOwnProperty('brightness') && meta.state.state === 'ON',
+};
+
+const configureMagicPacket = async (device, coordinatorEndpoint, logger) => {
+    const endpoint = device.endpoints[0];
+    await endpoint.read('genBasic', ['manufacturerName', 'zclVersion', 'appVersion', 'modelId', 'powerSource', 0xfffe]);
+};
+
+const fingerprint = (modelID, manufacturerNames) => {
+    return manufacturerNames.map((manufacturerName) => {
+        return {modelID, manufacturerName};
+    });
+};
+
+const valueConverterBasic = {
+    lookup: (map) => {
+        return {
+            to: (v) => {
+                if (map[v] === undefined) throw new Error(`Value '${v}' is not allowed, expected one of ${Object.keys(map)}`);
+                return map[v];
+            },
+            from: (v) => {
+                const value = Object.entries(map).find((i) => i[1] === v);
+                if (!value) throw new Error(`Value '${v}' is not allowed, expected one of ${Object.values(map)}`);
+                return value[0];
+            },
+        };
+    },
+    scale: (min1, max1, min2, max2) => {
+        return {to: (v) => utils.mapNumberRange(v, min1, max1, min2, max2), from: (v) => utils.mapNumberRange(v, min2, max2, min1, max1)};
+    },
+    raw: () => {
+        return {to: (v) => v, from: (v) => v};
+    },
+    divideBy: (value) => {
+        return {to: (v) => v * value, from: (v) => v / value};
+    },
+};
+
+const valueConverter = {
+    trueFalse: valueConverterBasic.lookup({1: true, 0: false}),
+    onOff: valueConverterBasic.lookup({'ON': true, 'OFF': false}),
+    powerOnBehavior: valueConverterBasic.lookup({'off': 0, 'on': 1, 'previous': 2}),
+    lightType: valueConverterBasic.lookup({'led': 0, 'incandescent': 1, 'halogen': 2}),
+    countdown: valueConverterBasic.raw(),
+    scale0_254to0_1000: valueConverterBasic.scale(0, 254, 0, 1000),
+    scale0_1to0_1000: valueConverterBasic.scale(0, 1, 0, 1000),
+    divideBy100: valueConverterBasic.divideBy(100),
+};
+
+const tzDataPoints = {
+    key: ['state', 'brightness', 'min_brightness', 'max_brightness', 'power_on_behavior', 'countdown', 'light_type'],
+    convertSet: async (entity, key, value, meta) => {
+        // A set converter is only called once; therefore we need to loop
+        const state = {};
+        if (!meta.mapped.meta || !meta.mapped.meta.tuyaDatapoints) throw new Error('No datapoints map defined');
+        const datapoints = meta.mapped.meta.tuyaDatapoints;
+        for (const [key, value] of Object.entries(meta.message)) {
+            const convertedKey = meta.mapped.meta.multiEndpoint ? `${key}_${meta.endpoint_name}` : key;
+            const dpEntry = datapoints.find((d) => d[1] === convertedKey);
+            if (!dpEntry || !dpEntry[1]) {
+                throw new Error(`No datapoint defined for '${key}'`);
+            }
+            if (dpEntry[3] && dpEntry[3].skip && dpEntry[3].skip(meta)) continue;
+            const dpId = dpEntry[0];
+            const convertedValue = dpEntry[2].to(value);
+            if (typeof convertedValue === 'boolean') {
+                await sendDataPointBool(entity, dpId, convertedValue, 'dataRequest', 1);
+            } else if (typeof convertedValue === 'number') {
+                await sendDataPointValue(entity, dpId, convertedValue, 'dataRequest', 1);
+            } else {
+                throw new Error(`Don't know how to send type '${typeof convertedValue}'`);
+            }
+            state[convertedKey] = value;
+        }
+        return {state};
+    },
+};
+
+const fzDataPoints = {
+    cluster: 'manuSpecificTuya',
+    type: ['commandDataResponse', 'commandDataReport'],
+    convert: (model, msg, publish, options, meta) => {
+        const result = {};
+        if (!model.meta || !model.meta.tuyaDatapoints) throw new Error('No datapoints map defined');
+        const datapoints = model.meta.tuyaDatapoints;
+        for (const dpValue of msg.data.dpValues) {
+            const dpId = dpValue.dp;
+            const dpEntry = datapoints.find((d) => d[0] === dpId);
+            if (dpEntry) {
+                const value = getDataValue(dpValue);
+                result[dpEntry[1]] = dpEntry[2].from(value);
+            } else {
+                meta.logger.warn(`Datapoint ${dpId} not defined for '${meta.device.manufacturerName}' ` +
+                    `with data ${JSON.stringify(dpValue)}`);
+            }
+        }
+        return result;
+    },
+};
+
 module.exports = {
+    exposes: tuyaExposes,
+    skip,
+    configureMagicPacket,
+    fingerprint,
+    valueConverterBasic,
+    valueConverter,
+    tzDataPoints,
+    fzDataPoints,
     sendDataPoint,
     sendDataPoints,
     sendDataPointValue,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zigbee-herdsman-converters",
-  "version": "14.0.633",
+  "version": "14.0.635",
   "description": "Collection of device converters to be used with zigbee-herdsman",
   "main": "index.js",
   "files": [
@@ -38,7 +38,7 @@
     "buffer-crc32": "^0.2.13",
     "https-proxy-agent": "^5.0.1",
     "tar-stream": "^2.2.0",
-    "zigbee-herdsman": "^0.14.59"
+    "zigbee-herdsman": "^0.14.62"
   },
   "devDependencies": {
     "eslint": "*",