Class defaultAbstract

hasZdoMessageOverhead

manufacturerID

AbstractaddInstallCode

• addInstallCode(ieeeAddress, key): Promise<void>

• Parameters

  • ieeeAddress: string
  • key: Buffer

  Returns Promise<void>

Abstractbackup

• backup(ieeeAddressesInDatabase): 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, networkAddress?): Promise<void>

• Parameters

  • seconds: number
  • OptionalnetworkAddress: number

  Returns Promise<void>

Abstractreset

• reset(type): Promise<void>

• Parameters

  • type: "soft" | "hard"

  Returns Promise<void>

AbstractrestoreChannelInterPAN

• restoreChannelInterPAN(): Promise<void>

• Returns Promise<void>

AbstractsendZclFrameInterPANBroadcast

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

• Parameters

  • zclFrame: ZclFrame
  • timeout: number

  Returns Promise<ZclPayload>

AbstractsendZclFrameInterPANToIeeeAddr

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

• Parameters

  • zclFrame: ZclFrame
  • ieeeAddress: string

  Returns Promise<void>

AbstractsendZclFrameToAll

• sendZclFrameToAll(endpoint, zclFrame, sourceEndpoint, destination): Promise<void>

• Parameters

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

  Returns Promise<void>

AbstractsendZclFrameToEndpoint

• sendZclFrameToEndpoint(ieeeAddr, networkAddress, endpoint, zclFrame, timeout, disableResponse, disableRecovery, sourceEndpoint?): Promise<void | ZclPayload>

• ZCL

  Parameters

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

  Returns Promise<void | ZclPayload>

AbstractsendZclFrameToGroup

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

• Parameters

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

  Returns Promise<void>

AbstractsendZdo

• sendZdo(ieeeAddress, networkAddress, clusterId, payload, disableResponse): Promise<void>

• ZDO

  Parameters

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

  Returns Promise<void>
• sendZdo<K>(ieeeAddress, networkAddress, clusterId, payload, disableResponse): Promise<RequestToResponseMap[K]>

• Type Parameters

  • K extends keyof RequestToResponseMap

  Parameters

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

  Returns Promise<RequestToResponseMap[K]>

• sendZdo<K>(ieeeAddress, networkAddress, clusterId, payload, disableResponse): Promise<void | RequestToResponseMap[K]>

• Type Parameters

  • K extends keyof RequestToResponseMap

  Parameters

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

  Returns Promise<void | RequestToResponseMap[K]>

AbstractsetChannelInterPAN

• setChannelInterPAN(channel): Promise<void>

• InterPAN

  Parameters

  • channel: number

  Returns Promise<void>

AbstractsetTransmitPower

• setTransmitPower(value): Promise<void>

• Parameters

  • value: 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, endpoint, frameType, direction, transactionSequenceNumber, clusterID, commandIdentifier, timeout): {
      cancel: (() => void);
      promise: Promise<ZclPayload>;
  }

• Parameters

  • networkAddress: undefined | number
  • endpoint: number
  • frameType: FrameType
  • direction: Direction
  • transactionSequenceNumber: undefined | number
  • clusterID: number
  • commandIdentifier: number
  • timeout: number

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

  • cancel: (() => void)

    • • (): void

      • Returns void

  • promise: Promise<ZclPayload>

Staticcreate

• create(networkOptions, serialPortOptions, backupPath, adapterOptions): Promise<default>

• Utility

  Parameters

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

  Returns Promise<default>