@willieee802/zigbee-herdsman 0.49.4 → 0.50.0

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

@@ -15,9 +15,12 @@ export enum Status {
     // UNSUP_CLUSTER_COMMAND = 0x81, DEPRECATED in favor of UNSUP_COMMAND
     /** The specified command is not supported on the device. Command not carried out. */
     UNSUP_COMMAND = 0x81,
-    UNSUP_GENERAL_COMMAND = 0x82, // DEPRECATED in favor of UNSUP_COMMAND
-    UNSUP_MANUF_CLUSTER_COMMAND = 0x83, // DEPRECATED in favor of UNSUP_COMMAND
-    UNSUP_MANUF_GENERAL_COMMAND = 0x84, // DEPRECATED in favor of UNSUP_COMMAND
+    /** @deprecated use UNSUP_COMMAND */
+    UNSUP_GENERAL_COMMAND = 0x82,
+    /** @deprecated use UNSUP_COMMAND */
+    UNSUP_MANUF_CLUSTER_COMMAND = 0x83,
+    /** @deprecated use UNSUP_COMMAND */
+    UNSUP_MANUF_GENERAL_COMMAND = 0x84,
     /** At least one field of the command contains an incorrect value, according to the specification the device is implemented to. */
     INVALID_FIELD = 0x85,
     /** The specified attribute does not exist on the device. */
@@ -32,7 +35,8 @@ export enum Status {
     READ_ONLY = 0x88,
     /** An operation failed due to an insufficient amount of free space available. */
     INSUFFICIENT_SPACE = 0x89,
-    DUPLICATE_EXISTS = 0x8a, // DEPRECATED in favor of SUCCESS
+    /** @deprecated use SUCCESS */
+    DUPLICATE_EXISTS = 0x8a,
     /** The requested information (e.g., table entry) could not be found. */
     NOT_FOUND = 0x8b,
     /** Periodic reports cannot be issued for this attribute.*/
@@ -41,11 +45,15 @@ export enum Status {
     INVALID_DATA_TYPE = 0x8d,
     /** The selector for an attribute is incorrect. */
     INVALID_SELECTOR = 0x8e,
-    WRITE_ONLY = 0x8f, // DEPRECATED in favor of NOT_AUTHORIZED
-    INCONSISTENT_STARTUP_STATE = 0x90, // DEPRECATED in favor of FAILURE
-    DEFINED_OUT_OF_BAND = 0x91, // DEPRECATED in favor of FAILURE
+    /** @deprecated use NOT_AUTHORIZED */
+    WRITE_ONLY = 0x8f,
+    /** @deprecated use FAILURE */
+    INCONSISTENT_STARTUP_STATE = 0x90,
+    /** @deprecated use FAILURE */
+    DEFINED_OUT_OF_BAND = 0x91,
     RESERVED14 = 0x92,
-    ACTION_DENIED = 0x93, // DEPRECATED in favor of FAILURE
+    /** @deprecated use FAILURE */
+    ACTION_DENIED = 0x93,
     /** The exchange was aborted due to excessive response time. */
     TIMEOUT = 0x94,
     /** Failed case when a client or a server decides to abort the upgrade process. */
@@ -60,10 +68,13 @@ export enum Status {
     REQUIRE_MORE_IMAGE = 0x99,
     /** The command has been received and is being processed. */
     NOTIFICATION_PENDING = 0x9a,
-    HARDWARE_FAILURE = 0xc0, // DEPRECATED in favor of FAILURE
-    SOFTWARE_FAILURE = 0xc1, // DEPRECATED in favor of FAILURE
+    /** @deprecated use FAILURE */
+    HARDWARE_FAILURE = 0xc0,
+    /** @deprecated use FAILURE */
+    SOFTWARE_FAILURE = 0xc1,
     RESERVED15 = 0xc2,
     /** The cluster is not supported. */
     UNSUPPORTED_CLUSTER = 0xc3,
-    LIMIT_REACHED = 0xc4, // DEPRECATED in favor of SUCCESS
+    /** @deprecated use SUCCESS */
+    LIMIT_REACHED = 0xc4,
 }

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

@@ -1,4 +1,5 @@
-import type {BuffaloZclDataType, DataType, DataTypeClass, Direction, FrameType, ParameterCondition, StructuredIndicatorType} from "./enums";
+import type {BuffaloZclDataType, DataType, Direction, FrameType, ParameterCondition, StructuredIndicatorType} from "./enums";
+import type {Status} from "./status";
 
 export interface BuffaloZclOptions {
     length?: number;
@@ -22,10 +23,6 @@ export interface StructuredSelector {
     indicatorType?: StructuredIndicatorType;
 }
 
-export interface KeyZclValue {
-    [s: string | number]: number | string;
-}
-
 export interface Struct {
     elmType: DataType;
     elmVal: unknown;
@@ -119,11 +116,46 @@ export interface GpdCustomReply {
     buffer: Buffer;
 }
 
-export interface GpdAttributeReport {
-    manufacturerCode: number;
+export type GpdAttributeReport = {
     clusterID: number;
-    attributes: KeyZclValue;
-}
+    clusterName: string;
+    attributes: Record<string | number, unknown>;
+};
+
+export type GpdManufAttributeReport = {
+    manufacturerCode: number;
+} & GpdAttributeReport;
+
+export type GpdMultiClusterAttributeReport = {
+    reports: Array<{
+        clusterID: number;
+        clusterName: string;
+        attribute: string | number;
+        attrData: unknown;
+    }>;
+};
+
+export type GpdManufMultiClusterAttributeReport = {
+    manufacturerCode: number;
+} & GpdMultiClusterAttributeReport;
+
+export type GpdAttributeReporting =
+    | GpdAttributeReport
+    | GpdManufAttributeReport
+    | GpdMultiClusterAttributeReport
+    | GpdManufMultiClusterAttributeReport;
+
+export type GpdRequestAttribute = {
+    options: number;
+    manufacturerID: number | undefined;
+    records: Array<{clusterID: number; attributes: Array<number>}>;
+};
+
+export type GpdReadAttributeResponse = {
+    options: number;
+    manufacturerID: number | undefined;
+    records: Array<{clusterID: number; clusterName: string; attributes: Record<string | number, {status: Status; attrData: unknown}>}>;
+};
 
 export interface TuyaDataPointValue {
     dp: number;
@@ -147,7 +179,7 @@ export interface FrameControl {
 /**
  * @see https://github.com/project-chip/zap/blob/master/zcl-builtin/dotdot/README.md#restrictions
  */
-interface Restrictions {
+type Restrictions = Readonly<{
     /** specifies an exact length, generally used for a string. */
     length?: number;
     /** specifies the minimum length that a type must take, generally used for a string or a list/array */
@@ -177,7 +209,7 @@ interface Restrictions {
      * `value` is kept as string for easier handling (will be checked on spot if used anyway) though most often is a hex number string (without 0x)
      */
     special?: [name: string, value: string][];
-}
+}>;
 
 /**
  * @see https://github.com/project-chip/zap/blob/master/zcl-builtin/dotdot/README.md#attributes
@@ -188,7 +220,7 @@ interface Restrictions {
  * - requiredIf: Allows for an expression to be implemented which indicates the conditions in which an attribute is mandatory.
  *               Defaults to false
  */
-export interface Attribute extends Restrictions {
+export type Attribute = Readonly<{
     ID: number;
     name: string;
     type: DataType;
@@ -215,16 +247,16 @@ export interface Attribute extends Restrictions {
     // defaultRef?: string;
     /** If attribute is client side */
     client?: true;
-}
+}> &
+    Restrictions;
 
-export interface Parameter extends Restrictions {
+export type Parameter = Readonly<{
     name: string;
     type: DataType | BuffaloZclDataType;
-    conditions?: (
+    conditions?: readonly (
         | {type: ParameterCondition.MINIMUM_REMAINING_BUFFER_BYTES; value: number}
         | {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; reversed?: boolean}
         | {type: ParameterCondition.FIELD_GT; field: string; value: number /*; reversed?: boolean*/}
     )[];
@@ -239,54 +271,34 @@ export interface Parameter extends Restrictions {
      * that field may be referenced using this attribute.
      */
     // arrayLengthField?: string;
-}
+}> &
+    Restrictions;
 
 /**
  * @see https://github.com/project-chip/zap/blob/master/zcl-builtin/dotdot/README.md#commands
  * Extra metadata:
  * - requiredIf: Allows for an expression to be implemented which indicates the conditions in which a command is mandatory. Defaults to false
  */
-export interface Command {
+export type Command = Readonly<{
     ID: number;
     name: string;
     parameters: readonly Parameter[];
     response?: number;
     /** If the command is mandatory. Defaults to false */
     required?: true;
-}
+}>;
 
-export interface AttributeDefinition extends Omit<Attribute, "name"> {}
-
-export interface CommandDefinition extends Omit<Command, "name"> {
-    parameters: readonly Parameter[];
-}
-
-export interface Cluster {
+export type Cluster = Readonly<{
     ID: number;
     name: string;
     manufacturerCode?: number;
-    attributes: {[s: string]: Attribute};
-    commands: {
-        [s: string]: Command;
-    };
-    commandsResponse: {
-        [s: string]: Command;
-    };
-    getAttribute: (key: number | string) => Attribute | undefined;
-    getCommand: (key: number | string) => Command;
-    getCommandResponse: (key: number | string) => Command;
-}
-
-export interface ClusterDefinition {
-    ID: number;
-    manufacturerCode?: number;
-    attributes: Readonly<Record<string, Readonly<AttributeDefinition>>>;
-    commands: Readonly<Record<string, Readonly<CommandDefinition>>>;
-    commandsResponse: Readonly<Record<string, Readonly<CommandDefinition>>>;
-}
+    attributes: Readonly<Record<string, Attribute>>;
+    commands: Readonly<Record<string, Command>>;
+    commandsResponse: Readonly<Record<string, Command>>;
+}>;
 
 export interface CustomClusters {
-    [k: string]: ClusterDefinition;
+    [k: string]: Cluster;
 }
 
 export type ClusterName =
@@ -323,6 +335,7 @@ export type ClusterName =
     | "neighborCleaning"
     | "nearestGateway"
     | "keepAlive"
+    | "zigbeeDirectConfiguration"
     | "closuresShadeCfg"
     | "closuresDoorLock"
     | "closuresWindowCovering"
@@ -416,17 +429,5 @@ export type ClusterName =
     | "haElectricalMeasurement"
     | "haDiagnostic"
     | "touchlink"
-    | "manuSpecificPhilips"
-    | "manuSpecificPhilips2"
-    | "manuSpecificSinope"
     | "manuSpecificTuya"
-    | "manuSpecificLumi"
-    | "manuSpecificTuya2"
-    | "manuSpecificTuya3"
-    | "manuSpecificSmartThingsArrivalSensor"
-    | "manuSpecificSiglisZigfred"
-    | "owonClearMetering"
-    | "zosungIRTransmit"
-    | "zosungIRControl"
-    | "manuSpecificProfalux1"
     | "manuSpecificAmazonWWAH";