zigbee-herdsman 10.6.3 → 10.8.0

package/dist/zspec/zcl/definition/cluster.js

@@ -381,7 +381,7 @@ exports.Clusters = {
             currentGroup: { name: "currentGroup", ID: 0x0002, type: enums_1.DataType.UINT16, required: true, max: 0xfff7, default: 0 },
             sceneValid: { name: "sceneValid", ID: 0x0003, type: enums_1.DataType.BOOLEAN, required: true, default: 0 },
             nameSupport: { name: "nameSupport", ID: 0x0004, type: enums_1.DataType.BITMAP8, required: true, default: 0 },
-            lastCfgBy: { name: "lastCfgBy", ID: 0x0005, type: enums_1.DataType.IEEE_ADDR, special: [["UnknownOrNotConfigured", "ffffffffffffffff"]] },
+            lastCfgBy: { name: "lastCfgBy", ID: 0x0005, type: enums_1.DataType.IEEE_ADDR, special: { "0xffffffffffffffff": "UnknownOrNotConfigured" } },
         },
         commands: {
             add: {
@@ -558,11 +558,11 @@ exports.Clusters = {
                         type: enums_1.DataType.UINT8,
                         min: 0,
                         max: 0xff,
-                        special: [
-                            ["NoFurtherScenesMayBeAdded", "00"],
-                            ["AtLeastOneFurtherSceneMayBeAdded", "fe"],
-                            ["Unknown", "ff"],
-                        ],
+                        special: {
+                            0: "NoFurtherScenesMayBeAdded",
+                            254: "AtLeastOneFurtherSceneMayBeAdded",
+                            255: "Unknown",
+                        },
                     },
                     { name: "groupid", type: enums_1.DataType.UINT16 },
                     {
@@ -630,7 +630,7 @@ exports.Clusters = {
             globalSceneCtrl: { name: "globalSceneCtrl", ID: 0x4000, type: enums_1.DataType.BOOLEAN, default: 1 },
             onTime: { name: "onTime", ID: 0x4001, type: enums_1.DataType.UINT16, write: true, max: 0xffff, default: 0 },
             offWaitTime: { name: "offWaitTime", ID: 0x4002, type: enums_1.DataType.UINT16, write: true, max: 0xffff, default: 0 },
-            startUpOnOff: { name: "startUpOnOff", ID: 0x4003, type: enums_1.DataType.ENUM8, write: true, max: 0xff, special: [["SetToPreviousValue", "ff"]] },
+            startUpOnOff: { name: "startUpOnOff", ID: 0x4003, type: enums_1.DataType.ENUM8, write: true, max: 0xff, special: { 255: "SetToPreviousValue" } },
         },
         commands: {
             off: { name: "off", ID: 0x00, parameters: [], required: true },
@@ -701,10 +701,10 @@ exports.Clusters = {
                 type: enums_1.DataType.UINT8,
                 write: true,
                 max: 0xff,
-                special: [
-                    ["MinimumDeviceValuePermitted", "00"],
-                    ["SetToPreviousValue", "ff"],
-                ],
+                special: {
+                    0: "MinimumDeviceValuePermitted",
+                    255: "SetToPreviousValue",
+                },
             },
         },
         commands: {
@@ -1414,21 +1414,21 @@ exports.Clusters = {
                 write: true,
                 required: true,
                 default: "0xffffffffffffffff",
-                special: [["PANIdUnspecified", "ffffffffffffffff"]],
+                special: { "0xffffffffffffffff": "PANIdUnspecified" },
             },
             panId: { name: "panId", ID: 0x0002, type: enums_1.DataType.UINT16, write: true, required: true, max: 0xffff },
             channelmask: { name: "channelmask", ID: 0x0003, type: enums_1.DataType.BITMAP32, write: true, required: true },
             protocolVersion: { name: "protocolVersion", ID: 0x0004, type: enums_1.DataType.UINT8, write: true, required: true, min: 0x02, max: 0x02 },
             stackProfile: { name: "stackProfile", ID: 0x0005, type: enums_1.DataType.UINT8, write: true, required: true, min: 0x01, max: 0x02 },
             startupControl: { name: "startupControl", ID: 0x0006, type: enums_1.DataType.ENUM8, write: true, required: true, max: 0x03 },
-            trustCenterress: {
-                name: "trustCenterress",
+            trustCenterAddress: {
+                name: "trustCenterAddress",
                 ID: 0x0010,
                 type: enums_1.DataType.IEEE_ADDR,
                 write: true,
                 required: true,
                 default: "0x0000000000000000",
-                special: [["AddressUnspecified", "0000000000000000"]],
+                special: { "0x0000000000000000": "AddressUnspecified" },
             },
             trustCenterMasterKey: { name: "trustCenterMasterKey", ID: 0x0011, type: enums_1.DataType.SEC_KEY, write: true },
             networkKey: { name: "networkKey", ID: 0x0012, type: enums_1.DataType.SEC_KEY, write: true, required: true },
@@ -2223,10 +2223,10 @@ exports.Clusters = {
                 type: enums_1.DataType.UINT8,
                 write: true,
                 max: 0xff,
-                special: [
-                    ["MinimumDeviceValuePermitted", "00"],
-                    ["SetToPreviousValue", "ff"],
-                ],
+                special: {
+                    0: "MinimumDeviceValuePermitted",
+                    255: "SetToPreviousValue",
+                },
             },
         },
         commands: {
@@ -2895,7 +2895,7 @@ exports.Clusters = {
                 write: true,
                 max: 0xffff,
                 default: 0xffff,
-                special: [["Never", "ffff"]],
+                special: { 65535: "Never" },
             },
         },
         commands: {},
@@ -3043,7 +3043,7 @@ exports.Clusters = {
                 writeOptional: true,
                 report: true,
                 default: 0,
-                special: [["Disabled", "0"]],
+                special: { 0: "Disabled" },
             },
             soundVolume: { name: "soundVolume", ID: 0x0024, type: enums_1.DataType.UINT8, write: true, writeOptional: true, report: true, default: 0 },
             operatingMode: { name: "operatingMode", ID: 0x0025, type: enums_1.DataType.ENUM8, write: true, writeOptional: true, report: true, default: 0 },
@@ -3129,7 +3129,7 @@ exports.Clusters = {
                 name: "getLogRecord",
                 ID: 0x04,
                 response: 0x04,
-                parameters: [{ name: "logindex", type: enums_1.DataType.UINT16, special: [["MostRecent", "0"]] }],
+                parameters: [{ name: "logindex", type: enums_1.DataType.UINT16, special: { 0: "MostRecent" } }],
             },
             setPinCode: {
                 name: "setPinCode",
@@ -3499,7 +3499,7 @@ exports.Clusters = {
                 scene: true,
                 required: true,
                 max: 100,
-                special: [["PositionUnknown", "ff"]],
+                special: { 255: "PositionUnknown" },
             },
         },
         commands: {
@@ -3780,7 +3780,7 @@ exports.Clusters = {
                 scene: true,
                 max: 0xfeff,
                 default: 0x00fa,
-                special: [["Undefined", "0000"]],
+                special: { 0: "Undefined" },
             },
             colorMode: { name: "colorMode", ID: 0x0008, type: enums_1.DataType.ENUM8, required: true, max: 0x02, default: 1 },
             options: { name: "options", ID: 0x000f, type: enums_1.DataType.BITMAP8, write: true, required: true, default: 0 },
@@ -3853,7 +3853,7 @@ exports.Clusters = {
                 type: enums_1.DataType.UINT16,
                 write: true,
                 max: 0xfeff,
-                special: [["SetColorTempToPreviousValue", "ffff"]],
+                special: { 65535: "SetColorTempToPreviousValue" },
             },
         },
         commands: {
@@ -4222,15 +4222,15 @@ exports.Clusters = {
                 required: true,
                 max: 0xfffe,
                 default: 0,
-                special: [
-                    ["TooLowToBeMeasured", "0000"],
-                    ["Invalid", "ffff"],
-                ],
+                special: {
+                    0: "TooLowToBeMeasured",
+                    65535: "Invalid",
+                },
             },
             minMeasuredValue: { name: "minMeasuredValue", ID: 0x0001, type: enums_1.DataType.UINT16, required: true, min: 1, max: 65533 },
             maxMeasuredValue: { name: "maxMeasuredValue", ID: 0x0002, type: enums_1.DataType.UINT16, required: true, min: 2, max: 65534 },
             tolerance: { name: "tolerance", ID: 0x0003, type: enums_1.DataType.UINT16, max: 0x0800 },
-            lightSensorType: { name: "lightSensorType", ID: 0x0004, type: enums_1.DataType.ENUM8, default: 0xff, special: [["Unknown", "ff"]] },
+            lightSensorType: { name: "lightSensorType", ID: 0x0004, type: enums_1.DataType.ENUM8, default: 0xff, special: { 255: "Unknown" } },
         },
         commands: {},
         commandsResponse: {},
@@ -6897,10 +6897,10 @@ exports.Clusters = {
                         name: "duration",
                         type: enums_1.DataType.UINT16,
                         max: 0xffff,
-                        special: [
-                            ["ExitIdentifyMode", "0000"],
-                            ["IdentifyForReceiverKnownTime", "ffff"],
-                        ],
+                        special: {
+                            0: "ExitIdentifyMode",
+                            65535: "IdentifyForReceiverKnownTime",
+                        },
                     },
                 ],
                 required: true,
@@ -7140,23 +7140,18 @@ exports.Clusters = {
         },
     },
     /**
-     * Tuya cluster
-     *
-     * Common parameters:
-     *
+     * Common parameter:
      *  seq -  Sequence number of transmitted data, range 0-65535, revert to 0 after reaching 65535
      *
-     * Official Tuya documentation: https://developer.tuya.com/en/docs/iot-device-dev/tuya-zigbee-universal-docking-access-standard?id=K9ik6zvofpzql#subtitle-6-Private%20cluster
-     *
+     * Tuya cluster documentation: https://developer.tuya.com/en/docs/iot-device-dev/tuya-zigbee-universal-docking-access-standard?id=K9ik6zvofpzql#subtitle-6-Private%20cluster
+     * Device types documentation: https://developer.tuya.com/en/docs/connect-subdevices-to-gateways/Zigbee_2?id=Kcww7qppbe87m
      */
     manuSpecificTuya: {
         name: "manuSpecificTuya",
         ID: 0xef00, // 61184
         attributes: {},
         commands: {
-            /**
-             * Gateway-side data request
-             */
+            /** Read/write some datapoints. Device returns dataResponse(s) */
             dataRequest: {
                 name: "dataRequest",
                 ID: 0x00,
@@ -7165,21 +7160,9 @@ exports.Clusters = {
                     { name: "dpValues", type: enums_1.BuffaloZclDataType.LIST_TUYA_DATAPOINT_VALUES },
                 ],
             },
-            /**
-             * GW send, trigger MCU side to report all current information, no zcl payload.
-             * Note: Device side can make a policy, data better not to report centrally
-             */
+            /** Read all datapoints. Device returns dataResponse(s) */
             dataQuery: { name: "dataQuery", ID: 0x03, parameters: [] },
-            /**
-             * Gw->Zigbee gateway query MCU version
-             */
-            mcuVersionRequest: { name: "mcuVersionRequest", ID: 0x10, parameters: [{ name: "seq", type: enums_1.DataType.UINT16, max: 0xffff }] },
-            /**
-             * FIXME: This command is not listed in Tuya zigbee cluster description,
-             *  but there is some command 0x04 (description is: Command Issuance)
-             *  in `Serial command list` section of the same document
-             *  So, need to investigate more information about it
-             */
+            /** Some devices need this instead of dataRequest? Device returns dataResponse(s) */
             sendData: {
                 name: "sendData",
                 ID: 0x04,
@@ -7188,9 +7171,9 @@ exports.Clusters = {
                     { name: "dpValues", type: enums_1.BuffaloZclDataType.LIST_TUYA_DATAPOINT_VALUES },
                 ],
             },
-            /**
-             * Gw->Zigbee gateway notifies MCU of upgrade
-             */
+            /** Read MCU version. Device returns mcuVersionResponse */
+            mcuVersionRequest: { name: "mcuVersionRequest", ID: 0x10, parameters: [{ name: "seq", type: enums_1.DataType.UINT16, max: 0xffff }] },
+            /** Notify update. Device returns mcuOtaBlockDataRequest */
             mcuOtaNotify: {
                 name: "mcuOtaNotify",
                 ID: 0x12,
@@ -7208,9 +7191,7 @@ exports.Clusters = {
                     { name: "crc", type: enums_1.DataType.UINT32, max: 0xffffffff },
                 ],
             },
-            /**
-             * Gw->Zigbee gateway returns the requested upgrade package for MCU
-             */
+            /** Reply to mcuOtaBlockDataRequest with chunks of update file. Ends with device returning mcuOtaResult */
             mcuOtaBlockDataResponse: {
                 name: "mcuOtaBlockDataResponse",
                 ID: 0x14,
@@ -7224,9 +7205,7 @@ exports.Clusters = {
                     { name: "imageData", type: enums_1.BuffaloZclDataType.LIST_UINT8 },
                 ],
             },
-            /**
-             * Time synchronization (bidirectional)
-             */
+            /** Device asks current time, gateway replies with same command + payload */
             mcuSyncTime: {
                 name: "mcuSyncTime",
                 ID: 0x24,
@@ -7235,9 +7214,7 @@ exports.Clusters = {
                     { name: "payload", type: enums_1.BuffaloZclDataType.LIST_UINT8 },
                 ],
             },
-            /**
-             * Gateway connection status (bidirectional)
-             */
+            /** Gateway connection status (bidirectional) */
             mcuGatewayConnectionStatus: {
                 name: "mcuGatewayConnectionStatus",
                 ID: 0x25,
@@ -7246,15 +7223,11 @@ exports.Clusters = {
                     { name: "payload", type: enums_1.DataType.UINT8, max: 0xff },
                 ],
             },
-            /**
-             * Weather forecast synchronization (check requestWeatherInformation)
-             */
+            /** Weather forecast sync. Reply to requestWeatherInformation */
             tuyaWeatherSync: { name: "tuyaWeatherSync", ID: 0x61, parameters: [{ name: "payload", type: enums_1.BuffaloZclDataType.BUFFER }] },
         },
         commandsResponse: {
-            /**
-             * Reply to MCU-side data request
-             */
+            /** Reply to dataQuery or sendData with some datapoints */
             dataResponse: {
                 name: "dataResponse",
                 ID: 0x01,
@@ -7263,9 +7236,7 @@ exports.Clusters = {
                     { name: "dpValues", type: enums_1.BuffaloZclDataType.LIST_TUYA_DATAPOINT_VALUES },
                 ],
             },
-            /**
-             * MCU-side data active upload (bidirectional)
-             */
+            /** Report some datapoints. Bidirectional? */
             dataReport: {
                 name: "dataReport",
                 ID: 0x02,
@@ -7302,9 +7273,7 @@ exports.Clusters = {
                     { name: "dpValues", type: enums_1.BuffaloZclDataType.LIST_TUYA_DATAPOINT_VALUES },
                 ],
             },
-            /**
-             * Zigbee->Gw MCU return version or actively report version
-             */
+            /** Report / reply to mcuVersionRequest */
             mcuVersionResponse: {
                 name: "mcuVersionResponse",
                 ID: 0x11,
@@ -7313,9 +7282,7 @@ exports.Clusters = {
                     { name: "version", type: enums_1.DataType.UINT8, max: 0xff },
                 ],
             },
-            /**
-             * Zigbee->Gw requests an upgrade package for the MCU
-             */
+            /** Request chunks of update file. Replying to mcuOtaNotify */
             mcuOtaBlockDataRequest: {
                 name: "mcuOtaBlockDataRequest",
                 ID: 0x13,
@@ -7328,9 +7295,7 @@ exports.Clusters = {
                     { name: "size", type: enums_1.DataType.UINT32, max: 0xffffffff },
                 ],
             },
-            /**
-             * Zigbee->Gw returns the upgrade result for the mcu
-             */
+            /** End update. Replying to last mcuOtaBlockDataResponse */
             mcuOtaResult: {
                 name: "mcuOtaResult",
                 ID: 0x15,
@@ -7342,25 +7307,15 @@ exports.Clusters = {
                     { name: "version", type: enums_1.DataType.UINT8, max: 0xff },
                 ],
             },
-            /**
-             * Time synchronization (bidirectional)
-             */
+            /** Device asks current time, gateway replies with same command + payload */
             mcuSyncTime: { name: "mcuSyncTime", ID: 0x24, parameters: [{ name: "payloadSize", type: enums_1.DataType.UINT16, max: 0xffff }] },
-            /**
-             * Gateway connection status (bidirectional)
-             */
+            /** Gateway connection status (bidirectional) */
             mcuGatewayConnectionStatus: {
                 name: "mcuGatewayConnectionStatus",
                 ID: 0x25,
                 parameters: [{ name: "payloadSize", type: enums_1.DataType.UINT16, max: 0xffff }],
             },
-            /**
-             * Device can request weather forecast information and expects response respecting given parameters.
-             * This command ID seem to be device speciffic, because there is simmilar structure documented in Tuya Serial Communication Protocol,
-             * but with different ID (0x3a and 0x3b respectively). In this case, I'm not sure if the name should reflect the one from
-             * docs or be also speciffic (providing space for the implementation of the correct one in the future)?
-             *
-             */
+            /** Request weather forecast. Can be device-specific */
             tuyaWeatherRequest: { name: "tuyaWeatherRequest", ID: 0x60, parameters: [{ name: "payload", type: enums_1.BuffaloZclDataType.BUFFER }] },
         },
     },