Class AdapterAbstract

hasZdoMessageOverhead

manufacturerID

AbstractaddInstallCode

• addInstallCode(ieeeAddress: string, key: Buffer, hashed: boolean): Promise<void>

  Parameters

  • ieeeAddress: string
  • key: Buffer
  • hashed: boolean

  Returns Promise<void>

Abstractbackup

• backup(ieeeAddressesInDatabase: string[]): Promise<Backup>

  Parameters

  • ieeeAddressesInDatabase: string[]

  Returns Promise<Backup>

AbstractgetCoordinatorIEEE

• getCoordinatorIEEE(): Promise<string>

  Returns Promise<string>

AbstractgetCoordinatorVersion

• getCoordinatorVersion(): Promise<CoordinatorVersion>

  Returns Promise<CoordinatorVersion>

AbstractgetNetworkParameters

• getNetworkParameters(): Promise<NetworkParameters>

  Returns Promise<NetworkParameters>

AbstractpermitJoin

• permitJoin(seconds: number, networkAddress?: number): Promise<void>

  Parameters

  • seconds: number
  • OptionalnetworkAddress: number

  Returns Promise<void>

Abstractreset

• reset(type: "soft" | "hard"): Promise<void>

  Parameters

  • type: "soft" | "hard"

  Returns Promise<void>

AbstractrestoreChannelInterPAN

• restoreChannelInterPAN(): Promise<void>

  Returns Promise<void>

AbstractsendZclFrameInterPANBroadcast

• sendZclFrameInterPANBroadcast(
      zclFrame: ZclFrame,
      timeout: number,
      disableResponse: false,
  ): Promise<ZclPayload>

  Parameters

  • zclFrame: ZclFrame
  • timeout: number
  • disableResponse: false

  Returns Promise<ZclPayload>

• sendZclFrameInterPANBroadcast(
      zclFrame: ZclFrame,
      timeout: number,
      disableResponse: true,
  ): Promise<undefined>

  Parameters

  • zclFrame: ZclFrame
  • timeout: number
  • disableResponse: true

  Returns Promise<undefined>

• sendZclFrameInterPANBroadcast(
      zclFrame: ZclFrame,
      timeout: number,
      disableResponse: boolean,
  ): Promise<ZclPayload | undefined>

  Parameters

  • zclFrame: ZclFrame
  • timeout: number
  • disableResponse: boolean

  Returns Promise<ZclPayload | undefined>

AbstractsendZclFrameInterPANToIeeeAddr

• sendZclFrameInterPANToIeeeAddr(
      zclFrame: ZclFrame,
      ieeeAddress: string,
  ): Promise<void>

  Parameters

  • zclFrame: ZclFrame
  • ieeeAddress: string

  Returns Promise<void>

AbstractsendZclFrameToAll

• sendZclFrameToAll(
      endpoint: number,
      zclFrame: ZclFrame,
      sourceEndpoint: number,
      destination: BroadcastAddress,
      profileId?: number,
  ): Promise<void>

  Parameters

  • endpoint: number
  • zclFrame: ZclFrame
  • sourceEndpoint: number
  • destination: BroadcastAddress
  • OptionalprofileId: number

  Returns Promise<void>

AbstractsendZclFrameToEndpoint

• sendZclFrameToEndpoint(
      ieeeAddr: string,
      networkAddress: number,
      endpoint: number,
      zclFrame: ZclFrame,
      timeout: number,
      disableResponse: boolean,
      disableRecovery: boolean,
      sourceEndpoint?: number,
      profileId?: number,
  ): Promise<ZclPayload | undefined>

  ZCL

  Parameters

  • ieeeAddr: string
  • networkAddress: number
  • endpoint: number
  • zclFrame: ZclFrame
  • timeout: number
  • disableResponse: boolean
  • disableRecovery: boolean
  • OptionalsourceEndpoint: number
  • OptionalprofileId: number

  Returns Promise<ZclPayload | undefined>

AbstractsendZclFrameToGroup

• sendZclFrameToGroup(
      groupID: number,
      zclFrame: ZclFrame,
      sourceEndpoint?: number,
      profileId?: number,
  ): Promise<void>

  Parameters

  • groupID: number
  • zclFrame: ZclFrame
  • OptionalsourceEndpoint: number
  • OptionalprofileId: number

  Returns Promise<void>

AbstractsendZdo

• sendZdo(
      ieeeAddress: string,
      networkAddress: number,
      clusterId: ClusterId,
      payload: Buffer,
      disableResponse: true,
  ): Promise<void>

  ZDO

  Parameters

  • ieeeAddress: string
  • networkAddress: number
  • clusterId: ClusterId
  • payload: Buffer
  • disableResponse: true

  Returns Promise<void>

• sendZdo<K extends keyof RequestToResponseMap>(
      ieeeAddress: string,
      networkAddress: number,
      clusterId: K,
      payload: Buffer,
      disableResponse: false,
  ): Promise<RequestToResponseMap[K]>

  ZDO

  Type Parameters

  • K extends keyof RequestToResponseMap

  Parameters

  • ieeeAddress: string
  • networkAddress: number
  • clusterId: K
  • payload: Buffer
  • disableResponse: false

  Returns Promise<RequestToResponseMap[K]>

• sendZdo<K extends keyof RequestToResponseMap>(
      ieeeAddress: string,
      networkAddress: number,
      clusterId: K,
      payload: Buffer,
      disableResponse: boolean,
  ): Promise<RequestToResponseMap[K] | undefined>

  ZDO

  Type Parameters

  • K extends keyof RequestToResponseMap

  Parameters

  • ieeeAddress: string
  • networkAddress: number
  • clusterId: K
  • payload: Buffer
  • disableResponse: boolean

  Returns Promise<RequestToResponseMap[K] | undefined>

AbstractsetChannelInterPAN

• setChannelInterPAN(channel: number): Promise<void>

  InterPAN

  Parameters

  • channel: number

  Returns Promise<void>

Abstractstart

• start(): Promise<StartResult>

  Returns Promise<StartResult>

Abstractstop

• stop(): Promise<void>

  Returns Promise<void>

AbstractsupportsBackup

• supportsBackup(): Promise<boolean>

  Returns Promise<boolean>

AbstractwaitFor

• waitFor(
      networkAddress: number,
      endpoint: number,
      frameType: FrameType,
      direction: Direction,
      transactionSequenceNumber: number | undefined,
      clusterId: number,
      commandId: number,
      timeout: number,
  ): { cancel: () => void; promise: Promise<ZclPayload> }

  Parameters

  • networkAddress: number
  • endpoint: number
  • frameType: FrameType
  • direction: Direction
  • transactionSequenceNumber: number | undefined
  • clusterId: number
  • commandId: number
  • timeout: number

  Returns { cancel: () => void; promise: Promise<ZclPayload> }

StaticclusterWaitressTimeoutFormatter

• clusterWaitressTimeoutFormatter(
      matcher: ClusterWaitressMatcher,
      timeout: number,
  ): string

  Parameters

  • matcher: ClusterWaitressMatcher
  • timeout: number

  Returns string

Staticcreate

• create(
      networkOptions: NetworkOptions,
      serialPortOptions: SerialPortOptions,
      backupPath: string,
      adapterOptions: AdapterOptions,
  ): Promise<Adapter>

  Utility

  Parameters

  • networkOptions: NetworkOptions
  • serialPortOptions: SerialPortOptions
  • backupPath: string
  • adapterOptions: AdapterOptions

  Returns Promise<Adapter>

StaticzclWaitressValidator

• zclWaitressValidator(
      payload: ZclWaitressPayload,
      matcher: ClusterWaitressMatcher,
  ): boolean

  Parameters

  • payload: ZclWaitressPayload
  • matcher: ClusterWaitressMatcher

  Returns boolean