feat(add): LYWSD03MMC-z, CGDK2, TS0201-z (#7457)

* ZigbeeTLc firmware devices support * modernExtend, cleanup * Fallback to default configure() * Updated models not to conflict with existing device models * Update zigbeetlc.ts --------- Co-authored-by: Rob van Oostenrijk <robvanoostenrijk@noreply.users.github.com> Co-authored-by: Koen Kanters <koenkanters94@gmail.com>
Koenkk · May 1, 2024 · cb6dd3e · cb6dd3e
1 parent 425d755
commit cb6dd3e
Show file tree

Hide file tree

Showing 2 changed files with 226 additions and 0 deletions.
diff --git a/src/devices/index.ts b/src/devices/index.ts
@@ -295,6 +295,7 @@ import yookee from './yookee';
 import ysrsai from './ysrsai';
 import zemismart from './zemismart';
 import zen from './zen';
+import zigbeetlc from './zigbeetlc';
 import zipato from './zipato';
 
 export default [
@@ -595,5 +596,6 @@ export default [
     ...ysrsai,
     ...zemismart,
     ...zen,
+    ...zigbeetlc,
     ...zipato,
 ];
diff --git a/src/devices/zigbeetlc.ts b/src/devices/zigbeetlc.ts
@@ -0,0 +1,224 @@
+import {Zcl} from 'zigbee-herdsman';
+
+import {
+    battery,
+    binary,
+    enumLookup,
+    humidity,
+    numeric,
+    ota,
+    quirkAddEndpointCluster,
+    temperature,
+} from '../lib/modernExtend';
+
+const extend = {
+    comfortDisplay: binary({
+        name: 'comfort_display',
+        valueOn: ['show', 0],
+        valueOff: ['hide', 1],
+        cluster: 'hvacUserInterfaceCfg',
+        attribute: {ID: 0x0002, type: Zcl.DataType.enum8},
+        description: 'Whether to show a comfort indicator on the device screen.',
+    }),
+    comfortHumidityMax: numeric({
+        name: 'comfort_humidity_max',
+        unit: '%',
+        cluster: 'hvacUserInterfaceCfg',
+        attribute: {ID: 0x0105, type: Zcl.DataType.uint16},
+        valueMin: 0,
+        valueMax: 9999,
+        scale: 10,
+        description: 'Comfort parameters/Humidity maximum, in 1% steps, default 60.00%.',
+    }),
+    comfortHumidityMin: numeric({
+        name: 'comfort_humidity_min',
+        unit: '%',
+        cluster: 'hvacUserInterfaceCfg',
+        attribute: {ID: 0x0104, type: Zcl.DataType.uint16},
+        valueMin: 0,
+        valueMax: 9999,
+        scale: 10,
+        description: 'Comfort parameters/Humidity minimum, in 1% steps, default 40.00%',
+    }),
+    comfortTemperatureMin: numeric({
+        name: 'comfort_temperature_min',
+        unit: '°C',
+        cluster: 'hvacUserInterfaceCfg',
+        attribute: {ID: 0x0102, type: Zcl.DataType.int16},
+        valueMin: -50.0,
+        valueMax: 120.0,
+        valueStep: 0.01,
+        scale: 10,
+        description: 'Comfort parameters/Temperature minimum, in 0.01°C steps, default 20.00°C.',
+    }),
+    comfortTemperatureMax: numeric({
+        name: 'comfort_temperature_max',
+        unit: '°C',
+        cluster: 'hvacUserInterfaceCfg',
+        attribute: {ID: 0x0103, type: Zcl.DataType.int16},
+        valueMin: -50.0,
+        valueMax: 120.0,
+        valueStep: 0.01,
+        scale: 10,
+        description: 'Comfort parameters/Temperature maximum, in 0.01°C steps, default 25.00°C.',
+    }),
+    display: binary({
+        name: 'display',
+        valueOn: ['on', 0],
+        valueOff: ['off', 1],
+        cluster: 'hvacUserInterfaceCfg',
+        attribute: {ID: 0x0106, type: Zcl.DataType.enum8},
+        description: 'Whether to enable the device display.',
+    }),
+    endpointQuirk: quirkAddEndpointCluster({
+        endpointID: 1,
+        outputClusters: [
+            'genOta',
+        ],
+        inputClusters: [
+            'genBasic',
+            'genPowerCfg',
+            'genIdentify',
+            'hvacUserInterfaceCfg',
+            'msTemperatureMeasurement',
+            'msRelativeHumidity',
+        ],
+    }),
+    humidityCalibration: numeric({
+        name: 'humidity_calibration',
+        unit: '%',
+        cluster: 'hvacUserInterfaceCfg',
+        attribute: {ID: 0x0101, type: Zcl.DataType.int16},
+        valueMin: -50.0,
+        valueMax: 50.0,
+        valueStep: 0.01,
+        scale: 10,
+        description: 'Humidity calibration, in 0.01% steps, default 0%.',
+    }),
+    measurementInterval: numeric({
+        name: 'measurement_interval',
+        unit: 's',
+        cluster: 'hvacUserInterfaceCfg',
+        attribute: {ID: 0x0107, type: Zcl.DataType.uint8},
+        valueMin: 3,
+        valueMax: 255,
+        description: 'Measurement interval, default 10 seconds.',
+    }),
+    tempCalibration: numeric({
+        name: 'temperature_calibration',
+        unit: '°C',
+        cluster: 'hvacUserInterfaceCfg',
+        attribute: {ID: 0x0100, type: Zcl.DataType.int16},
+        valueMin: -50.0,
+        valueMax: 50.0,
+        valueStep: 0.01,
+        scale: 10,
+        description: 'Temperature calibration, in 0.01° steps, default 0 °C.',
+    }),
+    tempDisplayMode: enumLookup({
+        name: 'temperature_display_mode',
+        lookup: {'celsius': 0, 'fahrenheit': 1},
+        cluster: 'hvacUserInterfaceCfg',
+        attribute: 'tempDisplayMode',
+        description: 'The unit of the temperature displayed on the device screen.',
+    }),
+};
+
+/*
+    ZigbeeTLc devices with the full supported option set:
+    - Temperature (+calibration)
+    - Humidity (+calibration)
+    - Display
+    - Comfort (Temperature / Humidity)
+*/
+const definitions = [
+    {
+        fingerprint: [
+            {modelID: 'LYWSD03MMC-z', manufacturerName: 'Xiaomi'},
+            {modelID: 'LYWSD03MMC-bz', manufacturerName: 'Xiaomi'},
+            {modelID: 'MHO-C122-z', manufacturerName: 'MiaoMiaoCe'},
+            {modelID: 'MHO-C122-bz', manufacturerName: 'MiaoMiaoCe'},
+            {modelID: 'MHO-C401N-z', manufacturerName: 'MiaoMiaoCe'},
+            {modelID: 'MHO-C401N-bz', manufacturerName: 'MiaoMiaoCe'},
+        ],
+        // LYWSD03MMC or similar with ZigbeeTLc firmware (alternative is devbis firmware)
+        model: 'LYWSD03MMC-z',
+        vendor: 'Xiaomi',
+        description: 'Temp & RH Monitor Lite (pvxx/ZigbeeTLc)',
+        extend: [
+            temperature({reporting: {min: 10, max: 300, change: 10}}),
+            humidity({reporting: {min: 10, max: 300, change: 50}}),
+            extend.display,
+            extend.tempDisplayMode,
+            extend.comfortDisplay,
+            extend.comfortTemperatureMin,
+            extend.comfortTemperatureMax,
+            extend.comfortHumidityMin,
+            extend.comfortHumidityMax,
+            extend.tempCalibration,
+            extend.humidityCalibration,
+            extend.measurementInterval,
+            battery(),
+            extend.endpointQuirk,
+            ota(),
+        ],
+    },
+    /*
+        ZigbeeTLc devices supporting:
+        - Temperature (+calibration)
+        - Humidity (+calibration)
+        - Display
+    */
+    {
+        fingerprint: [
+            {modelID: 'CGDK2-z', manufacturerName: 'Qingping'},
+            {modelID: 'CGDK2-bz', manufacturerName: 'Qingping'},
+        ],
+        // CGDK2 with ZigbeeTLc firmware, normal device is Bluetooth only
+        model: 'CGDK2',
+        vendor: 'Qingping',
+        description: 'Temp & RH Monitor Lite (pvxx/ZigbeeTLc)',
+        extend: [
+            temperature({reporting: {min: 10, max: 300, change: 10}}),
+            humidity({reporting: {min: 10, max: 300, change: 50}}),
+            extend.display,
+            extend.tempDisplayMode,
+            extend.tempCalibration,
+            extend.humidityCalibration,
+            extend.measurementInterval,
+            battery(),
+            extend.endpointQuirk,
+            ota(),
+        ],
+    },
+    /*
+        ZigbeeTLc devices supporting:
+        - Temperature (+calibration)
+        - Humidity (+calibration)
+    */
+    {
+        fingerprint: [
+            {modelID: 'TS0201-z', manufacturerName: 'Tuya'},
+            {modelID: 'TS0201-bz', manufacturerName: 'Tuya'},
+            {modelID: 'TH03Z-z', manufacturerName: 'Tuya'},
+            {modelID: 'TH03Z-bz', manufacturerName: 'Tuya'},
+        ],
+        // TS0201 with ZigbeeTLc firmware
+        model: 'TS0201-z',
+        vendor: 'Tuya',
+        description: 'Temperature & Humidity Sensor (pvxx/ZigbeeTLc)',
+        extend: [
+            temperature({reporting: {min: 10, max: 300, change: 10}}),
+            humidity({reporting: {min: 10, max: 300, change: 50}}),
+            extend.tempCalibration,
+            extend.humidityCalibration,
+            extend.measurementInterval,
+            battery(),
+            extend.endpointQuirk,
+            ota(),
+        ],
+    },
+];
+
+export default definitions;
+module.exports = definitions;