| layout | title |
|---|---|
documentation |
SCN04 - ZWave |
{% include base.html %}
This describes the Z-Wave device SCN04, manufactured by Hank with the thing type UID of hank_scn04_00_000.
The device is in the category of Remote Control, defining Any portable or hand-held device that controls the status of something, e.g. remote control, keyfob etc..
The SCN04 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 SCN04 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.
Hank Z-Wave Scene Controller with 4 buttons. Supports security functions. The Scene controller offers three button action types: short press, held down and release.
- If a button is pressed quickly (for less than a second), the scene controller sends a central scene notification command to association group 1. This message contains a scene number from 1-4 depending on which button is pressed. It also sends a basic set command to the items in the association group for the button (even groups numbered 2 to 8) and a multilevel set command to the nodes in the association group for the button with an uneven number (3 for button 1, 5 for button 2 etc.).
- If a button is pressed and held down for more than a second, the scene controller sends a central scene notification command to association group 1 as above. It also sends a multilevel start level change (i.e. dim up) command to the nodes in the association group for the button.
- If a button is released after it has been held down, the scene controller sends a similar central scene notification command as well as a multilevel stop command the buttons association group.
Included as non-secure device:
- Insert the LIR2450 battery.
- Set the Z-Wave network main controller into learning mode( see Z-Wave network controller operating manual).
- Triple click a button.
- If the inclusion is successful, the LED will blink in blue less than 5 seconds and then keep on for 15 seconds.Included as a
secure device:
- Insert the LIR2450 battery.
- Set the Z-Wave network main controller into learning mode( see Z-Wave network controller operating manual).
- Pressing and holding a button for 3 seconds.
- If the inclusion is successful, the LED will blink in green less than for 5 seconds and then keep on for 15 seconds.
- Insert the LIR2450 battery.
- Set the Z-Wave network main controller into remove mode (see Z-Wave controller operating manual).
- Triple click the a button, if the exclusion is successful, LED will blink in orange for less than 5 seconds and then keep on for 3 seconds.
The SCN04 does not permanently listen for messages sent from the controller - it will periodically wake up automatically to check if the controller has messages to send, but will sleep most of the time to conserve battery life. The wakeup period can be configured in the user interface - it is advisable not to make this too short as it will impact battery life - a reasonable compromise is 1 hour.
The wakeup period does not impact the devices ability to report events or sensor data. The device can be manually woken with a button press on the device as described below - note that triggering a device to send an event is not the same as a wakeup notification, and this will not allow the controller to communicate with the device.
Press and hold any button for three seconds. LED will turn Blue->turquoise->green.
The following table summarises the channels available for the SCN04 -:
| 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 |
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 |
Represents the battery level as a percentage (0-100%). Bindings for things supporting battery level in a different format (e.g. 4 levels) should convert to a percentage to provide a consistent battery level reading.
The system.battery-level channel is of type system.battery-level and supports the Number item and is in the Battery category.
This channel provides the battery level as a percentage and also reflects the low battery warning state. If the battery state is in low battery warning state, this will read 0%.
The following table provides a summary of the 1 configuration parameters available in the SCN04. Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|---|---|---|
| 254 | Enable configuration | Lock/unlock all configuration parameters. |
| 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 |
Lock/unlock all configuration parameters. Lock/unlock configuration of unit.
0 = Unlock (default)
1 = Lock
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Unlock |
| 1 | Lock |
The manufacturer defined default value is 0 (Unlock).
This parameter has the configuration ID config_254_1 and is of type INTEGER.
The wakeup interval sets the period at which the device will listen for messages from the controller. This is required for battery devices that sleep most of the time in order to conserve battery life. The device will wake up at this interval and send a message to the controller to tell it that it can accept messages - after a few seconds, it will go back to sleep if there is no further communications.
This setting is defined in seconds. It is advisable not to set this interval too short or it could impact battery life. A period of 1 hour (3600 seconds) is suitable in most instances.
Note that this setting does not affect the devices ability to send sensor data, or notification events.
This parameter has the configuration ID wakeup_interval and is of type INTEGER.
When sleeping devices wake up, they send a notification to a listening device. Normally, this device is the network controller, and normally the controller will set this automatically to its own address. In the event that the network contains multiple controllers, it may be necessary to configure this to a node that is not the main controller. This is an advanced setting and should not be changed without a full understanding of the impact.
This parameter has the configuration ID wakeup_node and is of type INTEGER.
Association groups allow the device to send unsolicited reports to the controller, or other devices in the network. Using association groups can allow you to eliminate polling, providing instant feedback of a device state change without unnecessary network traffic.
The SCN04 supports 9 association groups.
Scene commands and battery reports Scene Controller will send the central scene notification command and battery report command to the associated nodes if any button is triggered.
Button 1-4 sends scene commands 1-4. I.e. button 1 sends scene 1, button 2 scene 2 etc. More info about all association group commands can be seen from the table below.
<td>
<strong>Group ID</strong>
</td>
<td>
<strong>Action & Notification</strong>
</td>
<td>
1
</td>
<td>
Press: Central scene notification ( Key Attributes=0 )<br />Hold: Central scene notification ( Key Attributes=2 )<br />Release: Central scene notification ( Key attributes=1 )
</td>
<td>
2
</td>
<td>
Press: Basic Set<br />Hold: Reserve<br />Release: Reserve
</td>
<td>
Press: Switch multilevel set<br />Hold: Multilevel start level change<br />Release: Multilevel stop level change
</td>
<td>
4
</td>
<td>
Press: Basic Set<br />Hold: Reserve<br />Release: Reserve
</td>
<td>
Press: Switch multilevel set<br />Hold: Multilevel start level change<br />Release: Multilevel stop level change
</td>
<td>
6
</td>
<td>
Press: Basic Set<br />Hold: Reserve<br />Release: Reserve
</td>
<td>
Press: Switch multilevel set<br />Hold: Multilevel start level change<br />Release: Multilevel stop level change
</td>
<td>
8
</td>
<td>
Press: Basic Set<br />Hold: Reserve<br />Release: Reserve
</td>
<td>
Press: Switch multilevel set<br />Hold: Multilevel start level change<br />Release: Multilevel stop level change
</td>
| Button ID |
| Any button |
| Button 1 |
| 3 |
| Button 2 |
| 5 |
| Button 3 |
| 7 |
| Button 4 |
| 9 |
Association group 1 supports 5 nodes.
Send basic commands for button 1 Scene Controller will send Basic Set command to the associated nodes if button 1 is pressed.
Association group 2 supports 5 nodes.
Send multilevel commands for button 1 Scene Controller will send switch multilevel set, the multilevel start level change and multilevel stop level change command to the associated nodes if button 1 is pressed, hold and released, respectively.
Association group 3 supports 5 nodes.
Send basic commands for button 2 Scene Controller will send Basic Set command to the associated nodes if button 2 is pressed.
Association group 4 supports 5 nodes.
Send multilevel commands for button 2 Scene Controller will send switch multilevel set, the multilevel start level change and multilevel stop level change command to the associated nodes if button 2 is pressed, hold and released, respectively.
Association group 5 supports 5 nodes.
Send basic commands for button 3 Scene Controller will send Basic Set command to the associated nodes if button 3 is pressed.
Association group 6 supports 5 nodes.
Send multilevel commands for button 3 Scene Controller will send switch multilevel set, the multilevel start level change and multilevel stop level change command to the associated nodes if button 3 is pressed, hold and released, respectively.
Association group 7 supports 5 nodes.
Send basic commands for button 4 Scene Controller will send Basic Set command to the associated nodes if button 4 is pressed.
Association group 8 supports 5 nodes.
Send multilevel commands for button 4 Scene Controller will send switch multilevel set, the multilevel start level change and multilevel stop level change command to the associated nodes if button 4 is pressed, hold and released, respectively.
Association group 9 supports 5 nodes.
| 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_CENTRAL_SCENE_V2 | |
| 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_BATTERY_V1 | |
| COMMAND_CLASS_WAKE_UP_V2 | |
| COMMAND_CLASS_ASSOCIATION_V2 | |
| COMMAND_CLASS_VERSION_V2 |
Did you spot an error in the above definition or want to improve the content? You can contribute to the database here.