Class ZclFrame

Readonlycluster

Readonlycommand

Readonlyheader

Readonlypayload

isCluster

• isCluster(clusterName: ClusterName | FoundationCommandName): boolean

• Parameters

  • clusterName: ClusterName | FoundationCommandName

  Returns boolean

isCommand

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

• Parameters

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

  Returns boolean

toBuffer

• toBuffer(): Buffer<ArrayBufferLike>

• Returns Buffer<ArrayBufferLike>

toString

• toString(): string

• Returns string

StaticconditionsValid

• conditionsValid(
      parameter: ParameterDefinition,
      entry: any,
      remainingBufferBytes: null | number,
  ): boolean

• Utils

  Parameters

  • parameter: ParameterDefinition
  • entry: any
  • remainingBufferBytes: null | number

  Returns boolean

Staticcreate

• create(
      frameType: FrameType,
      direction: Direction,
      disableDefaultResponse: boolean,
      manufacturerCode: undefined | number,
      transactionSequenceNumber: number,
      commandKey: string | number,
      clusterKey: string | number,
      payload: any,
      customClusters: CustomClusters,
      reservedBits?: number,
  ): ZclFrame

• Creating

  Parameters

  • frameType: FrameType
  • direction: Direction
  • disableDefaultResponse: boolean
  • manufacturerCode: undefined | number
  • transactionSequenceNumber: number
  • commandKey: string | number
  • clusterKey: string | number
  • payload: any
  • customClusters: CustomClusters
  • reservedBits: number = 0

  Returns ZclFrame

StaticfromBuffer

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

• Parsing

  Parameters

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

  Returns ZclFrame