Class EmberAdapter

constructor

• new EmberAdapter(networkOptions, serialPortOptions, backupPath, adapterOptions): EmberAdapter

• Parameters

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

  Returns EmberAdapter

ReadonlystackConfig

addInstallCode

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

• Parameters

  • ieeeAddress: string
  • key: Buffer

  Returns Promise<void>

backup

• backup(ieeeAddressesInDatabase): Promise<Backup>

• Parameters

  • ieeeAddressesInDatabase: string[]

  Returns Promise<Backup>

broadcastNetworkKeyUpdate

• broadcastNetworkKeyUpdate(): Promise<void>

• Routine to update the network key and broadcast the update to the network after a set time. NOTE: This should run at a large interval, but before the uint32_t of the frame counter is able to reach all Fs (can't wrap to 0). This may disrupt sleepy end devices that miss the update, but they should be able to TC rejoin (in most cases...). On the other hand, the more often this runs, the more secure the network is...

  Returns Promise<void>

clearNetworkCache

• clearNetworkCache(): void

• Clear the cached network values (set to invalid values).

  Returns void

emberGetEui64

• emberGetEui64(): Promise<`0x${string}`>

• Return the EUI 64 of the local node This call caches the results on the host to prevent frequent EZSP transactions. Check against BLANK_EUI64 for validity.

  Returns Promise<`0x${string}`>

emberGetExtendedPanId

• emberGetExtendedPanId(): Promise<ExtendedPanId>

• Return the Extended PAN ID of the local node. This call caches the results on the host to prevent frequent EZSP transactions. Check against BLANK_EXTENDED_PAN_ID for validity.

  Returns Promise<ExtendedPanId>

emberGetPanId

• emberGetPanId(): Promise<number>

• Return the PAN ID of the local node. This call caches the results on the host to prevent frequent EZSP transactions. Check against INVALID_PAN_ID for validity.

  Returns Promise<number>

emberGetRadioChannel

• emberGetRadioChannel(): Promise<number>

• Return the radio channel (uint8_t) of the current network. This call caches the results on the host to prevent frequent EZSP transactions. Check against INVALID_RADIO_CHANNEL for validity.

  Returns Promise<number>

exportLinkKeys

• exportLinkKeys(): Promise<LinkKeyBackupData[]>

• Export link keys for backup.

  Returns Promise<LinkKeyBackupData[]>

  List of keys data with AES hashed keys

getCoordinatorIEEE

• getCoordinatorIEEE(): Promise<string>

• Returns Promise<string>

getCoordinatorVersion

• getCoordinatorVersion(): Promise<CoordinatorVersion>

• Returns Promise<CoordinatorVersion>

getNetworkParameters

• getNetworkParameters(): Promise<NetworkParameters>

• Returns Promise<NetworkParameters>

importLinkKeys

• importLinkKeys(backupData): Promise<void>

• Import link keys from backup.

  Parameters

  • backupData: LinkKeyBackupData[]

  Returns Promise<void>

permitJoin

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

• Parameters

  • seconds: number
  • OptionalnetworkAddress: number

  Returns Promise<void>

reset

• reset(type): Promise<void>

• Parameters

  • type: "soft" | "hard"

  Returns Promise<void>

restoreChannelInterPAN

• restoreChannelInterPAN(): Promise<void>

• Returns Promise<void>

sendZclFrameInterPANBroadcast

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

• Parameters

  • zclFrame: ZclFrame
  • timeout: number

  Returns Promise<ZclPayload>

sendZclFrameInterPANToIeeeAddr

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

• Parameters

  • zclFrame: ZclFrame
  • ieeeAddress: string

  Returns Promise<void>

sendZclFrameToAll

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

• Parameters

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

  Returns Promise<void>

sendZclFrameToEndpoint

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

sendZclFrameToGroup

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

• Parameters

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

  Returns Promise<void>

sendZdo

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

setChannelInterPAN

• setChannelInterPAN(channel): Promise<void>

• InterPAN

  Parameters

  • channel: number

  Returns Promise<void>

setTransmitPower

• setTransmitPower(value): Promise<void>

• Parameters

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

• WARNING: Adapter impl. Starts timer immediately upon returning

  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>

StaticautoDetectPath

• autoDetectPath(): Promise<undefined | string>

• Returns Promise<undefined | string>

StaticisValidPath

• isValidPath(path): Promise<boolean>

• Parameters

  • path: string

  Returns Promise<boolean>