Class ZBOSSDriver

constructor

• new ZBOSSDriver(options: SerialPortOptions, nwkOpt: NetworkOptions): ZBOSSDriver

  Parameters

  • options: SerialPortOptions
  • nwkOpt: NetworkOptions

  Returns ZBOSSDriver

netInfo

Readonlyport

brequest

• brequest(
      addr: BroadcastAddress,
      profileID: number,
      clusterID: number,
      dstEp: number,
      srcEp: number,
      data: Buffer,
  ): Promise<ZBOSSFrame>

  Parameters

  • addr: BroadcastAddress
  • profileID: number
  • clusterID: number
  • dstEp: number
  • srcEp: number
  • data: Buffer

  Returns Promise<ZBOSSFrame>

connect

• connect(): Promise<boolean>

  Returns Promise<boolean>

execCommand

• execCommand(
      commandId: number,
      params?: KeyValue,
      timeout?: number,
  ): Promise<ZBOSSFrame>

  Parameters

  • commandId: number
  • params: KeyValue = {}
  • timeout: number = 10000

  Returns Promise<ZBOSSFrame>

grequest

• grequest(
      group: number,
      profileID: number,
      clusterID: number,
      srcEp: number,
      data: Buffer,
  ): Promise<ZBOSSFrame>

  Parameters

  • group: number
  • profileID: number
  • clusterID: number
  • srcEp: number
  • data: Buffer

  Returns Promise<ZBOSSFrame>

ieeeByNwk

• ieeeByNwk(nwk: number): Promise<string>

  Parameters

  • nwk: number

  Returns Promise<string>

isInitialized

• isInitialized(): undefined | boolean

  Returns undefined | boolean

request

• request(
      ieee: string,
      profileID: number,
      clusterID: number,
      dstEp: number,
      srcEp: number,
      data: Buffer,
  ): Promise<ZBOSSFrame>

  Parameters

  • ieee: string
  • profileID: number
  • clusterID: number
  • dstEp: number
  • srcEp: number
  • data: Buffer

  Returns Promise<ZBOSSFrame>

requestZdo

• requestZdo(
      clusterId: ClusterId,
      payload: Buffer,
      disableResponse: boolean,
  ): Promise<undefined | ZBOSSFrame>

  Parameters

  • clusterId: ClusterId
  • payload: Buffer
  • disableResponse: boolean

  Returns Promise<undefined | ZBOSSFrame>

startup

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

  Parameters

  • OptionaltransmitPower: number

  Returns Promise<StartResult>

stop

• stop(): Promise<void>

  Returns Promise<void>

waitFor

• waitFor(
      commandId: number,
      tsn: undefined | number,
      timeout?: number,
  ): { ID: number; start: () => { ID: number; promise: Promise<ZBOSSFrame> } }

  Parameters

  • commandId: number
  • tsn: undefined | number
  • timeout: number = 10000

  Returns { ID: number; start: () => { ID: number; promise: Promise<ZBOSSFrame> } }