Class ZBOSSDriver

constructor

• new ZBOSSDriver(options, nwkOpt): ZBOSSDriver

• Parameters

  • options: SerialPortOptions
  • nwkOpt: NetworkOptions

  Returns ZBOSSDriver

netInfo

Readonlyport

brequest

• brequest(addr, profileID, clusterID, dstEp, srcEp, data): 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, params?, timeout?): Promise<ZBOSSFrame>

• Parameters

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

  Returns Promise<ZBOSSFrame>

grequest

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

• Parameters

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

  Returns Promise<ZBOSSFrame>

ieeeByNwk

• ieeeByNwk(nwk): Promise<string>

• Parameters

  • nwk: number

  Returns Promise<string>

isInitialized

• isInitialized(): undefined | boolean

• Returns undefined | boolean

request

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

• Parameters

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

  Returns Promise<ZBOSSFrame>

requestZdo

• requestZdo(clusterId, payload, disableResponse): Promise<void | ZBOSSFrame>

• Parameters

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

  Returns Promise<void | ZBOSSFrame>

startup

• startup(): Promise<StartResult>

• Returns Promise<StartResult>

stop

• stop(): Promise<void>

• Returns Promise<void>

waitFor

• waitFor(commandId, tsn, timeout?): {
      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>;
      });
  }

  • ID: number

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

    • • (): {
            ID: number;
            promise: Promise<ZBOSSFrame>;
        }

      • Returns {
            ID: number;
            promise: Promise<ZBOSSFrame>;
        }

        • ID: number

        • promise: Promise<ZBOSSFrame>