zigbee-herdsman 5.0.4 → 6.0.1

package/src/zspec/zcl/definition/enums.ts

@@ -97,10 +97,10 @@ export enum DataType {
     /** class=composite, length=0x0000-0xFFFE, non-value=0xFFFF */
     LONG_CHAR_STR = 0x44,
 
-    /** class=composite, length=variable, non-value=[0]==0xFFFF */
+    /** class=composite, length=variable, non-value=(length=0xFFFF) */
     ARRAY = 0x48,
 
-    /** class=composite, length=variable, non-value=(length) */
+    /** class=composite, length=variable, non-value=(length=0xFFFF) */
     STRUCT = 0x4c,
 
     /** class=composite, length=max(0xFFFE * DataType) non-value=(length=0xFFFF) */
@@ -157,14 +157,12 @@ export enum BuffaloZclDataType {
 
 /** @TODO strings for backwards compat in tests. Should be moved to numbers. */
 export enum ParameterCondition {
-    STATUS_EQUAL = "statusEquals",
-    STATUS_NOT_EQUAL = "statusNotEquals",
     MINIMUM_REMAINING_BUFFER_BYTES = "minimumRemainingBufferBytes",
-    DIRECTION_EQUAL = "directionEquals",
     BITMASK_SET = "bitMaskSet",
     BITFIELD_ENUM = "bitFieldEnum",
     DATA_TYPE_CLASS_EQUAL = "dataTypeValueTypeEquals",
     FIELD_EQUAL = "fieldEquals",
+    FIELD_GT = "fieldGT",
 }
 
 export enum FrameType {
@@ -192,3 +190,14 @@ export enum StructuredIndicatorType {
     /** Remove element from the set/bag */
     WriteRemove = 0x20,
 }
+
+/** Mapping of descriptive string power to source bits. */
+export enum PowerSource {
+    Unknown = 0,
+    "Mains (single phase)" = 1,
+    "Mains (3 phase)" = 2,
+    Battery = 3,
+    "DC Source" = 4,
+    "Emergency mains constantly powered" = 5,
+    "Emergency mains and transfer switch" = 6,
+}

package/src/zspec/zcl/definition/foundation.ts

@@ -49,8 +49,12 @@ export const Foundation: Readonly<Record<FoundationCommandName, Readonly<Foundat
         parameters: [
             {name: "attrId", type: DataType.UINT16},
             {name: "status", type: DataType.UINT8},
-            {name: "dataType", type: DataType.UINT8, conditions: [{type: ParameterCondition.STATUS_EQUAL, value: Status.SUCCESS}]},
-            {name: "attrData", type: BuffaloZclDataType.USE_DATA_TYPE, conditions: [{type: ParameterCondition.STATUS_EQUAL, value: Status.SUCCESS}]},
+            {name: "dataType", type: DataType.UINT8, conditions: [{type: ParameterCondition.FIELD_EQUAL, field: "status", value: Status.SUCCESS}]},
+            {
+                name: "attrData",
+                type: BuffaloZclDataType.USE_DATA_TYPE,
+                conditions: [{type: ParameterCondition.FIELD_EQUAL, field: "status", value: Status.SUCCESS}],
+            },
         ],
     },
     /** Write Attributes */
@@ -80,7 +84,11 @@ export const Foundation: Readonly<Record<FoundationCommandName, Readonly<Foundat
         parseStrategy: "repetitive",
         parameters: [
             {name: "status", type: DataType.UINT8},
-            {name: "attrId", type: DataType.UINT16, conditions: [{type: ParameterCondition.STATUS_NOT_EQUAL, value: Status.SUCCESS}]},
+            {
+                name: "attrId",
+                type: DataType.UINT16,
+                conditions: [{type: ParameterCondition.FIELD_EQUAL, field: "status", reversed: true, value: Status.SUCCESS}],
+            },
         ],
     },
     /** Write Attributes No Response */
@@ -100,26 +108,34 @@ export const Foundation: Readonly<Record<FoundationCommandName, Readonly<Foundat
         parameters: [
             {name: "direction", type: DataType.UINT8},
             {name: "attrId", type: DataType.UINT16},
-            {name: "dataType", type: DataType.UINT8, conditions: [{type: ParameterCondition.DIRECTION_EQUAL, value: Direction.CLIENT_TO_SERVER}]},
+            {
+                name: "dataType",
+                type: DataType.UINT8,
+                conditions: [{type: ParameterCondition.FIELD_EQUAL, field: "direction", value: Direction.CLIENT_TO_SERVER}],
+            },
             {
                 name: "minRepIntval",
                 type: DataType.UINT16,
-                conditions: [{type: ParameterCondition.DIRECTION_EQUAL, value: Direction.CLIENT_TO_SERVER}],
+                conditions: [{type: ParameterCondition.FIELD_EQUAL, field: "direction", value: Direction.CLIENT_TO_SERVER}],
             },
             {
                 name: "maxRepIntval",
                 type: DataType.UINT16,
-                conditions: [{type: ParameterCondition.DIRECTION_EQUAL, value: Direction.CLIENT_TO_SERVER}],
+                conditions: [{type: ParameterCondition.FIELD_EQUAL, field: "direction", value: Direction.CLIENT_TO_SERVER}],
             },
             {
                 name: "repChange",
                 type: BuffaloZclDataType.USE_DATA_TYPE,
                 conditions: [
-                    {type: ParameterCondition.DIRECTION_EQUAL, value: Direction.CLIENT_TO_SERVER},
+                    {type: ParameterCondition.FIELD_EQUAL, field: "direction", value: Direction.CLIENT_TO_SERVER},
                     {type: ParameterCondition.DATA_TYPE_CLASS_EQUAL, value: DataTypeClass.ANALOG},
                 ],
             },
-            {name: "timeout", type: DataType.UINT16, conditions: [{type: ParameterCondition.DIRECTION_EQUAL, value: Direction.SERVER_TO_CLIENT}]},
+            {
+                name: "timeout",
+                type: DataType.UINT16,
+                conditions: [{type: ParameterCondition.FIELD_EQUAL, field: "direction", value: Direction.SERVER_TO_CLIENT}],
+            },
         ],
         response: 0x07, // configReportRsp
     },
@@ -153,26 +169,34 @@ export const Foundation: Readonly<Record<FoundationCommandName, Readonly<Foundat
             {name: "status", type: DataType.UINT8},
             {name: "direction", type: DataType.UINT8},
             {name: "attrId", type: DataType.UINT16},
-            {name: "dataType", type: DataType.UINT8, conditions: [{type: ParameterCondition.DIRECTION_EQUAL, value: Direction.CLIENT_TO_SERVER}]},
+            {
+                name: "dataType",
+                type: DataType.UINT8,
+                conditions: [{type: ParameterCondition.FIELD_EQUAL, field: "direction", value: Direction.CLIENT_TO_SERVER}],
+            },
             {
                 name: "minRepIntval",
                 type: DataType.UINT16,
-                conditions: [{type: ParameterCondition.DIRECTION_EQUAL, value: Direction.CLIENT_TO_SERVER}],
+                conditions: [{type: ParameterCondition.FIELD_EQUAL, field: "direction", value: Direction.CLIENT_TO_SERVER}],
             },
             {
                 name: "maxRepIntval",
                 type: DataType.UINT16,
-                conditions: [{type: ParameterCondition.DIRECTION_EQUAL, value: Direction.CLIENT_TO_SERVER}],
+                conditions: [{type: ParameterCondition.FIELD_EQUAL, field: "direction", value: Direction.CLIENT_TO_SERVER}],
             },
             {
                 name: "repChange",
                 type: BuffaloZclDataType.USE_DATA_TYPE,
                 conditions: [
-                    {type: ParameterCondition.DIRECTION_EQUAL, value: Direction.CLIENT_TO_SERVER},
+                    {type: ParameterCondition.FIELD_EQUAL, field: "direction", value: Direction.CLIENT_TO_SERVER},
                     {type: ParameterCondition.DATA_TYPE_CLASS_EQUAL, value: DataTypeClass.ANALOG},
                 ],
             },
-            {name: "timeout", type: DataType.UINT16, conditions: [{type: ParameterCondition.DIRECTION_EQUAL, value: Direction.SERVER_TO_CLIENT}]},
+            {
+                name: "timeout",
+                type: DataType.UINT16,
+                conditions: [{type: ParameterCondition.FIELD_EQUAL, field: "direction", value: Direction.SERVER_TO_CLIENT}],
+            },
         ],
     },
     /** Report attributes */
@@ -240,12 +264,16 @@ export const Foundation: Readonly<Record<FoundationCommandName, Readonly<Foundat
         // contains only one SUCCESS record for all written attributes if all written successfully
         parameters: [
             {name: "status", type: DataType.UINT8},
-            {name: "attrId", type: DataType.UINT16, conditions: [{type: ParameterCondition.STATUS_NOT_EQUAL, value: Status.SUCCESS}]},
+            {
+                name: "attrId",
+                type: DataType.UINT16,
+                conditions: [{type: ParameterCondition.FIELD_EQUAL, field: "status", reversed: true, value: Status.SUCCESS}],
+            },
             // always one zero-octet if failed attribute not of type array or structure, otherwise can also be zero if no info on which element caused failure
             {
                 name: "selector",
                 type: BuffaloZclDataType.STRUCTURED_SELECTOR,
-                conditions: [{type: ParameterCondition.STATUS_NOT_EQUAL, value: Status.SUCCESS}],
+                conditions: [{type: ParameterCondition.FIELD_EQUAL, field: "status", reversed: true, value: Status.SUCCESS}],
             },
         ],
     },

package/src/zspec/zcl/definition/tstype.ts

@@ -1,5 +1,4 @@
 import type {BuffaloZclDataType, DataType, DataTypeClass, Direction, FrameType, ParameterCondition, StructuredIndicatorType} from "./enums";
-import type {Status} from "./status";
 
 export interface BuffaloZclOptions {
     length?: number;
@@ -23,6 +22,120 @@ export interface StructuredSelector {
     indicatorType?: StructuredIndicatorType;
 }
 
+export interface KeyZclValue {
+    [s: string | number]: number | string;
+}
+
+export interface Struct {
+    elmType: DataType;
+    elmVal: unknown;
+}
+
+export interface ZclTimeOfDay {
+    /** [0-23] */
+    hours?: number;
+    /** [0-59] */
+    minutes?: number;
+    /** [0-59] */
+    seconds?: number;
+    /** [0-99] */
+    hundredths?: number;
+}
+
+export interface ZclDate {
+    /** [1900-2155], converted to/from [0-255] => value+1900=year */
+    year?: number;
+    /** [1-12] */
+    month?: number;
+    /** [1-31] */
+    dayOfMonth?: number;
+    /** [1-7] */
+    dayOfWeek?: number;
+}
+
+export interface ZoneInfo {
+    zoneID: number;
+    zoneStatus: number;
+}
+
+export interface ExtensionFieldSet {
+    clstId: number;
+    len: number;
+    extField: unknown[];
+}
+
+export interface ThermoTransition {
+    transitionTime: number;
+    heatSetpoint?: number;
+    coolSetpoint?: number;
+}
+
+export interface Gpd {
+    deviceID: number;
+    options: number;
+    extendedOptions: number;
+    securityKey: Buffer;
+    keyMic: number;
+    outgoingCounter: number;
+    applicationInfo: number;
+    manufacturerID: number;
+    modelID: number;
+    numGpdCommands: number;
+    gpdCommandIdList: Buffer;
+    numServerClusters: number;
+    numClientClusters: number;
+    gpdServerClusters: Buffer;
+    gpdClientClusters: Buffer;
+    genericSwitchConfig: number;
+    currentContactStatus: number;
+}
+
+export interface GpdChannelRequest {
+    nextChannel: number;
+    nextNextChannel: number;
+}
+
+export interface GpdChannelConfiguration {
+    commandID: number;
+    operationalChannel: number;
+    basic: boolean;
+}
+
+export interface GpdCommissioningReply {
+    commandID: number;
+    options: number;
+    /** expected valid if corresponding `options` bits set */
+    panID?: number;
+    /** expected valid if corresponding `options` bits set */
+    securityKey?: Buffer;
+    /** expected valid if corresponding `options` bits set */
+    keyMic?: number;
+    /** expected valid if corresponding `options` bits set */
+    frameCounter?: number;
+}
+
+export interface GpdCustomReply {
+    commandID: number;
+    buffer: Buffer;
+}
+
+export interface GpdAttributeReport {
+    manufacturerCode: number;
+    clusterID: number;
+    attributes: KeyZclValue;
+}
+
+export interface TuyaDataPointValue {
+    dp: number;
+    datatype: number;
+    data: Buffer;
+}
+
+export interface MiboxerZone {
+    zoneNum: number;
+    groupId: number;
+}
+
 export interface FrameControl {
     reservedBits: number;
     frameType: FrameType;
@@ -58,14 +171,12 @@ export interface AttributeDefinition {
 
 export interface ParameterDefinition extends Parameter {
     conditions?: (
-        | {type: ParameterCondition.STATUS_EQUAL; value: Status}
-        | {type: ParameterCondition.STATUS_NOT_EQUAL; value: Status}
         | {type: ParameterCondition.MINIMUM_REMAINING_BUFFER_BYTES; value: number}
-        | {type: ParameterCondition.DIRECTION_EQUAL; value: Direction}
         | {type: ParameterCondition.BITMASK_SET; param: string; mask: number /* not set */; reversed?: boolean}
         | {type: ParameterCondition.BITFIELD_ENUM; param: string; offset: number; size: number; value: number}
         | {type: ParameterCondition.DATA_TYPE_CLASS_EQUAL; value: DataTypeClass}
-        | {type: ParameterCondition.FIELD_EQUAL; field: string; value: unknown}
+        | {type: ParameterCondition.FIELD_EQUAL; field: string; value: unknown; reversed?: boolean}
+        | {type: ParameterCondition.FIELD_GT; field: string; value: number /*; reversed?: boolean*/}
     )[];
 }
 
@@ -239,8 +350,8 @@ export type ClusterName =
     | "manuSpecificTuya"
     | "manuSpecificLumi"
     | "liXeePrivate"
-    | "manuSpecificTuya_2"
-    | "manuSpecificTuya_3"
+    | "manuSpecificTuya2"
+    | "manuSpecificTuya3"
     | "manuSpecificCentraliteHumidity"
     | "manuSpecificSmartThingsArrivalSensor"
     | "manuSpecificSamsungAccelerometer"
@@ -253,7 +364,6 @@ export type ClusterName =
     | "elkoSwitchConfigurationClusterServer"
     | "manuSpecificSchneiderLightSwitchConfiguration"
     | "manuSpecificSchneiderFanSwitchConfiguration"
-    | "sprutDevice"
     | "sprutVoc"
     | "sprutNoise"
     | "sprutIrBlaster"

package/src/zspec/zcl/index.ts

@@ -1,4 +1,5 @@
 export {Clusters} from "./definition/cluster";
+export type * as ClustersTypes from "./definition/clusters-types";
 export * from "./definition/consts";
 export * from "./definition/enums";
 export {Foundation} from "./definition/foundation";

package/src/zspec/zcl/utils.ts

@@ -264,7 +264,7 @@ function createCluster(name: string, cluster: ClusterDefinition, manufacturerCod
     };
 }
 
-export function getCluster(key: string | number, manufacturerCode: number | undefined, customClusters: CustomClusters): Cluster {
+export function getCluster(key: string | number, manufacturerCode: number | undefined = undefined, customClusters: CustomClusters = {}): Cluster {
     const {name, cluster} = getClusterDefinition(key, manufacturerCode, customClusters);
     return createCluster(name, cluster, manufacturerCode);
 }

package/src/zspec/zcl/zclFrame.ts

@@ -3,7 +3,6 @@ import "../../utils/patchBigIntSerialization";
 import {BuffaloZcl} from "./buffaloZcl";
 import {BuffaloZclDataType, DataType, Direction, FrameType, ParameterCondition} from "./definition/enums";
 import type {FoundationCommandName} from "./definition/foundation";
-import type {Status} from "./definition/status";
 import type {BuffaloZclOptions, Cluster, ClusterName, Command, CustomClusters, ParameterDefinition} from "./definition/tstype";
 import * as Utils from "./utils";
 import {ZclHeader} from "./zclHeader";
@@ -195,7 +194,11 @@ export class ZclFrame {
                 }
             }
 
-            payload[parameter.name] = buffalo.read(parameter.type, options);
+            try {
+                payload[parameter.name] = buffalo.read(parameter.type, options);
+            } catch (error) {
+                throw new Error(`Cannot parse '${command.name}:${parameter.name}' (${(error as Error).message})`);
+            }
         }
 
         return payload;
@@ -286,38 +289,53 @@ export class ZclFrame {
         if (parameter.conditions) {
             for (const condition of parameter.conditions) {
                 switch (condition.type) {
-                    case ParameterCondition.STATUS_EQUAL: {
-                        if ((entry.status as Status) !== condition.value) return false;
-                        break;
-                    }
-                    case ParameterCondition.STATUS_NOT_EQUAL: {
-                        if ((entry.status as Status) === condition.value) return false;
-                        break;
-                    }
-                    case ParameterCondition.DIRECTION_EQUAL: {
-                        if ((entry.direction as Direction) !== condition.value) return false;
+                    case ParameterCondition.FIELD_EQUAL: {
+                        if (condition.reversed) {
+                            if (entry[condition.field] === condition.value) {
+                                return false;
+                            }
+                        } else if (entry[condition.field] !== condition.value) {
+                            return false;
+                        }
                         break;
                     }
                     case ParameterCondition.BITMASK_SET: {
                         if (condition.reversed) {
-                            if ((entry[condition.param] & condition.mask) === condition.mask) return false;
-                        } else if ((entry[condition.param] & condition.mask) !== condition.mask) return false;
+                            if ((entry[condition.param] & condition.mask) === condition.mask) {
+                                return false;
+                            }
+                        } else if ((entry[condition.param] & condition.mask) !== condition.mask) {
+                            return false;
+                        }
                         break;
                     }
                     case ParameterCondition.BITFIELD_ENUM: {
-                        if (((entry[condition.param] >> condition.offset) & ((1 << condition.size) - 1)) !== condition.value) return false;
+                        if (((entry[condition.param] >> condition.offset) & ((1 << condition.size) - 1)) !== condition.value) {
+                            return false;
+                        }
                         break;
                     }
                     case ParameterCondition.MINIMUM_REMAINING_BUFFER_BYTES: {
-                        if (remainingBufferBytes !== undefined && remainingBufferBytes < condition.value) return false;
+                        if (remainingBufferBytes !== undefined && remainingBufferBytes < condition.value) {
+                            return false;
+                        }
                         break;
                     }
                     case ParameterCondition.DATA_TYPE_CLASS_EQUAL: {
-                        if (Utils.getDataTypeClass(entry.dataType) !== condition.value) return false;
+                        if (Utils.getDataTypeClass(entry.dataType) !== condition.value) {
+                            return false;
+                        }
                         break;
                     }
-                    case ParameterCondition.FIELD_EQUAL: {
-                        if (entry[condition.field] !== condition.value) return false;
+                    case ParameterCondition.FIELD_GT: {
+                        /*if (condition.reversed) {
+                            if (entry[condition.field] >= condition.value) {
+                                return false;
+                            }
+                        } else */
+                        if (entry[condition.field] <= condition.value) {
+                            return false;
+                        }
                         break;
                     }
                 }

package/src/zspec/zdo/buffaloZdo.ts

@@ -74,15 +74,6 @@ const NS = "zh:zdo:buffalo";
 const MAX_BUFFER_SIZE = 255;
 
 export class BuffaloZdo extends Buffalo {
-    /**
-     * Set the position of the internal position tracker.
-     * TODO: move to base `Buffalo` class
-     * @param position
-     */
-    public setPosition(position: number): void {
-        this.position = position;
-    }
-
     /**
      * Set the byte at given position without affecting the internal position tracker.
      * TODO: move to base `Buffalo` class