Class OTRCPDriver

constructor

• new OTRCPDriver(
      callbacks: StackCallbacks,
      streamRawConfig: StreamRawConfig,
      netParams: NetworkParameters,
      saveDir: string,
      emitMACFrames?: boolean,
  ): OTRCPDriver

  Parameters

  • callbacks: StackCallbacks
  • streamRawConfig: StreamRawConfig
  • netParams: NetworkParameters
  • saveDir: string
  • emitMACFrames: boolean = false

  Returns OTRCPDriver

ReadonlyapsHandler

Readonlycontext

ReadonlymacHandler

ReadonlynwkGPHandler

ReadonlynwkHandler

Readonlyparser

Readonlywriter

currentSpinelTID

• get currentSpinelTID(): number

  Returns number

interfaceType

• get interfaceType(): number

  Returns number

isNetworkUp

• get isNetworkUp(): boolean

  Returns boolean

ncpVersion

• get ncpVersion(): string

  Returns string

protocolVersionMajor

• get protocolVersionMajor(): number

  Returns number

protocolVersionMinor

• get protocolVersionMinor(): number

  Returns number

rcpAPIVersion

• get rcpAPIVersion(): number

  Returns number

rcpMinHostAPIVersion

• get rcpMinHostAPIVersion(): number

  Returns number

formNetwork

• formNetwork(): Promise<void>

  Set the Spinel properties required to start a 802.15.4 MAC network.

  Should be called after start.

  Returns Promise<void>

getInterfaceType

• getInterfaceType(): Promise<number>

  Returns Promise<number>

  SPINEL_PROTOCOL_TYPE_*

getNCPVersion

• getNCPVersion(): Promise<string>

  Recommended format: STACK-NAME/STACK-VERSION[BUILD_INFO][; OTHER_INFO]; BUILD_DATE_AND_TIME Encoded as a zero-terminated UTF-8 string.

  Returns Promise<string>

getPHYCCAThreshold

• getPHYCCAThreshold(): Promise<number>

  The CCA (clear-channel assessment) threshold. NOTE: Currently not implemented in: ot-ti

  Returns Promise<number>

  dBm (int8)

getPHYRSSI

• getPHYRSSI(): Promise<number>

  The current RSSI (Received signal strength indication) from the radio. This value can be used in energy scans and for determining the ambient noise floor for the operating environment.

  Returns Promise<number>

  dBm (int8)

getPHYRXSensitivity

• getPHYRXSensitivity(): Promise<number>

  The radio receive sensitivity. This value can be used as lower bound noise floor for link metrics computation.

  Returns Promise<number>

  dBm (int8)

getPHYTXPower

• getPHYTXPower(): Promise<number>

  The transmit power of the radio.

  Returns Promise<number>

  dBm (int8)

getProperty

• getProperty(
      propertyId: SpinelPropertyId,
      timeout?: number,
  ): Promise<SpinelFrame>

  Parameters

  • propertyId: SpinelPropertyId
  • timeout: number = 10000

  Returns Promise<SpinelFrame>

getProtocolVersion

• getProtocolVersion(): Promise<[major: number, minor: number]>

  Returns Promise<[major: number, minor: number]>

  [SPINEL_PROTOCOL_VERSION_THREAD_MAJOR, SPINEL_PROTOCOL_VERSION_THREAD_MINOR]

getRCPAPIVersion

• getRCPAPIVersion(): Promise<number>

  Returns Promise<number>

getRCPMinHostAPIVersion

• getRCPMinHostAPIVersion(): Promise<number>

  Returns Promise<number>

onFrame

• onFrame(buffer: Buffer): Promise<void>

  Parameters

  • buffer: Buffer

  Returns Promise<void>

onStreamRawFrame

• onStreamRawFrame(
      payload: Buffer,
      metadata: SpinelStreamRawMetadata | undefined,
  ): Promise<void>

  Logic optimizes code paths to try to avoid more parsing when frames will eventually get ignored by detecting as early as possible. HOT PATH: This method is called for every incoming frame. Optimizations:

  • Early bail-outs to minimize processing
  • Inline-able operations
  • Minimal allocations in critical paths

  Parameters

  • payload: Buffer
  • metadata: SpinelStreamRawMetadata | undefined

  Returns Promise<void>

resetIntoBootloader

• resetIntoBootloader(): Promise<void>

  Performs a software reset into bootloader. If up, will stop network before.

  Returns Promise<void>

resetNetwork

• resetNetwork(): Promise<void>

  Remove the current state file and clear all related tables.

  Will throw if state already loaded (should be called before start).

  Returns Promise<void>

resetStack

• resetStack(): Promise<void>

  Performs a STACK reset after resetting a few PHY/MAC properties to default. If up, will stop network before.

  Returns Promise<void>

sendBroadcast

• sendBroadcast(
      payload: Buffer,
      profileId: number,
      clusterId: number,
      dest16: number,
      destEp: number,
      sourceEp: number,
  ): Promise<number>

  Wraps Zigbee APS DATA sending for broadcast. Throws if could not send.

  Parameters

  • payload: Buffer
  • profileId: number
  • clusterId: number
  • dest16: number

    The broadcast address to send to [0xfff8..0xffff]

  • destEp: number
  • sourceEp: number

  Returns Promise<number>

  The APS counter of the sent frame.

sendCommand

• sendCommand(
      commandId: SpinelCommandId,
      buffer: Buffer,
      waitForResponse: false,
  ): Promise<undefined>

  Parameters

  • commandId: SpinelCommandId
  • buffer: Buffer
  • waitForResponse: false

  Returns Promise<undefined>

• sendCommand(
      commandId: SpinelCommandId,
      buffer: Buffer,
      waitForResponse: true,
      timeout: number,
  ): Promise<SpinelFrame>

  Parameters

  • commandId: SpinelCommandId
  • buffer: Buffer
  • waitForResponse: true
  • timeout: number

  Returns Promise<SpinelFrame>

sendGroupcast

• sendGroupcast(
      payload: Buffer,
      profileId: number,
      clusterId: number,
      group: number,
      sourceEp: number,
  ): Promise<number>

  Wraps Zigbee APS DATA sending for groupcast. Throws if could not send.

  Parameters

  • payload: Buffer
  • profileId: number
  • clusterId: number
  • group: number

    The group to send to

  • sourceEp: number

  Returns Promise<number>

  The APS counter of the sent frame.

sendStreamRaw

• sendStreamRaw(payload: Buffer): Promise<void>

  Parameters

  • payload: Buffer

  Returns Promise<void>

sendUnicast

• sendUnicast(
      payload: Buffer,
      profileId: number,
      clusterId: number,
      dest16: number,
      dest64: bigint | undefined,
      destEp: number,
      sourceEp: number,
  ): Promise<number>

  Wraps Zigbee APS DATA sending for unicast. Throws if could not send.

  Parameters

  • payload: Buffer
  • profileId: number
  • clusterId: number
  • dest16: number
  • dest64: bigint | undefined
  • destEp: number
  • sourceEp: number

  Returns Promise<number>

  The APS counter of the sent frame.

sendZDO

• sendZDO(
      payload: Buffer,
      nwkDest16: number,
      nwkDest64: bigint | undefined,
      clusterId: number,
  ): Promise<[number, number]>

  Wraps Zigbee APS DATA sending for ZDO. Throws if could not send.

  Parameters

  • payload: Buffer
  • nwkDest16: number
  • nwkDest64: bigint | undefined
  • clusterId: number

  Returns Promise<[number, number]>

  • The APS counter of the sent frame.
  • The ZDO counter of the sent frame.

setPHYCCAThreshold

• setPHYCCAThreshold(ccaThreshold: number): Promise<void>

  The CCA (clear-channel assessment) threshold. Set to -128 to disable. The value will be rounded down to a value that is supported by the underlying radio hardware. NOTE: Currently not implemented in: ot-ti

  Parameters

  • ccaThreshold: number

    dBm (>= -128 and <= 127)

  Returns Promise<void>

setPHYTXPower

• setPHYTXPower(txPower: number): Promise<void>

  The transmit power of the radio. The value will be rounded down to a value that is supported by the underlying radio hardware.

  Parameters

  • txPower: number

    dBm (>= -128 and <= 127)

  Returns Promise<void>

setProperty

• setProperty(payload: Buffer, timeout?: number): Promise<void>

  Parameters

  • payload: Buffer
  • timeout: number = 10000

  Returns Promise<void>

start

• start(): Promise<void>

  Get the basic info from the RCP firmware and reset it.

  Returns Promise<void>

  See

  https://datatracker.ietf.org/doc/html/draft-rquattle-spinel-unified#appendix-C.1

  Should be called before formNetwork but after resetNetwork (if needed)

startEnergyScan

• startEnergyScan(
      channels: number[],
      period: number,
      txPower: number,
  ): Promise<void>

  Start an energy scan. Cannot be used after state is loaded or network is up.

  Parameters

  • channels: number[]

    List of channels to scan

  • period: number

    milliseconds per channel

  • txPower: number

  Returns Promise<void>

  See

  • https://datatracker.ietf.org/doc/html/draft-rquattle-spinel-unified#section-5.8.1
  • https://datatracker.ietf.org/doc/html/draft-rquattle-spinel-unified#section-5.8.10

startSniffer

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

  Start sniffing. Cannot be used after state is loaded or network is up. WARNING: This is expected to run in the "run-and-quit" pattern as it overrides the onStreamRawFrame function.

  Parameters

  • channel: number

    The channel to sniff on

  Returns Promise<void>

startStack

• startStack(): Promise<void>

  Start the components of the Zigbee stack

  Returns Promise<void>

stop

• stop(): Promise<void>

  Returns Promise<void>

stopEnergyScan

• stopEnergyScan(): Promise<void>

  Returns Promise<void>

stopSniffer

• stopSniffer(): Promise<void>

  Returns Promise<void>

stopStack

• stopStack(): void

  Stop the components of the Zigbee stack

  Returns void

waitForReset

• waitForReset(): Promise<void>

  Returns Promise<void>

waitForTID

• waitForTID(tid: number, timeout: number): Promise<SpinelFrame>

  Parameters

  • tid: number
  • timeout: number

  Returns Promise<SpinelFrame>