Topics and properties of the events published by the Z-Wave module.

You can develop applications which track the events related to Z-Wave network and separate devices. To do so you need to subscribe for the events that are published by the Z-Wave Module, i.e. register an event handler.The supported topics and related event properties and predefined values are available in the com.prosyst.mbs.services.zwave.ZWaveController interface.

Subscribing for Events Related to Z-Wave Devices

• Register an Event Handler service for the following topics depending on your needs:

  Field	Description
  Z_WAVE_CONTROL_EVENT_TOPIC_ADD	An event with that topic will be fired when new devices has been added to the network.
  Z_WAVE_CONTROL_EVENT_TOPIC_CONTROLLER_INFO_CHANGED	An event with that topic will be fired when the controller is reinitialized or network update is done.
  Z_WAVE_CONTROL_EVENT_TOPIC_DEVICE_AWAKE_BEGIN	An event with that topic will be fired when a sleeping device becomes available.
  Z_WAVE_CONTROL_EVENT_TOPIC_DEVICE_AWAKE_PASSED	An event with that topic will be fired when the sleeping device has become awakened and the attempt to read device info has already finished.
  Z_WAVE_CONTROL_EVENT_TOPIC_DEVICE_CLASSINFO_BEGIN	An event with that topic will be send when a the supported command classes of a device become known.
  Z_WAVE_CONTROL_EVENT_TOPIC_DEVICE_NIF_RECEIVED_BEGIN	An event with that topic will be send when an unsolicited NIF frame of a device is received.
  Z_WAVE_CONTROL_EVENT_TOPIC_ERROR_EMPTY_DEVICE_LIST	An event with this topic will be fired when the driver has finished its initialization and the controller has reported that there are no devices in the list.
  Z_WAVE_CONTROL_EVENT_TOPIC_INIT_END	An event with this topic will be fired when the driver has finished its initialization and all devices are available to be accessed with getDevice(int).
  Z_WAVE_CONTROL_EVENT_TOPIC_MODE_BEGIN	An event with that topic will be fired when the controller mode is changed Property Z_WAVE_CONTROL_EVENT_MODE will contain the changed mode.
  Z_WAVE_CONTROL_EVENT_TOPIC_REMOVE	An event with that topic will be fired when new devices has been removed from the network.
  Z_WAVE_CONTROL_EVENT_TOPIC_REPLACE	An event with that topic will be fired when new devices has been replaced by a new one in the network.
  Z_WAVE_NETWORK_EVENT_MESSAGE	All network events will have property with that name that contains the received Z-Wave message.
  Z_WAVE_PROGRESS_TRACKING_ADD_ALLOWED	An event with this topic will be sent when the controller enters add mode.
  Z_WAVE_PROGRESS_TRACKING_ADD_ALREADY_KNOWN_DEVICE	An event with this topic will be sent if the user presses a button of a device already included into the network.
  Z_WAVE_PROGRESS_TRACKING_ADD_COMMAND_CLASS_INFO_READ	An event with this topic will be sent when the command class info have been acquired from the device.
  Z_WAVE_PROGRESS_TRACKING_ADD_DISALLOWED	An event with this topic will be sent when the controller leaves add mode.
  Z_WAVE_PROGRESS_TRACKING_ADD_DONE	An event with this topic will be sent when the driver has finished processing the device and it will become available for the using applications.
  Z_WAVE_PROGRESS_TRACKING_ADD_ERROR	An event with this topic will be sent when there was an error.
  Z_WAVE_PROGRESS_TRACKING_ADD_FILLING_CACHE_DONE	An event with this topic will be sent when filling the cache finish.
  Z_WAVE_PROGRESS_TRACKING_ADD_FILLING_CACHE_FOR_COMMAND_CLASS	An event with this topic will be sent when the controller start to fill the cache for supported by the device command classes.
  Z_WAVE_PROGRESS_TRACKING_ADD_FILLING_CACHE_FOR_SECURE_COMMAND_CLASS	An event with this topic will be sent when the controller start to fill the cache for supported by the device secure command classes.
  Z_WAVE_PROGRESS_TRACKING_ADD_FILLING_CACHE_START	An event with this topic will be sent when the driver starts filling the cache for the supported by the device command classes.
  Z_WAVE_PROGRESS_TRACKING_ADD_NEW_DEVICE	An event with this topic will be sent when new device have been added to the network.
  Z_WAVE_PROGRESS_TRACKING_ADD_SECURE_COMMAND_CLASS_INFO_READ	An event with this topic will be sent when the information about the secure command classes have been acquired from the device.
  Z_WAVE_PROGRESS_TRACKING_ADD_START_SECURE_INCLUSION	An event with this topic will be sent when the secure inclusion part of the inclusion process has been started.
  Z_WAVE_PROGRESS_TRACKING_REPLACE_ALLOWED	An event with this topic will be sent when the controller enters replace mode.
  Z_WAVE_PROGRESS_TRACKING_REPLACE_ALREADY_KNOWN_DEVICE	An event with this topic will be sent if the user presses a button of a device already included into the network.
  Z_WAVE_PROGRESS_TRACKING_REPLACE_DISALLOWED	An event with this topic will be sent when the controller leaves replace mode.
  Z_WAVE_PROGRESS_TRACKING_REPLACE_DONE	An event with this topic will be sent when the driver has finished processing the device and it will become available for the using applications.
  Z_WAVE_PROGRESS_TRACKING_REPLACE_ERROR	An event with this topic will be sent when there was an error.
  Z_WAVE_PROGRESS_TRACKING_REPLACE_NEW_DEVICE	An event with this topic will be sent when new device has been replaced in the network.

All driver event topic constants that end with "_BEGIN" are common prefixes for event topics. To listen to mode changes of a specific controller a listener that catches ZWaveController.Z_WAVE_CONTROL_EVENT_TOPIC_MODE_BEGIN + <ctrl_node_id> must be registered.

• In the handleEvent method of your Event Handler implementation, process the properties of the passed Event as follows:
  • ZWaveController.Z_WAVE_CONTROL_EVENT_DEVICE - to access the device (of type com.prosyst.mbs.services.zwave.ZWaveDevice) which triggered the event
  • ZWaveController.Z_WAVE_CONTROL_EVENT_MODE - to get the new mode of the controller. Possible values are:
    • ZWaveController.STATE_ADDING
    • ZWaveController.STATE_REMOVING
    • ZWaveController.STATE_NORMAL
  • ZWaveController.Z_WAVE_CONTROL_EVENT_MODE_OPTION_HIGH_POWER - a boolean property for the controller mode option High Power. This property is available only when the property ZWaveController.Z_WAVE_CONTROL_EVENT_MODE has the value ZWaveController.STATE_ADDING or ZWaveController.STATE_REMOVING.
  • ZWaveController.Z_WAVE_CONTROL_EVENT_MODE_OPTION_NETWORK_WIDE - a boolean property for the controller mode option Network-Wide Inclusion (check the Network Setup, Topology and Operation section in the Technology Overview). This property is available only when the ZWaveController.Z_WAVE_CONTROL_EVENT_MODE has the value ZWaveController.STATE_ADDING
  • ZWaveController.PROPERTY_Z_WAVE_PROGRESS_TRACKING_ADD_NODE_ID - contains the node id of the source device
  • ZWaveController.PROPERTY_Z_WAVE_PROGRESS_TRACKING_ADD_CC_INFO - contains the command classes supported by the source device
  • ZWaveController.PROPERTY_Z_WAVE_PROGRESS_TRACKING_ADD_CLASS_ID - contains the id of the command class
  • ZWaveController.PROPERTY_Z_WAVE_PROGRESS_TRACKING_ADD_HOUSE_ID - contains the home id of the network

Subscribing for Events Related to the Network

• Register an Event Handler service for the following topics depending on your needs:
  • ZWaveController.Z_WAVE_NETWORK_EVENT_TOPIC_ALL_V2 - for all events relevant to the network.
  • ZWaveController.Z_WAVE_NETWORK_LOAD_TOPIC - for events carrying network load information (such events are periodically sent).
• In the handleEvent method of your Event Handler implementation, process the property of the passed Event as follows:

  Field	Description
  Z_WAVE_NETWORK_LOAD_DEVICE_MESSAGES_FAILED	Network load event will have property with that name indicating failed messages (sent or received) for specified period.
  Z_WAVE_NETWORK_LOAD_DEVICE_MESSAGES_RECEIVED	Network load event will have property with that name indicating received messages from devices.
  Z_WAVE_NETWORK_LOAD_DEVICE_MESSAGES_SENT	Network load event will have property with that name indicating sent messages per device.
  Z_WAVE_NETWORK_LOAD_DEVICES	Network load event will have property with that name indicating device ids contributing to network load.
  Z_WAVE_NETWORK_LOAD_FAILED	Network load event will have property with that name indicating failed messages (sent or received) for specified period.
  Z_WAVE_NETWORK_LOAD_PERIOD_MINUTES	Network load event will have property with that name indicating period in minutes of gathered statistics.
  Z_WAVE_NETWORK_LOAD_RECEIVED	Network load event will have property with that name indicating received messages for specified period.
  Z_WAVE_NETWORK_LOAD_SENT	Network load event will have property with that name indicating sent messages for specified period.