1 3. Controller class

AlCalzone edited this page 2019-08-23 15:48:03 +02:00

Table of Contents

• beginInclusion method
• stopInclusion method
• nodes property
• libraryVersion property
• type property
• homeId property
• ownNodeId property

The controller instance contains information about the controller and a list of its nodes.

beginInclusion method

async beginInclusion(): Promise<boolean>

Starts the inclusion process for a new node. The returned promise resolves to true if starting the inclusion was successful, false if it failed or if it was already active.

stopInclusion method

async stopInclusion(): Promise<boolean>

Stops the inclusion process for a new node. The returned promise resolves to true if stopping the inclusion was successful, false if it failed or if it was not active.

nodes property

readonly nodes: ReadonlyMap<number, ZWaveNode>

This property contains a map of all nodes that you can access by their node ID, e.g. nodes.get(2) for node 2.

libraryVersion property

readonly libraryVersion: string

Returns the Z-Wave library version that is supported by the controller hardware.

Note: This property is only defined after the controller interview!

type property

readonly type: ZWaveLibraryTypes

Returns the type of the Z-Wave library that is supported by the controller hardware. The following values are possible:

export enum ZWaveLibraryTypes {
	"Unknown",
	"Static Controller",
	"Controller",
	"Enhanced Slave",
	"Slave",
	"Installer",
	"Routing Slave",
	"Bridge Controller",
	"Device under Test",
	"N/A",
	"AV Remote",
	"AV Device",
}

Note: This property is only defined after the controller interview!

homeId property

readonly homeId: number

A 32bit number identifying the current network.

Note: This property is only defined after the controller interview!

ownNodeId property

readonly ownNodeId: number

Returns the ID of the controller in the current network.

Note: This property is only defined after the controller interview!