Skip to content

Latest commit

 

History

History
executable file
·
520 lines (352 loc) · 22.7 KB

zw130_0_0.md

File metadata and controls

executable file
·
520 lines (352 loc) · 22.7 KB
layout title
documentation
ZW130 - ZWave

{% include base.html %}

ZW130 WallMote Quad

This describes the Z-Wave device ZW130, manufactured by AEON Labs with the thing type UID of aeon_zw130_00_000.

The device is in the category of Wall Switch, defining Any device attached to the wall that controls a binary status of something, for ex. a light switch.

ZW130 product image

The ZW130 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is unable to participate in the routing of data from other devices.

The ZW130 does not permanently listen for messages sent from the controller - it will periodically wake up automatically to check if the controller has messages to send, but will sleep most of the time to conserve battery life. Refer to the Wakeup Information section below for further information.

Overview

Aeotec WallMote Quad is an intelligent Z-Wave remote controller that mounted on a wall.

It has 4 touch buttons that you can easily control the Z-Wave devices in your home network via touching, long pressing or sliding the button areas. Its surface has a RGB LED to indicate the button actions also accompanied by touch beep and vibration.

The WallMote Quad is also a security Z-Wave device and supports Over The Air (OTA) feature for the products firmware upgrade.

Inclusion Information

Including WallMote Quad as a non-secure device:

If you want your WallMote Quad as a non-security device in your Z-wave network, you just need to press the Action Button once on WallMote Quad when you use a controller/gateway to add/include it. The green LED will be on for 2 seconds and then the orange LED will fast blink for 10 minutes (if the WallMote Quad does not receive the Wake Up No More Info command from primary Controller) to indicate the inclusion is successful

Including WallMote Quad as a secure device:

In order to take full advantage of all functionality the WallMote Quad, you may want your WallMote Quad is a security device that uses secure/encrypted message to communicate in Z-wave network, so a security enabled controller/gateway is needed for the WallMote Quad to be used as a security device. You need to press the WallMote Quad’s Action Button 2 times within 1 second when your security controller/gateway starts the network inclusion. The blue LED will be on for 2 seconds and then the orange LED will fast blink for 10 minutes (if the WallMote Quad does not receive the Wake Up No More Info command from primary Controller) to indicate the inclusion is successful.

Exclusion Information

Your WallMote Quad can be removed from your Z-Wave network at any time. You'll need to use your Z-Wave network's main controller/ gateway. To do this, please refer to the part of their respective manuals that tell you how to remove devices from your network.

  1. Put your primary controller into device removal mode.
  2. Unlock your WallMote Quad from the Back Mount plate and take the WallMote Quad unit near to your primary controller.
  3. Press the Action Button on your WallMote Quad.

If your WallMote Quad is successfully removed from the Z-Wave network, the LED will become a colourful gradient for a few seconds and then turn off. If the removing was unsuccessful, the red LED will be solid for 2 seconds and then turn off, repeat the above steps.

Wakeup Information

The ZW130 does not permanently listen for messages sent from the controller - it will periodically wake up automatically to check if the controller has messages to send, but will sleep most of the time to conserve battery life. The wakeup period can be configured in the user interface - it is advisable not to make this too short as it will impact battery life - a reasonable compromise is 1 hour.

The wakeup period does not impact the devices ability to report events or sensor data. The device can be manually woken with a button press on the device as described below - note that triggering a device to send an event is not the same as a wakeup notification, and this will not allow the controller to communicate with the device.

In order to send your WallMote Quad new configuration commands from your Z-Wave controller or gateway, it will need to be woken up.

Remove your WallMote Quad unit from its Back Mounting Plate, press and hold the Action Button for 3 seconds(the buzzer chirp once and the orange LED will be ON) on the back of the WallMote Quad unit and then release it. This will trigger and send a wake up notification command to your controller/gateway, then your WallMote Quad will wake up for 10 minutes and the orange LED will fast blink while it is awake (if the WallMote Quad does not receive the Wake Up No More Info from the primary Controller).

General Usage Information

You need to add the Controller to the association groups for Basic and Multilevel for each button in order to get on/off and increase/decrease notifications on the appropriate channel.

Channels

The following table summarises the channels available for the ZW130 -:

Channel Name Channel ID Channel Type Category Item Type
Scene Number scene_number scene_number Number
Low battery alarm alarm_battery alarm_battery LowBattery Switch
Battery Level battery-level system.battery_level Battery Number
Button Number 1 switch_binary1 switch_binary Switch Switch
Swipe Switch 1 switch_startstop1 switch_startstop Switch String
Scene Number 1 scene_number1 scene_number Number
Button Number 2 switch_binary2 switch_binary Switch Switch
Swipe Switch 2 switch_startstop2 switch_startstop Switch String
Scene Number 2 scene_number2 scene_number Number
Button Number 3 switch_binary3 switch_binary Switch Switch
Swipe Switch 3 switch_startstop3 switch_startstop Switch String
Scene Number 3 scene_number3 scene_number Number
Button Number 4 switch_binary4 switch_binary Switch Switch
Swipe Switch 4 switch_startstop4 switch_startstop Switch String
Scene Number 4 scene_number4 scene_number Number

Scene Number

Triggers when a scene button is pressed.

The scene_number channel is of type scene_number and supports the Number item. This channel provides the scene, and the event as a decimal value in the form <scene>.<event>. The scene number is set by the device, and the event is as follows -:

Event ID Event Description
0 Single key press
1 Key released
2 Key held down
3 Double keypress
4 Tripple keypress
5 4 x keypress
6 5 x keypress

Low battery alarm

Indicates if the low battery alarm is triggered.

The alarm_battery channel is of type alarm_battery and supports the Switch item and is in the LowBattery category. This is a read only channel so will only be updated following state changes from the device.

The following state translation is provided for this channel to the Switch item type -:

Value Label
OFF OK
ON Alarm

Battery Level

Represents the battery level as a percentage (0-100%). Bindings for things supporting battery level in a different format (e.g. 4 levels) should convert to a percentage to provide a consistent battery level reading.

The system.battery-level channel is of type system.battery-level and supports the Number item and is in the Battery category. This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%.

Button Number 1

Switch the power on and off.

The switch_binary1 channel is of type switch_binary and supports the Switch item and is in the Switch category.

Swipe Switch 1

Switch indicating direction.

The switch_startstop1 channel is of type switch_startstop and supports the String item and is in the Switch category. This channel provides the start/stop state of a switch as a JSON string. It is designed for use in rules and will indicate the direction of travel of the switch as INCREASE, DECREASE, STOP.

Scene Number 1

Triggers when a scene button is pressed.

The scene_number1 channel is of type scene_number and supports the Number item. This channel provides the scene, and the event as a decimal value in the form <scene>.<event>. The scene number is set by the device, and the event is as follows -:

Event ID Event Description
0 Single key press
1 Key released
2 Key held down
3 Double keypress
4 Tripple keypress
5 4 x keypress
6 5 x keypress

Button Number 2

Switch the power on and off.

The switch_binary2 channel is of type switch_binary and supports the Switch item and is in the Switch category.

Swipe Switch 2

Switch indicating direction.

The switch_startstop2 channel is of type switch_startstop and supports the String item and is in the Switch category. This channel provides the start/stop state of a switch as a JSON string. It is designed for use in rules and will indicate the direction of travel of the switch as INCREASE, DECREASE, STOP.

Scene Number 2

Triggers when a scene button is pressed.

The scene_number2 channel is of type scene_number and supports the Number item. This channel provides the scene, and the event as a decimal value in the form <scene>.<event>. The scene number is set by the device, and the event is as follows -:

Event ID Event Description
0 Single key press
1 Key released
2 Key held down
3 Double keypress
4 Tripple keypress
5 4 x keypress
6 5 x keypress

Button Number 3

Switch the power on and off.

The switch_binary3 channel is of type switch_binary and supports the Switch item and is in the Switch category.

Swipe Switch 3

Switch indicating direction.

The switch_startstop3 channel is of type switch_startstop and supports the String item and is in the Switch category. This channel provides the start/stop state of a switch as a JSON string. It is designed for use in rules and will indicate the direction of travel of the switch as INCREASE, DECREASE, STOP.

Scene Number 3

Triggers when a scene button is pressed.

The scene_number3 channel is of type scene_number and supports the Number item. This channel provides the scene, and the event as a decimal value in the form <scene>.<event>. The scene number is set by the device, and the event is as follows -:

Event ID Event Description
0 Single key press
1 Key released
2 Key held down
3 Double keypress
4 Tripple keypress
5 4 x keypress
6 5 x keypress

Button Number 4

Switch the power on and off.

The switch_binary4 channel is of type switch_binary and supports the Switch item and is in the Switch category.

Swipe Switch 4

Switch indicating direction.

The switch_startstop4 channel is of type switch_startstop and supports the String item and is in the Switch category. This channel provides the start/stop state of a switch as a JSON string. It is designed for use in rules and will indicate the direction of travel of the switch as INCREASE, DECREASE, STOP.

Scene Number 4

Triggers when a scene button is pressed.

The scene_number4 channel is of type scene_number and supports the Number item. This channel provides the scene, and the event as a decimal value in the form <scene>.<event>. The scene number is set by the device, and the event is as follows -:

Event ID Event Description
0 Single key press
1 Key released
2 Key held down
3 Double keypress
4 Tripple keypress
5 4 x keypress
6 5 x keypress

Device Configuration

The following table provides a summary of the 7 configuration parameters available in the ZW130. Detailed information on each parameter can be found in the sections below.

Param Name Description
1 Touch sound Enable/disable the touch sound.
2 Touch vibration Enable/disable the touch vibration.
3 Button slide Enable/disable the function of button slide.
4 Notification report Which notification to be sent to the associated devices.
5 Color Configure which color will be displayed when a button is pressed
39 Low battery value Set the low battery value
255 Reset the WallMote Quad Reset the WallMote Quad to factory default.
Wakeup Interval Sets the interval at which the device will accept commands from the controller
Wakeup Node Sets the node ID of the device to receive the wakeup notifications

Parameter 1: Touch sound

Enable/disable the touch sound.

The following option values may be configured -:

Value Description
0 Disable
1 Enable

The manufacturer defined default value is 1 (Enable).

This parameter has the configuration ID config_1_1 and is of type INTEGER.

Parameter 2: Touch vibration

Enable/disable the touch vibration.

The following option values may be configured -:

Value Description
0 Disable
1 Enable

The manufacturer defined default value is 1 (Enable).

This parameter has the configuration ID config_2_1 and is of type INTEGER.

Parameter 3: Button slide

Enable/disable the function of button slide.

The following option values may be configured -:

Value Description
0 Disable
1 Enable

The manufacturer defined default value is 1 (Enable).

This parameter has the configuration ID config_3_1 and is of type INTEGER.

Parameter 4: Notification report

Which notification to be sent to the associated devices. To set which notification would be sent to the associated devices (Group 1) when pressing the buttons. When the parameter is set to 3, slide functionality on the buttons is activated. The following option values may be configured -:

Value Description
1 Central scene
3 Central scene and config

The manufacturer defined default value is 1 (Central scene).

This parameter has the configuration ID config_4_1 and is of type INTEGER.

Parameter 5: Color

Configure which color will be displayed when a button is pressed Each color component occupies a single byte. To calculate the color value do:

color = ((((Red * 256) + Green) * 256) + Blue) * 256

Value 1 = Red

Value 2 = Green

Value 3 = Blue

Value 4 = Reserved Values in the range 0 to 4294967040 may be set.

The manufacturer defined default value is 65280.

This parameter has the configuration ID config_5_4 and is of type INTEGER.

Parameter 39: Low battery value

Set the low battery value

Values in the range 0 to 50 may be set.

The manufacturer defined default value is 5.

This parameter has the configuration ID config_39_1 and is of type INTEGER.

Parameter 255: Reset the WallMote Quad

Reset the WallMote Quad to factory default.

The following option values may be configured -:

Value Description
0 Reset to factory default
1431655765 Reset and remove

The manufacturer defined default value is 0 (Reset to factory default).

This parameter has the configuration ID config_255_4_wo and is of type INTEGER. This is a write only parameter.

Wakeup Interval

The wakeup interval sets the period at which the device will listen for messages from the controller. This is required for battery devices that sleep most of the time in order to conserve battery life. The device will wake up at this interval and send a message to the controller to tell it that it can accept messages - after a few seconds, it will go back to sleep if there is no further communications.

This setting is defined in seconds. It is advisable not to set this interval too short or it could impact battery life. A period of 1 hour (3600 seconds) is suitable in most instances.

Note that this setting does not affect the devices ability to send sensor data, or notification events.

This parameter has the configuration ID wakeup_interval and is of type INTEGER.

Wakeup Node

When sleeping devices wake up, they send a notification to a listening device. Normally, this device is the network controller, and normally the controller will set this automatically to its own address. In the event that the network contains multiple controllers, it may be necessary to configure this to a node that is not the main controller. This is an advanced setting and should not be changed without a full understanding of the impact.

This parameter has the configuration ID wakeup_node and is of type INTEGER.

Association Groups

Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic.

The ZW130 supports 9 association groups.

Group 1: Lifeline

The Lifeline association group reports device status to a hub and is not designed to control other devices directly. When using the Lineline group with a hub, in most cases, only the lifeline group will need to be configured and normally the hub will perform this automatically during the device initialisation. Central Scene Notification When touching the Button 1 to 4, the Central Scene Notificcation command will be sent to the associated node (1) in Association group 1.

Association group 1 supports 1 node.

Group 2: Button 1 basic

On/off control via button 1 When touching the Button 1, the Basic Set command will be sent to the associated nodes in Association group 2.

Association group 2 supports 5 nodes.

Group 3: Button 1 multilevel

Dim control via button 1 When touching the Button 1, the Multilevel Switch Set command will be sent to the associated nodes in Association group 3

Association group 3 supports 5 nodes.

Group 4: Button 2 basic

On/off control via button 2 When touching the Button 2, the Basic Set command will be sent to the associated nodes in Association group 4.

Association group 4 supports 5 nodes.

Group 5: Button 2 multilevel

Dim control via button 2 When touching the Button 2, the Multilevel Switch Set command will be sent to the associated nodes in Association group 5.

Association group 5 supports 5 nodes.

Group 6: Button 3 basic

On/off control via button 3 When touching the Button 3, the Basic Set command will be sent to the associated nodes in Association group 6.

Association group 6 supports 5 nodes.

Group 7: Button 3 multilevel

Dim control via button 3 When touching the Button 3, the Multilevel Switch Set command will be sent to the associated nodes in Association group 7.

Association group 7 supports 5 nodes.

Group 8: Button 4 basic

On/off control via button 4 When touching the Button 4, the Basic Set command will be sent to the associated nodes in Association group 8.

Association group 8 supports 5 nodes.

Group 9: Button 4 multilevel

Dim control via button 4 When touching the Button 4, the Multilevel Switch Set command will be sent to the associated nodes in Association group 9.

Association group 9 supports 5 nodes.

Technical Information

Endpoints

Endpoint 0

Command Class Comment
COMMAND_CLASS_NO_OPERATION_V1
COMMAND_CLASS_BASIC_V1
COMMAND_CLASS_SWITCH_MULTILEVEL_V1 Linked to BASIC
COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1
COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1
COMMAND_CLASS_CENTRAL_SCENE_V2
COMMAND_CLASS_ZWAVEPLUS_INFO_V1
COMMAND_CLASS_MULTI_CHANNEL_V2
COMMAND_CLASS_CONFIGURATION_V1
COMMAND_CLASS_ALARM_V4
COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1
COMMAND_CLASS_POWERLEVEL_V1
COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1
COMMAND_CLASS_BATTERY_V1
COMMAND_CLASS_WAKE_UP_V2
COMMAND_CLASS_ASSOCIATION_V2
COMMAND_CLASS_VERSION_V2
COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3

Endpoint 1

Command Class Comment
COMMAND_CLASS_BASIC_V1
COMMAND_CLASS_SWITCH_MULTILEVEL_V1 Linked to BASIC
COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1
COMMAND_CLASS_CENTRAL_SCENE_V2
COMMAND_CLASS_ZWAVEPLUS_INFO_V1
COMMAND_CLASS_ASSOCIATION_V2
COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3

Endpoint 2

Command Class Comment
COMMAND_CLASS_BASIC_V1
COMMAND_CLASS_SWITCH_MULTILEVEL_V1 Linked to BASIC
COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1
COMMAND_CLASS_CENTRAL_SCENE_V2
COMMAND_CLASS_ZWAVEPLUS_INFO_V1
COMMAND_CLASS_ASSOCIATION_V2
COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3

Endpoint 3

Command Class Comment
COMMAND_CLASS_BASIC_V1
COMMAND_CLASS_SWITCH_MULTILEVEL_V1 Linked to BASIC
COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1
COMMAND_CLASS_CENTRAL_SCENE_V2
COMMAND_CLASS_ZWAVEPLUS_INFO_V1
COMMAND_CLASS_ASSOCIATION_V2
COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3

Endpoint 4

Command Class Comment
COMMAND_CLASS_BASIC_V1
COMMAND_CLASS_SWITCH_MULTILEVEL_V1 Linked to BASIC
COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1
COMMAND_CLASS_CENTRAL_SCENE_V2
COMMAND_CLASS_ZWAVEPLUS_INFO_V1
COMMAND_CLASS_ASSOCIATION_V2
COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3

Documentation Links


Did you spot an error in the above definition or want to improve the content? You can contribute to the database here.