Class ZBOSSAdapter

Hierarchy (view full)

default
- ZBOSSAdapter

Constructors

constructor

new ZBOSSAdapter(networkOptions, serialPortOptions, backupPath, adapterOptions): ZBOSSAdapter
Parameters
- networkOptions: NetworkOptions
- serialPortOptions: SerialPortOptions
- backupPath: string
- adapterOptions: AdapterOptions
Returns ZBOSSAdapter
Overrides Adapter.constructor
- Defined in src/adapter/zboss/adapter/zbossAdapter.ts:40

Properties

hasZdoMessageOverhead

hasZdoMessageOverhead: boolean

manufacturerID

manufacturerID: ManufacturerCode

Methods

addInstallCode

addInstallCode(ieeeAddress, key): Promise<void>
Parameters
- ieeeAddress: string
- key: Buffer
Returns Promise<void>
Overrides default.addInstallCode
- Defined in src/adapter/zboss/adapter/zbossAdapter.ts:209

backup

backup(ieeeAddressesInDatabase): Promise<Backup>
Parameters
- ieeeAddressesInDatabase: string[]
Returns Promise<Backup>
Overrides default.backup
- Defined in src/adapter/zboss/adapter/zbossAdapter.ts:183

getCoordinatorIEEE

getCoordinatorIEEE(): Promise<string>
Returns Promise<string>
Overrides default.getCoordinatorIEEE
- Defined in src/adapter/zboss/adapter/zbossAdapter.ts:146

getCoordinatorVersion

getCoordinatorVersion(): Promise<CoordinatorVersion>
Returns Promise<CoordinatorVersion>
Overrides default.getCoordinatorVersion
- Defined in src/adapter/zboss/adapter/zbossAdapter.ts:150

getNetworkParameters

getNetworkParameters(): Promise<NetworkParameters>
Returns Promise<NetworkParameters>
Overrides default.getNetworkParameters
- Defined in src/adapter/zboss/adapter/zbossAdapter.ts:187

permitJoin

permitJoin(seconds, networkAddress?): Promise<void>
Parameters
- seconds: number
- OptionalnetworkAddress: number
Returns Promise<void>
Overrides default.permitJoin
- Defined in src/adapter/zboss/adapter/zbossAdapter.ts:214

reset

reset(type): Promise<void>
Parameters
- type: "soft" | "hard"
Returns Promise<void>
Overrides default.reset
- Defined in src/adapter/zboss/adapter/zbossAdapter.ts:174

restoreChannelInterPAN

restoreChannelInterPAN(): Promise<void>
Returns Promise<void>
Overrides default.restoreChannelInterPAN
- Defined in src/adapter/zboss/adapter/zbossAdapter.ts:480

sendZclFrameInterPANBroadcast

sendZclFrameInterPANBroadcast(zclFrame, timeout): Promise<ZclPayload>
Parameters
- zclFrame: ZclFrame
- timeout: number
Returns Promise<ZclPayload>
Overrides default.sendZclFrameInterPANBroadcast
- Defined in src/adapter/zboss/adapter/zbossAdapter.ts:475

sendZclFrameInterPANToIeeeAddr

sendZclFrameInterPANToIeeeAddr(zclFrame, ieeeAddress): Promise<void>
Parameters
- zclFrame: ZclFrame
- ieeeAddress: string
Returns Promise<void>
Overrides default.sendZclFrameInterPANToIeeeAddr
- Defined in src/adapter/zboss/adapter/zbossAdapter.ts:470

sendZclFrameToAll

sendZclFrameToAll(endpoint, zclFrame, sourceEndpoint, destination): Promise<void>
Parameters
- endpoint: number
- zclFrame: ZclFrame
- sourceEndpoint: number
- destination: BroadcastAddress
Returns Promise<void>
Overrides default.sendZclFrameToAll
- Defined in src/adapter/zboss/adapter/zbossAdapter.ts:449

sendZclFrameToEndpoint

sendZclFrameToEndpoint(ieeeAddr, networkAddress, endpoint, zclFrame, timeout, disableResponse, disableRecovery, sourceEndpoint?): Promise<void | ZclPayload>
ZCL
Parameters
- ieeeAddr: string
- networkAddress: number
- endpoint: number
- zclFrame: ZclFrame
- timeout: number
- disableResponse: boolean
- disableRecovery: boolean
- OptionalsourceEndpoint: number
Returns Promise<void | ZclPayload>
Overrides default.sendZclFrameToEndpoint
- Defined in src/adapter/zboss/adapter/zbossAdapter.ts:311

sendZclFrameToGroup

sendZclFrameToGroup(groupID, zclFrame, sourceEndpoint?): Promise<void>
Parameters
- groupID: number
- zclFrame: ZclFrame
- OptionalsourceEndpoint: number
Returns Promise<void>
Overrides default.sendZclFrameToGroup
- Defined in src/adapter/zboss/adapter/zbossAdapter.ts:439

sendZdo

sendZdo(ieeeAddress, networkAddress, clusterId, payload, disableResponse): Promise<void>
ZDO
Parameters
- ieeeAddress: string
- networkAddress: number
- clusterId: ClusterId
- payload: Buffer
- disableResponse: true
Returns Promise<void>
Overrides default.sendZdo
- Defined in src/adapter/zboss/adapter/zbossAdapter.ts:247
sendZdo<K>(ieeeAddress, networkAddress, clusterId, payload, disableResponse): Promise<RequestToResponseMap[K]>
Type Parameters
- K extends keyof RequestToResponseMap
Parameters
- ieeeAddress: string
- networkAddress: number
- clusterId: K
- payload: Buffer
- disableResponse: false
Returns Promise<RequestToResponseMap[K]>
Overrides default.sendZdo
- Defined in src/adapter/zboss/adapter/zbossAdapter.ts:254

setChannelInterPAN

setChannelInterPAN(channel): Promise<void>
InterPAN
Parameters
- channel: number
Returns Promise<void>
Overrides default.setChannelInterPAN
- Defined in src/adapter/zboss/adapter/zbossAdapter.ts:465

setTransmitPower

setTransmitPower(value): Promise<void>
Parameters
- value: number
Returns Promise<void>
Overrides default.setTransmitPower
- Defined in src/adapter/zboss/adapter/zbossAdapter.ts:201

start

start(): Promise<StartResult>
Returns Promise<StartResult>
Overrides default.start
- Defined in src/adapter/zboss/adapter/zbossAdapter.ts:132

stop

stop(): Promise<void>
Returns Promise<void>
Overrides default.stop
- Defined in src/adapter/zboss/adapter/zbossAdapter.ts:140

supportsBackup

supportsBackup(): Promise<boolean>
Returns Promise<boolean>
Overrides default.supportsBackup
- Defined in src/adapter/zboss/adapter/zbossAdapter.ts:178

waitFor

waitFor(networkAddress, endpoint, frameType, direction, transactionSequenceNumber, clusterID, commandIdentifier, timeout): {
cancel: (() => void);
promise: Promise<ZclPayload>;
}
Parameters
- networkAddress: number
- endpoint: number
- frameType: FrameType
- direction: Direction
- transactionSequenceNumber: undefined | number
- clusterID: number
- commandIdentifier: number
- timeout: number
Returns {
cancel: (() => void);
promise: Promise<ZclPayload>;
}
- cancel: (() => void)
  - - (): void
    - Returns void
- promise: Promise<ZclPayload>
Overrides default.waitFor
- Defined in src/adapter/zboss/adapter/zbossAdapter.ts:506

`Static`autoDetectPath

autoDetectPath(): Promise<null | string>
Returns Promise<null | string>
- Defined in src/adapter/zboss/adapter/zbossAdapter.ts:126

`Static`create

create(networkOptions, serialPortOptions, backupPath, adapterOptions): Promise<default>
Utility
Parameters
- networkOptions: NetworkOptions
- serialPortOptions: SerialPortOptions
- backupPath: string
- adapterOptions: AdapterOptions
Returns Promise<default>
Inherited from default.create
- Defined in src/adapter/adapter.ts:51

`Static`isValidPath

isValidPath(path): Promise<boolean>
Parameters
- path: string
Returns Promise<boolean>
- Defined in src/adapter/zboss/adapter/zbossAdapter.ts:112

Class ZBOSSAdapter

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ZBOSSAdapter

Properties

hasZdoMessageOverhead

manufacturerID

Methods

addInstallCode

Parameters

Returns Promise<void>

backup

Parameters

Returns Promise<Backup>

getCoordinatorIEEE

Returns Promise<string>

getCoordinatorVersion

Returns Promise<CoordinatorVersion>

getNetworkParameters

Returns Promise<NetworkParameters>

permitJoin

Parameters

Returns Promise<void>

reset

Parameters

Returns Promise<void>

restoreChannelInterPAN

Returns Promise<void>

sendZclFrameInterPANBroadcast

Parameters

Returns Promise<ZclPayload>

sendZclFrameInterPANToIeeeAddr

Parameters

Returns Promise<void>

sendZclFrameToAll

Parameters

Returns Promise<void>

sendZclFrameToEndpoint

Parameters

Returns Promise<void | ZclPayload>

sendZclFrameToGroup

Parameters

Returns Promise<void>

sendZdo

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<RequestToResponseMap[K]>

setChannelInterPAN

Parameters

Returns Promise<void>

setTransmitPower

Parameters

Returns Promise<void>

start

Returns Promise<StartResult>

stop

Returns Promise<void>

supportsBackup

Returns Promise<boolean>

waitFor

Parameters

Returns { cancel: (() => void); promise: Promise<ZclPayload>; }

cancel: (() => void)

Returns void

promise: Promise<ZclPayload>

StaticautoDetectPath

Returns Promise<null | string>

Staticcreate

Parameters

Returns Promise<default>

StaticisValidPath

Parameters

Returns {
cancel: (() => void);
promise: Promise<ZclPayload>;
}

`Static`autoDetectPath

`Static`create

`Static`isValidPath