Skip to content

Latest commit

 

History

History
executable file
·
767 lines (478 loc) · 28.7 KB

zw111_0_0.md

File metadata and controls

executable file
·
767 lines (478 loc) · 28.7 KB
layout title
documentation
ZW111 - ZWave

{% include base.html %}

ZW111 Nano Dimmer

This describes the Z-Wave device ZW111, manufactured by AEON Labs with the thing type UID of aeon_zw111_00_000. This version of the device is limited to firmware versions below 2.2

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.

ZW111 product image

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

Aeotec Nano Dimmer is a Z-Wave Smart Dimmer specifically used to enable Z-Wave command and control (on/off/dim) of any wall switches. It can report immediate wattage consumption or kWh energy usage over a period of time. In the event of power failure, non-volatile memory retains all programmed information relating to the unit’s operating status.
It can connect to 2 external manual switches to control the load ON/OFF independently. Its surface has a pin socket, which can be used for connecting to the touch panel, so you can also use the touch panel to control the Nano Dimmer.
The Nano Dimmer is also a security Z-Wave plus device and supports Over The Air (OTA) feature for the products firmware upgrade.

Inclusion Information

Including Nano Dimmer as a non-secure device:

If you want your Nano Dimmer as a non-secure device in your Z-Wave network, press the Action Button once on Nano Dimmer when you pair it to your gateway. If inclusion is successful, the green LED will be on for 2 seconds, and then return to a solid indication. If inclusion is unsuccessful, the red LED will be on for 2 seconds and then return to a colourful gradient.

Including Nano Dimmer as a secure device:

In order to take full advantage of the Nano Dimmer, you will want your Nano Dimmer as a security device that uses encrypted messages to communicate in your Z-wave network. A security enabled controller/ gateway (or Z-Wave Plus controller) is required.

  1. Set your Z-Wave Plus controller into pairing mode.
  2. Press the Action Button 2 times within 1 second on the Nano Dimmer, the blue LED (secure indication) will blink to indicate the Nano Dimmer is entering into secure pairing mode.
  3. If the Nano Dimmer has been successfully added to your Z-Wave network, its RGB LED will be solid. If the pairing was unsuccessful, the red LED will be on for 2 seconds and then remain a colourful gradient, repeat the instructions above from step 1.

Exclusion Information

Your Nano Dimmer can be removed from your Z-Wave network at any time. You’ll need to use your Z-Wave network’s main controller. To set your Z-Wave controller/gateway into removal mode, please refer to the respective section within your controller instruction manual.

  1. Set your Z-Wave controller into removal mode.
  2. Press the Action Button on the Nano Dimmer or toggle the external manual switch 2 times in fast succession.
  3. If the Nano Dimmer has been successfully removed from your Z-Wave network, its RGB LED will remain colourful gradient. If the removal was unsuccessful, the RGB LED will still be solid (following the state of the output load), repeat the instructions above from step 1.

General Usage Information

Reset your Nano Dimmer.

If at some stage, your primary controller is missing or inoperable, you may wish to reset all of your Nano Dimmer’s settings to their factory defaults. To do this, press and hold the Action Button for 20 seconds and then release it. Your Nano Dimmer will now be reset to its original settings, and the green LED will be solid for 2 seconds and then remain the colourful gradient status as a confirmation

Channels

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

Channel Name Channel ID Channel Type Category Item Type
Switch [Deprecated] switch_binary switch_binary Switch Switch
Dimmer switch_dimmer switch_dimmer DimmableLight Dimmer
Scene Number scene_number scene_number Number
Electric meter (kWh) meter_kwh meter_kwh Energy Number
Electric meter (watts) meter_watts meter_watts Energy Number
Electric meter (volts) meter_voltage meter_voltage Energy Number
Electric meter (amps) meter_current meter_current Energy Number
Clear Accumulated Energy meter_reset meter_reset Energy Switch
Alarm (power) alarm_power alarm_power Energy Switch
Alarm (heat) alarm_heat alarm_heat Fire Switch
Clock Time Offset time_offset time_offset Time Number

Switch [Deprecated]

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.

Note: This channel is marked as deprecated so should not be used.

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.

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 (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.

Electric meter (volts)

Indicates the instantaneous voltage.

The meter_voltage channel is of type meter_voltage 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 (amps)

Indicates the instantaneous current consumption.

The meter_current channel is of type meter_current 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.

Clear Accumulated Energy

Reset the meter.

The meter_reset channel is of type meter_reset and supports the Switch item and is in the Energy category.

Alarm (power)

Indicates if a power alarm is triggered.

The alarm_power channel is of type alarm_power and supports the Switch item and is in the Energy category. This is a read only channel so will only be updated following state changes from the device.

The following state translation is provided for this channel to the Switch item type -:

Value Label
OFF OK
ON Alarm

Alarm (heat)

Indicates if a heat alarm is triggered.

The alarm_heat channel is of type alarm_heat and supports the Switch item and is in the Fire category. This is a read only channel so will only be updated following state changes from the device.

The following state translation is provided for this channel to the Switch item type -:

Value Label
OFF OK
ON Alarm

Clock Time Offset

Provides the current time difference for the devices time.

The time_offset channel is of type time_offset and supports the Number item and is in the Time category.

Device Configuration

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

Param Name Description
3 Current Overload Protection Current Overload Protection
4 Overheat protection Overheat protection
20 Configure the output status after re-power on it Configure the output status after re-power on it
80 Group 1 notification Set notification sent to associated nodes (group 1)
81 Group 3 notificaiton Set notification sent to associated nodes (group 3)
82 Group 4 notificaiton Set notification sent to associated nodes (group 4)
85 Set appointment 1 Set appointment 1
86 Set appointment 2 Set appointment 2
90 (En/dis)able 91 and 92 Enables/disables parameter 91 and 92
91 Set the threshold value of wattage Threshold change in wattage (in terms of wattage) to induce an automatic report
92 Set the threshold value of percent power Threshold change in wattage (in terms of percentage)
100 Reset 101-103 to default Reset parameters 101-103 to default values
101 Set group 1 reports To set which reports need to be sent in Report group 1
102 Set group 2 reports To set which reports need to be sent in Report group 2
103 Set Group 3 Reports To set which reports need to be sent in Report group 3
110 Reset 111-113 to default Reset parameters 111-113 to default values
111 Automatic report interval group 1 Set the interval of automatic report for Report group 1
112 Automatic report interval group 2 Set the interval of automatic report for Report group 2
113 Automatic report interval group 3 Set the interval of automatic report for Report group 3
120 Configure the external switch mode for S1 Configure the external switch mode for S1
121 Configure the external switch mode for S2 Configure the external switch mode for S2
122 Get the state of touch panel port Get the state of touch panel port
123 Destination for switch S1 Set the control destination for external switch S1
124 Set the control destination for external switch S2 Set the control destination for external switch S2
125 Set the default dimming rate The value range is 1 to 255 seconds
128 Get the current working mode Get the current working mode
129 Set the dimming principle Set the dimming principle
130 Type of load To get what type of load the Dimmer is connected to.
131 Set the minimum brightness Set the min brightness level that the load can reach to
132 Set the maximum brightness level Set the max brightness level that the load can reach to
249 Set the recognition way of load Set the recognition way of load
252 Lock/unlock configuration parameters Lock/unlock configuration parameters
255 Reset the Nano Dimmer Reset the Nano Dimmer
Switch All Mode Set the mode for the switch when receiving SWITCH ALL commands

Parameter 3: Current Overload Protection

Current Overload Protection

The following option values may be configured -:

Value Description
0 Disable
1 (Default) Enable

The manufacturer defined default value is 1 ((Default) Enable).

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

Parameter 4: Overheat protection

Overheat protection

The following option values may be configured -:

Value Description
0 (Default) Disable
1 Enable

The manufacturer defined default value is 0 ((Default) Disable).

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

Parameter 20: Configure the output status after re-power on it

Configure the output status after re-power on it

The following option values may be configured -:

Value Description
0 (Default) Last status
1 Always on
2 Always off

The manufacturer defined default value is 0 ((Default) Last status).

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

Parameter 80: Group 1 notification

Set notification sent to associated nodes (group 1) To set which notification would be sent to the associated devices (Group 1) when the state of Nano Dimmer’s load is changed. The following option values may be configured -:

Value Description
0 (Default) Send Nothing
1 Send Hail CC
2 Send Basic CC report
3 Send Multilevel Switch report
4 Send Hail CC when using the manual switch

The manufacturer defined default value is 0 ((Default) Send Nothing).

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

Parameter 81: Group 3 notificaiton

Set notification sent to associated nodes (group 3) set notification sent to associated nodes (group 3)

To set which notification would be sent to the associated nodes in association Group 3 when using the external switch 1 to switch the loads. The following option values may be configured -:

Value Description
0 Send Nothing
1 (Default) Send Basic Set CC

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

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

Parameter 82: Group 4 notificaiton

Set notification sent to associated nodes (group 4) To set which notification would be sent to the associated nodes in association Group 4 when using the external switch 2 to switch the loads. The following option values may be configured -:

Value Description
0 Send Nothing
1 (Default) Send Basic Set CC

The manufacturer defined default value is 1 ((Default) Send Basic Set CC).

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

Parameter 85: Set appointment 1

Set appointment 1 0 to 99     The brightness level
256 to 316     The minute value of ON time
65536 to 65560     The hour value of ON time
16777215 to 16777222     The day value (Mon to Sun) Values in the range 0 to 16843197 may be set.

The manufacturer defined default value is 0.

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

Parameter 86: Set appointment 2

Set appointment 2 0 to 99     The brightness level
256 to 316     The minute value of ON time
65536 to 65560     The hour value of ON time
16777215 to 16777222     The day value (Mon to Sun) Values in the range 0 to 16843197 may be set.

The manufacturer defined default value is 0.

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

Parameter 90: (En/dis)able 91 and 92

Enables/disables parameter 91 and 92

The following option values may be configured -:

Value Description
0 (Default) Disable
1 Enable

The manufacturer defined default value is 0 ((Default) Disable).

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

Parameter 91: Set the threshold value of wattage

Threshold change in wattage (in terms of wattage) to induce an automatic report

Values in the range 0 to 60000 may be set.

The manufacturer defined default value is 25.

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

Parameter 92: Set the threshold value of percent power

Threshold change in wattage (in terms of percentage) Threshold change in wattage (in terms of percentage) to induce an automatic report Values in the range 0 to 100 may be set.

The manufacturer defined default value is 5.

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

Parameter 100: Reset 101-103 to default

Reset parameters 101-103 to default values 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 0 -:

Value Description
0 Reset the parameter 101-103

The manufacturer defined default value is 0 (Reset the parameter 101-103).

This parameter has the configuration ID config_100_1_wo and is of type INTEGER. This is a write only parameter.

Parameter 101: Set group 1 reports

To set which reports need to be sent in Report group 1 1     Send Meter Report of voltage (V)
2     Send Meter Report of current (A)
4     Send Meter Report of wattage (W)
8     Send Meter Report of energy (kWh) Values in the range 0 to 0 may be set.

The manufacturer defined default value is 0.

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

Parameter 102: Set group 2 reports

To set which reports need to be sent in Report group 2 1     Send Meter Report of voltage (V)
2     Send Meter Report of current (A)
4     Send Meter Report of wattage (W)
8     Send Meter Report of energy (kWh) Values in the range 0 to 0 may be set.

The manufacturer defined default value is 0.

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

Parameter 103: Set Group 3 Reports

To set which reports need to be sent in Report group 3 1     Send Meter Report of voltage (V)
2     Send Meter Report of current (A)
4     Send Meter Report of wattage (W)
8     Send Meter Report of energy (kWh) Values in the range 0 to 15 may be set.

The manufacturer defined default value is 0.

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

Parameter 110: Reset 111-113 to default

Reset parameters 111-113 to default values 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 0 -:

Value Description
0 Reset the parameter 111-113

The manufacturer defined default value is 0 (Reset the parameter 111-113).

This parameter has the configuration ID config_110_1_wo and is of type INTEGER. This is a write only parameter.

Parameter 111: Automatic report interval group 1

Set the interval of automatic report for Report group 1

Values in the range 1 to 2147483647 may be set.

The manufacturer defined default value is 2147483647.

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

Parameter 112: Automatic report interval group 2

Set the interval of automatic report for Report group 2

Values in the range 1 to 2147483647 may be set.

The manufacturer defined default value is 2147483647.

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

Parameter 113: Automatic report interval group 3

Set the interval of automatic report for Report group 3

Values in the range 0 to 2147483647 may be set.

The manufacturer defined default value is 2147483647.

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

Parameter 120: Configure the external switch mode for S1

Configure the external switch mode for S1

The following option values may be configured -:

Value Description
0 (Default) Unknown mode
1 2-state switch mode
2 3 way switch mode
3 Momentary push button mode
4 Enter automatic identification mode

The manufacturer defined default value is 0 ((Default) Unknown mode).

This parameter has the configuration ID config_120_1_wo and is of type INTEGER. This is a write only parameter.

Parameter 121: Configure the external switch mode for S2

Configure the external switch mode for S2

The following option values may be configured -:

Value Description
0 (Default) Unknown mode
1 2-state switch mode
2 3 way switch mode
3 Momentary push button mode
4 Enter automatic identification mode

The manufacturer defined default value is 0 ((Default) Unknown mode).

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

Parameter 122: Get the state of touch panel port

Get the state of touch panel port

The following option values may be configured -:

Value Description
0 (Default) the touch panel is not connected.
5 the touch panel is connected

The manufacturer defined default value is 0 ((Default) the touch panel is not connected.).

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

Parameter 123: Destination for switch S1

Set the control destination for external switch S1

The following option values may be configured -:

Value Description
1 control the output loads of itself
2 control the other nodes
3 Control itself and other nodes

The manufacturer defined default value is 3 (Control itself and other nodes).

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

Parameter 124: Set the control destination for external switch S2

Set the control destination for external switch S2

The following option values may be configured -:

Value Description
1 control the output loads of itself
2 control the other nodes
3 Control itself and other nodes

The manufacturer defined default value is 3 (Control itself and other nodes).

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

Parameter 125: Set the default dimming rate

The value range is 1 to 255 seconds

Values in the range 1 to 255 may be set.

The manufacturer defined default value is 255.

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

Parameter 128: Get the current working mode

Get the current working mode

The following option values may be configured -:

Value Description
0 (Default) Unknown working mode
1 2-wire mode
2 3-wire mode

The manufacturer defined default value is 0 ((Default) Unknown working mode).

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

Parameter 129: Set the dimming principle

Set the dimming principle

The following option values may be configured -:

Value Description
0 Trailing edge mode
1 (Default) Leading edge mode

The manufacturer defined default value is 1 ((Default) Leading edge mode).

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

Parameter 130: Type of load

To get what type of load the Dimmer is connected to.

The following option values may be configured -:

Value Description
0 (Default) Unknown load
1 Resistive load
2 Capacitive load
3 Inductive load

The manufacturer defined default value is 0 ((Default) Unknown load).

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

Parameter 131: Set the minimum brightness

Set the min brightness level that the load can reach to

Values in the range 0 to 99 may be set.

The manufacturer defined default value is 99.

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

Parameter 132: Set the maximum brightness level

Set the max brightness level that the load can reach to

Values in the range 0 to 99 may be set.

The manufacturer defined default value is 99.

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

Parameter 249: Set the recognition way of load

Set the recognition way of load

The following option values may be configured -:

Value Description
0 Never recognize the load when power on
1 Only recognize once when first power on
2 (Default) Recognize the load once power on

The manufacturer defined default value is 2 ((Default) Recognize the load once power on).

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

Parameter 252: Lock/unlock configuration parameters

Lock/unlock configuration parameters

The following option values may be configured -:

Value Description
0 (Default) Unlock
1 Lock

The manufacturer defined default value is 0 ((Default) Unlock).

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

Parameter 255: Reset the Nano Dimmer

Reset the Nano Dimmer 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 -:

Value Description
0 (Default) factory default
1431655765 factory default and remove

The manufacturer defined default value is 0 ((Default) factory default).

This parameter has the configuration ID config_255_4 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 ZW111 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. Z-Wave Plus Lifeline Z-Wave Plus Lifeline. When the load state of Nano Dimmer (on/off/dim the load ) is changed, the Hail CC, Switch Multilevel Report and Basic Report (configured by parameter 80) can be sent to the associated nodes in this group.

Association group 1 supports 5 nodes.

Group 2: Forward

Forward the Basic Set, Switch Binary Set, Switch Multilevel Start Level Change, Switch Multilevel Stop Level Change, Switch Multilevel Set, Switch all to the associated nodes in Group 2 when the Nano Dimmer receives the Basic Set, Switch Binary Set, Switch Multilevel Start Level Change, Switch Multilevel Stop Level Change, Switch Multilevel Set, Switch all commands from main controller.

Association group 2 supports 5 nodes.

Group 3: Send Basic Set (Group 3) Sw 1

Send Basic Set (configured by parameter 0x51 ) to the associated nodes in Group 3 when the external switch S1 is operated

Association group 3 supports 5 nodes.

Group 4: Send Basic Set (Group 3) Sw 2

Send Basic Set (configured by parameter 0x52) to the associated nodes in Group 4 when the external switch S2 is operated

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_BINARY_V1
COMMAND_CLASS_SWITCH_MULTILEVEL_V3 Linked to BASIC
COMMAND_CLASS_SWITCH_ALL_V1
COMMAND_CLASS_SCENE_ACTIVATION_V1
COMMAND_CLASS_SCENE_ACTUATOR_CONF_V1
COMMAND_CLASS_METER_V3
COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1
COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1
COMMAND_CLASS_ZWAVEPLUS_INFO_V2
COMMAND_CLASS_CONFIGURATION_V1
COMMAND_CLASS_ALARM_V4
COMMAND_CLASS_MANUFACTURER_SPECIFIC_V2
COMMAND_CLASS_POWERLEVEL_V1
COMMAND_CLASS_FIRMWARE_UPDATE_MD_V3
COMMAND_CLASS_CLOCK_V1
COMMAND_CLASS_HAIL_V1
COMMAND_CLASS_ASSOCIATION_V2
COMMAND_CLASS_VERSION_V2

Documentation Links


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