Class ZoHAdapter

constructor

• new ZoHAdapter(
      networkOptions: NetworkOptions,
      serialPortOptions: SerialPortOptions,
      backupPath: string,
      adapterOptions: AdapterOptions,
  ): ZoHAdapter

  Parameters

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

  Returns ZoHAdapter

Readonlydriver

ReadonlystackConfig

addInstallCode

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

  Parameters

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

  Returns Promise<void>

backup

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

  Parameters

  • _ieeeAddressesInDatabase: string[]

  Returns Promise<Backup>

closePort

• closePort(): Promise<void>

  Returns Promise<void>

getCoordinatorIEEE

• getCoordinatorIEEE(): Promise<string>

  Returns Promise<string>

getCoordinatorVersion

• getCoordinatorVersion(): Promise<CoordinatorVersion>

  Returns Promise<CoordinatorVersion>

getNetworkParameters

• getNetworkParameters(): Promise<NetworkParameters>

  Returns Promise<NetworkParameters>

initPort

• initPort(): Promise<void>

  Init the serial or socket port and hook parser/writer.

  Returns Promise<void>

onDeviceAuthorized

• onDeviceAuthorized(_source16: number, _source64: bigint): void

  Parameters

  • _source16: number
  • _source64: bigint

  Returns void

onDeviceJoined

• onDeviceJoined(
      source16: number,
      source64: bigint,
      capabilities: MACCapabilities,
  ): void

  Parameters

  • source16: number
  • source64: bigint
  • capabilities: MACCapabilities

  Returns void

onDeviceLeft

• onDeviceLeft(source16: number, source64: bigint): void

  Parameters

  • source16: number
  • source64: bigint

  Returns void

onDeviceRejoined

• onDeviceRejoined(
      source16: number,
      source64: bigint,
      _capabilities: MACCapabilities,
  ): void

  Parameters

  • source16: number
  • source64: bigint
  • _capabilities: MACCapabilities

  Returns void

onFrame

• onFrame(
      sender16: number | undefined,
      sender64: bigint | undefined,
      apsHeader: ZigbeeAPSHeader,
      apsPayload: ZigbeeAPSPayload,
      rssi: number,
  ): void

  Parameters

  • sender16: number | undefined

    If undefined, sender64 is expected defined

  • sender64: bigint | undefined

    If undefined, sender16 is expected defined

  • apsHeader: ZigbeeAPSHeader
  • apsPayload: ZigbeeAPSPayload
  • rssi: number

  Returns void

onGPFrame

• onGPFrame(
      cmdId: number,
      payload: Buffer,
      macHeader: MACHeader,
      nwkHeader: ZigbeeNWKGPHeader,
      rssi: number,
  ): void

  Parameters

  • cmdId: number
  • payload: Buffer
  • macHeader: MACHeader
  • nwkHeader: ZigbeeNWKGPHeader
  • rssi: number

  Returns void

permitJoin

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

  Parameters

  • seconds: number
  • OptionalnetworkAddress: number

  Returns Promise<void>

reset

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

  Parameters

  • type: "soft" | "hard"

  Returns Promise<void>

restoreChannelInterPAN

• restoreChannelInterPAN(): Promise<void>

  Returns Promise<void>

sendZclFrameInterPANBroadcast

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

  Parameters

  • zclFrame: ZclFrame
  • timeout: number

  Returns Promise<ZclPayload>

sendZclFrameInterPANToIeeeAddr

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

  Parameters

  • zclFrame: ZclFrame
  • ieeeAddress: string

  Returns Promise<void>

sendZclFrameToAll

• 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>

sendZclFrameToEndpoint

• 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>

sendZclFrameToGroup

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

  Parameters

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

  Returns Promise<void>

sendZdo

• 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]>

setChannelInterPAN

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

  InterPAN

  Parameters

  • channel: number

  Returns Promise<void>

start

• start(): Promise<StartResult>

  Returns Promise<StartResult>

stop

• stop(): Promise<void>

  Returns Promise<void>

supportsBackup

• supportsBackup(): Promise<boolean>

  Returns Promise<boolean>

waitFor

• waitFor(
      networkAddress: number,
      endpoint: number,
      _frameType: FrameType,
      _direction: Direction,
      transactionSequenceNumber: number | undefined,
      clusterID: number,
      commandIdentifier: number,
      timeout: number,
  ): { cancel: () => void; promise: Promise<ZclPayload> }

  Parameters

  • networkAddress: number
  • endpoint: number
  • _frameType: FrameType
  • _direction: Direction
  • transactionSequenceNumber: number | undefined
  • clusterID: number
  • commandIdentifier: number
  • timeout: number

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