16 KiB
| layout | title |
|---|---|
| documentation | HS-WX300 - ZWave |
{% include base.html %}
HS-WX300 Scene Capable Wall Dimmer Switch
This describes the Z-Wave device HS-WX300, manufactured by HomeSeer Technologies with the thing type UID of homeseer_hs-wx300_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.
The HS-WX300 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
HS-WX300 is a Z-Wave in-wall light switch that may be configured to operate as either a dimmer switch or an on/off switch. It may be installed with or without a neutral wire and it works with both wired and wireless companion switches in 3-way circuit configurations.
Inclusion Information
Follow this 2-step procedure to add (or remove) your new HomeSeer switch to (or from) your Z-Wave network:
Put your Z-Wave controller into inclusion (or exclusion) mode.
In rapid succession, tap the bottom paddle 2 times, then press & hold the bottom paddle for 3 seconds (tap-tap-press & hold). This will initiate the inclusion (or exclusion) process.
Exclusion Information
Same procedure as Inclusion. (Note: The switch will default to dimmer mode after Z-Wave exclusion.)
General Usage Information
Channels
The following table summarises the channels available for the HS-WX300 -:
| 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 24 configuration parameters available in the HS-WX300. Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|---|---|---|
| 3 | Bottom LED Operation | Sets bottom LED operation (in normal mode) |
| 4 | Orientation | Sets paddle load orientation |
| 5 | Dimming Threshold | Sets the lowest dimming threshold |
| 6 | Central Scene Control | Enables/Disables Central Scene and multiple tap functions |
| 11 | Remote Ramp Rate | Set dimmer ramp rate for remote control |
| 12 | Local Ramp Rate | Set dimmer ramp rate for local control |
| 13 | Status Mode | Set dimmer display mode |
| 14 | Load Status LED Color | Set the LED color when displaying load status |
| 21 | Status LED 1 Color | Status LED 1 Color (bottom) |
| 22 | Status LED 2 Color | Status LED 2 Color |
| 23 | Status LED 3 Color | Status LED 3 Color |
| 24 | Status LED 4 Color | Status LED 4 Color |
| 25 | Status LED 5 Color | Status LED 5 Color |
| 26 | Status LED 6 Color | Status LED 6 Color |
| 27 | Status LED 7 Color | Status LED 7 Color (top) |
| 30 | Blink Frequency | Set blink frequency when displaying custom status |
| 31 | LED 7 Blink Status | LED 7 Blink Status (top) |
| 31 | LED 6 Blink Status | LED 6 Blink Status |
| 31 | LED 5 Blink Status | LED 5 Blink Status |
| 31 | LED 4 Blink Status | LED 4 Blink Status |
| 31 | LED 3 Blink Status | LED 3 Blink Status |
| 31 | LED 2 Blink Status | LED 2 Blink Status |
| 31 | LED 1 Blink Status | LED 1 Blink Status (bottom) |
| 32 | Wire mode | Sets the Wire mode / no neutral mod of the switch |
Parameter 3: Bottom LED Operation
Sets bottom LED operation (in normal mode)
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Bottom LED ON if load is OFF |
| 1 | Bottom LED OFF if load is OFF |
The manufacturer defined default value is 1 (Bottom LED OFF if load is OFF).
This parameter has the configuration ID config_3_1 and is of type INTEGER.
Parameter 4: Orientation
Sets paddle load orientation
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Top of Paddle turns load ON |
| 1 | Bottom of Paddle turns load ON |
The manufacturer defined default value is 0 (Top of Paddle turns load ON).
This parameter has the configuration ID config_4_1 and is of type INTEGER.
Parameter 5: Dimming Threshold
Sets the lowest dimming threshold Possible values: 1-14
3-wire mode (1=16%, 14=25%)
2-wire mode (1=25%, 14=30%) Values in the range 1 to 14 may be set.
The manufacturer defined default value is 1.
This parameter has the configuration ID config_5_1 and is of type INTEGER.
Parameter 6: Central Scene Control
Enables/Disables Central Scene and multiple tap functions
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Central Scene Enabled, controls load with delay. Enables Multi-tap and |
| 1 | Central Scene Disabled, controls load instantly. Disables multi-tap, c |
The manufacturer defined default value is 0 (Central Scene Enabled, controls load with delay. Enables Multi-tap and).
This parameter has the configuration ID config_6_1 and is of type INTEGER.
Parameter 11: Remote Ramp Rate
Set dimmer ramp rate for remote control Possible values: 0-90
0=No delay (instant ON), 1=1 second Values in the range 0 to 90 may be set.
The manufacturer defined default value is 3.
This parameter has the configuration ID config_11_1 and is of type INTEGER.
Parameter 12: Local Ramp Rate
Set dimmer ramp rate for local control Possible values: 0-90
0=No delay (instant ON), 1=1 second Values in the range 0 to 90 may be set.
The manufacturer defined default value is 3.
This parameter has the configuration ID config_12_1 and is of type INTEGER.
Parameter 13: Status Mode
Set dimmer display mode
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Load Status |
| 1 | Custom Status |
The manufacturer defined default value is 0 (Load Status).
This parameter has the configuration ID config_13_1 and is of type INTEGER.
Parameter 14: Load Status LED Color
Set the LED color when displaying load status
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | White |
| 1 | Red |
| 2 | Green |
| 3 | Blue |
| 4 | Magenta |
| 5 | Yellow |
| 6 | Cyan |
The manufacturer defined default value is 0 (White).
This parameter has the configuration ID config_14_1 and is of type INTEGER.
Parameter 21: Status LED 1 Color
Status LED 1 Color (bottom)
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Off |
| 1 | Red |
| 2 | Green |
| 3 | Blue |
| 4 | Magenta |
| 5 | Yellow |
| 6 | Cyan |
| 7 | White |
The manufacturer defined default value is 0 (Off).
This parameter has the configuration ID config_21_1 and is of type INTEGER.
Parameter 22: Status LED 2 Color
Status LED 2 Color
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Off |
| 1 | Red |
| 2 | Green |
| 3 | Blue |
| 4 | Magenta |
| 5 | Yellow |
| 6 | Cyan |
| 7 | White |
The manufacturer defined default value is 0 (Off).
This parameter has the configuration ID config_22_1 and is of type INTEGER.
Parameter 23: Status LED 3 Color
Status LED 3 Color
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Off |
| 1 | Red |
| 2 | Green |
| 3 | Blue |
| 4 | Magenta |
| 5 | Yellow |
| 6 | Cyan |
| 7 | White |
The manufacturer defined default value is 0 (Off).
This parameter has the configuration ID config_23_1 and is of type INTEGER.
Parameter 24: Status LED 4 Color
Status LED 4 Color
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Off |
| 1 | Red |
| 2 | Green |
| 3 | Blue |
| 4 | Magenta |
| 5 | Yellow |
| 6 | Cyan |
| 7 | White |
The manufacturer defined default value is 0 (Off).
This parameter has the configuration ID config_24_0 and is of type INTEGER.
Parameter 25: Status LED 5 Color
Status LED 5 Color
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Off |
| 1 | Red |
| 2 | Green |
| 3 | Blue |
| 4 | Magenta |
| 5 | Yellow |
| 6 | Cyan |
| 7 | White |
The manufacturer defined default value is 0 (Off).
This parameter has the configuration ID config_25_1 and is of type INTEGER.
Parameter 26: Status LED 6 Color
Status LED 6 Color
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Off |
| 1 | Red |
| 2 | Green |
| 3 | Blue |
| 4 | Magenta |
| 5 | Yellow |
| 6 | Cyan |
| 7 | White |
The manufacturer defined default value is 0 (Off).
This parameter has the configuration ID config_26_1 and is of type INTEGER.
Parameter 27: Status LED 7 Color
Status LED 7 Color (top)
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Off |
| 1 | Red |
| 2 | Green |
| 3 | Blue |
| 4 | Magenta |
| 5 | Yellow |
| 6 | Cyan |
| 7 | White |
The manufacturer defined default value is 0 (Off).
This parameter has the configuration ID config_27_1 and is of type INTEGER.
Parameter 30: Blink Frequency
Set blink frequency when displaying custom status Possible values: 0, 1-255
0=No blink, 1=100ms ON then 100ms OFF Values in the range 0 to 255 may be set.
The manufacturer defined default value is 0.
This parameter has the configuration ID config_30_1 and is of type INTEGER.
Parameter 31: LED 7 Blink Status
LED 7 Blink Status (top)
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Solid |
| 1 | Blink |
The manufacturer defined default value is 0 (Solid).
This parameter has the configuration ID config_31_1_0000003F and is of type INTEGER.
Parameter 31: LED 6 Blink Status
LED 6 Blink Status
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Solid |
| 1 | Blink |
The manufacturer defined default value is 0 (Solid).
This parameter has the configuration ID config_31_1_0000005F and is of type INTEGER.
Parameter 31: LED 5 Blink Status
LED 5 Blink Status
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Solid |
| 1 | Blink |
The manufacturer defined default value is 0 (Solid).
This parameter has the configuration ID config_31_1_0000006F and is of type INTEGER.
Parameter 31: LED 4 Blink Status
LED 4 Blink Status
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Solid |
The manufacturer defined default value is 0 (Solid).
This parameter has the configuration ID config_31_1_00000077 and is of type INTEGER.
Parameter 31: LED 3 Blink Status
LED 3 Blink Status
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Solid |
| 1 | Blink |
The manufacturer defined default value is 0 (Solid).
This parameter has the configuration ID config_31_1_0000007B and is of type INTEGER.
Parameter 31: LED 2 Blink Status
LED 2 Blink Status
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Solid |
| 1 | Blink |
The manufacturer defined default value is 0 (Solid).
This parameter has the configuration ID config_31_1_0000007D and is of type INTEGER.
Parameter 31: LED 1 Blink Status
LED 1 Blink Status (bottom)
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Solid |
| 1 | Blink |
The manufacturer defined default value is 0 (Solid).
This parameter has the configuration ID config_31_1_0000007E and is of type INTEGER.
Parameter 32: Wire mode
Sets the Wire mode / no neutral mod of the switch
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | 3 wire mode (Neutral, Line, & Load) |
| 1 | 2 wire mode (Line & Load) |
The manufacturer defined default value is 0 (3 wire mode (Neutral, Line, & Load)).
This parameter has the configuration ID config_32_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 HS-WX300 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. Lifeline association only supports the "manual reset" event.
Association group 1 supports 5 nodes.
Group 2: Companion Sync
Any device added to group 2 will be controlled. This allows other WX300 devices to used as companion switches. LEDS will be kept in sync.
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 | |
| 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_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_INDICATOR_V3 | |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3 | |
| COMMAND_CLASS_SECURITY_2_V1 |
Documentation Links
Did you spot an error in the above definition or want to improve the content? You can contribute to the database here.