Skip to content

Latest commit

 

History

History
736 lines (453 loc) · 26.5 KB

zw122_0_0.md

File metadata and controls

736 lines (453 loc) · 26.5 KB
layout title
documentation
ZW122 - ZWave

{% include base.html %}

ZW122 Water Sensor 6

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

The device is in the category of Sensor, defining Device used to measure something.

ZW122 product image

The ZW122 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 ZW122 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

The ZW122  contains 4 sensing points, which would be more accurately to detect the presence and absence of water or detect whether there is water leak in some places of your home. The Water Sensor 6 has an inbuilt buzzer that can play alarm sounds to let you know when the water is detected.

Inclusion Information

  1. Let your Z-Wave primary controller/gateway enter into adding/inclusion mode. Take your Sensor near to your primary controller.
  2. Press the Action Button once on your Sensor, the green LED will blink.
  3. If your Water Sensor has been successfully added to your Z-Wave network, its green LED will be solid for 2 seconds and then the orange LED will fast blink for 10 minutes if the Sensor does not receive the Wake Up No More info Command from Controller. If the adding was unsuccessful and the red LED will be solid for 2 seconds and then become colourful gradient for a few seconds before it turns off, repeat the above steps.

Exclusion Information

  1. Turn your primary controller into device removal mode. Take the Sensor unit near to your primary controller.
  2. Press the Action Button on your Sensor.
  3. If your Water Sensor is successfully removed from the Z-Wave network, the RGB LED will become a colourful gradient for a few seconds and then turn off. If the removing was unsuccessful, the blue LED will be solid for 2 seconds and then turn off, repeat the above steps

Wakeup Information

The ZW122 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.

Press the Action Button on the Sensor unit and then release the Action Button. This will trigger and send a wake up notification command to your controller/gateway.
If you want your Sensor to keep awake for a longer time, press and hold the Action Button on the back of the Sensor unit for 3 seconds, then your Sensor will wake up for 10 minutes and the orange LED will fast blink while it is awake.

Channels

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

Channel Name Channel ID Channel Type Category Item Type
Sensor (temperature) sensor_temperature sensor_temperature Temperature Number:Temperature
Alarm (burglar) alarm_burglar alarm_burglar Door Switch
Alarm (heat) alarm_heat alarm_heat Fire Switch
Alarm (flood) alarm_flood alarm_flood Water Switch
Battery Level battery-level Battery Number
Alarm (flood) 1 alarm_flood1 alarm_flood Water Switch
Alarm (flood) 2 alarm_flood2 alarm_flood Water Switch

Sensor (temperature)

Indicates the current temperature.

The sensor_temperature channel and is of type sensor_temperature and supports the Number:Temperature item and is in the Temperature category.

Alarm (burglar)

Indicates if the burglar alarm is triggered.

The alarm_burglar channel and is of type alarm_burglar and supports the Switch item and is in the Door 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

Alarm (heat)

Indicates if a heat alarm is triggered.

The alarm_heat channel and is of type alarm_heat and supports the Switch item and is in the Fire 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

Alarm (flood)

Indicates if the flood alarm is triggered.

The alarm_flood channel and is of type alarm_flood and supports the Switch item and is in the Water 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

Channel type information on this channel is not found.

Alarm (flood) 1

Indicates if the flood alarm is triggered.

The alarm_flood1 channel and is of type alarm_flood and supports the Switch item and is in the Water 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

Alarm (flood) 2

Indicates if the flood alarm is triggered.

The alarm_flood2 channel and is of type alarm_flood and supports the Switch item and is in the Water 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

Device Configuration

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

Param Name Description
2 Enable/Disable Power On Wake Period Enables or disables a wake period of 10 minutes after power up.
8 WakeUp Time Out The number of seconds for the device to stay awake after the WakeUp is sent out.
9 Current power mode (read only) Get the current power mode
10 Alarm time for buzzer Set the alarm time for the buzzer when triggered
10 Repeat cyle Repeat cylce of buzzer alarm
10 Time of buzzer keeping ON state Time of buzzer keeping ON state
10 Time of buzzer keeping OFF state Time of buzzer keeping OFF state
39 Low Battery Threshold Set the low battery value. (Range: 10% to 50%)
48 Enable/Disable Sensor report Enable/Disable Sensor report
49 Set the upper limit value Set the upper limit value (overheat)
49 Temperature Unit Celsius or Fahrenheit
49 Temperature value Temperature value
50 Set the lower limit value Set the lower limit value (underheat)
50 Temperature unit Celsius or Fahrenheit
50 Temperature value Temperature value
57 Recover limit value Set the recover limit value of the temperature sensor
57 Temperature unit Celsius or Fahrenheit
57 Recover limit value Recover limit value
64 Default Temperature Unit Sets the default temperature unit.
84 State of tilt sensor State of tilt sensor, read only
86 Enable/Disable the buzzer Enables or disables the buzzer
87 Buzzer Trigger(s) Sets which of the alarms should trigger the buzzer.
88 Basic Set sent to association group 3 Basic Set sent to association group 3
89 Basic Set sent to association group 4 Basic Set sent to association group 4
94 Power source level reported 0=report USB, 1=report Battery
101 Lifeline Report Type To set what unsolicited report would be sent to the Lifeline group.
111 Lifeline Report Interval Set the interval time for sending the unsolicited report.
135 Sensor reports for non multichannel devices Sensor reports for non multichannel devices
136 Sensor probe status Sensor probe status (read only)
201 Temperature calibration Temperature calibration
201 Temperature unit Temperature unit
201 Calibration value Calibration value
252 Lock configuration Enable/Disable lock configuration
255 Reset device to factory default Reset device 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 2: Enable/Disable Power On Wake Period

Enables or disables a wake period of 10 minutes after power up. Enable/disable wake up for 10 minutes state when re-power on the Sensor. ( 0 = Disable, 1 = Enable. ) The following option values may be configured -:

Value Description
0 Disabled
1 Enabled

The manufacturer defined default value is 0 (Disabled).

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

Parameter 8: WakeUp Time Out

The number of seconds for the device to stay awake after the WakeUp is sent out. Set the timeout to go into the sleep state after the Wake Up Notification was sent out. 15 - 255 Values in the range 15 to 255 may be set.

The manufacturer defined default value is 30.

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

Parameter 9: Current power mode (read only)

Get the current power mode Value 1: 0=USB power, 1=Battery power

Value 2: 0=sleeping after powered on, 1=keep awake for 10 min after power on, 2=always awake Values in the range 0 to 0 may be set.

The manufacturer defined default value is 0.

This parameter has the configuration ID config_9_2 and is of type INTEGER. This is a read only parameter.

Parameter 10: Alarm time for buzzer

Set the alarm time for the buzzer when triggered This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. Values in the range 0 to 0 may be set.

The manufacturer defined default value is 0.

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

Parameter 10: Repeat cyle

Repeat cylce of buzzer alarm Once cycle is equal to the buzzer from ON state to OFF state Values in the range 0 to 255 may be set.

The manufacturer defined default value is 10.

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

Parameter 10: Time of buzzer keeping ON state

Time of buzzer keeping ON state

Values in the range 0 to 255 may be set.

The manufacturer defined default value is 10.

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

Parameter 10: Time of buzzer keeping OFF state

Time of buzzer keeping OFF state

Values in the range 0 to 32767 may be set.

The manufacturer defined default value is 30.

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

Parameter 39: Low Battery Threshold

Set the low battery value. (Range: 10% to 50%) Set the low battery value. Range: 10% to 50%.  Values in the range 10 to 50 may be set.

The manufacturer defined default value is 20.

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

Parameter 48: Enable/Disable Sensor report

Enable/Disable Sensor report

The following option values may be configured -:

Value Description
0 Disable Sensor report
1 Enable Sensor report

The manufacturer defined default value is 1 (Enable Sensor report).

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

Parameter 49: Set the upper limit value

Set the upper limit value (overheat) This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. Values in the range 0 to 2147483647 may be set.

The manufacturer defined default value is 0.

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

Parameter 49: Temperature Unit

Celsius or Fahrenheit US Version: 0x04100100 (104 °F), other versions: 0x01900000 (40 °C) The following option values may be configured -:

Value Description
0 Celsius
1 Fahrenheit

The manufacturer defined default value is 1 (Fahrenheit).

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

Parameter 49: Temperature value

Temperature value US Version: 0x04100100 (104 °F), other versions: 0x01900000 (40 °C) Values in the range 0 to 32767 may be set.

The manufacturer defined default value is 4.

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

Parameter 50: Set the lower limit value

Set the lower limit value (underheat) This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. Values in the range 0 to 2147483647 may be set.

The manufacturer defined default value is 0.

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

Parameter 50: Temperature unit

Celsius or Fahrenheit 0=Celsius, 1=Fahrenheit The following option values may be configured -:

Value Description
0 Celsius
1 Fahrenheit

The manufacturer defined default value is 1 (Fahrenheit).

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

Parameter 50: Temperature value

Temperature value US Version: 0x01400100 (32 °F), other versions: 0x00000000 (0 °C) Values in the range 0 to 32767 may be set.

The manufacturer defined default value is 1.

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

Parameter 57: Recover limit value

Set the recover limit value of the temperature sensor This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. Values in the range 0 to 65535 may be set.

The manufacturer defined default value is 0.

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

Parameter 57: Temperature unit

Celsius or Fahrenheit 0=Celsius, 1=Fahrenheit The following option values may be configured -:

Value Description
0 Celsius
1 Fahrenheit

The manufacturer defined default value is 1 (Fahrenheit).

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

Parameter 57: Recover limit value

Recover limit value

Values in the range 1 to 255 may be set.

The manufacturer defined default value is 20.

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

Parameter 64: Default Temperature Unit

Sets the default temperature unit. Sets the default temperature unit.  0 = Celsius unit. 1 = Fahrenheit unit. The following option values may be configured -:

Value Description
0 Celsius
1 Fahrenheit

The manufacturer defined default value is 1 (Fahrenheit).

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

Parameter 84: State of tilt sensor

State of tilt sensor, read only 0=main unit horizontal, 1=main unit vertical Values in the range 0 to 1 may be set.

The manufacturer defined default value is 0.

This parameter has the configuration ID config_84_1 and is of type INTEGER. This is a read only parameter.

Parameter 86: Enable/Disable the buzzer

Enables or disables the buzzer Enable/Disable the buzzer 1 - Enabled, 0 - Disabled The following option values may be configured -:

Value Description
0 Disabled
1 Enabled

The manufacturer defined default value is 1 (Enabled).

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

Parameter 87: Buzzer Trigger(s)

Sets which of the alarms should trigger the buzzer. To set which sensor is triggered the buzzer will alarm.

  • 1 = If the Water leak is triggered, the buzzer will alarm.
  • 2 = If the vibration is triggered, the buzzer will alarm.
  • 4 = If the tilt sensor is triggered, the buzzer will alarm.
  • 16 = If the under heat is triggered, the buzzer will alarm.
  • 32 = If the overheat is triggered, the buzzer will alarm.

Note: if the value = 1+2+4+16+32=55, which means if any sensor is triggered, the buzzer will alarm.  Values in the range 1 to 55 may be set.

The manufacturer defined default value is 55.

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

Parameter 88: Basic Set sent to association group 3

Basic Set sent to association group 3

The following option values may be configured -:

Value Description
0 Send nothing
1 Water present 0xFF, no water present 0x00
2 Water present 0x00, no water present 0xFF

The manufacturer defined default value is 0 (Send nothing).

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

Parameter 89: Basic Set sent to association group 4

Basic Set sent to association group 4

The following option values may be configured -:

Value Description
0 Send nothing
1 Water present 0xFF, no water present 0x00
2 Water present 0x00, no water present 0xFF

The manufacturer defined default value is 0 (Send nothing).

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

Parameter 94: Power source level reported

0=report USB, 1=report Battery

The following option values may be configured -:

Value Description
0 Report USB power level
1 Report Battery power level

The manufacturer defined default value is 0 (Report USB power level).

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

Parameter 101: Lifeline Report Type

To set what unsolicited report would be sent to the Lifeline group. To set what unsolicited report would be sent to the Lifeline group.

  • 0 = Send Nothing.
  • 1 = Battery Report.
  • 2 = Multilevel sensor report for temperature.
  • 3 = Battery Report and Multilevel sensor report for temperature.  The following option values may be configured -:
Value Description
0 Send Nothing
1 Battery Report
2 Temperature
3 Battery and Temperature

The manufacturer defined default value is 3 (Battery and Temperature).

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

Parameter 111: Lifeline Report Interval

Set the interval time for sending the unsolicited report. Set the interval time for sending the unsolicited report that configured by parameter 0x65. (Valid values 0x05-0x28DE80)

Note: 1. The unit of interval time is second if USB power. 2. If battery power, the minimum interval time is equal to Wake Up interval set by the Wake Up CC.  Values in the range 5 to 2678400 may be set.

The manufacturer defined default value is 3600.

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

Parameter 135: Sensor reports for non multichannel devices

Sensor reports for non multichannel devices

Values in the range 0 to 3 may be set.

The manufacturer defined default value is 1.

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

Parameter 136: Sensor probe status

Sensor probe status (read only)

Values in the range 0 to 0 may be set.

The manufacturer defined default value is 0.

This parameter has the configuration ID config_136_1 and is of type INTEGER. This is a read only parameter.

Parameter 201: Temperature calibration

Temperature calibration This is an advanced parameter and will therefore not show in the user interface without entering advanced mode. Values in the range -128 to 127 may be set.

The manufacturer defined default value is 1.

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

Parameter 201: Temperature unit

Temperature unit 0=Celsius,1=Fahrenheit The following option values may be configured -:

Value Description
0 Celsius
1 Fahrenheit

The manufacturer defined default value is 1 (Fahrenheit).

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

Parameter 201: Calibration value

Calibration value

Values in the range -128 to 127 may be set.

The manufacturer defined default value is 0.

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

Parameter 252: Lock configuration

Enable/Disable lock configuration

The following option values may be configured -:

Value Description
0 Disable configuration locked
1 Enable configuration locked

The manufacturer defined default value is 0 (Disable configuration locked).

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

Parameter 255: Reset device to factory default

Reset device to factory default

The following option values may be configured -:

Value Description
1 do nothing
1431655765 Reset device to factory defaults

The manufacturer defined default value is 1 (do nothing).

This parameter has the configuration ID config_255_4 and is of type INTEGER. This is a read 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 ZW122 supports 4 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.

Association group 1 supports 5 nodes.

Group 2: Sensor Status

Association group 2 supports 5 nodes.

Group 3: Sensor 1 Alarm

Association group 3 supports 5 nodes.

Group 4: Sensor 2 Alarm

Association group 4 supports 5 nodes.

Technical Information

Endpoints

Endpoint 0

Command Class Comment
COMMAND_CLASS_NO_OPERATION_V1
COMMAND_CLASS_BASIC_V1
COMMAND_CLASS_SENSOR_MULTILEVEL_V5
COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1
COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1
COMMAND_CLASS_ZWAVEPLUS_INFO_V1
COMMAND_CLASS_MULTI_CHANNEL_V2
COMMAND_CLASS_CONFIGURATION_V1
COMMAND_CLASS_ALARM_V7
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

Endpoint 1

Command Class Comment
COMMAND_CLASS_BASIC_V1
COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1
COMMAND_CLASS_ZWAVEPLUS_INFO_V1
COMMAND_CLASS_ALARM_V7

Endpoint 2

Command Class Comment
COMMAND_CLASS_BASIC_V1
COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1
COMMAND_CLASS_ZWAVEPLUS_INFO_V1
COMMAND_CLASS_ALARM_V7

Documentation Links


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