| layout | title |
|---|---|
documentation |
ZW095 - ZWave |
{% include base.html %}
This describes the Z-Wave device ZW095, manufactured by AEON Labs with the thing type UID of aeon_zw095_00_000.
The device is in the category of Sensor, defining Device used to measure something.
The ZW095 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.
Aeon Labs Home Energy Meter is energy meter for the entire home. It can wirelessly report instantaneous Power, KWH, Voltage and Amperage measurements to Z‐Wave gateway/controller. It can send Z‐Wave REPORTS (Meter v3 Command Class) at any time when it receives Z‐Wave Get Commands.
The HEM can be setup to send automatic reports to any associated nodes in association group 1 at an interval time
The HEM can independently report the measurements from the Clamps via the Multi Channel Command Class encapsulation.
It can be included and operated in any Z‐wave network with other Z‐wave certified devices from other manufacturers and/or other applications. All non‐battery operated nodes within the network will act as repeaters regardless of vendor to increase reliability of the network.
It also supports Security Command Class and has the AES‐128 bit security encryption built right in. While a Security enabled Controller is needed in order to fully use the security feature.
The electrical installation of your Home Energy Meter (HEM) is now complete. You must now wirelessly add it to your Z-Wave network.
- Put your primary Z-Wave controller, usually a gateway or hub, into inclusion mode. If you are not sure how to do this, please refer to your controller’s user manual.
- Press the Action Button on your HEM. If it has been successfully added to your network, its LED will remain illuminated. If the adding was unsuccessful, your HEM’s LED will continue to blink.
The installation of your Home Energy Meter is now complete. The next step is to set up your Home Energy Meter within the interface of your primary Z-Wave controller. This will allow you to visualize and utilize the energy consumption data that your meter collects. Your Home Energy Meter can report wattage energy usage or KWH energy usage to your primary controller. As each controller is different, please refer to your controller’s user manual for further information on monitoring and visualizing this data. The Z-Wave commands supporting energy monitoring are the Meter Command Classes.
Resetting your Home Energy Meter.
At some stage or your primary controller is missing or inoperable, you may also wish to reset all of your Home Energy Monitor’s settings to their factory defaults. To do this, press and hold the action button for 10 seconds and then release it. Your HEM will now be
Removing:
Removing your meter from a Z-Wave network. Your Home Energy Meter (HEM) can be removed from your Z-Wave network at any time. You'll need to use your Z-Wave network’s primary to do this
- Put your main controller into its device removal mode. If you are unsure how to do this, please refer to your controller’s user manual.
- Press the Action Button on your HEM. If it has been successfully removed from your network, its LED will blink. If the removal was unsuccessful, its LED will be solid and it will be then repeated again.
The following table summarises the channels available for the ZW095 -:
| Channel Name | Channel ID | Channel Type | Category | Item Type |
|---|---|---|---|---|
| Electric meter (amps) | meter_current | meter_current | Energy | Number |
| Electric meter (watts) | meter_watts | meter_watts | Energy | Number |
| Electric meter (kWh) | meter_kwh | meter_kwh | Energy | Number |
| Electric meter (volts) | meter_voltage | meter_voltage | Energy | Number |
| Reset Meter | meter_reset | meter_reset | Energy | Switch |
| Electric meter (amps) 1 | meter_current1 | meter_current | Energy | Number |
| Electric meter (watts) 1 | meter_watts1 | meter_watts | Energy | Number |
| Electric meter (kWh) 1 | meter_kwh1 | meter_kwh | Energy | Number |
| Electric meter (volts) 1 | meter_voltage1 | meter_voltage | Energy | Number |
| Electric meter (amps) 2 | meter_current2 | meter_current | Energy | Number |
| Electric meter (watts) 2 | meter_watts2 | meter_watts | Energy | Number |
| Electric meter (kWh) 2 | meter_kwh2 | meter_kwh | Energy | Number |
| Electric meter (volts) 2 | meter_voltage2 | meter_voltage | Energy | Number |
| Electric meter (amps) 3 | meter_current3 | meter_current | Energy | Number |
| Electric meter (watts) 3 | meter_watts3 | meter_watts | Energy | Number |
| Electric meter (kWh) 3 | meter_kwh3 | meter_kwh | Energy | Number |
| Electric meter (volts) 3 | meter_voltage3 | meter_voltage | Energy | Number |
Indicates the instantaneous current consumption.
The meter_current channel and 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.
Indicates the instantaneous power consumption.
The meter_watts channel and 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.
Indicates the energy consumption (kWh).
The meter_kwh channel and 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.
Indicates the instantaneous voltage.
The meter_voltage channel and 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.
Reset the meter.
The meter_reset channel and is of type meter_reset and supports the Switch item and is in the Energy category.
Indicates the instantaneous current consumption.
The meter_current1 channel and 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.
Indicates the instantaneous power consumption.
The meter_watts1 channel and 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.
Indicates the energy consumption (kWh).
The meter_kwh1 channel and 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.
Indicates the instantaneous voltage.
The meter_voltage1 channel and 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.
Indicates the instantaneous current consumption.
The meter_current2 channel and 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.
Indicates the instantaneous power consumption.
The meter_watts2 channel and 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.
Indicates the energy consumption (kWh).
The meter_kwh2 channel and 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.
Indicates the instantaneous voltage.
The meter_voltage2 channel and 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.
Indicates the instantaneous current consumption.
The meter_current3 channel and 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.
Indicates the instantaneous power consumption.
The meter_watts3 channel and 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.
Indicates the energy consumption (kWh).
The meter_kwh3 channel and 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.
Indicates the instantaneous voltage.
The meter_voltage3 channel and 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.
The following table provides a summary of the 19 configuration parameters available in the ZW095. Detailed information on each parameter can be found in the sections below.
| Param | Name | Description |
|---|---|---|
| 2 | Energy detection mode | This parameter is used to configure the energy detection mode. |
| 3 | Selective Reporting | Enable selective reporting. |
| 4 | Current Threshold - Whole HEM | Threshold change in wattage (Whole HEM). |
| 5 | Current Threshold - Clamp 1 | Threshold change in wattage (Clamp 1). |
| 6 | Current Threshold - Clamp 2 | Threshold change in wattage (Clamp 2). |
| 7 | Current Threshold - Clamp 3 | Threshold change in wattage (Clamp 3). |
| 8 | Percent Change - Whole HEM | Percentage change in wattage (Whole HEM). |
| 9 | Percent Change - Clamp 1 | Percentage change in wattage (Clamp 1). |
| 10 | Percent Change - Clamp 2 | Percentage change in wattage (Clamp 2). |
| 11 | Percent Change - Clamp 3 | Percentage change in wattage (Clamp3) |
| 13 | Enable /Disable CRC-16 Encapsulation | |
| 101 | Report Group 1 | Which reports need to send in Report group 1 |
| 102 | Report Group 2 | Which reports need to send in Report group 2 |
| 103 | Report Group 3 | Which reports need to send in Report group 3 |
| 111 | Interval to send out reports of group 1 | |
| 112 | Interval to send out reports of group 2 | |
| 113 | Interval to send out reports of group 3 | |
| 252 | Lock Configuration | Enable/Disable Lock Configuration |
| 255 | Reset to Default Factory Setting | Reset all settings to factory defaults |
This parameter is used to configure the energy detection mode.
This parameter is used to configure the energy detection mode when the parameter 101~103 have been configured:
0 = report Wattage and the absolute KWH value (default);
1 = report positive/negative Wattage and the algebraic sum KWH value;
2 = report positive/negative Wattage and the positive KWH value (consuming electricity);
3 = report positive/negative Wattage and the negative KWH value (generating electricity).
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Energy absolute value |
| 1 | Algebraic sum energy |
| 2 | Consuming electricity |
| 3 | Generating electricity |
The manufacturer defined default value is 0 (Energy absolute value).
This parameter has the configuration ID config_2_1 and is of type INTEGER.
Enable selective reporting. Enable selective reporting only when power change reaches
a certain threshold or percentage set in 4‐10 below. This is
used to reduce network traffic. (0 == disable, 1 == enable) Values in the range 0 to 16 may be set.
The manufacturer defined default value is 1.
This parameter has the configuration ID config_3_1 and is of type INTEGER.
Threshold change in wattage (Whole HEM).
Values in the range 0 to 60000 may be set.
The manufacturer defined default value is 50.
This parameter has the configuration ID config_4_2 and is of type INTEGER.
Threshold change in wattage (Clamp 1).
Values in the range 0 to 60000 may be set.
The manufacturer defined default value is 50.
This parameter has the configuration ID config_5_2 and is of type INTEGER.
Threshold change in wattage (Clamp 2).
Values in the range 0 to 60000 may be set.
The manufacturer defined default value is 50.
This parameter has the configuration ID config_6_2 and is of type INTEGER.
Threshold change in wattage (Clamp 3).
Values in the range 0 to 60000 may be set.
The manufacturer defined default value is 50.
This parameter has the configuration ID config_7_2 and is of type INTEGER.
Percentage change in wattage (Whole HEM).
Values in the range 0 to 100 may be set.
The manufacturer defined default value is 10.
This parameter has the configuration ID config_8_1 and is of type INTEGER.
Percentage change in wattage (Clamp 1).
Values in the range 0 to 100 may be set.
The manufacturer defined default value is 10.
This parameter has the configuration ID config_9_1 and is of type INTEGER.
Percentage change in wattage (Clamp 2).
Values in the range 0 to 100 may be set.
The manufacturer defined default value is 10.
This parameter has the configuration ID config_10_1 and is of type INTEGER.
Percentage change in wattage (Clamp3)
Values in the range 0 to 100 may be set.
The manufacturer defined default value is 10.
This parameter has the configuration ID config_11_1 and is of type INTEGER.
The following option values may be configured -:
| Value | Description |
|---|---|
| 0 | Disabled |
| 1 | Enabled |
The manufacturer defined default value is 0 (Disabled).
This parameter has the configuration ID config_13_1 and is of type INTEGER.
Which reports need to send in Report group 1 This page provides examples for setting the type of reports you want from the clamps and total readings using Parameter 101-103 for Home Energy Meter Gen5 and form part of the larger Home Energy Meter Gen5 user guide.
To set specific reports for your HEM Gen5, refer to the decimal table below if you do not know how to read a binary table. All you will need to do is add the decimal values together of all the settings you want, and then utilize the sum as the parameter setting value.
You may download an easy excel sheet by clicking here, or clicking on the attachment below.
ie. Parameter 101 [4 byte dec]: 6927 [This reports kwh and watt for total HEM, clamp 1, and clamp 2 + Voltage and Amperage for Total HEM readings]
ie2. Parameter 101 [4 btye dec]: 3 (from 1 + 2) (reports kWh and Watt on Total Readings)
Byte # Decimal Value Output Clamp # HEM Restriction
byte 4 1 kWh Total Readings
byte 4 2 Watt Total Readings
byte 4 4 Voltage Total Readings
byte 4 8 Amperage Total Readings
byte 4 16 kVarh Total Readings Gen5 only
byte 4 32 kVar Total Readings Gen5 only
byte 4 64 Reserved
byte 4 128 Reserved
byte 3 256 Watt Clamp 1
byte 3 512 Watt Clamp 2
byte 3 1024 Watt Clamp 3
byte 3 2048 kWh Clamp 1
byte 3 4096 kWh Clamp 2
byte 3 8192 kWh Clamp 3
byte 3 16384 Reserved
byte 3 32768 Reserved
byte 2 65536 Voltage Clamp 1
byte 2 131072 Voltage Clamp 2
byte 2 262144 Voltage Clamp 3
byte 2 524288 Amperage Clamp 1
byte 2 1048576 Amperage Clamp 2
byte 2 2097152 Amperage Clamp 3
byte 2 4194304 Reserved
byte 2 8388608 Reserved
byte 1 16777216 kVah Clamp 1 Gen5 only
byte 1 33554432 kVah Clamp 2 Gen5 only
byte 1 67108864 kVah Clamp 3 Gen5 only
byte 1 134217728 kVar Clamp 1 Gen5 only
byte 1 268435456 kVar Clamp 2 Gen5 only
byte 1 536870912 kVar Clamp 3 Gen5 only
byte 1 1073741824 Reserved
byte 1 2147483648 Reserved
The table above shows a decimal representation of all flags that can be set on parameter 101-103 to report specific data.
Example use of the Report Table.
For example, if you want to report only the total KWH consumption, and the Wattage for clamp 3, you would add 1 + 1024 and set the sum (1025) to parameter 101, 102, or 103.
As another example, if you want to report Wattage and KWH power consumption for all clamps, you would add 256 + 512 + 1024 + 2048 + 4096 + 8192, then set the sum (16128) to parameter 101, 102, or 103.
And if you want to report everything, you would add the whole table together and set it to 101, and set 102 and 103 to 0 values.
Setting an automatic report interval.
Parameter 111-113 [4 byte dec] can be configured through your gateway in case the default settings of your HEM is not what you desire.
Parameter 111 will set the interval for Group 1 (parameter 101), parameter 112 will set the interval for Group 2 (parameter 102), and parameter 113 will set the interval for Group 3 (parameter 103).
As an example, you have set parameter 101 to report the total KWH consumption and the wattage for clamp 3, and you want to report it every 500 seconds. Set Parameter 111 [4 byte dec] to 500.
Utilizing different groups.
Your Home Energy Meter has 3 different groups that you may setup, from the settings and examples above, you may configure each group to report different clamps and total reports to report at different interval. Group 1 uses Parameter 101 and 111, group 2 uses parameter 102 and 112, and group 3 uses parameter 103 and 113. Values in the range 0 to 2147483647 may be set.
The manufacturer defined default value is 2.
This parameter has the configuration ID config_101_4 and is of type INTEGER.
Which reports need to send in Report group 2 See Report Group 1 Values in the range 0 to 2147483647 may be set.
The manufacturer defined default value is 1.
This parameter has the configuration ID config_102_4 and is of type INTEGER.
Which reports need to send in Report group 3 See Report Group 1 Values in the range 0 to 2147483647 may be set.
The manufacturer defined default value is 0.
This parameter has the configuration ID config_103_4 and is of type INTEGER.
Values in the range 1 to 2147483647 may be set.
The manufacturer defined default value is 60.
This parameter has the configuration ID config_111_4 and is of type INTEGER.
Values in the range 1 to 2147483647 may be set.
The manufacturer defined default value is 120.
This parameter has the configuration ID config_112_4 and is of type INTEGER.
Values in the range 1 to 2147483647 may be set.
The manufacturer defined default value is 120.
This parameter has the configuration ID config_113_4 and is of type INTEGER.
Enable/Disable Lock Configuration Enable/Disable Lock ConfigurationThis 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 | All configuration parameters are configurable. |
| 1 | All conf parame are not configurable (Locked). |
The manufacturer defined default value is 0 (All configuration parameters are configurable.).
This parameter has the configuration ID config_252_1 and is of type INTEGER.
Reset all settings to factory defaults Will reset the configuration to factory defaults. If you upgrade firmware and are getting crazy readings back, reset the unit and reconfigure it.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 | Do nothing |
| 1 | Reset to Factory Defaults |
| 1431655765 | Reset product to def factory setting and exclude |
The manufacturer defined default value is 0 (Do nothing).
This parameter has the configuration ID config_255_4_wo and is of type INTEGER.
This is a write only parameter.
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 ZW095 supports 3 association groups.
Association group 1 supports 5 nodes.
Association group 2 supports 5 nodes.
Association group 3 supports 5 nodes.
| Command Class | Comment |
|---|---|
| COMMAND_CLASS_BASIC_V1 | |
| COMMAND_CLASS_METER_V4 | |
| COMMAND_CLASS_CRC_16_ENCAP_V1 | |
| COMMAND_CLASS_ASSOCIATION_GRP_INFO_V1 | |
| COMMAND_CLASS_DEVICE_RESET_LOCALLY_V1 | |
| COMMAND_CLASS_ZWAVEPLUS_INFO_V2 | |
| COMMAND_CLASS_MULTI_CHANNEL_V4 | |
| COMMAND_CLASS_CONFIGURATION_V1 | |
| COMMAND_CLASS_MANUFACTURER_SPECIFIC_V2 | |
| COMMAND_CLASS_POWERLEVEL_V1 | |
| COMMAND_CLASS_FIRMWARE_UPDATE_MD_V2 | |
| COMMAND_CLASS_ASSOCIATION_V2 | |
| COMMAND_CLASS_VERSION_V2 | |
| COMMAND_CLASS_MULTI_CHANNEL_ASSOCIATION_V3 | |
| COMMAND_CLASS_SECURITY_V1 | |
| COMMAND_CLASS_MARK_V1 |
| Command Class | Comment |
|---|---|
| COMMAND_CLASS_BASIC_V1 | |
| COMMAND_CLASS_METER_V4 |
| Command Class | Comment |
|---|---|
| COMMAND_CLASS_BASIC_V1 | |
| COMMAND_CLASS_METER_V4 |
| Command Class | Comment |
|---|---|
| COMMAND_CLASS_BASIC_V1 | |
| COMMAND_CLASS_METER_V4 |
- User Manual
- Engineering Manual
- Instructions manual for Aeon Labs Home Energy Meter Gen5.pdf
- Engineering Specifications and Advanced Functions for Developers
Did you spot an error in the above definition or want to improve the content? You can contribute to the database here.