Class Driver

constructor

• new Driver(serialOpt, nwkOpt, backupPath): Driver

• Parameters

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

  Returns Driver

backupMan

ezsp

ieee

networkParams

version

addEndpoint

• addEndpoint(__namedParameters): Promise<void>

• Parameters

  • __namedParameters: AddEndpointParameters

  Returns Promise<void>

addInstallCode

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

• Parameters

  • ieeeAddress: string
  • key: Buffer

  Returns Promise<void>

addTransientLinkKey

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

• Parameters

  • partner: EmberEUI64
  • transientKey: EmberKeyData

  Returns Promise<EZSPFrameData>

brequest

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

• Parameters

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

  Returns Promise<boolean>

getKey

• getKey(keyType): Promise<EZSPFrameData>

• Parameters

  • keyType: EmberKeyType

  Returns Promise<EZSPFrameData>

getNetworkKeyInfo

• getNetworkKeyInfo(): Promise<EZSPFrameData>

• Returns Promise<EZSPFrameData>

handleNodeJoined

• handleNodeJoined(nwk, ieee): void

• Parameters

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

  Returns void

ieeerawrequest

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

• Parameters

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

  Returns Promise<boolean>

makeApsFrame

• makeApsFrame(clusterId, disableResponse): EmberApsFrame

• Parameters

  • clusterId: number
  • disableResponse: boolean

  Returns EmberApsFrame

makeEmberIeeeRawFrame

• makeEmberIeeeRawFrame(): EmberIeeeRawFrame

• Returns EmberIeeeRawFrame

makeEmberRawFrame

• makeEmberRawFrame(): EmberRawFrame

• Returns EmberRawFrame

makeZDOframe

• makeZDOframe(name, params): Buffer

• Parameters

  • name: string | number
  • params: ParamsDesc

  Returns Buffer

mrequest

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

• Parameters

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

  Returns Promise<boolean>

networkIdToEUI64

• networkIdToEUI64(nwk): Promise<EmberEUI64>

• Parameters

  • nwk: number

  Returns Promise<EmberEUI64>

permitJoining

• permitJoining(seconds): Promise<EZSPFrameData>

• Parameters

  • seconds: number

  Returns Promise<EZSPFrameData>

preJoining

• preJoining(seconds): Promise<void>

• Parameters

  • seconds: number

  Returns Promise<void>

rawrequest

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

• Parameters

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

  Returns Promise<boolean>

request

• request(nwk, apsFrame, data, extendedTimeout?): 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): Promise<EZSPFrameData>

• Parameters

  • channel: number

  Returns Promise<EZSPFrameData>

setNode

• setNode(nwk, ieee): void

• Parameters

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

  Returns void

setRadioPower

• setRadioPower(value): Promise<EZSPFrameData>

• Parameters

  • value: number

  Returns Promise<EZSPFrameData>

startup

• startup(): Promise<StartResult>

• Returns Promise<StartResult>

stop

• stop(emitClose?): Promise<void>

• Parameters

  • emitClose: boolean = true

  Returns Promise<void>

waitFor

• waitFor(address, clusterId, sequence, timeout?): {
      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);
  }