Class ZBOSSAdapter

Hierarchy (View Summary)

Adapter
- ZBOSSAdapter

Constructors

constructor

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

Properties

hasZdoMessageOverhead

hasZdoMessageOverhead: boolean

manufacturerID

manufacturerID: ManufacturerCode

Methods

addInstallCode

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

backup

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

getCoordinatorIEEE

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

getCoordinatorVersion

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

getNetworkParameters

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

permitJoin

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

reset

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

restoreChannelInterPAN

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

sendZclFrameInterPANBroadcast

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

sendZclFrameInterPANToIeeeAddr

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

sendZclFrameToAll

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

sendZclFrameToEndpoint

sendZclFrameToEndpoint(
    ieeeAddr: string,
    networkAddress: number,
    endpoint: number,
    zclFrame: ZclFrame,
    timeout: number,
    disableResponse: boolean,
    disableRecovery: boolean,
    sourceEndpoint?: number,
): 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 Adapter.sendZclFrameToEndpoint
- Defined in src/adapter/zboss/adapter/zbossAdapter.ts:274

sendZclFrameToGroup

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

sendZdo

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

setChannelInterPAN

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

start

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

stop

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

supportsBackup

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

waitFor

waitFor(
    networkAddress: number,
    endpoint: number,
    frameType: FrameType,
    direction: Direction,
    transactionSequenceNumber: undefined | number,
    clusterID: number,
    commandIdentifier: number,
    timeout: number,
): { 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> }
Overrides Adapter.waitFor
- Defined in src/adapter/zboss/adapter/zbossAdapter.ts:469

`Static`create

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

Class ZBOSSAdapter

Hierarchy (View Summary)

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>

start

Returns Promise<StartResult>

stop

Returns Promise<void>

supportsBackup

Returns Promise<boolean>

waitFor

Parameters

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

Staticcreate

Parameters

Returns Promise<Adapter>

Settings

On This Page

`Static`create