Class ZclFrame

Readonlycluster

Readonlycommand

Readonlyheader

Readonlypayload

isCluster

• isCluster(clusterName: ClusterName | FoundationCommandName): boolean

  Parameters

  • clusterName: ClusterName | FoundationCommandName

  Returns boolean

isCommand

• isCommand(
      commandName:
          | "add"
          | "remove"
          | "getAlarm"
          | "queryNextImageRequest"
          | "checkin"
          | "enrollReq"
          | "arm"
          | FoundationCommandName,
  ): boolean

  Parameters

  • commandName:
        | "add"
        | "remove"
        | "getAlarm"
        | "queryNextImageRequest"
        | "checkin"
        | "enrollReq"
        | "arm"
        | FoundationCommandName

  Returns boolean

toBuffer

• toBuffer(): Buffer

  Returns Buffer

toString

• toString(): string

  Returns string

StaticconditionsValid

• conditionsValid(
      parameter: Parameter,
      entry: any,
      remainingBufferBytes: number | undefined,
  ): boolean

  Utils

  Parameters

  • parameter: Parameter
  • entry: any
  • remainingBufferBytes: number | undefined

  Returns boolean

Staticcreate

• create(
      frameType: FrameType,
      direction: Direction,
      disableDefaultResponse: boolean,
      manufacturerCode: number | undefined,
      transactionSequenceNumber: number,
      commandKey:
          | string
          | number
          | Readonly<
              {
                  ID: number;
                  name: string;
                  parameters: readonly Parameter[];
                  required?: true;
                  response?: number;
              },
          >,
      clusterKey:
          | string
          | number
          | Readonly<
              {
                  attributes: Readonly<Record<string, Attribute>>;
                  commands: Readonly<Record<string, Command>>;
                  commandsResponse: Readonly<Record<string, Command>>;
                  ID: number;
                  manufacturerCode?: number;
                  name: string;
              },
          >,
      payload: any,
      customClusters: CustomClusters,
      reservedBits?: number,
  ): ZclFrame

  Creating

  Parameters

  • frameType: FrameType
  • direction: Direction
  • disableDefaultResponse: boolean
  • manufacturerCode: number | undefined
  • transactionSequenceNumber: number
  • commandKey:
        | string
        | number
        | Readonly<
            {
                ID: number;
                name: string;
                parameters: readonly Parameter[];
                required?: true;
                response?: number;
            },
        >
  • clusterKey:
        | string
        | number
        | Readonly<
            {
                attributes: Readonly<Record<string, Attribute>>;
                commands: Readonly<Record<string, Command>>;
                commandsResponse: Readonly<Record<string, Command>>;
                ID: number;
                manufacturerCode?: number;
                name: string;
            },
        >
  • payload: any
  • customClusters: CustomClusters
  • reservedBits: number = 0

  Returns ZclFrame

StaticfromBuffer

• fromBuffer(
      clusterID: number,
      header: ZclHeader | undefined,
      buffer: Buffer,
      customClusters: CustomClusters,
  ): ZclFrame

  Parsing

  Parameters

  • clusterID: number
  • header: ZclHeader | undefined
  • buffer: Buffer
  • customClusters: CustomClusters

  Returns ZclFrame