Zum Inhalt

ZWave

Methods

ZWave.AddNetwork

ADMIN

Add a new Z-Wave network with the given serial port.

Parameters:

Field Type Notes
serialPort String

Returns:

Field Type Notes
networkUuid Uuid optional
zwaveError ZWaveError

ZWave.AddNode

ADMIN

Start the node inclusion procedure for the given Z-Wave network.

Parameters:

Field Type Notes
networkUuid Uuid

Returns:

Field Type Notes
zwaveError ZWaveError

ZWave.CancelPendingOperation

ADMIN

Cancel any running node inclusion or removal procedure for the given Z-Wave network.

Parameters:

Field Type Notes
networkUuid Uuid

Returns:

Field Type Notes
zwaveError ZWaveError

ZWave.FactoryResetNetwork

ADMIN

Factory reset the controller for the given Z-Wave network.

Parameters:

Field Type Notes
networkUuid Uuid

Returns:

Field Type Notes
zwaveError ZWaveError

ZWave.GetNetworks

ADMIN

Get all the Z-Wave networks in the system.

Parameters:

No parameters.

Returns:

Field Type Notes
networks ZWaveNetwork[]

ZWave.GetNodes

ADMIN

Get the list of nodes in a network

Parameters:

Field Type Notes
networkUuid Uuid

Returns:

Field Type Notes
nodes ZWaveNode[] optional
zwaveError ZWaveError

ZWave.GetSerialPorts

ADMIN

Get the list of available serial ports from the host system.

Parameters:

No parameters.

Returns:

Field Type Notes
serialPorts SerialPorts

ZWave.IsZWaveAvailable

ADMIN

Query if the Z-Wave subsystem is available at all.

Parameters:

No parameters.

Returns:

Field Type Notes
available Bool

ZWave.RemoveFailedNode

ADMIN

Remove the given failed node from the given Z-Wave network. This will not work if node is not marked as failed.

Parameters:

Field Type Notes
networkUuid Uuid
nodeId Uint

Returns:

Field Type Notes
zwaveError ZWaveError

ZWave.RemoveNetwork

ADMIN

Remove the given Z-Wave network from the system.

Parameters:

Field Type Notes
networkUuid Uuid

Returns:

Field Type Notes
zwaveError ZWaveError

ZWave.RemoveNode

ADMIN

Start the node removal procedure for the given Z-Wave network.

Parameters:

Field Type Notes
networkUuid Uuid

Returns:

Field Type Notes
zwaveError ZWaveError

Notifications

ZWave.NetworkAdded

Emitted whenever a new Z-Wave network has been added to the system.

Parameters:

Field Type Notes
network ZWaveNetwork

ZWave.NetworkChanged

Emitted whenever a Z-Wave network changes.

Parameters:

Field Type Notes
network ZWaveNetwork

ZWave.NetworkRemoved

Emitted whenever a Z-Wave network has been removed from the system.

Parameters:

Field Type Notes
networkUuid Uuid

ZWave.NodeAdded

Emitted whenever a Z-Wave node is added.

Parameters:

Field Type Notes
networkUuid Uuid
node ZWaveNode

ZWave.NodeChanged

Emitted whenever a Z-Wave node has changed.

Parameters:

Field Type Notes
networkUuid Uuid
node ZWaveNode

ZWave.NodeRemoved

Emitted whenever a Z-Wave node is removed.

Parameters:

Field Type Notes
networkUuid Uuid
nodeId Uint