| layout | title |
|---|---|
documentation |
Flood sensor - ZWave |
{% include base.html %}
This describes the Z-Wave device Flood sensor, manufactured by Shenzhen Neo Electronics Co., Ltd with the thing type UID of shenzhen_floodsensor_00_000.
The device is in the category of Sensor, defining Device used to measure something.
The Flood sensor 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 Flood sensor 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.
Flood/Water detection
- Remove the sensor cover.
- Make sure the sensor is powered.
- Set Z‐Wave controller or Z‐Wave gateway into inclusion mode (Refer to the controller or gateway operating manual)
- Press the button three times within 1.5 second, the device will enter inclusion mode. And the LED will flash on and off alternately five times..
- Remove the device cover.
- Make sure the sensor is powered.
- Set Z‐Wave controller or Z‐Wave gateway into exclusion mode (Refer to the controller or gateway operating manual)
- Press the button three times within 1.5 second, the device will enter exclusion mode.
The Flood sensor 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.
- You can press the button once to wake up the device and send wakeup notification to controller.
- If press successfully, the LED will blink one time.
- The minimum wakeup interval is 300s
- The maximum wakeup interval is 16,777,200s (about 194 days)
- Allowable interval among each wakeup interval is 60 second, such as 360, 420, 480…
- Note: The default value is 12 hours. This value is longer, the battery life is greater.
The following table summarises the channels available for the Flood sensor -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|---|---|---|---|---|
| Flood Alarm | alarm_flood | alarm_flood | Water | Switch |
| Battery Level | battery-level | system.battery_level | Battery | Number |
Indicates if the flood alarm is triggered.
The alarm_flood channel 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 |
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%.
The following table provides a summary of the 7 configuration parameters available in the Flood sensor. Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|---|---|---|
| 1 | Alarm Duration Time | Alarm Duration Time |
| 2 | Alarm Interval | Alarm Interval |
| 3 | First Alarm On Time Duration | First Alarm On Time Duration |
| 4 | Alarm on Time Duration | Alarm on Time Duration |
| 5 | Alarm Enable/Disable | Alarm Enable/Disable |
| 6 | Water Leakage Detection | Water Leakage Detection |
| 7 | Basic Set Level | Basic Set Level |
| 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 |
Alarm Duration Time This configuration parameter that can be used to adjust the time for beep and LED turned on when water leakage is detected.
If this parameter is set to ‘0’, the beep and LED will be turn on always until water leakage is not detected Values in the range 0 to 255 may be set.
The manufacturer defined default value is 120.
This parameter has the configuration ID config_1_1 and is of type INTEGER.
Alarm Interval This Parameter defines beep on /off interval time when water leakage is detected. Values in the range 1 to 255 may be set.
The manufacturer defined default value is 1.
This parameter has the configuration ID config_2_2 and is of type INTEGER.
First Alarm On Time Duration This parameter defines beep on duration first time when water leakage is detected. Values in the range 10 to 255 may be set.
The manufacturer defined default value is 60.
This parameter has the configuration ID config_3_1 and is of type INTEGER.
Alarm on Time Duration This parameter defines beep on duration after first beep on when water leakage is detected. Values in the range 5 to 255 may be set.
The manufacturer defined default value is 5.
This parameter has the configuration ID config_4_1 and is of type INTEGER.
Alarm Enable/Disable This parameter defines beep on is enabled or disabled when water leakage is detected.
- ‘0’ indicate beep on is disable, but LED will be turned on when water leakage detected.
- ‘1’ indicate beep on is enabled, the BEEP and LED will be turned on when water leakage detected. The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Beep Disabled |
| 1 | Beep Enabled |
The manufacturer defined default value is 1 (Beep Enabled).
This parameter has the configuration ID config_5_1 and is of type INTEGER.
Water Leakage Detection This parameter defines the function than water leakage detect is enabled or disabled.
- ‘0’ indicate disable water leakage detect,
- ‘1’ indicate enable water leakage detect. 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_6_1 and is of type INTEGER.
Basic Set Level Basic Set Command will be sent where contains a value when the door/window is opened or closed, the receiver will take it for consideration; for instance, if a lamp module is received the Basic Set Command of which value is decisive as to how bright of dim level of lamp module shall be. Values in the range 0 to 255 may be set.
The manufacturer defined default value is 255.
This parameter has the configuration ID config_7_1 and is of type INTEGER.
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.
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 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 Flood sensor supports 4 association groups.
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.
Association group 2 supports 5 nodes.
Association group 3 supports 5 nodes.
Association group 4 supports 5 nodes.
| Command Class | Comment |
|---|---|
| COMMAND_CLASS_NO_OPERATION_V1 | |
| COMMAND_CLASS_BASIC_V1 | |
| COMMAND_CLASS_SENSOR_BINARY_V2 | |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1 | |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1 | |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V2 | |
| COMMAND_CLASS_CONFIGURATION_V1 | |
| COMMAND_CLASS_ALARM_V1 | |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V2 | |
| COMMAND_CLASS_POWERLEVEL_V1 | |
| COMMAND_CLASS_BATTERY_V1 | |
| COMMAND_CLASS_WAKE_UP_V2 | |
| COMMAND_CLASS_ASSOCIATION_V2 | |
| COMMAND_CLASS_VERSION_V1 |
Did you spot an error in the above definition or want to improve the content? You can contribute to the database here.