Class Driver

constructor

• new Driver(
      serialOpt: SerialPortOptions,
      nwkOpt: NetworkOptions,
      backupPath: string,
  ): Driver

• Parameters

  • serialOpt: SerialPortOptions
  • nwkOpt: NetworkOptions
  • backupPath: string

  Returns Driver

backupMan

ezsp

ieee

networkParams

version

addEndpoint

• addEndpoint(__namedParameters: AddEndpointParameters): Promise<void>

• Parameters

  • __namedParameters: AddEndpointParameters

  Returns Promise<void>

addInstallCode

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

• Parameters

  • ieeeAddress: string
  • key: Buffer

  Returns Promise<void>

addTransientLinkKey

• addTransientLinkKey(
      partner: EmberEUI64,
      transientKey: EmberKeyData,
  ): Promise<EZSPFrameData>

• Parameters

  • partner: EmberEUI64
  • transientKey: EmberKeyData

  Returns Promise<EZSPFrameData>

brequest

• brequest(
      destination: number,
      apsFrame: EmberApsFrame,
      data: Buffer,
  ): Promise<boolean>

• Parameters

  • destination: number
  • apsFrame: EmberApsFrame
  • data: Buffer

  Returns Promise<boolean>

getKey

• getKey(keyType: EmberKeyType): Promise<EZSPFrameData>

• Parameters

  • keyType: EmberKeyType

  Returns Promise<EZSPFrameData>

getNetworkKeyInfo

• getNetworkKeyInfo(): Promise<EZSPFrameData>

• Returns Promise<EZSPFrameData>

handleNodeJoined

• handleNodeJoined(nwk: number, ieee: number[] | EmberEUI64): void

• Parameters

  • nwk: number
  • ieee: number[] | EmberEUI64

  Returns void

ieeerawrequest

• ieeerawrequest(
      rawFrame: EmberIeeeRawFrame,
      data: Buffer,
      timeout?: number,
  ): Promise<boolean>

• Parameters

  • rawFrame: EmberIeeeRawFrame
  • data: Buffer
  • timeout: number = 10000

  Returns Promise<boolean>

makeApsFrame

• makeApsFrame(clusterId: number, disableResponse: boolean): EmberApsFrame

• Parameters

  • clusterId: number
  • disableResponse: boolean

  Returns EmberApsFrame

makeEmberIeeeRawFrame

• makeEmberIeeeRawFrame(): EmberIeeeRawFrame

• Returns EmberIeeeRawFrame

makeEmberRawFrame

• makeEmberRawFrame(): EmberRawFrame

• Returns EmberRawFrame

makeZDOframe

• makeZDOframe(name: string | number, params: ParamsDesc): Buffer

• Parameters

  • name: string | number
  • params: ParamsDesc

  Returns Buffer

mrequest

• mrequest(
      apsFrame: EmberApsFrame,
      data: Buffer,
      timeout?: number,
  ): Promise<boolean>

• Parameters

  • apsFrame: EmberApsFrame
  • data: Buffer
  • timeout: number = 30000

  Returns Promise<boolean>

networkIdToEUI64

• networkIdToEUI64(nwk: number): Promise<EmberEUI64>

• Parameters

  • nwk: number

  Returns Promise<EmberEUI64>

permitJoining

• permitJoining(seconds: number): Promise<EZSPFrameData>

• Parameters

  • seconds: number

  Returns Promise<EZSPFrameData>

preJoining

• preJoining(seconds: number): Promise<void>

• Parameters

  • seconds: number

  Returns Promise<void>

rawrequest

• rawrequest(
      rawFrame: EmberRawFrame,
      data: Buffer,
      timeout?: number,
  ): Promise<boolean>

• Parameters

  • rawFrame: EmberRawFrame
  • data: Buffer
  • timeout: number = 10000

  Returns Promise<boolean>

request

• request(
      nwk: number | EmberEUI64,
      apsFrame: EmberApsFrame,
      data: Buffer,
      extendedTimeout?: boolean,
  ): Promise<boolean>

• Parameters

  • nwk: number | EmberEUI64
  • apsFrame: EmberApsFrame
  • data: Buffer
  • extendedTimeout: boolean = false

  Returns Promise<boolean>

reset

• reset(): Promise<void>

• Requested by the EZSP watchdog after too many failures, or by UART layer after port closed unexpectedly. Tries to stop the layers below and startup again.

  Returns Promise<void>

setChannel

• setChannel(channel: number): Promise<EZSPFrameData>

• Parameters

  • channel: number

  Returns Promise<EZSPFrameData>

setNode

• setNode(nwk: number, ieee: number[] | EmberEUI64): void

• Parameters

  • nwk: number
  • ieee: number[] | EmberEUI64

  Returns void

startup

• startup(transmitPower?: number): Promise<StartResult>

• Parameters

  • OptionaltransmitPower: number

  Returns Promise<StartResult>

stop

• stop(emitClose?: boolean): Promise<void>

• Parameters

  • emitClose: boolean = true

  Returns Promise<void>

waitFor

• waitFor(
      address: string | number,
      clusterId: number,
      sequence: number,
      timeout?: number,
  ): { ID: number; start: () => { ID: number; promise: Promise<EmberFrame> } } & {
      cancel: () => void;
  }

• Parameters

  • address: string | number
  • clusterId: number
  • sequence: number
  • timeout: number = 10000

  Returns { ID: number; start: () => { ID: number; promise: Promise<EmberFrame> } } & {
      cancel: () => void;
  }