Previous Topic

Next Topic

Book Contents

Book Index

Protocol Information

To be able to manage Z-Wave networks via the Home Device Manager you need to select the protocol adapter registered under the name Z-Wave.

Protocol Operations

The Z-Wave protocol adapter supports the following device administration operations:

Protocol Properties

The device properties related to the underlying Z-Wave protocol adapter are described in the table below:

Property

Access

Resolution

zwave.security.level

R

Mandatory

zwave.home_id

R

Mandatory

node_id

R

Mandatory

zwave.node_id

R

Mandatory

zwave.generic.type

R

Optional

zwave.specific.type

R

Optional

zwave.manufacturer_specific.manufacturer_id

R

Optional

zwave.manufacturer_specific.product_id

R

Optional

zwave.manufacturer_specific.product_type_id

R

Optional

zwave.protocol.version

R

Optional

zwave.application.version

R

Optional

zwave.library.type

R

Optional

zwave.sleeping.node

R

Optional

zwave.secure

R

Optional

zwave.minimal.polling.interval

RW

Mandatory

zwave.disable.full.polling

RW

Mandatory

zwave.device.configured

RE

Mandatory

zwave.plus

R

Optional

Conditional Properties

Added only if the Manufacturer Specific CC (0x72) version 2 is supported by the device:

Property

Access

Resolution

zwave.manufacturer_specific.serial

R

Optional

zwave.manufacturer_specific.oem_id

R

Optional

Added only if the Z-Wave Plus Info CC (0x5E) is supported by the device (i.e. zwave.plus property's value is set to true):

Property

Access

Resolution

zwave.plus.version

R

Optional

zwave.plus.role.type

R

Optional

zwave.plus.node.type

R

Optional

zwave.plus.device.type

R

Optional

zwave.plus.installer.icon.type

R

Optional

zwave.plus.user.icon.type

R

Optional

Added only if the Security CC (0x98) is supported by the device:

Property

Access

Resolution

zwave.security.status.code

RE

Mandatory

SECURE_INCLUSION_NOT_SUPPORTED 4;

RE

Mandatory

SECURE_INCLUSION_IN_PROGRESS 3;

RE

Mandatory

zwave.manufacturer_specific.oem_id

RE

Mandatory

You can retrieve a list of the properties required by the Z-Wave protocol adapter by using the getProperties or getPropertyMetadata method of the corresponding ProtocolAdapterInfo object. If a property is mandatory, its ProtocolAdapter.META_INFO_PROPERTY_RESOLUTION metadata property will be ProtocolAdapter.META_INFO_PROPERTY_RESOLUTION_MANDATORY.

Polling

Z-Wave protocol adapter implements a specific polling mechanism instead of the default HDM polling mechanism. Note that this mechanism is used only for legacy Z-Wave devices, since the Z-Wave Plus devices are required by specification to send events to the devices associated in group 1.

The specifics of this polling mechanism are as follow:

This approach allows for a better balance between the need for polling and potentially making the network unusable because of the overhead.

Please note that, however aggressive a polling method is, it can never overcome the delay in refreshing the device state. To avoid this problem we recommend to choose mains-powered devices which implement Z-Wave HAIL Command Class, since in this case the device state is refreshed almost instantly should an action on the end device occur. Alternatively the use of Z-Wave Plus devices circumvents the issue altogether, because they send events to the device that have been added to association group 1 and our driver will always associate the controller for all Z-Wave Plus devices.

Network Controller

The ZWaveNetworkController interface extends the com.prosyst.mbs.services.hdm.deviceclasses.NetworkController and the com.prosyst.mbs.services.hdm.deviceclasses.NetworkControllerExt HDM device classes. For more information refer to: Z-Wave Network Controller

The NetworkController device class provides support for network controllers. The network controller mode can be for example add, remove, learn, etc. For more information refer to: NetworkController

The NetworkControllerExt class provides additional support for network controllers. The network controller mode can be normal, pairing and removing. Additionally the mode duration and mode remaining time are provided. The operation reset has to reset the controller and to remove all home devices. For more information refer to: NetworkControllerExt .