OpenHAB
/
openhab-docs
mirror of https://github.com/openhab/openhab-docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated external 2.5.x content (Jenkins build 647)

pull/1689/head
openHAB Build Server 2020-12-27 06:09:54 +00:00
parent 62953cffee
commit 5c47c823b2
29 changed files with 5940 additions and 99 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

220
_addons_bindings/zwave/doc/act/zrf113_1_100.md Normal file
View File

@ -0,0 +1,220 @@
---
layout: documentation
title: ZRF113 - ZWave
---
{% include base.html %}
# ZRF113 Isolated Contact Fixture Module Release 1.1
This describes the Z-Wave device *ZRF113*, manufactured by *ACT - Advanced Control Technologies* with the thing type UID of ```act_zrf113_01_100```.
This version of the device is limited to firmware versions above 1.100
The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there.
![ZRF113 product image](https://opensmarthouse.org/zwavedatabase/1331/image/)
The ZRF113 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data between other devices in the mesh network.
## Overview
The ZRF113 Isolated Contact Fixture Module is a component of the HomePro lighting control system. Wire the Isolated Contact Fixture Module according to the diagram above and program it from the Wireless Controller to operate loads.  Inclusion of this Switch on the ZTH100 Wireless Controller menu allows remote ON/OFF control of load connected.
This Isolated Contact Fixture Module is designed to work with other Z-Wave enabled devices. Z-Wave nodes of other types can be included on the network and will also act as repeaters if they support this function.  
As part of a Z-Wave network, the ZRF113 will also act as a wireless repeater to insure that commands intended for another device in the network are received. This is useful when the device would otherwise be out of the radio range of the wireless controller.
There are no field repairable assemblies on this unit.. If service is needed, the unit must be returned where purchased.
DANGER! SHOCK HAZARD. Read and understand these instructions before installing. This device is intended for installation in accordance with the National Electric code and local regulations in the United States, or the Canadian Electrical Code and local regulations in Canada. It is recommended that a qualified electrician perform this installation.
**INSTALLATION**
Wire this module in series with a 20 amp (maximum) load according to the diagram above. If AS101’s are used they must be wired to the same line (or neutral) also wired to the master unit as well as the load being controlled, and not wired to any other neutral. If multiple neutral wires are tied together in one box, separate the neutral wires to preserve the integrity of the ZRF113 circuit. Caution! Do not wire unit “live” (with power on the circuit) and do notallow the yellow wire to contact line voltage, neutral or ground or you will damage the device. See the ZTH100 Wireless Controller operating instructions to include this module under the command of the Wireless Controller.
**NOTE **
If you have trouble adding the ZRF113 to a group it may be that the Home ID and Node ID were not cleared from it after testing. You must first “RESET UNIT” with your controller to remove it from the network. If using the ZTH100 select “SETUP” and scroll to “RESET UNIT”
Although adding it to a group includes it in the network, removing it from a group does not remove it from the network. If removed from a group, it functions only as a repeater.
With the Wireless Controller, the ZRF113 can be switched ON and OFF remotely, and can be included (or excluded) in groups of lights that operate at the same time (a group can also be a single module), and in scenes that set a lighting mood.
Note that the Associations, and possibly other features, vary depending on the release.  The original version 1 units used 4 associations.  This release, release 1.1, uses 2.
**SPECIFICATIONS**
Power: 120 VAC, 50/60 Hz
Signal (Frequency): 908.42 MHz
Maximum Load
   Isolated Contacts: 20 amps maximum General Purpose, 277 VAC, 10 FLA, 60 LRA, 250 VAC,
   Motor: 1 H.P. maximum, 120/240 VAC
   Incandescent: TV8 (Tungsten), 120 VAC, 960W maximum
Range: Up to 100 feet line of sight between the Wireless Controller and /or the closest HomePro Receiver Module
### Inclusion Information
STEP 1.. Prepare the Controller to include a unit to the network by adding it to a group (method of adding a node to the network). Refer to controller instructions. If using a ZTH100, push MENU button, select GROUPS, push OK button, see ADD UNIT TO GROUP displayed, push OK button.
STEP 2. The ZRF113 must be in its permanently installed location. Tap the button on the face of the ZRF113 once. Some Z-Wave products include the module on the release of the button.
STEP 3. You should see an indication on your Controller that the “DEVICE WAS INCLUDED” in the network.
### Exclusion Information
“RESET UNIT” with your controller to remove it from the network. If using the ZTH100 select “SETUP” and scroll to “RESET UNIT”
Although adding it to a group includes it in the network, removing it from a group does not remove it from the network. If removed from a group, it functions only as a repeater.
### General Usage Information
## Channels
The following table summarises the channels available for the ZRF113 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Switch | switch_binary | switch_binary | Switch | Switch |
| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer |
### Switch
Switch the power on and off.
The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category.
### Dimmer
The brightness channel allows to control the brightness of a light.
It is also possible to switch the light on and off.
The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category.
## Device Configuration
The following table provides a summary of the 2 configuration parameters available in the ZRF113.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 1 | Configuration Parameter 1 | Set Ignore Start Level Bit When Transmitting Dim Command |
| 19 | Configuration Parameter 19 | LED Transmission Indication |
| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands |
### Parameter 1: Configuration Parameter 1
Set Ignore Start Level Bit When Transmitting Dim Command
The ZRF113 can send Dim commands to Z-Wave enabled dimmers. The Dim command has a start level embedded in it. A dimmer receiving this command will start dimming from that start level. However, the command also has a bit that indicates whether the dimmer should ignore the start level. If the bit is set to 1, the dimmer will ignore the start level and instead start dimming from its current level. To clear this bit, configure this parameter to the value of 0.
NOTE: Each Configuration Parameter can be set to its default by setting the default bit in the Configuration Set command. See your controller’s instructions on how to do this (and if it supports it). All Configuration commands will be reset to their default state when the ZRF113 is excluded from the Z-Wave network by using the controller to reset the node (on the ZTH100 select “SETUP” and scroll to “RESET UNIT”).This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
| 0 | Don't Ignore Dimmer Command Start Level Bit |
| 1 | Ignore Dimmer Command Start Level Bit (Default) |
The manufacturer defined default value is ```1``` (Ignore Dimmer Command Start Level Bit (Default)).
This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```.
### Parameter 19: Configuration Parameter 19
LED Transmission Indication
The ZRF113 will flicker its LED when it is transmitting to any of its groups. This flickering can be set to not flicker at all (set to 0), to flicker the entire time it is transmitting (set to 1), or to flicker for only 1 second when it begins transmitting (set to 2). By default, the ZRF113 is set to flicker for only 1 second.
NOTE: Each Configuration Parameter can be set to its default by setting the default bit in the Configuration Set command. See your controller’s instructions on how to do this (and if it supports it). All Configuration commands will be reset to their default state when the ZRF113 is excluded from the Z-Wave network by using the controller to reset the node (on the ZTH100 select “SETUP” and scroll to “RESET UNIT”).This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
The following option values may be configured, in addition to values in the range 0 to 2 -:
| Value | Description |
|--------|-------------|
| 0 | No Flicker |
| 1 | Flicker while transmitting |
| 2 | Flicker for 1 second (Default) |
The manufacturer defined default value is ```2``` (Flicker for 1 second (Default)).
This parameter has the configuration ID ```config_19_1``` and is of type ```INTEGER```.
### Switch All Mode
Set the mode for the switch when receiving SWITCH ALL commands.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Exclude from All On and All Off groups |
| 1 | Include in All On group |
| 2 | Include in All Off group |
| 255 | Include in All On and All Off groups |
This parameter has the configuration ID ```switchall_mode``` 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 ZRF113 supports 3 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: Group 2
Auxilliary Switch 2 Tap
If you associate a Z-Wave device into Group 2, you can turn that device on and off by tapping the top or bottom of the auxiliary switch twice. You can brighten or dim devices by tapping the top or bottom of the auxiliary switch once and then holding the switch down. The load attached to the ZRF113 is not affected.
A NOTE ABOUT DIMMERS IN A GROUP: If you combine Z-Wave enabled dimmers and other types of ZWave devices in a group, place a Z-Wave enabled dimmer into the empty group first to ensure that the dimming operates correctly.
Association group 2 supports 5 nodes.
### Group 3: Group 3
Auxilliary Switch 3 Tap
If you associate a Z-Wave device into Group 3, you can turn that device on and off by tapping the top or bottom of the auxiliary switch three times . You can brighten or dim devices by tapping the top or bottom of the auxiliary switch twice and then hold the top down for brighten or bottom for dim (bottom only if AS001). The load attached to the ZRF113 is not affected.
A NOTE ABOUT DIMMERS IN A GROUP: If you combine Z-Wave enabled dimmers and other types of ZWave devices in a group, place a Z-Wave enabled dimmer into the empty group first to ensure that the dimming operates correctly.
Association group 3 supports 5 nodes.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_SWITCH_MULTILEVEL_V1| |
| COMMAND_CLASS_SWITCH_ALL_V1| |
| COMMAND_CLASS_BASIC_WINDOW_COVERING_V1| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_ASSOCIATION_V1| |
| COMMAND_CLASS_VERSION_V1| |
### Documentation Links
* [Please allow me access to add a device to the Z-Wave DB](https://opensmarthouse.org/zwavedatabase/1331/reference/ZRF113-S100_instr.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](https://opensmarthouse.org/zwavedatabase/1331).

6
_addons_bindings/zwave/doc/devolo/mt02648_0_0.md
View File

@ -253,13 +253,13 @@ Bit5: Disable Multi CC in auto report.
Bit6: Disable to report battery state when the device triggered.
Bit7: Reserve.
The following option values may be configured, in addition to values in the range 0 to 127 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 20 | PIR Super Sensitivity and Binary Report |
| 4 | Default |
The manufacturer defined default value is ```4```.
The manufacturer defined default value is ```4``` (Default).
This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```.

161
_addons_bindings/zwave/doc/eco/wirelesssiren_0_0.md Normal file
View File

@ -0,0 +1,161 @@
---
layout: documentation
title: Wireless Siren - ZWave
---
{% include base.html %}
# Wireless Siren Z-Wave plus plug in siren
This describes the Z-Wave device *Wireless Siren*, manufactured by *Ecolink* with the thing type UID of ```eco_wirelesssiren_00_000```.
The device is in the category of *Siren*, defining Siren used by Alarm systems.
![Wireless Siren product image](https://opensmarthouse.org/zwavedatabase/1263/image/)
The Wireless Siren supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data between other devices in the mesh network.
## Overview
The device is as simple to use as plugging in a wall outlet.
The device can create 4 independent tones for different alerts to the user. These could include but are not limited to: Security Alarm, entry/exit, smoke/Fire, temperature and more. The Z-Wave Plus Siren can also be used as a Z-Wave Plus network extension.
### Inclusion Information
Plug in the Z-Wave Siren and verify a single beep sound is heard.
The LED on the front of the unit will turn off if successful included into a network.
### Exclusion Information
1.  Plug in the Z-Wave Siren.
2. Unplug and re-plug in your Z-Wave Plus Siren.  
The device will play a long beep and the LED will begin to breathe if the device is successfully removed from the network.
### General Usage Information
## Channels
The following table summarises the channels available for the Wireless Siren -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Switch | switch_binary | switch_binary | Switch | Switch |
| Switch 1 | switch_binary1 | switch_binary | Switch | Switch |
| Switch 2 | switch_binary2 | switch_binary | Switch | Switch |
| Switch 3 | switch_binary3 | switch_binary | Switch | Switch |
| Switch 4 | switch_binary4 | switch_binary | Switch | Switch |
### Switch
Switch the power on and off.
The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category.
### Switch 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.
### Switch 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.
### Switch 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.
### Switch 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.
## Device Configuration
The device has no configuration parameters defined.
## 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 Wireless Siren supports 1 association group.
### 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.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_MULTI_CHANNEL_V2| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| 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_BINARY_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
#### Endpoint 2
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
#### Endpoint 3
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
#### Endpoint 4
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
### Documentation Links
* [Manual](https://opensmarthouse.org/zwavedatabase/1263/reference/0_-_Ecolink_Siren_Z-Wave_Plus_Manual_standard.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](https://opensmarthouse.org/zwavedatabase/1263).

4
_addons_bindings/zwave/doc/fibaro/fgd211_0_0.md
View File

@ -36,6 +36,10 @@ The Dimmer enters the mode of inclusion after a quick pressing three times the p
The Dimmer enters the mode of exclusion after a quick pressing three times the push-button connected to S1 terminal or push-button B located inside the housing. For bi-stable switch perform 3 position changes
### General Usage Information
## Channels
The following table summarises the channels available for the FGD211 -:

14
_addons_bindings/zwave/doc/fibaro/fgt001_0_0.md
View File

@ -282,7 +282,19 @@ Parameter 2 values may be combined, e.g. 1+8=9 means that Open Window Detector a
8 (bit 3) - enabled LED indications when controlling remotely
16 (bit 4) - protect from setting Full ON and Full OFF mode by turning the knob manually
Values in the range 0 to 31 may be set.
32 (bit 5) - device mounted in vertical position
64 (bit 6) - moderate regulator behaviour (instead of Rapid)
128 (bit 7) - inverted knob operation
256 (bit 8) - report when heating medium is required
512 (bit 9) - detecting heating system failures
Values in the range 0 to 1023 may be set.
The manufacturer defined default value is ```1```.

6
_addons_bindings/zwave/doc/ge/zw4008_0_0.md
View File

@ -10,7 +10,7 @@ This describes the Z-Wave device *43072/ZW4008DV*, manufactured by *Jasco Produc
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.
![43072/ZW4008DV product image](https://www.cd-jackson.com/zwave_device_uploads/1155/1155_default.jpg)
![43072/ZW4008DV product image](https://opensmarthouse.org/zwavedatabase/1155/image/)
The 43072/ZW4008DV supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data between other devices in the mesh network.
@ -141,9 +141,9 @@ Association group 3 supports 5 nodes.
### Documentation Links
* [ZW4008 Manual](https://www.cd-jackson.com/zwave_device_uploads/1155/B1YLc65eVlS.pdf)
* [ZW4008 Manual](https://opensmarthouse.org/zwavedatabase/1155/reference/B1YLc65eVlS.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/1155).
You can [contribute to the database here](https://opensmarthouse.org/zwavedatabase/1155).

193
_addons_bindings/zwave/doc/habhome/iblindsib30_0_0.md Normal file
View File

@ -0,0 +1,193 @@
---
layout: documentation
title: IB3.0 - ZWave
---
{% include base.html %}
# IB3.0 Window Blind Controller
This describes the Z-Wave device *IB3.0*, manufactured by *HAB Home Intelligence, LLC* with the thing type UID of ```habhome_iblindsib30_00_000```.
The device is in the category of *Blinds*, defining Roller shutters, window blinds, etc..
![IB3.0 product image](https://opensmarthouse.org/zwavedatabase/1325/image/)
The IB3.0 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.
## Overview
An intelligent Z-Wave blind motor that installs out of sight in existing Horizontal (2" and 2 1/2" slatted-style) blind headrails. Use iBlinds to tilt the slats open, closed or use the value slider for precise positioning of the slat tilt angle.
### Inclusion Information
Follow the directions for your Z-Wave hub/controller to place it in the add for inclusion mode.
Press the inclusion button (IN/EX) once and wait for the device to be discovered and joined to the Z-Wave network. Follow the directions of your Z-Wave controller to uniquely identify your iblinds device. (Ex: Bedroom iblinds).
Note: If the device is not joined to the network. Press the CLBR button, wait 1 second and repeat steps 1 and 2 again. If you continue to have trouble joining the iblinds motor to the Z-Wave network, follow the Z-Wave network exclusion process.
### Exclusion Information
Follow the directions for your Z-Wave hub/controller to place it in the exclusion mode.
Press the exclude button (IN/EX) once and wait for the iblinds device to be removed from the Z-Wave network.
If you are having issues with exclusion, please check our troubleshooting page here.
### General Usage Information
NOTE: The command polling period should be set to 'disabled' 
## Channels
The following table summarises the channels available for the IB3.0 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Switch | switch_binary | switch_binary | Switch | Switch |
| Blinds Control | blinds_control | blinds_control | Blinds | Rollershutter |
| Battery Level | battery-level | system.battery_level | Battery | Number |
### Switch
Switch the power on and off.
The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category.
### Blinds Control
Provides start / stop control of blinds.
The ```blinds_control``` channel is of type ```blinds_control``` and supports the ```Rollershutter``` item and is in the ```Blinds``` category.
### 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%.
## Device Configuration
The following table provides a summary of the 5 configuration parameters available in the IB3.0.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 1 | Close Interval | Close Interval |
| 2 | Reverse Direction | Reverse Direction |
| 3 | Disable Report | Disable Report |
| 4 | Default ON Value | Default ON Value |
| 6 | Speed | Speed |
### Parameter 1: Close Interval
Close Interval
Used for large blind auto calibration endpoint detection. A smaller value will make the blinds close tighter
Values in the range 15 to 30 may be set.
The manufacturer defined default value is ```22```.
This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```.
### Parameter 2: Reverse Direction
Reverse Direction
Used to reverse the direction of the blinds
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
| 0 | Forwards |
| 1 | Reverse |
The manufacturer defined default value is ```0``` (Forwards).
This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```.
### Parameter 3: Disable Report
Disable Report
Used to disable Z-Wave Report. This is useful for systems that poll iBlinds immediately after sending a position command. Disable if an immediate Z-Wave GET command is causing iBlinds motor to function improperly
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
| 0 | False |
| 1 | True |
The manufacturer defined default value is ```0``` (False).
This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```.
### Parameter 4: Default ON Value
Default ON Value
Used to set the default ON level. Default value for ON=50% (0x32). Change this value if you wish to change the Charge Adapter push button ON or the Z-Wave Binary Switch ON default value
Values in the range 1 to 99 may be set.
The manufacturer defined default value is ```50```.
This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```.
### Parameter 6: Speed
Speed
Used to set the default blind speed. 0 = No Delay. The larger the value the slower the speed. Note: A Z-Wave MultiLevel Switch command sent with a Duration value greater than 0 will always override the speed parameter
Values in the range 0 to 100 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_6_1``` 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 IB3.0 supports 1 association group.
### 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.
Z-Wave Plus Lifeline
Association group 1 supports 5 nodes.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_SWITCH_MULTILEVEL_V3| |
| COMMAND_CLASS_TRANSPORT_SERVICE_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_SUPERVISION_V1| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| COMMAND_CLASS_BATTERY_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
| COMMAND_CLASS_SECURITY_2_V1| |
### Documentation Links
* [User Guide v3.0](https://opensmarthouse.org/zwavedatabase/1325/reference/User-Guide-v3.0-1.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](https://opensmarthouse.org/zwavedatabase/1325).

1255
_addons_bindings/zwave/doc/heltun/heht01_0_0.md Normal file
View File

File diff suppressed because it is too large Load Diff

19
_addons_bindings/zwave/doc/honeywell/39339_0_0.md
View File

@ -61,12 +61,13 @@ The ```scene_number``` channel is of type ```scene_number``` and supports the ``
## Device Configuration
The following table provides a summary of the 7 configuration parameters available in the 39339 (ZW3107) .
The following table provides a summary of the 8 configuration parameters available in the 39339 (ZW3107) .
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 3 | LED Light | LED Light Control |
| 6 | Dim Up/Down Behavior | Controls whether level changes are instant or smooth |
| 7 | Dim Rate Adjustments (Z-Wave Controller) | Number of steps or levels |
| 8 | Dim Rate Adjustments (Z-Wave Controller, Timing) | Timing of steps |
| 9 | Dim Rate Adjustments (manually controlled) | Number of steps or levels |
@ -92,6 +93,22 @@ The manufacturer defined default value is ```0``` (Set parameter to factory defa
This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```.
### Parameter 6: Dim Up/Down Behavior
Controls whether level changes are instant or smooth
This is an undocumented feature. This parameter allows you to choose between instant level changes and smooth level changes on newer Jasco/Honeywell/GE dimmers. This feature should work on dimmers that come out of the box with instant level changes, it may not work on older dimmers that smoothly change levels by default.
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
| 0 | Instant Level Changes |
| 1 | Smooth Level Changes |
The manufacturer defined default value is ```0``` (Instant Level Changes).
This parameter has the configuration ID ```config_6_1``` and is of type ```INTEGER```.
### Parameter 7: Dim Rate Adjustments (Z-Wave Controller)
Number of steps or levels

160
_addons_bindings/zwave/doc/honeywell/zw4103_0_0.md Normal file
View File

@ -0,0 +1,160 @@
---
layout: documentation
title: ZW4103 - ZWave
---
{% include base.html %}
# ZW4103 Z-Wave Plug in Smart Switch
This describes the Z-Wave device *ZW4103*, manufactured by *Honeywell* with the thing type UID of ```honeywell_zw4103_00_000```.
The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there.
![ZW4103 product image](https://opensmarthouse.org/zwavedatabase/1329/image/)
The ZW4103 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data between other devices in the mesh network.
## Overview
Control, automate, and schedule your homes lighting and appliances with the Plug-In Smart Switch. Using this Smart Switch means taking control of your homes lighting and appliances regardless of if you are in a different part of your home, the couch, work or away on vacation - all from your mobile device and Z-Wave compatible hub.
The plug-in smart switch gives you wireless control of your plug-in lighting and appliances from any mobile device, computer or Z-Wave enabled remote via a Z-Wave Certified gateway/hub. Automating you lights will not only make your life easier but it will also save energy, cut costs, and boost your home’s security. Plug-in Smart Switch has 1 grounded outlet located on the left side of the module and leaves bottom outlet
Schedule timed events and customize scenes for day or night, home or away - wirelessly control from anywhere through your smartphone, tablet, PC or Z-Wave remote
* Features 1 controlled grounded outlet w/ manual ON/OFF & program button - works with all LED, CFL, halogen and incandescent bulbs and other devices
* Requires a Z-Wave Certified Hub: Compatible with the following Z-Wave Hubs: Honeywell, Ring, SmartThings, Wink, HomeSeer, Fibaro, Trane, Nexia, ADT, Vera, and more
* Simply plug the module into any in-wall outlet, then connect your light to the smart outlet located on the left side of the plug-in
* 2nd wallplate outlet still free for use
### Inclusion Information
1. Follow the instructions for your Z-Wave certified controller to include the device to the Z-Wave network.
2. Once the controller is ready to include your smart switch, single press and release the manual/program button on the smart dimmer to include it in the network.
3. Once your controller has confirmed that the smart switch has been included, refresh the Z-Wave network to optimize performance.
### Exclusion Information
1. Follow the instructions for your Z-Wave certified controller to exclude a device from the Z-Wave network.
2. Once the controller is ready to exclude your device, press and release the manual/program button on the smart switch to exclude it from the network. 
### General Usage Information
## Channels
The following table summarises the channels available for the ZW4103 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Switch | switch_binary | switch_binary | Switch | Switch |
| Scene Number | scene_number | scene_number | | Number |
### Switch
Switch the power on and off.
The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category.
### Scene Number
Triggers when a scene button is pressed.
The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item.
## Device Configuration
The following table provides a summary of the 1 configuration parameters available in the ZW4103.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 3 | LED Light | Changes the behavior of the LED light |
| | Switch All Mode | Set the mode for the switch when receiving SWITCH ALL commands |
### Parameter 3: LED Light
Changes the behavior of the LED light
Values in the range 0 to 2 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```.
### Switch All Mode
Set the mode for the switch when receiving SWITCH ALL commands.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Exclude from All On and All Off groups |
| 1 | Include in All On group |
| 2 | Include in All Off group |
| 255 | Include in All On and All Off groups |
This parameter has the configuration ID ```switchall_mode``` 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 ZW4103 supports 3 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.
Supports device reset locally and receives unsolicited status updates
Association group 1 supports 5 nodes.
### Group 2: Single Press
Association Group 2 supports BasicSet and is controlled by single pressing the button
Association group 2 supports 5 nodes.
### Group 3: Double Press
Association Group 3 supports BasicSet and is controlled by double pressing the button
Association group 3 supports 5 nodes.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_SWITCH_ALL_V1| |
| COMMAND_CLASS_SCENE_ACTIVATION_V1| |
| COMMAND_CLASS_SCENE_ACTUATOR_CONF_V1| |
| COMMAND_CLASS_CRC_16_ENCAP_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
### Documentation Links
* [Honeywell_ZW4103_UserManual](https://opensmarthouse.org/zwavedatabase/1329/reference/ZW4103_UserManual.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](https://opensmarthouse.org/zwavedatabase/1329).

105
_addons_bindings/zwave/doc/horstmann/ssp301_0_0.md Normal file
View File

@ -0,0 +1,105 @@
---
layout: documentation
title: SSP301 - ZWave
---
{% include base.html %}
# SSP301 Plug-in switch
This describes the Z-Wave device *SSP301*, manufactured by *Horstmann Controls Limited* with the thing type UID of ```horstmann_ssp301_00_000```.
The device is in the category of *Battery*, defining Batteries, Energy Storages.
![SSP301 product image](https://opensmarthouse.org/zwavedatabase/1328/image/)
The SSP301 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data between other devices in the mesh network.
## Overview
ON/OFF mains power module - unlike the SSP302 this doesn't have energy metering
### Inclusion Information
To include the SSP 301 onto a network, put the controller into inclusion mode. Now, press and hold the button on SSP 301 for 4 to 7 seconds then release. The network status LED will start flashing (twice per second) on successful start of inclusion process.
Note: Refer to the controller's manual for controller relevant actions.
On successful inclusion the LED will turn off.
Note: Inclusion means add and exclusion means delete.
The total process can take up to 20 seconds (Refer to the “Technical specifications – Radio” section for details). If the device fails to join the network it will go back to factory default state and the Network status LED will start flashing once per second. If there is an issue with RF Communication, then re-locate the device and repeat the inclusion process again.
### Exclusion Information
To exclude the SSP 301 from a network, put the controller into exclusion mode (refer to controller instructions) and follow the same sequence as per the inclusion process for include node. After successful exclusion the network status LED will start flashing once per second, and the device will reset to factory default.
If exclusion fails, SSP 301 network status LED will turn off after about 5 seconds.
Note: Exclusion only works when the device is in direct range of the controller (no repeater allowed).
### General Usage Information
## Channels
The following table summarises the channels available for the SSP301 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Switch | switch_binary | switch_binary | Switch | Switch |
### Switch
Switch the power on and off.
The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category.
## Device Configuration
The device has no configuration parameters defined.
## 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 SSP301 supports 1 association group.
### 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.
Lifeline
Association group 1 supports 1 node.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
### Documentation Links
* [SSP301 User Manual](https://opensmarthouse.org/zwavedatabase/1328/reference/SSP_301_resize_for_web_final.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](https://opensmarthouse.org/zwavedatabase/1328).

10
_addons_bindings/zwave/doc/idlock/idl150new_1_6.md
View File

@ -5,7 +5,7 @@ title: ID-150 - ZWave
{% include base.html %}
# ID-150 Z wave module for ID Lock 150 and 101
# ID-150 Z wave module for ID Lock 150
This describes the Z-Wave device *ID-150*, manufactured by *ID Lock AS* with the thing type UID of ```idlock_idl150new_01_006```.
This version of the device is limited to firmware versions above 1.6
@ -14,8 +14,6 @@ The device is in the category of *Lock*, defining Devices whose primary pupose i
![ID-150 product image](https://opensmarthouse.org/zwavedatabase/1106/image/)
The ID-150 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.
## Overview
The ID Lock Z-wave module is a security enabled Z-wave Plus product that is able to use encrypted Z-wave Plus messages in order to communicate to other Z-wave Plus products enabled security.
@ -48,7 +46,7 @@ The ID Lock Z-wave module can be included and operated in any Z-wave network con
### General Usage Information
Configuration parameters 2 RFID Registration Configuration and 10 Retrieve RFID Information have not been added since they are only valid for the 101 model. 
## Channels
@ -363,13 +361,13 @@ Association group 1 supports 5 nodes.
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_DOOR_LOCK_V1| |
| COMMAND_CLASS_DOOR_LOCK_V2| |
| COMMAND_CLASS_USER_CODE_V1| |
| 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_FIRMWARE_UPDATE_MD_V2| |
| COMMAND_CLASS_BATTERY_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |

32
_addons_bindings/zwave/doc/linear/gd00z8gc_0_0.md
View File

@ -37,9 +37,41 @@ The following table summarises the channels available for the GD00Z-8-GC -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Barrier State | barrier_state | barrier_state | Door | Number |
| Alarm (burglar) | alarm_burglar | alarm_burglar | Door | Switch |
| Alarm (access) | alarm_access | alarm_access | Door | Switch |
### Barrier State
Send 0 to CLOSE the Garage Door
Send 255 to OPEN the Garage Door
Reading this value provides the Status of the Garage Door. Status values are:
0 = Closed
252 = Closing
253 = Stopped
254 = Opening
255 = Open
Indicates the state of the barrier.
The ```barrier_state``` channel is of type ```barrier_state``` and supports the ```Number``` 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 ```Number``` item type -:
| Value | Label |
|-------|-----------|
| 0 | Closed |
| 252 | Closing |
| 253 | Stopped |
| 254 | Opening |
| 255 | Open |
### Alarm (burglar)
Indicates if the burglar alarm is triggered.

895
_addons_bindings/zwave/doc/logic/matrixzba7140_0_0.md Normal file
View File

@ -0,0 +1,895 @@
---
layout: documentation
title: MATRIX ZBA7140 - ZWave
---
{% include base.html %}
# MATRIX ZBA7140 Matrix ZBA7140
This describes the Z-Wave device *MATRIX ZBA7140*, manufactured by *[Logic Group](http://www.logic-group.com)* with the thing type UID of ```logic_matrixzba7140_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.
![MATRIX ZBA7140 product image](https://opensmarthouse.org/zwavedatabase/1330/image/)
The MATRIX ZBA7140 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 MATRIX ZBA7140 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
MATRIX type ZBA7140 (from hereon called MATRIX ZBA) is a multifunction battery wall controller that can be mounted in a modular wall-box or directly ontothe wall. It is compatible with existing FUGA® frames and wall boxes.MATRIX ZBA has four configurable pushbuttons that can control other Z-Wave devices through the wireless Z-Wave network. These buttons can send ‘ON’, ‘OFF’ and ‘DIM’ commands to the associated Z-Wave devices. These devices could be light dimmers, blinds, sunscreens, etc.MATRIX ZBA can also issue scene activation commands that can be used to activate scenes in the Z-Wave Controller.MATRIX ZBA has four RGB indicator LEDs, one for each pushbutton, that indicates activation of the pushbutton, and when MATRIX ZBA is in inclusion or exclusion mode. These indicators can be configured to a desired indication colour, or they can indicate the battery level when a pushbutton is activated.MATRIX ZBA is equipped with the newest battery-saving 700-series Z-Wave chip that uses up to 65% less power and have improved wireless range. This means that the small coin-cell battery can last between 5 –10years. MATRIX ZBA is estimated toabattery lifetime, at normal use, to approximately 5 years.
### Inclusion Information
MATRIXZBAis a SmartStart enabled product and can be added into a Z-Wave network by scanning the Z-Wave QR Code present on the product with a controller providing SmartStart inclusion. No further action is required and the SmartStart product will be added automatically within 10 minutes of being switched on in the network vicinity.Find the QR code and PIN Code on the back of the module.
Find the full DSK on the product packaging.
Add MATRIX ZBA to a network with Classic Inclusion by pressing once on the switch behind the pushbutton-cover. The LED near pushbutton 1 will start blinking.
Use same procedure for removing MATRIX ZBAwith Classic Exclusion. If MATRIXZBA already belongs to a Z-Wave network, the remove process must be performed before adding it in a new network. Otherwise, the adding of the device will fail.
### Exclusion Information
Add MATRIX ZBA to a network with Classic Inclusion by pressing once on the switch behind the pushbutton-cover. The LED near pushbutton 1 will start blinking.
Use same procedure for removing MATRIX ZBAwith Classic Exclusion.
### Wakeup Information
The MATRIX ZBA7140 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.
MATRIX ZBA is a battery-operated device and is turned into deep sleep state most of the time to save battery. Communication with the device is limited. In order to communicate with the device, a controller is needed in the network. This controller will maintain a mailbox for the battery-operated devices and store commands that can’t be received during deep sleep state. Without such a controller, communication may become impossible and/or the battery lifetime is significantly decreased. This device will wake up every 6 hours and announce the wake-upstate by sending out a so-called Wake Up Notification. The controller can then empty the mailbox. The wake-up interval is a trade-off between maximal battery lifetime and the desired responses of the device. The device will stay awake right after inclusion for 10 seconds allowing the controller to perform certain configuration. It is possible to manually wake up the device by double-activating the button
### General Usage Information
## Channels
The following table summarises the channels available for the MATRIX ZBA7140 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Scene Number | scene_number | scene_number | | Number |
| Battery Level | battery-level | system.battery_level | Battery | 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 |
### 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%.
## Device Configuration
The following table provides a summary of the 45 configuration parameters available in the MATRIX ZBA7140.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 1 | Enable Central Scene notifications | This parameter can be used for enabling or disabling Central scene notifications |
| 2 | Pushbutton press threshold time | Specifies the time that a pushbutton must be activated before it is detected as pressed. |
| 3 | Pushbutton held threshold time | Specifies the time that a pushbutton must have been activated before it is accepted as “held-down”. |
| 4 | Mode of the LED indication. | This parameter specifies the mode of the LED indication. |
| 5 | LEDs colour indication, Byte 1 | Specifies the level for the red colour. (Default is 255) |
| 5 | LEDs colour indication, Byte 2 | Specifies the level for the green colour. (Default is 85) |
| 5 | LEDs colour indication, Byte 3 | Specifies the level for the blue colour. (Default is 85) |
| 5 | Not used. | This byte is not used and must be set to 0. |
| 6 | Associations groups, transmission when included secure. | This parameter specifies if commands are transmitted as a secure message for each of the association groups. |
| 7 | Pushbutton 1 functionality. | This parameter specifies the functionality of pushbutton 1. |
| 8 | Switch multilevel set single-activation values for pushbutton 1, Byte 1 | Enable/Disable |
| 8 | Switch multilevel set single-activation values for pushbutton 1, Byte 2 | Upper switch value |
| 8 | Switch multilevel set single-activation values for pushbutton 1, Byte 3 | Lower switch value |
| 8 | Switch multilevel set single-activation values for pushbutton 1, Byte 4 | Duration |
| 9 | Switch Multilevel Set double-activation values for pushbutton 1. Byte 1 | Enable/Disable |
| 9 | Switch Multilevel Set double-activation values for pushbutton 1. Byte 2 | Upper switch value |
| 9 | Switch Multilevel Set double-activation values for pushbutton 1. Byte 3 | Lower switch value |
| 9 | Switch Multilevel Set double-activation values for pushbutton 1. Byte 4 | Duration |
| 10 | Pushbutton 2 functionality. | This parameter specifies the functionality of pushbutton 2. |
| 11 | Switch multilevel set single-activation values for pushbutton 2, Byte 1 | Enable/Disable |
| 11 | Switch multilevel set single-activation values for pushbutton 2, Byte 2 | Upper switch value |
| 11 | Switch multilevel set single-activation values for pushbutton 2, Byte 3 | Lower switch value |
| 11 | Switch multilevel set single-activation values for pushbutton 2, Byte 4 | Duration |
| 12 | Switch Multilevel Set double-activation values for pushbutton 2. Byte 1 | Enable/Disable |
| 12 | Switch Multilevel Set double-activation values for pushbutton 2. Byte 2 | Upper switch value |
| 12 | Switch Multilevel Set double-activation values for pushbutton 2. Byte 3 | Lower switch value |
| 12 | Switch Multilevel Set double-activation values for pushbutton 2. Byte 4 | Duration |
| 13 | Pushbutton 3 functionality. | This parameter specifies the functionality of pushbutton 3. |
| 14 | Switch multilevel set single-activation values for pushbutton 3, Byte 1 | Enable/Disable |
| 14 | Switch multilevel set single-activation values for pushbutton 3, Byte 2 | Upper switch value. |
| 14 | Switch multilevel set single-activation values for pushbutton 3, Byte 3 | Lower switch value |
| 14 | Switch multilevel set single-activation values for pushbutton 3, Byte 3 | Duaration |
| 15 | Switch Multilevel Set double-activation values for pushbutton 3. Byte 1 | Enable/Disable |
| 15 | Switch Multilevel Set double-activation values for pushbutton 3. Byte 2 | Upper switch value |
| 15 | Switch Multilevel Set double-activation values for pushbutton 3. Byte 3 | Lower switch value |
| 15 | Switch Multilevel Set double-activation values for pushbutton 3. Byte 4 | Duration |
| 16 | Pushbutton 4 functionality. | This parameter specifies the functionality of pushbutton 4. |
| 17 | Switch multilevel set single-activation values for pushbutton 4, Byte 1 | Enable/Disable |
| 17 | Switch multilevel set single-activation values for pushbutton 4, Byte 2 | Upper switch value |
| 17 | Switch multilevel set single-activation values for pushbutton 4, Byte 3 | Lower switch value |
| 17 | Switch multilevel set single-activation values for pushbutton 4, Byte 4 | Duration |
| 18 | Switch Multilevel Set double-activation values for pushbutton 4. Byte 1 | Enable/Disable |
| 18 | Switch Multilevel Set double-activation values for pushbutton 4. Byte 2 | Upper switch value |
| 18 | Switch Multilevel Set double-activation values for pushbutton 4. Byte 3 | Lower switch value |
| 18 | Switch Multilevel Set double-activation values for pushbutton 4. Byte 4 | Duration |
| | 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: Enable Central Scene notifications
This parameter can be used for enabling or disabling Central scene notifications
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
| 0 | Central Scene notifications are disabled. |
| 1 | Central Scene Notifications are enabled. (Default) |
The manufacturer defined default value is ```1``` (Central Scene Notifications are enabled. (Default)).
This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```.
### Parameter 2: Pushbutton press threshold time
Specifies the time that a pushbutton must be activated before it is detected as pressed.
Specifies the time that a pushbutton must be activated before it is detected as pressed. This parameter also affects the detection of double-and triple-activations, as a new activationmust be detectedwithin this specified time for the repeatedly detection. Be aware that this parameter must be lower than the value in Parameter 3. Therefore, change this parameter with caution.
Values in the range 1 to 1000 may be set.
The manufacturer defined default value is ```400```.
This parameter has the configuration ID ```config_2_2``` and is of type ```INTEGER```.
### Parameter 3: Pushbutton held threshold time
Specifies the time that a pushbutton must have been activated before it is accepted as “held-down”.
Specifies the time that a pushbutton must have been activated before it is accepted as “held-down”. This value must be higher than the value set in Parameter 2. Resolution is milliseconds
Values in the range 1 to 5000 may be set.
The manufacturer defined default value is ```600```.
This parameter has the configuration ID ```config_3_2``` and is of type ```INTEGER```.
### Parameter 4: Mode of the LED indication.
This parameter specifies the mode of the LED indication.
This parameter specifies the mode of the LED indication.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | LED indication is turned off. |
| 1 | LEDs indicates the current level of the battery, when the device is in |
| 2 | LED colour is set by configuration parameter 5. |
The manufacturer defined default value is ```1``` (LEDs indicates the current level of the battery, when the device is in).
This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```.
### Parameter 5: LEDs colour indication, Byte 1
Specifies the level for the red colour. (Default is 255)
This parameter specifies the colour levels for the red, green and blue colours in the 4 RGB LEDs. This parameter is not used unless configuration parameter 4 is set to the value 2. The default configuration is a white light, where red level value must be higher than the two other colours in order to get a white light.Value Description
Byte 1: Red colour level.0 -255Specifies the level for the red colour. (Default is 255)
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```255```.
This parameter has the configuration ID ```config_5_4_00000001``` and is of type ```INTEGER```.
### Parameter 5: LEDs colour indication, Byte 2
Specifies the level for the green colour. (Default is 85)
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```85```.
This parameter has the configuration ID ```config_5_4_0000FF00``` and is of type ```INTEGER```.
### Parameter 5: LEDs colour indication, Byte 3
Specifies the level for the blue colour. (Default is 85)
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```85```.
This parameter has the configuration ID ```config_5_4_00FF0000``` and is of type ```INTEGER```.
### Parameter 5: Not used.
This byte is not used and must be set to 0.
Values in the range 0 to 0 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_5_4_01000000``` and is of type ```INTEGER```.
### Parameter 6: Associations groups, transmission when included secure.
This parameter specifies if commands are transmitted as a secure message for each of the association groups.
This parameter specifies if commands are transmitted as a secure message for each of the association groups.This parameter is only used when the device is included in security mode (either S0 or S2).
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | All messages in all groups are sent as insecure. |
| 1 | Messages in association group 2 are sent as secure. |
| 2 | Messages in association group 3 are sent as secure. |
| 4 | Messages in association group 4 are sent as secure. |
| 8 | Messages in association group 5 are sent as secure. |
| 16 | Messages in association group 6 are sent as secure. |
| 32 | Messages in association group 7 are sent as secure. |
| 64 | Messages in association group 8 are sent as secure. |
| 128 | Messages in association group 9 are sent as secure. |
| 255 | All messages in all groups are sent as secure. (Default) |
The manufacturer defined default value is ```255``` (All messages in all groups are sent as secure. (Default)).
This parameter has the configuration ID ```config_6_2``` and is of type ```INTEGER```.
### Parameter 7: Pushbutton 1 functionality.
This parameter specifies the functionality of pushbutton 1.
0 Standard toggle-function, the state is switched between on and off, dimming up and down. (Default)
1 Always turn on or dim up. Using this parameter, the pushbutton can only send ‘on’ or ‘dim up’ commands. Use this in pair with another pushbutton with value 2.
2 Always turn offor dim down. Using this parameter, the pushbutton can only send ‘off’ or ‘dim down’ commands. Use this in pair with another pushbutton with value 1.
3 When the pushbutton is down; an on command is sent, and when the pushbutton is released; an off command is sent.
Values in the range 0 to 3 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```.
### Parameter 8: Switch multilevel set single-activation values for pushbutton 1, Byte 1
Enable/Disable
Byte 1: Enable / Disable
0 Disabled – A single activation of the pushbutton will not send commands to devices in the association group.
1 Enabled – A single activation will send commands to devices in the association group. Devices will receive commands with the values set in 3 following bytes.(Default)
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Disabled –A single activation of the pushbutton will not send commands |
| 1 | Enabled –A single activation will send commands to devices in the asso |
The manufacturer defined default value is ```1``` (Enabled –A single activation will send commands to devices in the asso).
This parameter has the configuration ID ```config_8_4_00000001``` and is of type ```INTEGER```.
### Parameter 8: Switch multilevel set single-activation values for pushbutton 1, Byte 2
Upper switch value
Byte 2: Upper switch value0 –99, 255When single pressing the pushbutton for ON, a Switch Multilevel Set with this value will be send to devices in the association group. (Default = 255)
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```255```.
This parameter has the configuration ID ```config_8_4_0000FF00``` and is of type ```INTEGER```.
### Parameter 8: Switch multilevel set single-activation values for pushbutton 1, Byte 3
Lower switch value
Byte 3: Lower switch value 0 -99 When single pressing the pushbutton for OFF, a Switch Multilevel Set with this value will be send to devices in the association group. (Default = 0)
Values in the range 0 to 99 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_8_4_00FF0000``` and is of type ```INTEGER```.
### Parameter 8: Switch multilevel set single-activation values for pushbutton 1, Byte 4
Duration
Byte 4: Duration 0 -255 When single pressing the pushbutton the Switch Multilevel Set with this duration value will be send to devices in the association group.
0: Use dimmer default timer value. (Default)
1 –127: Duration in seconds.
128 –255: Duration in minutes (minus 127) from 1 –128 minutes, where 128 is 1 minute.
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_8_4_01000000``` and is of type ```INTEGER```.
### Parameter 9: Switch Multilevel Set double-activation values for pushbutton 1. Byte 1
Enable/Disable
This parameter specifies the value that are sent to the devices in the Switch Multilevel association group (group 3) when the pushbutton is double-pressed.
Byte 1: Enable / Disable0Disabled –A double activation of the pushbutton will not send commands to devices in the association group.1Enabled –A double activation will send commands to devices in the association group. Devices will receive commands with the values set in 3 following bytes. (Default)
Values in the range 0 to 1 may be set.
The manufacturer defined default value is ```1```.
This parameter has the configuration ID ```config_9_4_00000001``` and is of type ```INTEGER```.
### Parameter 9: Switch Multilevel Set double-activation values for pushbutton 1. Byte 2
Upper switch value
Byte 2: Upper switch value 0 –99, 255 When double pressing the pushbutton for ON, a Switch Multilevel Set with this value will be send to devices in the association group. (Default = 99)
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```99```.
This parameter has the configuration ID ```config_9_4_0000FF00``` and is of type ```INTEGER```.
### Parameter 9: Switch Multilevel Set double-activation values for pushbutton 1. Byte 3
Lower switch value
Byte 3: Lower switch value 0 -99 When double pressing the pushbutton for OFF, a Switch Multilevel Set with this value will be send to devices in the association group. (Default = 99)
Values in the range 0 to 99 may be set.
The manufacturer defined default value is ```99```.
This parameter has the configuration ID ```config_9_4_00FF0000``` and is of type ```INTEGER```.
### Parameter 9: Switch Multilevel Set double-activation values for pushbutton 1. Byte 4
Duration
Byte 4: Duration 0 -255 When double pressing the pushbutton the Switch Multilevel Set with this duration value will be send to devices in the association group.
0: Use dimmer default timer value. (Default)
1 –127: Duration in seconds.
128 –255: Duration in minutes (minus 127) from 1 –128 minutes, where 128 is 1 minute.
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_9_4_01000000``` and is of type ```INTEGER```.
### Parameter 10: Pushbutton 2 functionality.
This parameter specifies the functionality of pushbutton 2.
0 Standard toggle-function, the state is switched between on and off, dimming up and down. (Default)
1 Always turn on or dim up. Using this parameter, the pushbutton can only send ‘on’ or ‘dim up’ commands. Use this in pair with another pushbutton with value 2.
2 Always turn off or dim down. Using this parameter, the pushbutton can only send ‘off’ or ‘dim down’ commands. Use this in pair with another pushbutton with value1.
3 When the pushbutton is down; an on command is sent, and when the pushbutton is released; an off command is sent.
Values in the range 0 to 3 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_10_1``` and is of type ```INTEGER```.
### Parameter 11: Switch multilevel set single-activation values for pushbutton 2, Byte 1
Enable/Disable
Byte 1: Enable / Disable
0 Disabled – A single activation of the pushbutton will not send commands to devices in the association group.
1 Enabled – A single activation will send commands to devices in the association group. Devices will receive commands with the values set in 3 following bytes. (Default)
Values in the range 0 to 1 may be set.
The manufacturer defined default value is ```1```.
This parameter has the configuration ID ```config_11_4_00000001``` and is of type ```INTEGER```.
### Parameter 11: Switch multilevel set single-activation values for pushbutton 2, Byte 2
Upper switch value
Byte 2: Upper switch value 0 –99, 255 When single pressing the pushbutton for ON, a Switch Multilevel Setwith this value will be send to devices in the association group. (Default = 255)
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```255```.
This parameter has the configuration ID ```config_11_4_0000FF00``` and is of type ```INTEGER```.
### Parameter 11: Switch multilevel set single-activation values for pushbutton 2, Byte 3
Lower switch value
Byte 3: Lower switch value 0 -99 When single pressing the pushbutton for OFF, a Switch Multilevel Set with this value will be send to devices in the association group. (Default = 0)
Values in the range 0 to 99 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_11_4_00FF0000``` and is of type ```INTEGER```.
### Parameter 11: Switch multilevel set single-activation values for pushbutton 2, Byte 4
Duration
Byte 4: Duration 0 -255 When single pressing the pushbutton the Switch Multilevel Set with this duration value will be send to devices in the association group.
0: Use dimmer default timer value. (Default)
1 –127: Duration in seconds.
128 –255: Duration in minutes (minus 127) from 1 –128 minutes, where 128 is 1 minute.
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_11_4_01000000``` and is of type ```INTEGER```.
### Parameter 12: Switch Multilevel Set double-activation values for pushbutton 2. Byte 1
Enable/Disable
Byte 1: Enable / Disable
0 Disabled – A double activation of the pushbutton will not send commands to devices in the association group.
1 Enabled – A double activation will send commands to devices in the association group. Devices will receive commands with the values set in 3 following bytes. (Default)
Values in the range 0 to 1 may be set.
The manufacturer defined default value is ```1```.
This parameter has the configuration ID ```config_12_4_00000001``` and is of type ```INTEGER```.
### Parameter 12: Switch Multilevel Set double-activation values for pushbutton 2. Byte 2
Upper switch value
Byte 2: Upper switch value 0 –99, 255 When double pressing the pushbutton for ON, a Switch Multilevel Set with this value will be send to devices in the association group. (Default = 99)
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```99```.
This parameter has the configuration ID ```config_12_4_0000FF00``` and is of type ```INTEGER```.
### Parameter 12: Switch Multilevel Set double-activation values for pushbutton 2. Byte 3
Lower switch value
Byte 3: Lower switch value 0 -99 When double pressing the pushbutton for OFF, a Switch Multilevel Set with this value will be send to devices in the association group. (Default = 99)
Values in the range 0 to 99 may be set.
The manufacturer defined default value is ```99```.
This parameter has the configuration ID ```config_12_4_00FF0000``` and is of type ```INTEGER```.
### Parameter 12: Switch Multilevel Set double-activation values for pushbutton 2. Byte 4
Duration
Byte 4: Duration 0 -255 When double pressing the pushbutton the Switch Multilevel Set with this duration value will be send to devices in the association group.
0: Use dimmer default timer value. (Default)
1 –127: Duration in seconds.
128 –255: Duration in minutes (minus 127) from 1 –128 minutes, where 128 is 1 minute.
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_12_4_01000000``` and is of type ```INTEGER```.
### Parameter 13: Pushbutton 3 functionality.
This parameter specifies the functionality of pushbutton 3.
0 Standard toggle-function, the state is switched between on and off, dimming up and down. (Default)
1 Always turn on or dim up. Using this parameter, the pushbutton can only send ‘on’ or ‘dim up’ commands. Use this in pair with another pushbutton with value 2.
2 Always turn offor dim down. Using this parameter, the pushbutton can only send ‘off’ or ‘dim down’ commands. Use this in pair with another pushbutton with value 1.
3 When the pushbutton is down; an on command is sent, and when the pushbutton is released; an off command is sent.
Values in the range 0 to 3 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_13_1``` and is of type ```INTEGER```.
### Parameter 14: Switch multilevel set single-activation values for pushbutton 3, Byte 1
Enable/Disable
Byte 1: Enable / Disable
0 Disabled – A single activation of the pushbutton will not send commands to devices in the association group.
1 Enabled – A single activation will send commands to devices in the association group. Devices will receive commands with the values set in 3 following bytes. (Default)
Values in the range 0 to 1 may be set.
The manufacturer defined default value is ```1```.
This parameter has the configuration ID ```config_14_4_00000001``` and is of type ```INTEGER```.
### Parameter 14: Switch multilevel set single-activation values for pushbutton 3, Byte 2
Upper switch value.
Byte 2: Upper switch value 0 –99, 255 When single pressing the pushbutton for ON, a Switch Multilevel Set with this value will be send to devices in the association group. (Default = 255)
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```255```.
This parameter has the configuration ID ```config_14_4_0000FF00``` and is of type ```INTEGER```.
### Parameter 14: Switch multilevel set single-activation values for pushbutton 3, Byte 3
Lower switch value
Byte 3: Lower switch value 0 -99 When single pressing the pushbutton for OFF, a Switch Multilevel Set with this value will be send to devices in the association group. (Default = 0)
Values in the range 0 to 99 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_14_4_00FF0000``` and is of type ```INTEGER```.
### Parameter 14: Switch multilevel set single-activation values for pushbutton 3, Byte 3
Duaration
Byte 4: Duration 0 -255 When single pressing the pushbutton the Switch Multilevel Set with this duration value will be send to devices in the association group.
0: Use dimmer default timer value. (Default)
1 –127: Duration in seconds.
128 –255: Duration in minutes (minus 127) from 1 –128 minutes, where 128 is 1 minute.
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_14_4_01000000``` and is of type ```INTEGER```.
### Parameter 15: Switch Multilevel Set double-activation values for pushbutton 3. Byte 1
Enable/Disable
Byte 1: Enable / Disable
0 Disabled – A double activation of the pushbutton will not send commands to devices in the association group.
1 Enabled – A double activation will send commands to devices in the association group. Devices will receive commands with the values set in 3 following bytes. (Default)
Values in the range 0 to 1 may be set.
The manufacturer defined default value is ```1```.
This parameter has the configuration ID ```config_15_4_00000001``` and is of type ```INTEGER```.
### Parameter 15: Switch Multilevel Set double-activation values for pushbutton 3. Byte 2
Upper switch value
Byte 2: Upper switch value 0 –99, 255 When double pressing the pushbutton for ON, a Switch Multilevel Set with this value will be send to devices in the association group. (Default = 99)
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```99```.
This parameter has the configuration ID ```config_15_4_0000FF00``` and is of type ```INTEGER```.
### Parameter 15: Switch Multilevel Set double-activation values for pushbutton 3. Byte 3
Lower switch value
Byte 3: Lower switch value 0 -99 When double pressing the pushbutton for OFF, a Switch Multilevel Set with this value will be send to devices in the association group. (Default = 99)
Values in the range 0 to 99 may be set.
The manufacturer defined default value is ```99```.
This parameter has the configuration ID ```config_15_4_00FF0000``` and is of type ```INTEGER```.
### Parameter 15: Switch Multilevel Set double-activation values for pushbutton 3. Byte 4
Duration
Byte 4: Duration 0 -255 When double pressing the pushbutton the Switch Multilevel Set with this duration value will be send to devices in the association group.
0: Use dimmer default timer value. (Default)
1 –127: Duration in seconds.
128 –255: Duration in minutes (minus 127) from 1 –128 minutes, where 128 is 1 minute.
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_15_4_01000000``` and is of type ```INTEGER```.
### Parameter 16: Pushbutton 4 functionality.
This parameter specifies the functionality of pushbutton 4.
0 Standard toggle-function, the state is switched between on and off, dimming up and down. (Default)
1 Always turn on or dim up. Using this parameter, the pushbutton can only send ‘on’ or ‘dim up’ commands. Use this in pair with another pushbutton with value 2.
2 Always turn offor dim down. Using this parameter, the pushbutton can only send ‘of’ or ‘dim down’ commands. Use this in pair with another pushbutton with value 1.
3 When the pushbutton is down; an on command is sent, and when the pushbutton is released; an off command is sent.
Values in the range 0 to 3 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_16_1``` and is of type ```INTEGER```.
### Parameter 17: Switch multilevel set single-activation values for pushbutton 4, Byte 1
Enable/Disable
Byte 1: Enable / Disable
0 Disabled – A single activation of the pushbutton will not send commands to devices in the association group.
1 Enabled – A single activation will send commands to devices in the association group. Devices will receive commands with the values set in 3 following bytes. (Default)
Values in the range 0 to 1 may be set.
The manufacturer defined default value is ```1```.
This parameter has the configuration ID ```config_17_4_00000001``` and is of type ```INTEGER```.
### Parameter 17: Switch multilevel set single-activation values for pushbutton 4, Byte 2
Upper switch value
Byte 2: Upper switch value 0 –99, 255 When single pressing the pushbutton for ON, a Switch Multilevel Set with this value will be send to devices in the association group. (Default = 255)
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```255```.
This parameter has the configuration ID ```config_17_4_0000FF00``` and is of type ```INTEGER```.
### Parameter 17: Switch multilevel set single-activation values for pushbutton 4, Byte 3
Lower switch value
Byte 3: Lower switch value 0 -99 When single pressing the pushbutton for OFF, a Switch Multilevel Set with this value will be send to devices in the association group. (Default = 0)
Values in the range 0 to 99 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_17_4_00FF0000``` and is of type ```INTEGER```.
### Parameter 17: Switch multilevel set single-activation values for pushbutton 4, Byte 4
Duration
Byte 4: Duration 0 -255 When single pressing the pushbutton the Switch Multilevel Set with this duration value will be send to devices in the association group.
0: Use dimmer default timer value. (Default)
1 –127: Duration in seconds.
128 –255: Duration in minutes (minus 127) from 1 –128 minutes, where 128 is 1 minute.
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_17_4_01000000``` and is of type ```INTEGER```.
### Parameter 18: Switch Multilevel Set double-activation values for pushbutton 4. Byte 1
Enable/Disable
Byte 1: Enable / Disable
0 Disabled – A double activation of the pushbutton will not send commands to devices in the association group.
1 Enabled – A double activation will send commands to devices in the association group. Devices will receive commands with the values set in 3 following bytes. (Default)
Values in the range 0 to 1 may be set.
The manufacturer defined default value is ```1```.
This parameter has the configuration ID ```config_18_4_00000001``` and is of type ```INTEGER```.
### Parameter 18: Switch Multilevel Set double-activation values for pushbutton 4. Byte 2
Upper switch value
Byte 2: Upper switch value 0 –99, 255 When double pressing the pushbutton for ON, a Switch Multilevel Set with this value will be send to devices in the association group. (Default = 99)
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```99```.
This parameter has the configuration ID ```config_18_4_0000FF00``` and is of type ```INTEGER```.
### Parameter 18: Switch Multilevel Set double-activation values for pushbutton 4. Byte 3
Lower switch value
Byte 3: Lower switch value 0 -99 When double pressing the pushbutton for OFF, a Switch Multilevel Set with this value will be send to devices in the association group. (Default = 99)
Values in the range 0 to 99 may be set.
The manufacturer defined default value is ```99```.
This parameter has the configuration ID ```config_18_4_00FF0000``` and is of type ```INTEGER```.
### Parameter 18: Switch Multilevel Set double-activation values for pushbutton 4. Byte 4
Duration
Byte 4: Duration 0 -255 When double pressing the pushbutton the Switch Multilevel Set with this duration value will be send to devices in the association group.
0: Use dimmer default timer value. (Default)
1 –127: Duration in seconds.
128 –255: Duration in minutes (minus 127) from 1 –128 minutes, where 128 is 1 minute.
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_18_4_01000000``` and is of type ```INTEGER```.
### 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 MATRIX ZBA7140 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.
Sends Device Reset notifications, Battery Reports, etc.
Sends Device Reset notifications, Battery Reports, Indicator Reports, Central Scene Configuration Reports and Central Scene notifications.
Association group 1 supports 5 nodes.
### Group 2: Button 1 Basic
Button 1 Basic
Nodes in this group receives Basic Set when pushbutton 1 is activated, the on or off status is decided by the internal button status and is toggled between each activation.
Association group 2 supports 5 nodes.
### Group 3: Button 1 Multilevel
Button 1 Multilevel
Nodes in this group receives Switch Multilevel Set / Switch Multilevel Start Level Change/ Switch Multilevel Stop Level Change when pushbutton 1 is operated. It can, as an example, be used for controlling light dimmers.
Association group 3 supports 5 nodes.
### Group 4: Button 2 Basic
Button 2 Basic
Association group 4 supports 5 nodes.
### Group 5: Button 2 Multilevel
Button 2 Multilevel
Association group 5 supports 5 nodes.
### Group 5: Button 4 Basic
Button 4 Basic
Association group 5 supports 8 nodes.
### Group 6: Button 3 Basic
Button 3 Basic
Association group 6 supports 5 nodes.
### Group 7: Button 3 Multilevel
Button 3 Multilevel
Association group 7 supports 5 nodes.
### Group 9: Button 4 Multilevel
Button 4 Multilevel
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_TRANSPORT_SERVICE_V2| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V3| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_CENTRAL_SCENE_V3| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V2| |
| COMMAND_CLASS_SUPERVISION_V1| |
| COMMAND_CLASS_CONFIGURATION_V4| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V2| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V5| |
| COMMAND_CLASS_BATTERY_V1| |
| COMMAND_CLASS_WAKE_UP_V2| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V3| |
| COMMAND_CLASS_INDICATOR_V3| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| |
| COMMAND_CLASS_SECURITY_V1| |
| COMMAND_CLASS_SECURITY_2_V1| |
### Documentation Links
* [manual](https://opensmarthouse.org/zwavedatabase/1330/reference/zba7140-user-manual-en-4.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](https://opensmarthouse.org/zwavedatabase/1330).

828
_addons_bindings/zwave/doc/logic/zdb5400_1_0.md Normal file
View File

@ -0,0 +1,828 @@
---
layout: documentation
title: ZDB5400 - ZWave
---
{% include base.html %}
# ZDB5400 MATRIX 55 Switch with Dimmer and Backlight
This describes the Z-Wave device *ZDB5400*, manufactured by *[Logic Group](http://www.logic-group.com)* with the thing type UID of ```logic_zdb5400_01_000```.
This version of the device is limited to firmware versions above 1.0
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.
![ZDB5400 product image](https://opensmarthouse.org/zwavedatabase/1316/image/)
The ZDB5400 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data between other devices in the mesh network.
## Overview
MATRIX type ZDB5400 is a multifunction switch that can be mounted in a modular wall-box, with built-in light dimmer and four configurable pushbuttons with RGB indicators.
The pushbuttons can control other Z-Wave devices through the wireless Z-Wave network. The pushbuttons can send ’ON’, ’OFF’ and ’DIM’ commands to the associated Z-Wave devices. These devices could be other light dimmers, blinds, sun-screens, etc.
The built-in light dimmer is per default attached to pushbutton 1. This attachment can be configured, thus it can be configured to not be controlled by any the four pushbuttons, so it can be independent of the local operation and thereby only be controllable from the Z-Wave network.
Furthermore, the pushbuttons can be configured to work together in pairs; thereby it can be possible to have one pushbutton to dim the light up, and another pushbutton to dim the light down.
MATRIX can also issue scene activation commands that can be used to activate scenes in the Z-Wave Controller.
The four RGB indicators, one for each pushbutton, can be used for different purposes, for example as orientation light, status light, different kind of indications, etc. The colour of the light and the control of it is fully controllable from the Z-Wave network.
MATRIX 55 also works as a repeater for the Z-Wave network and therefore expands the Z-Wave network coverage.
### Inclusion Information
MATRIX’ add function is initiated by pressing once on the switch (I) (under the pushbutton cover). The LED inside the module will start blinking.
If MATRIX already belongs to a Z-Wave network, the remove process must be performed before adding it into a new network. Otherwise, the adding of the device will fail.
MATRIX 55 can be factory reset by holding the switch through the hole (I) for at least 10 seconds.
### Exclusion Information
MATRIX’ remove function is initiated by pressing once on the switch (I) (under the pushbutton cover). The LED inside the module will start blinking.
### General Usage Information
## Channels
The following table summarises the channels available for the ZDB5400 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer |
| Color Control | color_color | color_color | ColorLight | Color |
| Color Temperature | color_temperature | color_temperature | ColorLight | Dimmer |
| Scene Number | scene_number | scene_number | | Number |
| Dimmer 1 | switch_dimmer1 | switch_dimmer | DimmableLight | Dimmer |
| Color Control 1 | color_color1 | color_color | ColorLight | Color |
| Color Temperature 1 | color_temperature1 | color_temperature | ColorLight | Dimmer |
| Scene Number 1 | scene_number1 | scene_number | | Number |
| Dimmer 2 | switch_dimmer2 | switch_dimmer | DimmableLight | Dimmer |
| Color Control 2 | color_color2 | color_color | ColorLight | Color |
| Color Temperature 2 | color_temperature2 | color_temperature | ColorLight | Dimmer |
| Scene Number 2 | scene_number2 | scene_number | | Number |
| Dimmer 3 | switch_dimmer3 | switch_dimmer | DimmableLight | Dimmer |
| Color Control 3 | color_color3 | color_color | ColorLight | Color |
| Color Temperature 3 | color_temperature3 | color_temperature | ColorLight | Dimmer |
| Scene Number 3 | scene_number3 | scene_number | | Number |
| Dimmer 4 | switch_dimmer4 | switch_dimmer | DimmableLight | Dimmer |
| Color Control 4 | color_color4 | color_color | ColorLight | Color |
| Color Temperature 4 | color_temperature4 | color_temperature | ColorLight | Dimmer |
| Scene Number 4 | scene_number4 | scene_number | | Number |
| Switch 5 | switch_binary5 | switch_binary | Switch | Switch |
| Dimmer 5 | switch_dimmer5 | switch_dimmer | DimmableLight | Dimmer |
### Dimmer
The brightness channel allows to control the brightness of a light.
It is also possible to switch the light on and off.
The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category.
### Color Control
The color channel allows to control the color of a light.
It is also possible to dim values and switch the light on and off.
The ```color_color``` channel is of type ```color_color``` and supports the ```Color``` item and is in the ```ColorLight``` category.
### Color Temperature
The color temperature channel allows to set the color
temperature of a light from 0 (cold) to 100 (warm).
The ```color_temperature``` channel is of type ```color_temperature``` and supports the ```Dimmer``` item and is in the ```ColorLight``` category.
### 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 |
### Dimmer 1
The brightness channel allows to control the brightness of a light.
It is also possible to switch the light on and off.
The ```switch_dimmer1``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category.
### Color Control 1
The color channel allows to control the color of a light.
It is also possible to dim values and switch the light on and off.
The ```color_color1``` channel is of type ```color_color``` and supports the ```Color``` item and is in the ```ColorLight``` category.
### Color Temperature 1
The color temperature channel allows to set the color
temperature of a light from 0 (cold) to 100 (warm).
The ```color_temperature1``` channel is of type ```color_temperature``` and supports the ```Dimmer``` item and is in the ```ColorLight``` category.
### 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 |
### Dimmer 2
The brightness channel allows to control the brightness of a light.
It is also possible to switch the light on and off.
The ```switch_dimmer2``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category.
### Color Control 2
The color channel allows to control the color of a light.
It is also possible to dim values and switch the light on and off.
The ```color_color2``` channel is of type ```color_color``` and supports the ```Color``` item and is in the ```ColorLight``` category.
### Color Temperature 2
The color temperature channel allows to set the color
temperature of a light from 0 (cold) to 100 (warm).
The ```color_temperature2``` channel is of type ```color_temperature``` and supports the ```Dimmer``` item and is in the ```ColorLight``` category.
### 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 |
### Dimmer 3
The brightness channel allows to control the brightness of a light.
It is also possible to switch the light on and off.
The ```switch_dimmer3``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category.
### Color Control 3
The color channel allows to control the color of a light.
It is also possible to dim values and switch the light on and off.
The ```color_color3``` channel is of type ```color_color``` and supports the ```Color``` item and is in the ```ColorLight``` category.
### Color Temperature 3
The color temperature channel allows to set the color
temperature of a light from 0 (cold) to 100 (warm).
The ```color_temperature3``` channel is of type ```color_temperature``` and supports the ```Dimmer``` item and is in the ```ColorLight``` category.
### 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 |
### Dimmer 4
The brightness channel allows to control the brightness of a light.
It is also possible to switch the light on and off.
The ```switch_dimmer4``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category.
### Color Control 4
The color channel allows to control the color of a light.
It is also possible to dim values and switch the light on and off.
The ```color_color4``` channel is of type ```color_color``` and supports the ```Color``` item and is in the ```ColorLight``` category.
### Color Temperature 4
The color temperature channel allows to set the color
temperature of a light from 0 (cold) to 100 (warm).
The ```color_temperature4``` channel is of type ```color_temperature``` and supports the ```Dimmer``` item and is in the ```ColorLight``` category.
### 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 |
### Switch 5
Switch the power on and off.
The ```switch_binary5``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category.
### Dimmer 5
The brightness channel allows to control the brightness of a light.
It is also possible to switch the light on and off.
The ```switch_dimmer5``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category.
## Device Configuration
The following table provides a summary of the 23 configuration parameters available in the ZDB5400.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 0 | Pushbutton debounce timer | Pushbutton input debounce time in 0.01 seconds resolution. |
| 1 | Operating pushbutton(s) for dimmer. | This parameter specifies which pushbutton(s) that shall be used to control the built-in dimmer |
| 2 | Duration of dimming | This parameter specifies the duration of a full regulation of the light from 0% to 100% |
| 3 | Duration of on/off | This parameter specifies the duration when turning the light on or off |
| 4 | Dimmer mode | The dimmer can work in three different modes. |
| 5 | Dimmer minimum level | This parameter specifies the actual level of the dimmer output when set to 0% |
| 6 | Dimmer maximum level | This parameter specifies the actual level of the dimmer output when set to 99% |
| 7 | Central Scene notifications | Central Scene notifications |
| 8 | Double-activation functionality | This parameter specifies the reaction when double-activating the pushbuttons |
| 10 | Enhanced LED control | This parameter can be used for enabling the enhanced LED control |
| 11 | Pushbutton debounce timer | Pushbutton input debounce time in 0.01 seconds resolution |
| 12 | Pushbutton press threshold time | Specifies the time that a pushbutton must be activated before it is detected as pressed |
| 13 | Pushbutton held threshold time | Specifies the time that a pushbutton must have been activated before it is accepted as “held-down” |
| 14 | Global brightness control | This parameter specifies a common brightness for each of the three base colours for all four pushbutton indicators |
| 15 | Associations groups, transmission when included secure | his parameter specifies if commands are transmitted as a secure message for each of the association groups |
| 16 | Pushbutton 1 functionality | This parameter specifies the functionality of pushbutton 1 |
| 17 | Timer value for pushbutton 1 | This parameter specifies the time used in parameter 16 |
| 18 | Multi-Level Switch Set values for pushbutton 1 | Multi-Level Switch Set values for pushbutton 1 |
| 19 | Basic Set support for pushbutton 1 | This parameter specifies how received Basic Set commands are handled |
| 20 | Pushbutton 1 LED indication. | This parameter specifies how the LED indication is controlled |
| 21 | Colour commands for pushbutton 1 LED indication | This parameter specifies how Command Class Switch Color commands are handled |
| 22 | ON indication RGB-saturation for pushbutton 1 | This parameter specifies the saturation levels when ON status is indicated |
| 23 | OFF indication RGB-saturation for pushbutton 1 | This parameter specifies the saturation levels when OFF status is indicated |
### Parameter 0: Pushbutton debounce timer
Pushbutton input debounce time in 0.01 seconds resolution.
1-255   1 – 2.55 seconds.
Default is 5, which equals to a debounce-filter on 50 milliseconds (0.05 seconds).
Values in the range 1 to 255 may be set.
The manufacturer defined default value is ```5```.
This parameter has the configuration ID ```config_0_1``` and is of type ```INTEGER```.
### Parameter 1: Operating pushbutton(s) for dimmer.
This parameter specifies which pushbutton(s) that shall be used to control the built-in dimmer
This parameter specifies which pushbutton(s) that shall be used to control the built-in dimmer. The parameter is a bitmask, so each of the values can be added up in order to have several pushbuttons to operate the dimmer
0    No local operation of the dimmer
1    Pushbutton 1 controls the dimmer
2    Pushbutton 2 controls the dimmer
4    Pushbutton 3 controls the dimmer
8    Pushbutton 4 controls the dimmer.
Values in the range 0 to 0 may be set.
The manufacturer defined default value is ```1```.
This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```.
### Parameter 2: Duration of dimming
This parameter specifies the duration of a full regulation of the light from 0% to 100%
A regulation of the light with 1% will take 1/100 of the specified duration. This is used when a pushbutton is held-down for controlling the dimming, and when the dimming is fulfilled from other Z-Wave devices when specifying factory default duration.
0           Immediately
1 - 127  Duration in seconds
128-255 Duration in minutes (minus 127), where 128 is 1 minute
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```5```.
This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```.
### Parameter 3: Duration of on/off
This parameter specifies the duration when turning the light on or off
This parameter specifies the duration when turning the light on or off
0                Immediately
1 - 127      Time in seconds.
128 - 255  Time in minutes (minus 127), where 128 is 1 minute.
Values in the range 0 to 255 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```.
### Parameter 4: Dimmer mode
The dimmer can work in three different modes.
The dimmer can work in three different modes: on/off, leading edge or trailing edge.
The following option values may be configured, in addition to values in the range 0 to 2 -:
| Value | Description |
|--------|-------------|
| 0 | No dimming |
| 1 | Trailing edge dimming |
| 2 | Leading edge dimming |
The manufacturer defined default value is ```1``` (Trailing edge dimming).
This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```.
### Parameter 5: Dimmer minimum level
This parameter specifies the actual level of the dimmer output when set to 0%
0 - 99 Corresponds to 0 – 99%
Values in the range 0 to 99 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```.
### Parameter 6: Dimmer maximum level
This parameter specifies the actual level of the dimmer output when set to 99%
1 - 99 Corresponds to 1 – 99%
Values in the range 1 to 99 may be set.
The manufacturer defined default value is ```99```.
This parameter has the configuration ID ```config_6_1``` and is of type ```INTEGER```.
### Parameter 7: Central Scene notifications
Central Scene notifications
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Notifications are disabled |
| 1 | Notifications are enabled |
The manufacturer defined default value is ```1``` (Notifications are enabled).
This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```.
### Parameter 8: Double-activation functionality
This parameter specifies the reaction when double-activating the pushbuttons
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Double-activation disabled |
| 1 | Double-activation sets light to 100% |
The manufacturer defined default value is ```1``` (Double-activation sets light to 100%).
This parameter has the configuration ID ```config_8_1``` and is of type ```INTEGER```.
### Parameter 10: Enhanced LED control
This parameter can be used for enabling the enhanced LED control
See document about MATRIX enhanced LED control
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Enhanced LED control is disabled |
| 1 | Enhanced LED control is enabled |
The manufacturer defined default value is ```0``` (Enhanced LED control is disabled).
This parameter has the configuration ID ```config_10_1``` and is of type ```INTEGER```.
### Parameter 11: Pushbutton debounce timer
Pushbutton input debounce time in 0.01 seconds resolution
1 - 255    1 – 2.55 seconds.
Default is 5, which equals to a debounce-filter on 50 milliseconds (0.05 seconds).
Values in the range 1 to 255 may be set.
The manufacturer defined default value is ```5```.
This parameter has the configuration ID ```config_11_1``` and is of type ```INTEGER```.
### Parameter 12: Pushbutton press threshold time
Specifies the time that a pushbutton must be activated before it is detected as pressed
1 - 255   1 – 2.55 seconds, Resolution is in 0.01 seconds
Default is 20, which equals to 200 milliseconds (0.2 seconds).
Values in the range 1 to 255 may be set.
The manufacturer defined default value is ```20```.
This parameter has the configuration ID ```config_12_1``` and is of type ```INTEGER```.
### Parameter 13: Pushbutton held threshold time
Specifies the time that a pushbutton must have been activated before it is accepted as “held-down”
1 - 255      1 – 2.55 seconds. Resolution is 0.01 seconds
Default is 50, which equals to 500 milliseconds (0,5 seconds).
Values in the range 1 to 255 may be set.
The manufacturer defined default value is ```50```.
This parameter has the configuration ID ```config_13_1``` and is of type ```INTEGER```.
### Parameter 14: Global brightness control
This parameter specifies a common brightness for each of the three base colours for all four pushbutton indicators
Byte 1: Red brightness
0 - 255   Brightness level for the red colour in the 4 indicator groups. (Default is 255)
Byte 2: Green brightness
0 – 255   Brightness level for the green colour in the 4 indicator groups. (Default is 255)
Byte 3: Blue brightness
0 - 255   Brightness level for the blue colour in the 4 indicator groups. (Default is 255)
Byte 4: Not used – must be set to 0.
Values in the range 0 to 0 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_14_4``` and is of type ```INTEGER```.
### Parameter 15: Associations groups, transmission when included secure
his parameter specifies if commands are transmitted as a secure message for each of the association groups
This parameter is only used when the device is included in security mode (either S0 or S2).
0 All messages in all groups are sent as insecure
1 Messages in association group 2 are sent as secure
2 Messages in association group 3 are sent as secure
4 Messages in association group 4 are sent as secure
8 Messages in association group 5 are sent as secure
16 Messages in association group 6 are sent as secure
32 Messages in association group 7 are sent as secure
64 Messages in association group 8 are sent as secure
128 Messages in association group 9 are sent as secure
256 Messages in association group 10 are sent as secure
512 Messages in association group 11 are sent as secure
1024 Messages in association group 12 are sent as secure
2048 Messages in association group 13 are sent as secure
4096 Messages in association group 14 are sent as secure
8191 Messages in all association groups are sent as secure. (Default)
NB. The above values are bitmasks and can be added up to select several options.
Values in the range 0 to 0 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_15_2``` and is of type ```INTEGER```.
### Parameter 16: Pushbutton 1 functionality
This parameter specifies the functionality of pushbutton 1
0 Standard toggle-function, the state is switched between on and off, dimming up and down.
1 Automatic turn off after the time has expired (staircase lighting function), the time is specified in the next configuration parameter.
2 Automatic turn on after the time has expired, the time is specified in the next configuration parameter.
3 Always turn off or dim down. Using this parameter, the pushbutton can only send ‘off’ or ‘dim down’ commands. Use this in pair with another pushbutton with value 4 (see chapter 5.6).
4 Always turn on or dim up. Using this parameter, the pushbutton can only send ‘on’ or ‘
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Standard toggle-function |
| 1 | Automatic turn off |
| 2 | Automatic turn on |
| 3 | Always turn off or dim down |
| 4 | Always turn on or dim up |
The manufacturer defined default value is ```0``` (Standard toggle-function).
This parameter has the configuration ID ```config_16_1``` and is of type ```INTEGER```.
### Parameter 17: Timer value for pushbutton 1
This parameter specifies the time used in parameter 16
This parameter specifies the time used in previous configuration parameter. This parameter is only applicable if previous parameter has value 1 or 2.
Specifies the time in seconds. Default is 300 = 5 minutes.
Values in the range 0 to 43200 may be set.
The manufacturer defined default value is ```300```.
This parameter has the configuration ID ```config_17_1``` and is of type ```INTEGER```.
### Parameter 18: Multi-Level Switch Set values for pushbutton 1
Multi-Level Switch Set values for pushbutton 1
Byte 1: Enable / Disable
0 Disabled – A single activation of the pushbutton will not send commands to devices in association group 4.
1 Enabled – A single activation will send commands to devices in association group 4. Devices will receive commands with the values set in Byte 2 and 3 (Default).
Byte 2: Upper switch value
0 – 99,255 When single pressing the pushbutton for ON, a Multilevel Switch Set with this value will be send to devices in association group 4. (Default = 255)
Byte 3: Lower switch value
0 - 99 When single pressing the pushbutton for OFF, a Multilevel Switch Set with this value will be send to devices in association group 4. (Default = 0)
Byte 4: Not used – must be set to 0.
Values in the range 0 to 0 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_18_4``` and is of type ```INTEGER```.
### Parameter 19: Basic Set support for pushbutton 1
This parameter specifies how received Basic Set commands are handled
0 Basic Set only controls the pushbutton indicator LEDs, ON/OFF. (Default)
1 Basic Set controls the internal switch status and the pushbutton indicator LEDs.
2 Basic Set is handled as if the user had activated the pushbutton, including transmission of commands via the association groups.
Values in the range 0 to 0 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_19_1``` and is of type ```INTEGER```.
### Parameter 20: Pushbutton 1 LED indication.
This parameter specifies how the LED indication is controlled
0 Internal LED control is disabled, only external commands control the indication.
1 The LED indication follows the switch status.
2 The LED indication follows the switch status – with inverted functionality.
3 Same as 1
4 Same as 2
5 The LED indication follows the status of the internal dimmer, ON or OFF.
6 The LED indication follows the status of the internal dimmer with inverted  functionality, ON or OFF.
7 The LED indicator is ON for 5 seconds when the pushbutton is activated. (Default).
Values in the range 0 to 0 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_20_1``` and is of type ```INTEGER```.
### Parameter 21: Colour commands for pushbutton 1 LED indication
This parameter specifies how Command Class Switch Color commands are handled
0 Direct control; the LED indication shows the received colour immediately, until the pushbutton is activated.
1 Colour command sets the colour for OFF indication. (Default).
2 Colour command sets the colour for ON indication.
Values in the range 0 to 0 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_21_1``` and is of type ```INTEGER```.
### Parameter 22: ON indication RGB-saturation for pushbutton 1
This parameter specifies the saturation levels when ON status is indicated
This parameter specifies the saturation levels for the red, green and blue LEDs, when ON status is indicated. (Default is the ON-state indicated by a 50% blue colour).
Byte 1: Colour saturation, red.
0 - 255 Specifies the saturation for the red LEDs. (Default is 0)
Byte 2: Colour saturation, green.
0 – 255 Specifies the saturation for the green LEDs. (Default is 0)
Byte 3: Colour saturation, blue.
0 - 255 Specifies the saturation for the blue LEDs. (Default is 127)
Byte 4: LED control.
0 - 255 LED indicator control; see the application note about this parameter.(Default is 0)
Values in the range 0 to 0 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_22_4``` and is of type ```INTEGER```.
### Parameter 23: OFF indication RGB-saturation for pushbutton 1
This parameter specifies the saturation levels when OFF status is indicated
This parameter specifies the saturation levels for the red, green and blue LEDs, when OFF status is indicated. (Default is the OFF-state indicated as a low white light on 5%)
Byte 1: Colour saturation, red.
0 - 255  Specifies the saturation for the red LEDs. (Default is 47).
Byte 2: Colour saturation, green.
0 – 255  Specifies the saturation for the green LEDs. (Default is 47)
Byte 3: Colour saturation, blue.
0 - 255  Specifies the saturation for the blue LEDs. (Default is 47)
Byte 4: LED control.
0 - 255  LED indicator control; see the application note about this parameter. (Default is 0)
Values in the range 0 to 0 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_23_4``` 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 ZDB5400 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: Button 1 Basic Report
Association group 2 supports 5 nodes.
### Group 3: Button 1 Switch Binary Set
Association group 3 supports 5 nodes.
### Group 4: Button 1 Switch Multilevel
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_SWITCH_MULTILEVEL_V3| |
| COMMAND_CLASS_SWITCH_COLOR_V1| |
| COMMAND_CLASS_TRANSPORT_SERVICE_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_CENTRAL_SCENE_V3| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_MULTI_CHANNEL_V2| |
| COMMAND_CLASS_SUPERVISION_V1| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| |
| COMMAND_CLASS_SECURITY_V1| |
| COMMAND_CLASS_SECURITY_2_V1| |
#### Endpoint 1
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_MULTILEVEL_V3| |
| COMMAND_CLASS_SWITCH_COLOR_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_CENTRAL_SCENE_V3| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| |
| COMMAND_CLASS_SECURITY_V1| |
#### Endpoint 2
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_MULTILEVEL_V3| |
| COMMAND_CLASS_SWITCH_COLOR_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_CENTRAL_SCENE_V3| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| |
| COMMAND_CLASS_SECURITY_V1| |
#### Endpoint 3
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_MULTILEVEL_V3| |
| COMMAND_CLASS_SWITCH_COLOR_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_CENTRAL_SCENE_V3| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| |
| COMMAND_CLASS_SECURITY_V1| |
#### Endpoint 4
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_MULTILEVEL_V3| |
| COMMAND_CLASS_SWITCH_COLOR_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_CENTRAL_SCENE_V3| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| |
| COMMAND_CLASS_SECURITY_V1| |
#### Endpoint 5
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_SWITCH_MULTILEVEL_V3| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| |
| COMMAND_CLASS_SECURITY_V1| |
### Documentation Links
* [ZDB5400 Manual](https://opensmarthouse.org/zwavedatabase/1316/reference/zdb5400-manual-3.pdf)
* [manual (readable)](https://opensmarthouse.org/zwavedatabase/1316/reference/772953_51628_manual-en.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](https://opensmarthouse.org/zwavedatabase/1316).

276
_addons_bindings/zwave/doc/mcohome/mh3901_0_0.md Normal file
View File

@ -0,0 +1,276 @@
---
layout: documentation
title: MH3901 - ZWave
---
{% include base.html %}
# MH3901 Boiler Thermostat
This describes the Z-Wave device *MH3901*, manufactured by *[McoHome Technology Co., Ltd](http://www.mcohome.com/)* with the thing type UID of ```mcohome_mh3901_00_000```.
The device is in the category of *HVAC*, defining Air condition devices, Fans.
![MH3901 product image](https://opensmarthouse.org/zwavedatabase/1253/image/)
The MH3901 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data between other devices in the mesh network.
## Overview
MCOHome Thermostat for Water Heating is a Z-Wave enabled device for indoor temperature control.
*  Capacitive touch buttons
* Attractive appearance
* Clear display, easy to operate
### Inclusion Information
Long press on S1 + S3 
### Exclusion Information
Long press on S1 + S3 
### General Usage Information
## Channels
The following table summarises the channels available for the MH3901 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Sensor (relative humidity) | sensor_relhumidity | sensor_relhumidity | Humidity | Number |
| Sensor (temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature |
| Thermostat mode | thermostat_mode | thermostat_mode | Temperature | Number |
| Operating State | thermostat_state | thermostat_state | Temperature | Number |
| Setpoint (heating) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature |
### Sensor (relative humidity)
Indicates the current relative humidity.
The ```sensor_relhumidity``` channel is of type ```sensor_relhumidity``` and supports the ```Number``` item and is in the ```Humidity``` category. This is a read only channel so will only be updated following state changes from the device.
### Sensor (temperature)
Indicates the current temperature.
The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category.
### Thermostat mode
Sets the thermostat.
The ```thermostat_mode``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category.
The following state translation is provided for this channel to the ```Number``` item type -:
| Value | Label |
|-------|-----------|
| 0 | Off |
| 1 | Heat |
| 2 | Cool |
| 3 | Auto |
| 4 | Aux Heat |
| 5 | Resume |
| 6 | Fan Only |
| 7 | Furnace |
| 8 | Dry Air |
| 9 | Moist Air |
| 10 | Auto Changeover |
| 11 | Heat Economy |
| 12 | Cool Economy |
| 13 | Away |
### Operating State
Sets the thermostat operating state.
The ```thermostat_state``` channel is of type ```thermostat_state``` and supports the ```Number``` item and is in the ```Temperature``` category.
The following state translation is provided for this channel to the ```Number``` item type -:
| Value | Label |
|-------|-----------|
| 0 | Idle |
| 1 | Heating |
| 2 | Cooling |
| 3 | Fan Only |
| 4 | Pending Heat |
| 5 | Pending Cool |
| 6 | Vent / Economiser |
### Setpoint (heating)
Sets the thermostat setpoint.
The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category.
## Device Configuration
The following table provides a summary of the 8 configuration parameters available in the MH3901.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 1 | Automatic Temperature Value Reporting | |
| 2 | Temperature Difference Setting | Base on 0.1 ºC unit; n*0.1 ºC=0.5 ºC |
| 3 | Timed report intervals | Base on 1s unit, it suggest to be set above 30s |
| 4 | Humidity Difference Reporting | |
| 5 | Association 2 SET Command Retransmition times | |
| 7 | Secret Manu P07 | |
| 8 | Secret Menu P08 | |
| 255 | Factory Reset | |
### Parameter 1: Automatic Temperature Value Reporting
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Off |
| 1 | Only report the difference |
| 2 | Regular reporting only |
| 3 | Difference reporting + interval reporting |
The manufacturer defined default value is ```1``` (Only report the difference).
This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```.
### Parameter 2: Temperature Difference Setting
Base on 0.1 ºC unit; n*0.1 ºC=0.5 ºC
Values in the range 3 to 995 may be set.
The manufacturer defined default value is ```60```.
This parameter has the configuration ID ```config_2_2``` and is of type ```INTEGER```.
### Parameter 3: Timed report intervals
Base on 1s unit, it suggest to be set above 30s
Values in the range 10 to 32767 may be set.
The manufacturer defined default value is ```60```.
This parameter has the configuration ID ```config_3_2``` and is of type ```INTEGER```.
### Parameter 4: Humidity Difference Reporting
0x00: Disabled
1-99: A Humidity difference value greater than this will be automatically reported to the gateway
Values in the range 0 to 99 may be set.
The manufacturer defined default value is ```3```.
This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```.
### Parameter 5: Association 2 SET Command Retransmition times
0: Not resend
1-127: Resend Times
Values in the range 0 to 127 may be set.
The manufacturer defined default value is ```3```.
This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```.
### Parameter 7: Secret Manu P07
Heating period setting unit: min, range: 10-120,
default: 20, step value: 1
Values in the range 10 to 120 may be set.
The manufacturer defined default value is ```20```.
This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```.
### Parameter 8: Secret Menu P08
Heating time should be less than P07 value. 
Values in the range 10 to 120 may be set.
The manufacturer defined default value is ```3```.
This parameter has the configuration ID ```config_8_1``` and is of type ```INTEGER```.
### Parameter 255: Factory Reset
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 17185 | Restore default complex parameters |
| 39030 | Restore factory settings |
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_255_2``` 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 MH3901 supports 2 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 1 node.
### Group 2: Device status changes
Association group 2 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_THERMOSTAT_MODE_V1| |
| COMMAND_CLASS_THERMOSTAT_OPERATING_STATE_V1| |
| COMMAND_CLASS_THERMOSTAT_SETPOINT_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
### Documentation Links
* [manual](https://opensmarthouse.org/zwavedatabase/1253/reference/MH3901-Z.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](https://opensmarthouse.org/zwavedatabase/1253).

230
_addons_bindings/zwave/doc/nietech/ms13z_0_0.md Normal file
View File

@ -0,0 +1,230 @@
---
layout: documentation
title: MS13Z - ZWave
---
{% include base.html %}
# MS13Z Minoston Toggle Dimmer Switch
This describes the Z-Wave device *MS13Z*, manufactured by *NIE Technology* with the thing type UID of ```nietech_ms13z_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.
![MS13Z product image](https://opensmarthouse.org/zwavedatabase/1229/image/)
The MS13Z supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data between other devices in the mesh network.
## Overview
Transform any home into a smart home with the Z-Wave Smart Switch. The switch enables you to wirelessly control to turn lights on and off, schedule a timed event or create a custom scene from anywhere in the world, at any time of the day. Take control of your home lighting with Z-Wave Smart Lighting Controls
### Inclusion Information
Make your controller/hub into the "inclusion" mode, triple press the Up/Down push button quickly to include it in the network.
### Exclusion Information
Make your controller/hub into the "exclusion" mode, triple press the Up/Down push button quickly to exclude it from the network.
### General Usage Information
## Channels
The following table summarises the channels available for the MS13Z -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer |
| Scene Number | scene_number | scene_number | | Number |
### Dimmer
The brightness channel allows to control the brightness of a light.
It is also possible to switch the light on and off.
The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category.
### 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 |
## Device Configuration
The following table provides a summary of the 6 configuration parameters available in the MS13Z.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 1 | Locally Button Function | LED flashes 2 times when the configuration parameter changed. |
| 2 | LED Indicator | LED flashes 2 times |
| 4 | Auto Turn-Off Timer | Auto Turn-Off Timer |
| 6 | Auto Turn-On Timer | Auto Turn-On Timer |
| 7 | Association Setting Parameter | Association Setting Parameter |
| 8 | Restores state after power failure | Restores state after power failure |
### Parameter 1: Locally Button Function
LED flashes 2 times when the configuration parameter changed.
Locally Button function(quickly press 7x)
Value=0 Up Button: On/Down Button: Off(Default)
Value=1 Up Button: Off/Down Button: On
Value=2 Up Button: On/Off/Down Button: On/Off
\---Parameter 1: Choose if you want the upper paddle to turn the light on or turn the light off when tapped, or if you'd like any paddle to change the state of the light.
Values: 0 – Upper paddle turns the light on, lower paddle turns the light off (default);
Values: 1 – Upper paddle turns the light off, lower paddle turns the light on;
Values: 2 – any paddle changes the state of the light.
Values in the range 0 to 2 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```.
### Parameter 2: LED Indicator
LED flashes 2 times
LED Indicator(quickly press 6x)
Value=0 On when output Off and Off when output On (default)
Value=1 On when output On and Off when output Off
Value=2 Always Off
Values in the range 0 to 2 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```.
### Parameter 4: Auto Turn-Off Timer
Auto Turn-Off Timer
Values: 0 – 65535 (minutes); 0 (minutes) – default setting
Values in the range 0 to 65535 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_4_4``` and is of type ```INTEGER```.
### Parameter 6: Auto Turn-On Timer
Auto Turn-On Timer
Values: 0 – 65535 (minutes); 0 (minutes) – default setting
Values in the range 0 to 65535 may be set.
The manufacturer defined default value is ```0```.
This parameter has the configuration ID ```config_6_4``` and is of type ```INTEGER```.
### Parameter 7: Association Setting Parameter
Association Setting Parameter
* Value=00 – none
* Value=01 - local
* Value=02 - 3way
* Value=03 - 3way & local
* Value=04 - z-wave hub
* Value= Value=05 - z-wave hub & local
* Value=06 - z-wave hub & 3-way
* Value=07 - z-wave hub & local & 3way
* Value=08 - timer
* Value=09 - timer & local
* Value=10 - timer & 3-way
* Value=11 - timer & 3-way & local
* Value=12 - timer & z-wave hub
* Value=13 - timer & z-wave hub & local
* Value=14 - timer & z-wave hub & 3-way
* Value=15 - all
Values in the range 0 to 15 may be set.
The manufacturer defined default value is ```1```.
This parameter has the configuration ID ```config_7_1``` and is of type ```INTEGER```.
### Parameter 8: Restores state after power failure
Restores state after power failure
Value=0 output off
Value=1 output on
Value=2 output the state after power
Values in the range 0 to 2 may be set.
The manufacturer defined default value is ```2```.
This parameter has the configuration ID ```config_8_1``` 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 MS13Z supports 2 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 1 node.
### Group 2: Send Basic Set ON / Off
Association group 2 supports 5 nodes.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_MULTILEVEL_V3| Linked to BASIC|
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_CENTRAL_SCENE_V3| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| |
### Documentation Links
* [User Manual](https://opensmarthouse.org/zwavedatabase/1229/reference/71GzBcTlViL.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](https://opensmarthouse.org/zwavedatabase/1229).

214
_addons_bindings/zwave/doc/philio/pab04_0_0.md Normal file
View File

@ -0,0 +1,214 @@
---
layout: documentation
title: PAB04 - ZWave
---
{% include base.html %}
# PAB04 Smart Energy Flow Meter
This describes the Z-Wave device *PAB04*, manufactured by *[Philio Technology Corp](http://www.philio-tech.com/)* with the thing type UID of ```philio_pab04_00_000```.
The device is in the category of *Valve*, defining Valves used to control water or gas. e.g. a flow stop valve..
![PAB04 product image](https://opensmarthouse.org/zwavedatabase/1224/image/)
The PAB04 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data between other devices in the mesh network.
## Overview
This valves controller PAB04 is a security enabled wireless switch, based on Z-Wave Plus technology. 
Connect PAB04 with an external water meter which can output pulse signals. PAB04 is able to detect instance water flow and the accumulated water.
### Inclusion Information
Pressing On/Off button three times within 2 seconds will enter inclusion mode.
### Exclusion Information
Pressing On/Off button three times within 2 seconds will enter exclusion mode.
### General Usage Information
## Channels
The following table summarises the channels available for the PAB04 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Switch | switch_binary | switch_binary | Switch | Switch |
| Sensor (WATER_FLOW) | water_flow | water_flow | | |
| Water meter (gal) | meter_water_gallons | meter_water_gallons | Water | Number |
| Water meter (m3) | meter_water_cubic_meters | meter_water_cubic_meters | Water | Number |
### Switch
Switch the power on and off.
The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category.
### Sensor (WATER_FLOW)
Channel type information on this channel is not found.
### Water meter (gal)
Indicates the instantaneous water consumption.
The ```meter_water_gallons``` channel is of type ```meter_water_gallons``` and supports the ```Number``` item and is in the ```Water``` category. This is a read only channel so will only be updated following state changes from the device.
### Water meter (m3)
Indicates the instantaneous water consumption.
The ```meter_water_cubic_meters``` channel is of type ```meter_water_cubic_meters``` and supports the ```Number``` item and is in the ```Water``` category. This is a read only channel so will only be updated following state changes from the device.
## Device Configuration
The following table provides a summary of the 6 configuration parameters available in the PAB04.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 1 | Unit of Water Flow | Unit of Water Flow |
| 2 | Accumulated Water Report | Accumulated Water Report |
| 3 | Instant Water Flow Percent Reported | Instant Water Flow Percent Reported |
| 4 | Pulses per Liter | Pulses per Liter |
| 5 | Relay Control Mode | Relay Control Mode |
| 6 | Periodic Auto Report Timer | Periodic Auto Report Timer |
### Parameter 1: Unit of Water Flow
Unit of Water Flow
The following option values may be configured, in addition to values in the range 1 to 2 -:
| Value | Description |
|--------|-------------|
| 1 | US Gallon |
| 2 | KL |
The manufacturer defined default value is ```2``` (KL).
This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```.
### Parameter 2: Accumulated Water Report
Accumulated Water Report
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
| 0 | Disable Report |
| 1 | Enable Report |
The manufacturer defined default value is ```1``` (Enable Report).
This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```.
### Parameter 3: Instant Water Flow Percent Reported
Instant Water Flow Percent Reported
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Disabled |
The manufacturer defined default value is ```10```.
This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```.
### Parameter 4: Pulses per Liter
Pulses per Liter
This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
Values in the range 1 to 32676 may be set.
The manufacturer defined default value is ```450```.
This parameter has the configuration ID ```config_4_2``` and is of type ```INTEGER```.
### Parameter 5: Relay Control Mode
Relay Control Mode
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
| 0 | Normally Closed |
| 1 | Normally Open |
The manufacturer defined default value is ```0``` (Normally Closed).
This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```.
### Parameter 6: Periodic Auto Report Timer
Periodic Auto Report Timer
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Disabled |
The manufacturer defined default value is ```60```.
This parameter has the configuration ID ```config_6_2``` 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 PAB04 supports 1 association group.
### 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 1 node.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_SENSOR_MULTILEVEL_V9| |
| COMMAND_CLASS_METER_V2| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
| COMMAND_CLASS_SECURITY_V1| |
### Documentation Links
* [Manual](https://opensmarthouse.org/zwavedatabase/1224/reference/PAB04_manual-V2-20200219.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](https://opensmarthouse.org/zwavedatabase/1224).

211
_addons_bindings/zwave/doc/philio/psm09_0_0.md Normal file
View File

@ -0,0 +1,211 @@
---
layout: documentation
title: PSM09 - ZWave
---
{% include base.html %}
# PSM09 Recessed Door Sensor + Door lock Sensor
This describes the Z-Wave device *PSM09*, manufactured by *[Philio Technology Corp](http://www.philio-tech.com/)* with the thing type UID of ```philio_psm09_00_000```.
The device is in the category of *Sensor*, defining Device used to measure something.
![PSM09 product image](https://opensmarthouse.org/zwavedatabase/1225/image/)
The PSM09 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 PSM09 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 PSM09 can detect the the door is open or not, and lock or unlock. The Recessed door sensor PSM09 is Base on Z-WaveTM technology. It is the Z-WaveTM plus product, it support the security, OTA... Those newest features of the Z-WaveTM technology. Z-WaveTM is a wireless communication protocol designed for home automation, specifically to remotely control applications in residential and light commercial environments. The technology uses a low-power RF radio embedded or retrofitted into home electronics devices and systems, such as lighting, home access control, entertainment systems and household appliances
### Inclusion Information
Have Z-WaveTM Controller entered inclusion mode. Pressing tamper key three times within 3 seconds to enter the inclusion mode. If the learning code is successful, the LED will flash slowly.
### Exclusion Information
Have Z-WaveTM Controller entered exclusion mode. Pressing tamper key three times within 3 seconds to enter the exclusion mode. If the removal is successful, the code light will flash for 30 seconds. Node ID has been excluded.
### Wakeup Information
The PSM09 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.
If the user want to wake-up the device immediately, please press the tamper key once. The device will wake-up 10 seconds.
### General Usage Information
## Channels
The following table summarises the channels available for the PSM09 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Alarm (access) | alarm_access | alarm_access | Door | Switch |
| Battery Level | battery-level | system.battery_level | Battery | Number |
| Battery Level | battery-level | system.battery_level | Battery | Number |
| Battery Level | battery-level | system.battery_level | Battery | Number |
### Alarm (access)
Indicates if the access control alarm is triggered.
The ```alarm_access``` channel is of type ```alarm_access``` 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 |
### 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%.
### 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%.
### 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%.
## Device Configuration
The following table provides a summary of the 4 configuration parameters available in the PSM09.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 1 | Auto report state time | |
| 2 | Door lock detect function switch | |
| 3 | Door lock detect timer | |
| 4 | Door lock detect 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 |
### Parameter 1: Auto report state time
The interval time for auto report the door/window & Lock state & battery level. 0 means turn off auto report state. Units of 30 minutes.
Values in the range 0 to 127 may be set.
The manufacturer defined default value is ```12```.
This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```.
### Parameter 2: Door lock detect function switch
0 means turn off Door lock detect funtion.
1 means turn on Door lock detect funtion.
Values in the range 0 to 1 may be set.
The manufacturer defined default value is ```1```.
This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```.
### Parameter 3: Door lock detect timer
Units of 20 seconds.
Values in the range 1 to 127 may be set.
The manufacturer defined default value is ```3```.
This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```.
### Parameter 4: Door lock detect level
When an error condition occurs in the door lock detection.
Can reduce its level to avoid door lock detection errors.
Values in the range 1 to 10 may be set.
The manufacturer defined default value is ```10```.
This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```.
### 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 PSM09 supports 1 association group.
### 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.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_ALARM_V8| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| COMMAND_CLASS_BATTERY_V1| |
| COMMAND_CLASS_BATTERY_V1| |
| COMMAND_CLASS_BATTERY_V1| |
| COMMAND_CLASS_WAKE_UP_V2| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| |
| COMMAND_CLASS_SECURITY_V1| |
### Documentation Links
* [Manual](https://opensmarthouse.org/zwavedatabase/1225/reference/PSM09_UserManual_0624.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](https://opensmarthouse.org/zwavedatabase/1225).

6
_addons_bindings/zwave/doc/qubino/zmnhxd_0_0.md
View File

@ -287,7 +287,7 @@ Available configuration parameters (data type is 1 Byte DEC)
**NOTE:** Device is measuring also some disturbances even if on the output is no load. To avoid disturbances:
* If measured Active Power (W) is below e.g. 5W-> the reported value in this case is 0WThis is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
The following option values may be configured, in addition to values in the range 0 to 100 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -313,7 +313,7 @@ Energy Total (kvarh), Total Energy (kVAh)
**Note:** Device is reporting only if there was a change of 0.1 in Energy
**Note:** In the future will be possible to measure and report also Active Energy on PH1, PH2 and PH3.This is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
The following option values may be configured, in addition to values in the range 600 to 65535 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -333,7 +333,7 @@ Energy reports for Voltage, Current, Total Power Factor, Total Reactive Power
* 0 – reporting disabled
* 600-65536 = 600 (600 seconds – 65536 seconds). Reporting enabled. Report is sent with the time interval set by entered value.
* Note: Device is reporting only if there was a changeThis is an advanced parameter and will therefore not show in the user interface without entering advanced mode.
The following option values may be configured, in addition to values in the range 600 to 65535 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|

47
_addons_bindings/zwave/doc/rehau/reguard_0_0.md
View File

@ -42,33 +42,35 @@ The following table summarises the channels available for the RE.GUARD -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Switch | switch_binary | switch_binary | Switch | Switch |
| Sensor (WATER_FLOW) | water_flow | water_flow | | |
| Sensor (water_temperature) | water_temperature | water_temperature | | |
| Sensor (WATER_PRESSURE) | water_pressure | water_pressure | | |
| Water meter (m³) | meter_water_cubic_meters | meter_water_cubic_meters | Water | Number |
| Open/Close | switch_binary | switch_binary | Switch | Switch |
| Sensor (water_flow) | sensor_waterflow | sensor_waterflow | | |
| Sensor (water_temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature |
| Sensor (water_pressure) | sensor_waterpressure | sensor_waterpressure | | |
| water meter (m³) | meter_water_cubic_meters | meter_water_cubic_meters | Water | Number |
| Alarm (flood) | alarm_flood | alarm_flood | Water | Switch |
| Alarm (system) | alarm_system | alarm_system | | Switch |
| Alarm (water_valve) | water_valve | water_valve | | |
| Alarm (water_valve) | alarm_system | alarm_system | | Switch |
| Alarm (power) | alarm_power | alarm_power | Energy | Switch |
| Battery Level | battery-level | system.battery_level | Battery | Number |
| Clock Time Offset | time_offset | time_offset | Time | Number |
### Switch
### Open/Close
Switch the power on and off.
The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category.
### Sensor (WATER_FLOW)
### Sensor (water_flow)
Channel type information on this channel is not found.
### Sensor (water_temperature)
Indicates the current temperature.
The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category.
### Sensor (water_pressure)
Channel type information on this channel is not found.
### Sensor (WATER_PRESSURE)
Channel type information on this channel is not found.
### Water meter (m³)
### water meter (m³)
Indicates the instantaneous water consumption.
The ```meter_water_cubic_meters``` channel is of type ```meter_water_cubic_meters``` and supports the ```Number``` item and is in the ```Water``` category. This is a read only channel so will only be updated following state changes from the device.
@ -98,7 +100,16 @@ The following state translation is provided for this channel to the ```Switch```
| ON | Alarm |
### Alarm (water_valve)
Channel type information on this channel is not found.
Indicates if a system alarm is triggered.
The ```alarm_system``` channel is of type ```alarm_system``` and supports the ```Switch``` item. 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 (power)
Indicates if a power alarm is triggered.
@ -176,9 +187,15 @@ Detailed information on each parameter can be found in the sections below.
0 valve always off; 1 user absent/holiday; 2 user present; 3 valve always on
Values in the range 0 to 3 may be set.
The following option values may be configured -:
The manufacturer defined default value is ```2```.
| Value | Description |
|--------|-------------|
| 0 | valve always off |
| 1 | user absent/holiday |
| 2 | user present |
The manufacturer defined default value is ```2``` (user present).
This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```.

110
_addons_bindings/zwave/doc/sunricher/ZV9001K4RGBW_0_0.md Normal file
View File

@ -0,0 +1,110 @@
---
layout: documentation
title: ZV9001K4-RGBW - ZWave
---
{% include base.html %}
# ZV9001K4-RGBW Z-Wave RGBW Remote Control
This describes the Z-Wave device *ZV9001K4-RGBW*, manufactured by *[Sunricher](www.sunricher.com)* with the thing type UID of ```sunricher_ZV9001K4RGBW_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.
![ZV9001K4-RGBW product image](https://opensmarthouse.org/zwavedatabase/1285/image/)
The ZV9001K4-RGBW 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 remote control is a Z-Wave device that can both control other Z-Wave devices and activate scenes in Gateways. Although it is controlling other devices, the device cannot act as Z-Wave network controller (primary or secondary) and will always need a Z-Wave network controller to be included into a Z-Wave network. It also supports the Over The Air (OTA) feature for the product’s firmware upgrade. The remote control has following functions: 1. Control of groups of other Z-Wave devices using 'ON', 'OFF', Dim and RGB color control commands. 2. Activation of scenes in Gateway mode. The encryption modes that the remote control supports are S0, S2 Authenticated, S2 Unauthenticated. When the remote control is being included into a Z-Wave network, you can use your primary controller/gateway to enable one encryption mode or disable encryption. (The primary controller/gateway shall support encryption mode configuration). 
### Inclusion Information
Step 1. Make sure the remote control does not belong to any Z-Wave network, short press any button, if LED indicator does not turn on, the remote control does not belong to any network, then continue step 2,if LED indicator turns on, it means the remote control has already been included to a network, please first set the remote control to exclusion mode (refer to the part "Exclusion" of this manual),then continue step 2. Step 2. Set primary controller/gateway into inclusion mode (Please refer to your primary controllers manual on how to turn your controller into inclusion). Step 3. Press and hold down both buttons and of Group 2 over 3 seconds, LED indicator turns on, the remote control will be set to inclusion mode, and waiting to be included, after 10s LED indicator blinks 6 times quickly to indicate successful inclusion. The remote control is a sleepy device, after inclusion it will not enter into sleepy mode immediately, and will continue activation status for 30s and wait data interaction from the gateway, the LED indicator will stay solid on, please be patient to wait LED indicator to turn off.
### Exclusion Information
There are two exclusion methods: Method 1: Exclusion from the primary controller/gateway as follows: 1. Set the primary controller/gateway into exclusion mode (Please refer to your primary controllers manual on how to set your controller into exclusion). 2. Press and hold down both buttons and of Group 2 over 3 seconds, LED indicator turns on, the remote control will be set to exclusion mode, and waiting to be excluded, after 7s LED indicator blinks 4 times quickly to indicate successful exclusion. Z-Wave RGBW Remote Control Front side 55.57 mm 71.20 mm 11 mm Back side Battery: CR2450 Before the first use, please remove the protective film 55.57 mm 71.20 mm The remote control can be fixed on the wall with 3M glue or screw. Group 2: click to turn on/off Group 2: press and hold down to increase/decrease light intensity Group 2: click to turn on/off white channel Group 2: click to get R, G, B colors one by one, press and hold down to cycle RGB colors Press and hold down both keys together for 3s to be added to or removed from Z-Wave network by Z-Wave master (primary) controller. Product Data Z-Wave Frequency Power Supply Operating temperature Relative humidity Dimensions Waterproof Grade 868.42MHz 3VDC(1xCR2450 battery) 0 to 40°C 8% to 80% 71.2x71.2x13.6mm IP20 Method 2: Factory reset the remote control will force the remote control to be excluded from a network. (please refer to the part “Factory Reset” of this manual) Note: Factory reset is not recommended for exclusion, please use this procedure only if the primary controller/gateway is missing or otherwise inoperable
### Wakeup Information
The ZV9001K4-RGBW 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.
The remote control is under sleepy mode for most of the time to save battery power. It can not receive wireless command under sleepy mode. Before the gateway interacts data with the remote, the remote control shall be activated manually first. Short press any button to activate the remote control for 3s, and press and hold down and buttons of Group 2 together over 1 second to activate the remote control for 7s. 
### General Usage Information
## Channels
The following table summarises the channels available for the ZV9001K4-RGBW -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Battery Level | battery-level | system.battery_level | Battery | Number |
### 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%.
## Device Configuration
The device has no configuration parameters defined.
## 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 ZV9001K4-RGBW supports 2 association groups.
### Group 1: Group 1
Lifeline
1. Send Command Class "Device Reset Locally Notification V1" to associated devices of this group to report factory reset information when factory reset the remote control. 2. When remote control battery power value changes, send Command Class "Battery Report V1" to associated devices of this group to report power value information. 3. Short press or press and hold down any button to send scene activation command to the associated devices of this group using Command Class “Central Scene Notification V3” 
Association group 1 supports 5 nodes.
### Group 2: Group 2
Launch 1
• devices of this group using Command Class "Basic Set V2". • Press and hold down button to send light intensity increase/decrease command to associated devices of this group using Command Class "Multilevel V4". • Short press W/ button of Group 2, turn on/off white/RGB channel of associated devices of this group using Command Class “Color Switch Set”. • Press and hold down W/ button of Group 2, adjust intensity of white/RGB channel of associated devices of this group using Command Class “Color Switch Start Level Change”. Short press button to send ON/OFF command to associated
Association group 2 supports 5 nodes.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_CENTRAL_SCENE_V3| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V2| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V2| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V4| |
| COMMAND_CLASS_BATTERY_V1| |
| COMMAND_CLASS_WAKE_UP_V2| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
| COMMAND_CLASS_SECURITY_V1| |
### Documentation Links
* [sr-zv9001k4-rgbw-manual](https://opensmarthouse.org/zwavedatabase/1285/reference/SR-ZV9001K4-RGBW-Instruction-V1.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](https://opensmarthouse.org/zwavedatabase/1285).

42
_addons_bindings/zwave/doc/thermofloor/pushbutton4_0_0.md
View File

@ -1,21 +1,21 @@
---
layout: documentation
title: Z-Push Button 4 - ZWave
title: Heatit Z-Push Button 4 - ZWave
---
{% include base.html %}
# Z-Push Button 4 Wall Mounted Switch
This describes the Z-Wave device *Z-Push Button 4*, manufactured by *ThermoFloor* with the thing type UID of ```thermofloor_pushbutton4_00_000```.
# Heatit Z-Push Button 4 Wall Mounted Switch
This describes the Z-Wave device *Heatit Z-Push Button 4*, manufactured by *ThermoFloor* with the thing type UID of ```thermofloor_pushbutton4_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.
![Z-Push Button 4 product image](https://www.cd-jackson.com/zwave_device_uploads/1162/1162_default.png)
![Heatit Z-Push Button 4 product image](https://opensmarthouse.org/zwavedatabase/1162/image/)
The Z-Push Button 4 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 Heatit Z-Push Button 4 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 Z-Push Button 4 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.
The Heatit Z-Push Button 4 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
@ -58,7 +58,7 @@ _Note: Factory reset is not recommended for removing, please use this procedure
### Wakeup Information
The Z-Push Button 4 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 Heatit Z-Push Button 4 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.
@ -67,12 +67,14 @@ The remote control is under sleepy mode for most of the time to save battery pow
## Channels
The following table summarises the channels available for the Z-Push Button 4 -:
The following table summarises the channels available for the Heatit Z-Push Button 4 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Scene Number | scene_number | scene_number | | Number |
| Battery Level | battery-level | system.battery_level | Battery | Number |
| Dimmer [Deprecated]| switch_dimmer1 | switch_dimmer | DimmableLight | Dimmer |
| Dimmer [Deprecated]| switch_dimmer2 | switch_dimmer | DimmableLight | Dimmer |
### Scene Number
Triggers when a scene button is pressed.
@ -95,6 +97,22 @@ Represents the battery level as a percentage (0-100%). Bindings for things suppo
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%.
### Dimmer [Deprecated]
The brightness channel allows to control the brightness of a light.
It is also possible to switch the light on and off.
The ```switch_dimmer1``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category.
**Note:** This channel is marked as deprecated so should not be used.
### Dimmer [Deprecated]
The brightness channel allows to control the brightness of a light.
It is also possible to switch the light on and off.
The ```switch_dimmer2``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category.
**Note:** This channel is marked as deprecated so should not be used.
## Device Configuration
@ -105,7 +123,7 @@ The device has no configuration parameters defined.
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 Z-Push Button 4 supports 3 association groups.
The Heatit Z-Push Button 4 supports 3 association groups.
### Group 1: Lifeline
@ -169,10 +187,10 @@ Association group 3 supports 5 nodes.
### Documentation Links
* [Installers manual - English](https://www.cd-jackson.com/zwave_device_uploads/1162/Manual-Heatit-Z-Push-Button-4--FW-1-26-Ver2019-A-ENG.pdf)
* [Product Sheet - Eng.](https://www.cd-jackson.com/zwave_device_uploads/1162/fdv-heatit-z-push-button-4-eng.pdf)
* [Installers manual - English](https://opensmarthouse.org/zwavedatabase/1162/reference/Manual-Heatit-Z-Push-Button-4--FW-1-26-Ver2019-A-ENG.pdf)
* [Product Sheet - Eng.](https://opensmarthouse.org/zwavedatabase/1162/reference/fdv-heatit-z-push-button-4-eng.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](http://www.cd-jackson.com/index.php/zwave/zwave-device-database/zwave-device-list/devicesummary/1162).
You can [contribute to the database here](https://opensmarthouse.org/zwavedatabase/1162).

5
_addons_bindings/zwave/doc/zooz/zen16_0_0.md
View File

@ -7,6 +7,7 @@ title: ZEN16 - ZWave
# ZEN16 Multirelay
This describes the Z-Wave device *ZEN16*, manufactured by *[Zooz](http://www.getzooz.com/)* with the thing type UID of ```zooz_zen16_00_000```.
This version of the device is limited to firmware versions below 1.0
The device is in the category of *Power Outlet*, defining Small devices to be plugged into a power socket in a wall which stick there.
@ -138,7 +139,6 @@ The following option values may be configured -:
| 0 | Momentary switch |
| 1 | Normal |
| 2 | Toggle switch (default) |
| 3 | garage door |
The manufacturer defined default value is ```2``` (Toggle switch (default)).
@ -156,7 +156,6 @@ The following option values may be configured -:
| 0 | Momentary switch |
| 1 | Normal |
| 2 | Toggle switch (default) |
| 3 | garage door |
The manufacturer defined default value is ```2``` (Toggle switch (default)).
@ -174,7 +173,6 @@ The following option values may be configured -:
| 0 | Momentary switch |
| 1 | Normal |
| 2 | Toggle switch (default) |
| 3 | garage door |
The manufacturer defined default value is ```2``` (Toggle switch (default)).
@ -426,7 +424,6 @@ Association group 4 supports 5 nodes.
### Documentation Links
* [Manual](https://opensmarthouse.org/zwavedatabase/1176/reference/zooz-s2-multirelay-zen16-ver1-0-manual-online.pdf)
* [manual for firmware 1.0.2](https://opensmarthouse.org/zwavedatabase/1176/reference/zooz-s2-multirelay-zen16-ver1-02-manual-1.pdf)
---

682
_addons_bindings/zwave/doc/zooz/zen16_1_10.md Normal file
View File

@ -0,0 +1,682 @@
---
layout: documentation
title: ZEN16 - ZWave
---
{% include base.html %}
# ZEN16 Multirelay
This describes the Z-Wave device *ZEN16*, manufactured by *[Zooz](http://www.getzooz.com/)* with the thing type UID of ```zooz_zen16_01_010```.
This version of the device is limited to firmware versions 1.10 to 1.30
The device is in the category of *Battery*, defining Batteries, Energy Storages.
![ZEN16 product image](https://opensmarthouse.org/zwavedatabase/1326/image/)
The ZEN16 supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data between other devices in the mesh network.
## Overview
**Features**
* Powerful dry contact relays to control loads up to 15 A and 20 A
* Perfect for outdoor lighting, pool pumps, garage door, or gas fireplace
* Control up to 3 connected loads independently or together
* Z-Wave or optional wall switch control (toggle or momentary type)
* Built-in timers for each relay to simplify automation
* Remembers and restores on/off status after power failure
* Built-in Z-Wave Plus signal repeater to extend network range
* Powered by 12-24 V DC/AC or USB C port for easy set-up
* Wall mounting and minimal design for clean installation
* S2 security protocol and the latest 500 Z-Wave chip
**Specifications**
* Model Number: ZEN16
* Z-Wave Signal Frequency: 908.42 MHz
* Power: 12-24 V DC/AC or USB C
* Maximum Load: Relay 1: 15A (HP), R2: 15A (HP), R3: 20A (HP)
* Range: Up to 100 feet line of sight
* Operating Temperature: 32-104° F (0-40° C)
* Installation and Use: Indoor only
### Inclusion Information
1. Start Z-Wave inclusion.
2. Quickly press the Z-Wave button 3 times.
The LED indicator will blink to signal communication and remain on for 2 seconds to confirm inclusion.
### Exclusion Information
1. Start Z-Wave inclusion.
2. Quickly press the Z-Wave button 3 times.
The LED indicator will blink to signal communication and remain on for 2 seconds to confirm inclusion.
### General Usage Information
**Manual Control From The Z-Wave Button**
* 3 x tap: enter inclusion (pairing) mode
* 5 x tap: change LED indicator mode (see parameter 5)
## Channels
The following table summarises the channels available for the ZEN16 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Switch | switch_binary | switch_binary | Switch | Switch |
| Dimmer | switch_dimmer | switch_dimmer | DimmableLight | Dimmer |
| Scene Number | scene_number | scene_number | | Number |
| Binary Sensor | sensor_binary | sensor_binary | | Switch |
| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number |
| Electric meter (kVAh) | meter_kvah | meter_kvah | Energy | Number |
| Electric meter (watts) | meter_watts | meter_watts | Energy | Number |
| Battery Level | battery-level | system.battery_level | Battery | Number |
| Switch 1 | switch_binary1 | switch_binary | Switch | Switch |
| Switch 2 | switch_binary2 | switch_binary | Switch | Switch |
| Switch 3 | switch_binary3 | switch_binary | Switch | Switch |
### Switch
Switch the power on and off.
The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category.
### Dimmer
The brightness channel allows to control the brightness of a light.
It is also possible to switch the light on and off.
The ```switch_dimmer``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category.
### Scene Number
Triggers when a scene button is pressed.
The ```scene_number``` channel is of type ```scene_number``` and supports the ```Number``` item.
### Binary Sensor
Indicates if a sensor has triggered.
The ```sensor_binary``` channel is of type ```sensor_binary``` and supports the ```Switch``` item. 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 |
|-------|-----------|
| ON | Triggered |
| OFF | Untriggered |
### Electric meter (kWh)
Indicates the energy consumption (kWh).
The ```meter_kwh``` channel is of type ```meter_kwh``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device.
### Electric meter (kVAh)
Indicates the energy consumption (kVAh).
The ```meter_kvah``` channel is of type ```meter_kvah``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device.
### Electric meter (watts)
Indicates the instantaneous power consumption.
The ```meter_watts``` channel is of type ```meter_watts``` and supports the ```Number``` item and is in the ```Energy``` category. This is a read only channel so will only be updated following state changes from the device.
### 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%.
### Switch 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.
### Switch 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.
### Switch 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.
## Device Configuration
The following table provides a summary of the 24 configuration parameters available in the ZEN16.
Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|-------|-------|-------------|
| 1 | On Off Status After Power Failure | Set the on off status for the relays after power failure |
| 2 | Switch Type for Relay 1 (Sw1) | Choose the wall switch type you want to connect to the Sw1 terminal |
| 3 | Switch Type for Relay 2 (Sw2) | Choose the wall switch type you want to connect to the Sw2 terminal |
| 4 | Switch Type for Relay 3 (Sw3) | Choose the wall switch type you want to connect to the Sw3 terminal. |
| 5 | LED Indicator Control | LED Indicator Control |
| 6 | Auto Turn-Off Timer for Relay 1 | Auto Turn-Off Timer for Relay 1 |
| 7 | Auto Turn-On Timer for Relay 1 | Auto Turn-On Timer for Relay 1 |
| 8 | Auto Turn-Off Timer for Relay 2 | Auto Turn-Off Timer for Relay 2 |
| 9 | Auto Turn-On Timer for Relay 2 | Auto Turn-On Timer for Relay 2 |
| 10 | Auto Turn-Off Timer for Relay 3 | Auto Turn-Off Timer for Relay 3 |
| 11 | Auto Turn-On Timer for Relay 3 | Auto Turn-On Timer for Relay 3 |
| 12 | Enable/Disable Manual Control for Sw1 | Enable/Disable Manual Control for Sw1 |
| 13 | Enable/Disable Manual Control for Sw2 | Enable/Disable Manual Control for Sw2 |
| 14 | Enable/Disable Manual Control for Sw3 | Enable/Disable Manual Control for Sw3 |
| 15 | Auto Timer-Off Timer Unit for Relay 1 | Use this parameter to choose between seconds, minutes, or hours to be used as the auto timer-off unit for Relay 1 |
| 16 | Auto Timer-On Timer Unit for Relay 1 | Use this parameter to choose between seconds, minutes, or hours to be used as the auto timer-on unit for Relay 1 |
| 17 | Auto Timer-Off Timer Unit for Relay 2 | Use this parameter to choose between seconds, minutes, or hours to be used as the auto timer-off unit for Relay 2 |
| 18 | Auto Timer-On Unit for Relay 2 | Use this parameter to choose between seconds, minutes, or hours to be used as the auto timer-on unit for Relay 2 |
| 19 | Auto Timer-Off Timer Unit for Relay 3 | Use this parameter to choose between seconds, minutes, or hours to be used as the auto timer-off unit for Relay 3 |
| 20 | Auto Timer-On Timer Unit for Relay 3 | Use this parameter to choose between seconds, minutes, or hours to be used as the auto timer-on unit for Relay 3 |
| 21 | Relay 1 - Default Relay State | Decide whether you'd like Relay 1 to be normally open (NO) or normally closed (NC) |
| 22 | Relay 2 - Default Relay State | Decide whether you'd like Relay 2 to be normally open (NO) or normally closed (NC) |
| 23 | Relay 3 - Default Relay State | Decide whether you'd like Relay 3 to be normally open (NO) or normally closed (NC) |
| 24 | DC Motor Mode | Sync Relay 1 and Relay 2 together to prevent them from being activated at the same time |
### Parameter 1: On Off Status After Power Failure
Set the on off status for the relays after power failure
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | ALL relays forced to OFF |
| 1 | ALL relays restore on/off status (default) |
| 2 | ALL relays forced to ON |
| 3 | Relay 1 and 2 restore on/off status, Relay 3 OFF |
| 4 | Relay 1 and 2 restore on/off status, Relay 3 ON |
The manufacturer defined default value is ```1``` (ALL relays restore on/off status (default)).
This parameter has the configuration ID ```config_1_1``` and is of type ```INTEGER```.
### Parameter 2: Switch Type for Relay 1 (Sw1)
Choose the wall switch type you want to connect to the Sw1 terminal
Press and hold the Z-Wave button for 5 seconds to change mode manually
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Momentary switch |
| 1 | Normal |
| 2 | Toggle switch (default) |
| 3 | Garage door switch |
The manufacturer defined default value is ```2``` (Toggle switch (default)).
This parameter has the configuration ID ```config_2_1``` and is of type ```INTEGER```.
### Parameter 3: Switch Type for Relay 2 (Sw2)
Choose the wall switch type you want to connect to the Sw2 terminal
Click-click’n’hold the Z-Wave button for 5 seconds to change mode manually.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Momentary switch |
| 1 | Normal |
| 2 | Toggle switch (default) |
| 3 | Garage door switch |
The manufacturer defined default value is ```2``` (Toggle switch (default)).
This parameter has the configuration ID ```config_3_1``` and is of type ```INTEGER```.
### Parameter 4: Switch Type for Relay 3 (Sw3)
Choose the wall switch type you want to connect to the Sw3 terminal.
Click-click-click’n’hold the Z-Wave button for 5 seconds to change mode manually
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Momentary switch |
| 1 | Normal |
| 2 | Toggle switch (default) |
| 3 | Garage door switch |
The manufacturer defined default value is ```2``` (Toggle switch (default)).
This parameter has the configuration ID ```config_4_1``` and is of type ```INTEGER```.
### Parameter 5: LED Indicator Control
LED Indicator Control
Choose if you want the LED indicator to turn on when any of the relays are on or if all of them are off, or if you want it to remain on or off at all times.
Click the Z-Wave button 5 times quickly to change mode manually
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | ON when all relays OFF (default) |
| 1 | ON when any relay ON |
| 2 | LED indicator is always OFF |
| 3 | LED indicator is always ON |
The manufacturer defined default value is ```0``` (ON when all relays OFF (default)).
This parameter has the configuration ID ```config_5_1``` and is of type ```INTEGER```.
### Parameter 6: Auto Turn-Off Timer for Relay 1
Auto Turn-Off Timer for Relay 1
Use this parameter to set the time after which you want the device connected to Relay 1 to automatically turn off once it has been turned on. The number entered as value corresponds to the number of minutes.
The following option values may be configured, in addition to values in the range 0 to 65535 -:
| Value | Description |
|--------|-------------|
| 0 | Timer disabled (default) |
The manufacturer defined default value is ```0``` (Timer disabled (default)).
This parameter has the configuration ID ```config_6_4``` and is of type ```INTEGER```.
### Parameter 7: Auto Turn-On Timer for Relay 1
Auto Turn-On Timer for Relay 1
Use this parameter to set the time after which you want the device connected to Relay 1 to automatically turn on once it has been turned off. The number entered as value corresponds to the number of minutes.
The following option values may be configured, in addition to values in the range 0 to 65535 -:
| Value | Description |
|--------|-------------|
| 0 | Timer disabled (default) |
The manufacturer defined default value is ```0``` (Timer disabled (default)).
This parameter has the configuration ID ```config_7_4``` and is of type ```INTEGER```.
### Parameter 8: Auto Turn-Off Timer for Relay 2
Auto Turn-Off Timer for Relay 2
Use this parameter to set the time after which you want the device connected to Relay 2 to automatically turn off once it has been turned on. The number entered as value corresponds to the number of minutes.
The following option values may be configured, in addition to values in the range 0 to 65535 -:
| Value | Description |
|--------|-------------|
| 0 | Timer disabled (default) |
The manufacturer defined default value is ```0``` (Timer disabled (default)).
This parameter has the configuration ID ```config_8_4``` and is of type ```INTEGER```.
### Parameter 9: Auto Turn-On Timer for Relay 2
Auto Turn-On Timer for Relay 2
Use this parameter to set the time after which you want the device connected to Relay 2 to automatically turn on once it has been turned off. The number entered as value corresponds to the number of minutes.
The following option values may be configured, in addition to values in the range 0 to 65535 -:
| Value | Description |
|--------|-------------|
| 0 | Timer disabled (default) |
The manufacturer defined default value is ```0``` (Timer disabled (default)).
This parameter has the configuration ID ```config_9_4``` and is of type ```INTEGER```.
### Parameter 10: Auto Turn-Off Timer for Relay 3
Auto Turn-Off Timer for Relay 3
Use this parameter to set the time after which you want the device connected to Relay 3 to automatically turn off once it has been turned on. The number entered as value corresponds to the number of minutes.
The following option values may be configured, in addition to values in the range 0 to 65535 -:
| Value | Description |
|--------|-------------|
| 0 | Timer disabled (default) |
The manufacturer defined default value is ```0``` (Timer disabled (default)).
This parameter has the configuration ID ```config_10_4``` and is of type ```INTEGER```.
### Parameter 11: Auto Turn-On Timer for Relay 3
Auto Turn-On Timer for Relay 3
Use this parameter to set the time after which you want the device connected to Relay 3 to automatically turn on once it has been turned off. The number entered as value corresponds to the number of minutes.
The following option values may be configured, in addition to values in the range 0 to 65535 -:
| Value | Description |
|--------|-------------|
| 0 | Timer disabled (default) |
The manufacturer defined default value is ```0``` (Timer disabled (default)).
This parameter has the configuration ID ```config_11_4``` and is of type ```INTEGER```.
### Parameter 12: Enable/Disable Manual Control for Sw1
Enable/Disable Manual Control for Sw1
Enable or disable physical on/off control of Relay 1 from the wall switch connected to Sw1 terminal. If disabled, you’ll only be able to control the connected device via Z-Wave.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Disable |
| 1 | Enable (default) |
The manufacturer defined default value is ```1``` (Enable (default)).
This parameter has the configuration ID ```config_12_1``` and is of type ```INTEGER```.
### Parameter 13: Enable/Disable Manual Control for Sw2
Enable/Disable Manual Control for Sw2
Enable or disable physical on/off control of Relay 2 from the wall switch connected to Sw2 terminal. If disabled, you’ll only be able to control the connected device via Z-Wave.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Disable |
| 1 | Enable (default) |
The manufacturer defined default value is ```1``` (Enable (default)).
This parameter has the configuration ID ```config_13_1``` and is of type ```INTEGER```.
### Parameter 14: Enable/Disable Manual Control for Sw3
Enable/Disable Manual Control for Sw3
Enable or disable physical on/off control of Relay 3 from the wall switch connected to Sw3 terminal. If disabled, you’ll only be able to control the connected device via Z-Wave.
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Disable |
| 1 | Enable (default) |
The manufacturer defined default value is ```1``` (Enable (default)).
This parameter has the configuration ID ```config_14_1``` and is of type ```INTEGER```.
### Parameter 15: Auto Timer-Off Timer Unit for Relay 1
Use this parameter to choose between seconds, minutes, or hours to be used as the auto timer-off unit for Relay 1
The following option values may be configured, in addition to values in the range 0 to 2 -:
| Value | Description |
|--------|-------------|
| 0 | Minutes (default) |
| 1 | Seconds |
| 2 | Hours |
The manufacturer defined default value is ```0``` (Minutes (default)).
This parameter has the configuration ID ```config_15_1``` and is of type ```INTEGER```.
### Parameter 16: Auto Timer-On Timer Unit for Relay 1
Use this parameter to choose between seconds, minutes, or hours to be used as the auto timer-on unit for Relay 1
The following option values may be configured, in addition to values in the range 0 to 2 -:
| Value | Description |
|--------|-------------|
| 0 | Minutes (default) |
| 1 | Seconds |
| 2 | Hours |
The manufacturer defined default value is ```0``` (Minutes (default)).
This parameter has the configuration ID ```config_16_1``` and is of type ```INTEGER```.
### Parameter 17: Auto Timer-Off Timer Unit for Relay 2
Use this parameter to choose between seconds, minutes, or hours to be used as the auto timer-off unit for Relay 2
The following option values may be configured, in addition to values in the range 0 to 2 -:
| Value | Description |
|--------|-------------|
| 0 | Minutes (default) |
| 1 | Seconds |
| 2 | Hours |
The manufacturer defined default value is ```0``` (Minutes (default)).
This parameter has the configuration ID ```config_17_1``` and is of type ```INTEGER```.
### Parameter 18: Auto Timer-On Unit for Relay 2
Use this parameter to choose between seconds, minutes, or hours to be used as the auto timer-on unit for Relay 2
The following option values may be configured -:
| Value | Description |
|--------|-------------|
| 0 | Minutes (default) |
| 1 | Seconds |
| 2 | Hours |
The manufacturer defined default value is ```0``` (Minutes (default)).
This parameter has the configuration ID ```config_18_1``` and is of type ```INTEGER```.
### Parameter 19: Auto Timer-Off Timer Unit for Relay 3
Use this parameter to choose between seconds, minutes, or hours to be used as the auto timer-off unit for Relay 3
The following option values may be configured, in addition to values in the range 0 to 2 -:
| Value | Description |
|--------|-------------|
| 0 | Minutes (default) |
| 1 | Seconds |
| 2 | Hours |
The manufacturer defined default value is ```0``` (Minutes (default)).
This parameter has the configuration ID ```config_19_1``` and is of type ```INTEGER```.
### Parameter 20: Auto Timer-On Timer Unit for Relay 3
Use this parameter to choose between seconds, minutes, or hours to be used as the auto timer-on unit for Relay 3
The following option values may be configured, in addition to values in the range 0 to 2 -:
| Value | Description |
|--------|-------------|
| 0 | Minutes (default) |
| 1 | Seconds |
| 2 | Hours |
The manufacturer defined default value is ```0``` (Minutes (default)).
This parameter has the configuration ID ```config_20_1``` and is of type ```INTEGER```.
### Parameter 21: Relay 1 - Default Relay State
Decide whether you'd like Relay 1 to be normally open (NO) or normally closed (NC)
The following option values may be configured, in addition to values in the range 0 to 2 -:
| Value | Description |
|--------|-------------|
| 0 | Normally open (relay reports off when it's open / switch is off and on |
| 1 | Normally closed (relay reports off when it's open / switch is on and o |
| 2 | Normally closed (relay reports off when it's closed / switch is off an |
The manufacturer defined default value is ```0``` (Normally open (relay reports off when it's open / switch is off and on).
This parameter has the configuration ID ```config_21_1``` and is of type ```INTEGER```.
### Parameter 22: Relay 2 - Default Relay State
Decide whether you'd like Relay 2 to be normally open (NO) or normally closed (NC)
The following option values may be configured, in addition to values in the range 0 to 2 -:
| Value | Description |
|--------|-------------|
| 0 | Normally open (relay reports off when it's open / switch is off and on |
| 1 | Normally closed (relay reports off when it's open / switch is on and o |
| 2 | Normally closed (relay reports off when it's closed / switch is off an |
The manufacturer defined default value is ```0``` (Normally open (relay reports off when it's open / switch is off and on).
This parameter has the configuration ID ```config_22_1``` and is of type ```INTEGER```.
### Parameter 23: Relay 3 - Default Relay State
Decide whether you'd like Relay 3 to be normally open (NO) or normally closed (NC)
The following option values may be configured, in addition to values in the range 0 to 2 -:
| Value | Description |
|--------|-------------|
| 0 | Normally open (relay reports off when it's open / switch is off and on |
| 1 | Normally closed (relay reports off when it's open / switch is on and o |
| 2 | Normally closed (relay reports off when it's closed / switch is off an |
The manufacturer defined default value is ```0``` (Normally open (relay reports off when it's open / switch is off and on).
This parameter has the configuration ID ```config_23_1``` and is of type ```INTEGER```.
### Parameter 24: DC Motor Mode
Sync Relay 1 and Relay 2 together to prevent them from being activated at the same time
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
| 0 | DC motor mode disabled (relays will always turn on whenever activated) |
| 1 | DC motor mode enabled (relay checks the status of the other relay afte |
The manufacturer defined default value is ```0``` (DC motor mode disabled (relays will always turn on whenever activated)).
This parameter has the configuration ID ```config_24_1``` 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 ZEN16 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 1 node.
### Group 2: Relay 1
Send BASIC_SET reports when operated manually
Association group 2 supports 5 nodes.
### Group 3: Relay 2
Send BASIC_SET reports when operated manually
Association group 3 supports 5 nodes.
### Group 4: Relay 3
Send BASIC_SET reports when operated manually
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_APPLICATION_STATUS_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_SWITCH_MULTILEVEL_V1| |
| COMMAND_CLASS_CHIMNEY_FAN_V1| |
| COMMAND_CLASS_SCENE_ACTIVATION_V1| |
| COMMAND_CLASS_SCENE_CONTROLLER_CONF_V1| |
| COMMAND_CLASS_SENSOR_BINARY_V1| |
| COMMAND_CLASS_METER_V1| |
| COMMAND_CLASS_TRANSPORT_SERVICE_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_MULTI_CHANNEL_V2| |
| COMMAND_CLASS_SUPERVISION_V1| |
| COMMAND_CLASS_CONFIGURATION_V1| |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| COMMAND_CLASS_BATTERY_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V1| |
| COMMAND_CLASS_SECURITY_2_V1| |
#### Endpoint 1
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V1| |
#### Endpoint 2
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V1| |
#### Endpoint 3
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1| |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V1| |
### Documentation Links
* [manual](https://opensmarthouse.org/zwavedatabase/1326/reference/zooz-s2-multirelay-zen16-ver1.02-manual_1.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](https://opensmarthouse.org/zwavedatabase/1326).

16
_addons_bindings/zwave/doc/zooz/zse11_0_0.md
View File

@ -145,7 +145,7 @@ Detailed information on each parameter can be found in the sections below.
Motion sensitivity
0 is disabled, 1 is low sensitivity, and 8 is high sensitivity.
The following option values may be configured, in addition to values in the range 0 to 8 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -171,7 +171,7 @@ This parameter has the configuration ID ```config_13_2``` and is of type ```INTE
Enable/disable Basic Set reports on motion detection
The following option values may be configured -:
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
@ -187,7 +187,7 @@ This parameter has the configuration ID ```config_14_1``` and is of type ```INTE
The following option values may be configured -:
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
@ -203,7 +203,7 @@ This parameter has the configuration ID ```config_15_1``` and is of type ```INTE
Enabled/disable Binary Sensor reports on motion detection
The following option values may be configured -:
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
@ -219,7 +219,7 @@ This parameter has the configuration ID ```config_16_1``` and is of type ```INTE
The following option values may be configured -:
The following option values may be configured, in addition to values in the range 0 to 2 -:
| Value | Description |
|--------|-------------|
@ -235,7 +235,7 @@ This parameter has the configuration ID ```config_18_1``` and is of type ```INTE
The following option values may be configured -:
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
@ -311,7 +311,7 @@ This parameter has the configuration ID ```config_183_2``` and is of type ```INT
Humidity reporting threshold
Set the reporting threshold for humidity. The sensor will report a new humidity value to the hub whenever humidity changes by the percentage number entered as value.
The following option values may be configured, in addition to values in the range 0 to 80 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -326,7 +326,7 @@ This parameter has the configuration ID ```config_184_1``` and is of type ```INT
Lux reporting threshold
Set the reporting threshold for lux. The sensor will report new lux to the hub whenever the brightness level changes by the number of lux entered as value.
The following option values may be configured, in addition to values in the range 0 to 30000 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|

6
_addons_bindings/zwave/doc/zooz/zse29_2_0.md
View File

@ -137,7 +137,7 @@ This parameter has the configuration ID ```config_1_1``` and is of type ```INTEG
Enable / Disable Motion Reports
Enable or disable motion reports completely. If motion sensor is disabled, the device will not report motion at all to your hub.
The following option values may be configured -:
The following option values may be configured, in addition to values in the range 0 to 1 -:
| Value | Description |
|--------|-------------|
@ -170,7 +170,7 @@ Set lux level trigger with 10 being the lowest reported value and 900 being the
1 - ignore lux readings and always report motion
10-900 - set custom trigger
The following option values may be configured, in addition to values in the range 10 to 900 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|
@ -190,7 +190,7 @@ Set motion re-trigger time for the delay before the sensor reports no motion to
0 - set manually by timer knob (default)
5-720 (seconds) - set custom re-trigger time
The following option values may be configured, in addition to values in the range 0 to 720 -:
The following option values may be configured -:
| Value | Description |
|--------|-------------|

199
_addons_bindings/zwave/doc/zwaveme/zmetio3s_0_0.md Normal file
View File

@ -0,0 +1,199 @@
---
layout: documentation
title: ZME_TIO_3S - ZWave
---
{% include base.html %}
# ZME\_TIO\_3S TION 3S Ventilator
This describes the Z-Wave device *ZME_TIO_3S*, manufactured by *Z-Wave.Me* with the thing type UID of ```zwaveme_zmetio3s_00_000```.
The device is in the category of *HVAC*, defining Air condition devices, Fans.
![ZME_TIO_3S product image](https://opensmarthouse.org/zwavedatabase/1312/image/)
The ZME_TIO_3S supports routing. This allows the device to communicate using other routing enabled devices as intermediate routers. This device is also able to participate in the routing of data between other devices in the mesh network.
## Overview
### Inclusion Information
Press the power button  5 sec until it blinks blue 
### Exclusion Information
Press the power button 5 sec until it blinks blue 
### General Usage Information
Ventilation system 
https://rus.z-wave.me/shop/termostats/provetrivatel-tion-3s-z-wave/#item-tabs
## Channels
The following table summarises the channels available for the ZME_TIO_3S -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|--------------|------------|--------------|----------|-----------|
| Power switch | switch_binary | switch_binary | Switch | Switch |
| Sensor (air temperature) | sensor_temperature | sensor_temperature | Temperature | Number:Temperature |
| Thermostat mode | thermostat_mode | thermostat_mode | Temperature | Number |
| Setpoint (heating) | thermostat_setpoint | thermostat_setpoint | Heating | Number:Temperature |
| Power switch 2 | switch_binary1 | switch_binary | Switch | Switch |
| AirType | switch_binary2 | switch_binary | Switch | Switch |
| FanSpeed | switch_dimmer3 | switch_dimmer | DimmableLight | Dimmer |
### Power switch
on/off device switch
Switch the power on and off.
The ```switch_binary``` channel is of type ```switch_binary``` and supports the ```Switch``` item and is in the ```Switch``` category.
### Sensor (air temperature)
Room temperature 
Indicates the current temperature.
The ```sensor_temperature``` channel is of type ```sensor_temperature``` and supports the ```Number:Temperature``` item and is in the ```Temperature``` category.
### Thermostat mode
Heater mode of external air
Sets the thermostat.
The ```thermostat_mode``` channel is of type ```thermostat_mode``` and supports the ```Number``` item and is in the ```Temperature``` category.
The following state translation is provided for this channel to the ```Number``` item type -:
| Value | Label |
|-------|-----------|
| 0 | Off |
| 1 | Heat |
| 2 | Cool |
| 3 | Auto |
| 4 | Aux Heat |
| 5 | Resume |
| 6 | Fan Only |
| 7 | Furnace |
| 8 | Dry Air |
| 9 | Moist Air |
| 10 | Auto Changeover |
| 11 | Heat Economy |
| 12 | Cool Economy |
| 13 | Away |
### Setpoint (heating)
Heating temperature 
Sets the thermostat setpoint.
The ```thermostat_setpoint``` channel is of type ```thermostat_setpoint``` and supports the ```Number:Temperature``` item and is in the ```Heating``` category.
### Power switch 2
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.
### AirType
OFF - internal air
ON - external air
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.
### FanSpeed
6 levels of speed:
16 - 1st level 
32 - 2nd level
48 - 3rd level
64 - 4th level
80 - 5th level
96 - 6th level
The brightness channel allows to control the brightness of a light.
It is also possible to switch the light on and off.
The ```switch_dimmer3``` channel is of type ```switch_dimmer``` and supports the ```Dimmer``` item and is in the ```DimmableLight``` category.
## Device Configuration
The device has no configuration parameters defined.
## 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 ZME_TIO_3S supports 1 association group.
### Group 1: general
main group
main group up to 8 nodes
Association group 1 supports 8 nodes.
## Technical Information
### Endpoints
#### Endpoint 0
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_NO_OPERATION_V1| |
| COMMAND_CLASS_BASIC_V1| |
| COMMAND_CLASS_SWITCH_BINARY_V1| |
| COMMAND_CLASS_SWITCH_MULTILEVEL_V1| |
| COMMAND_CLASS_SENSOR_MULTILEVEL_V7| |
| COMMAND_CLASS_THERMOSTAT_MODE_V1| |
| COMMAND_CLASS_THERMOSTAT_SETPOINT_V1| |
| 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_MANUFACTURER_SPECIFIC_V1| |
| COMMAND_CLASS_POWERLEVEL_V1| |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V1| |
| COMMAND_CLASS_ASSOCIATION_V2| |
| COMMAND_CLASS_VERSION_V2| |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3| |
#### Endpoint 1
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_SWITCH_BINARY_V1| |
#### Endpoint 2
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_SWITCH_BINARY_V1| |
#### Endpoint 3
| Command Class | Comment |
|---------------|---------|
| COMMAND_CLASS_SWITCH_MULTILEVEL_V1| |
### Documentation Links
* [user guide (Russian only)](https://opensmarthouse.org/zwavedatabase/1312/reference/ZMR_TION_3S.pdf)
* [Instruction (English)](https://opensmarthouse.org/zwavedatabase/1312/reference/sr-zv9001k4-rgbw-instruction-v1_1.pdf)
---
Did you spot an error in the above definition or want to improve the content?
You can [contribute to the database here](https://opensmarthouse.org/zwavedatabase/1312).

87
installation/openhabian.md
View File

@ -30,7 +30,7 @@ To that end, the project provides two things:
The following features are provided by the openHABian image out of the box:
- Hassle-free setup without a display or keyboard, connected via Ethernet or [WiFi](#wifi-based-setup-notes)
- the latest stable version of openHAB 2
- the latest stable version of openHAB
- Zulu Embedded OpenJDK Java 8, 11 or AdoptOpenJDK
- [openHABian Configuration Tool](#openhabian-configuration-tool) including updater functionality
- web based openHAB Log Viewer (based on [frontail](https://github.com/mthenw/frontail))
@ -81,7 +81,7 @@ openHABian is designed as a headless system, you will not need a display or a ke
- Enjoy!
- The device will be accessible by its IP or via the local DNS name `openhabiandevice` (or whatever you changed 'hostname' in `openhabian.conf` to)
- [Connect to the openHAB 2 dashboard](https://www.openhab.org/docs/configuration/packages.html): [http://openhabiandevice:8080](http://openhabiandevice:8080)
- Connect to the openHAB UI at [http://openhabiandevice:8080](http://openhabiandevice:8080)
- [Connect to the Samba network shares](https://www.openhab.org/docs/installation/linux.html#mounting-locally) with username `openhabian` and password `openhabian`
- Connect to the openHAB Log Viewer (frontail): [http://openhabiandevice:9001](http://openhabiandevice:9001)
- If you encounter any setup problem, [please continue here](#successful)
@ -99,7 +99,12 @@ You will see the following welcome screen:
<a id="manual-setup"></a>
### Other Linux Systems (add openHABian just like any other software)
openHABian is also supposed to run on generic Debian based systems on x86 and some ARM hardware platforms.
Going beyond what the RPi image provides, we support running openHABian on x86 hardware on top of any existing
Debian installation.
Note that although the core parts of openHABian were reported to work on there, Ubuntu is not supported and untested.
See the [README](https://github.com/openhab/openhabian#hardware-and-os-support) for details on supported hardware and OSs before you proceed.
***
Start with a fresh installation of your operating system, login and run
```shell
@ -115,7 +120,7 @@ apt-get update
apt-get install git
# download, link and create config file
git clone -b stable https://github.com/openhab/openhabian.git /opt/openhabian
git clone -b openHAB3 https://github.com/openhab/openhabian.git /opt/openhabian
ln -s /opt/openhabian/openhabian-setup.sh /usr/local/bin/openhabian-config
cp /opt/openhabian/openhabian.conf.dist /etc/openhabian.conf
```
@ -139,11 +144,10 @@ openhabian-config unattended
to get the automated openHABian installation going.
Please note that we cannot test HW/OS combos beyond RPis upfront so there is no support / no promise for this work as explained in the [README](https://github.com/openhab/openhabian/blob/master/README.md).
Drop us a note on Github.
Please note that we cannot test HW/OS combos beyond RPis upfront so there is no support / no promise for this work as explained in the [README](https://github.com/openhab/openhabian#hardware-and-os-support).
## openHABian Configuration Tool
The following instructions target a Raspberry Pi openHABian setup but should be applicable to all openHABian environments.
The following instructions are targeted at a Raspberry Pi but should be applicable to all openHABian environments.
Once connected to the command line console of your system, please execute the openHABian configuration tool by typing the following command.
(Hint: sudo executes a command with elevated rights and will hence ask for your password: `openhabian`).
@ -175,25 +179,25 @@ Regardless of if you want to copy some files or are on the search for a solution
Take a few minutes to study the above Tutorials and get to know the most basic commands and tools to be able to navigate on your Linux system, edit configurations, check the system state or look at log files.
It's not complicated and something that doesn't hurt on one's résumé.
### First Steps with openHAB
### First steps with openHAB
After your first setup of openHABian is successful and you are able to access the openHAB dashboard, you should dig into the possibilites.
Install [Bindings](https://www.openhab.org/addons/), discover your devices, and [configure your smart home](https://www.openhab.org/docs/configuration/).
You might want to start defining [Items](https://www.openhab.org/docs/configuration/items.html), [Sitemap](https://www.openhab.org/docs/configuration/sitemaps.html) and [HABPanel](https://www.openhab.org/docs/configuration/habpanel.html) dashboard for your home, but these are just some first hints.
Be sure to read up on the [Configuration](https://www.openhab.org/docs/configuration/) section of the documentation pages to learn more.
### Further Configuration Steps
### Further configuration steps
openHABian is supposed to provide a ready-to-use openHAB base system.
There are a few things, however, we need you to decide and act on right now at the beginning:
- **Delayed Rules Loading** openHAB startup times can be annoyingly long. There's an optimization available that *delays* loading the rules. It quickly renames rules forth and back after 2 minutes, *effectively speeding up* openHAB startup. This is setup by default, you can disable this via \[menu option: 44\].
- **Time Zone:** The time zone of your openHABian system will be determined based on your internet connection. In some cases you might have to adjust that setting.
- **Delayed Rules loading** openHAB startup times can be annoyingly long. There's an optimization available that *delays* loading the rules. It quickly renames rules forth and back after 2 minutes, *effectively speeding up* openHAB startup. This is setup by default, you can disable this via \[menu option: 44\].
- **Timezone:** The time zone of your openHABian system will be determined based on your internet connection. In some cases you might have to adjust that setting.
- **Language:** The `locale` setting of the openHABian base system is set to "en_US.UTF-8". While this setting will not do any harm, you might prefer e.g. console errors in German or Spanish. Change the locale settings accordingly. Be aware, that error solving might be easier when using the English error messages as search phrases.
- **Passwords:** Relying on default passwords is a security concern you should care about! The openHABian system is preconfigured with a few passwords you should change to ensure the security of your system. This is especially important if your system is accessible from outside your private subnet.
All of these settings **can easily be changed** via the openHABian Configuration Tool.
All of these settings can be changed via the openHABian configuration tool.
Here are the passwords in question with their respective default "username:password" values.
All password can be changed from openHABian menu.
They can be changed from openHABian menu.
### Passwords
- User password needed for SSH or sudo (e.g. "openhabian:openhabian")
@ -216,25 +220,26 @@ ZRAM is enabled by default for swap, logs and persistence data. You can toggle u
4. Use [Amanda Network Backup](http://www.amanda.org/) for full system backups, documentation [here](https://github.com/openhab/openhabian/blob/master/docs/openhabian-amanda.md). \[menu option 52\]
Standard openHABian install enables ZRAM by default (#1). Once you attach a *safe* external medium to your system (such as an SSD), you can disable ZRAM (#1) and move the system over using menu options 37 (#2).
Finally, we strongly suggest you install Amanda (#4) right after you finish your setup. Amanda is to take care to backup your openHAB config and whole server to be able to quickly restore it when in need.
Finally, we strongly suggest you install Amanda (#4) right after you finish your setup. Amanda is to take care to backup the whole system to be able to quickly restore it when in need.
This is not done by default because it requires a number of user inputs, but you should not skip it for your own safety !
Delayed rules load will also be enabled by default. This is renaming the rules files, then after 2 minutes it renames them back. You can toggle to use this feature in menu option 44.
`Delayed rules load` will be enabled by default in openHAB 2 but disabled in openHAB 3 (which has a new startlevel system).
This function will rename the rules files so they get ignored by the starting openHAB instance, then after 2 minutes they're renamed back. You can toggle to use this feature in menu option 44.
## Setup notes
### On openHAB3
openHABian will install latest stable **openHAB 2** by default. To ease upgrading, `openhabian-config` will migrate the openHABian environment and install openHAB3 for you.
There's big changes such as to install Java 11 (which is mandatory for openHAB3).
openHAB3 will use a separate file `/etc/default/openhab` and most directory names will change from `... /openhab2/ ...` to `... /openhab/ ...` (NOTE: not `openhab3`).
It's a number of places there'll be changes in, often subtle ones like the name of Samba export shares to change.
Note that this code is still in BETA so with some bad luck it might mess up your system. We kindly ask you to help and report any issues on Github, including simple ones like when a title hasn't been renamed.
NOTE: you need to be on the openHABian `master` branch for the following to work.
Menu option 42 will do the upgrade. Be aware that there is ONLY an openHAB upgrade path. You cannot downgrade from OH3 to OH2.
You can exchange the binary packages (which is what openHABian will do), but there is no help to change your configuration back to a OH2 compatible one.
So it is essential that you take a backup before you upgrade. You will have to restore your setup from that backup after a downgrade using menu option 51 or by manually using `openhab-cli restore <file>`.
Menu option 42 can also do the inverse and change the environment back to match openHAB 2.
Note it'll NOT downgrade Java however. openHAB 2 is known to run with Zulu Java 11, though.
Starting with its general release, openHABian will install **openHAB 3** by default.
There's some big changes also to openHABian such as to install Java 11 and to use changed file and directory names.
Most directory names `... /openhab2/ ...` will become `... /openhab/ ...` (NOTE: not `openhab3`) plus there's changes in a number of places, often subtle ones like the name of Samba export shares to change.
As openHABian users will be running openHAB 2.X by the time 3.0 gets released, `openhabian-config` offers to migrate the openHABian environment and install openHAB3 for you.
Menu option 42 will do the upgrade. Be aware that it isn't the universal answer to all your migration needs - there is ONLY an openHAB upgrade path. You cannot downgrade from OH3 to OH2.
::: warning No downgrades
Take an openHAB config backup BEFORE you upgrade from openHAB v2 to v3. You should also take a system level backup !
:::
Menu option 42 can also do the downgrade and change the environment back to match openHAB 2 **BUT** it'll ONLY exchange the binary packages. There is no migration to change your configuration back to a OH2 compatible one. So it is essential that you take a backup before you upgrade. You will have to restore your setup from that backup after a downgrade using menu option 51 or by manually using `openhab-cli restore <archive file>`.
Note option 42 will also not downgrade Java. openHAB 2 however is known to run with Zulu Java 11 as well.
### `openhabian.conf`
You can actually set a number of parameters _before_ you run an unattended installation. This applies to the RPi image on an SD card as well as to a manual installation.
@ -247,21 +252,21 @@ You can also try with a different set of parameters if your initial attempt fail
- Save, unmount/eject, remove and insert into the RPi and boot it
- Continue with the instructions for your hardware
Mind the comments of a configuration parameter. Browse the next documentation section for further explanations.
Mind the comments for each configuration parameter. Browse the next documentation section for more explanations.
#### Administration user
Raspi OS images include a Linux user (`pi`) that you can use for openHAB administration.
Raspberry Pi OS images include a Linux user (`pi`) that you can use for openHAB administration.
openHABian renames the user to what you specify in the `username` parameter and assigns the `userpw` password first, then it proceeds and makes various settings that are either useful (such as some aliases) or required to run openHAB.
You can also make use of this if you don't use the image but unattended installation on non-RPi hardware, openHABian will then _create_ that user for you if it does not yet exist.
#### admin key
Make the `adminkeyurl` point to an URL to contain a public SSH key. This will be included with your administration
user's `.ssh/authorized_keys` and the openHAB Karaf console so the admin user (yourself, usually) can login after installation.
user's `.ssh/authorized_keys` and the openHAB console so the admin user (yourself, usually) can login after installation.
#### WiFi based Setup Notes
#### WiFi based setup notes
If you own a RPi3, RPi3+, RPi4, a RPi0W or any other model with a compatible WiFi dongle you can set up and use openHABian via WiFi only.
For the WiFi based setup to work, you'll need to make your SSID and password known to the system before the first boot.
So in addition to the setup instructions given above, uncomment and complete the lines reading `wifi_ssid="My WiFi SSID"` and `wifi_psk="password123"` in `openhabian.conf`.
So in addition to the setup instructions given above, uncomment and complete the lines reading `wifi_ssid=""` and `wifi_psk=""` in `openhabian.conf`.
#### WiFi Hotspot
Whenever the WiFi interface wlan0 exists but does not have connectivity, openHABian will launch a **Hotspot**.
@ -269,7 +274,7 @@ When you use your mobile phone to scan for WiFi networks, you should be seeing a
Connecting will work without a password. Once connected, open your browser and point it at `http://raspberrypi.local` or `http://comitup-<n>`.
This may or may not work for your mobile browser as it requires Bonjour/ZeroConf abilities. If you cannot connect to this address, go to `http://10.42.0.1`.
On that page you can select the SSID of the network you want to connect your system to. Provide the password and press the button.
Note that as soon as you do, the wlan0 IP address changes so your mobile browser will not receive/priovide you any more feedback.
Note that as soon as you do, the wlan0 IP address changes so your mobile browser will not be able to provide you any feedback if that worked out.
Try to ping the new system's hostname (default is `openHABianDevice`) or check DHCP on your router if your openHABian system appeared there.
For more information on this feature see [comitup-cli](https://davesteele.github.io/comitup/).
You can use `sudo comitup-cli` inside openHABian to change networks and eventually remove network credentials.
@ -340,7 +345,7 @@ You'll find all of these in the [openHABian Configuration Tool](#openhabian-conf
- [Frontail](https://github.com/mthenw/frontail) - openHAB Log Viewer accessible from [http://openhab:9001](http://openhab:9001)
- [InfluxDB and Grafana](https://community.openhab.org/t/influxdb-grafana-persistence-and-graphing/13761/1) - persistence and graphing available from [http://openhab:3000](http://openhab:3000)
- [Eclipse Mosquitto](http://mosquitto.org) - Open Source MQTT v3.1/v3.1.1 Broker
- [Node-RED](https://nodered.org) - "Flow-based programming for the Internet of Things", with preinstalled [openHAB 2](https://flows.nodered.org/node/node-red-contrib-openhab2) and [BigTimer](https://flows.nodered.org/node/node-red-contrib-bigtimer) add-ons. Accessible from [http://openhab:1880](http://openhab:1880)
- [Node-RED](https://nodered.org) - "Flow-based programming for the Internet of Things". Access at [http://openhab:1880](http://openhab:1880).
- [Homegear](https://www.homegear.eu/index.php/Main_Page) - Homematic control unit emulation
- [KNXd](http://michlstechblog.info/blog/raspberry-pi-eibknx-ip-gateway-and-router-with-knxd) - KNX daemon running at `224.0.23.12:3671/UDP`
- [OWServer](http://owfs.org/index.php?page=owserver_protocol) - 1wire control system
@ -403,11 +408,13 @@ After the installation of openHABian was successful, you should be able to acces
If you are not able to access your system via the openHAB dashboard or SSH after more than one hour, chances are high that your hardware setup is the problem. Consult the [debug guide](openhabian-DEBUG.md) and move on from there.
<a id="switch-openhab-branch"></a>
#### Can I switch from openHAB 2 stable to the testing or unstable branch?
openHABian installs the latest stable build of openHAB 2.
If you want to switch over to the snapshot or milestone release, please do so via the openHABian Configuration Tool.
#### Can I switch openHAB 2 and 3 via openHABian branches ?
openHABian installs the latest stable build of openHAB.
The standard openHABian `stable` and `master` branches will install openHAB version 2 and the `openHAB3` branch will install the new openHAB version 3.
You can migrate between versions by selecting the corresponding 4X menu option. That should also result in an openHABian branch change.
If you want to choose from stable, snapshot or milestone releases, please do so via `openhabian-config` tool (also menu 4X).
Note this will **not** result in any openHABian branch change.
Switching from stable to newer development releases might introduce changes and incompatibilities, so please be sure to make a full openHAB backup first!
Check the Linux installation article for all needed details: [Linux: Changing Versions](https://www.openhab.org/docs/installation/linux.html#changing-versions)
<a id="headache"></a>
@ -415,11 +422,11 @@ Check the Linux installation article for all needed details: [Linux: Changing Ve
I've just installed openHABian and now I'm confused.
No fancy login screen, no windows, no mouse support. What did I get into?
You are not the first one to get confused about the **intended use case of openHABian** or most other solutions based on a Raspberry Pi.
You are not the first one to get confused about the **intended use case of openHABian**.
Maybe it helps to not think of the RPi as a PC as we know it.
An RPi is not (well, not *necessarily*) to be used with a keyboard and display.
Its intended use case is to sit in a corner and provide a service reliably 24/7.
You already own a **powerful PC or Mac** which you should benefit from.
Its intended use case is to sit in a corner and provide a service reliably 24 hours a day, 7 days a week.
You already own a **powerful PC or Mac** to work on.
It would be a shame to have a powerful computer at your fingertips and then have to **restrict yourself** to a very limited graphical frontend on another device, wouldn't you agree?
Moving on.