For the Aeotec Home Energy Monitor Gen 5 (ZW095-A) only.
This thread has been created to combine/update the information about this device/driver. As well as provide detailed documentation on how to deploy it. This driver is maintained by @codahq, with support/documentation by yours truly. It is a fairly complex driver. Please read this carefully. If you have questions, or updated data, please post.
MUST READ - If you read nothing else, please read this section
On first use go to the Device details, and Preferences section. Here you must set Cost (can be anything, or the actual cost from your electric company), as well as your Reporting Group options. If you do not make the Cost/Reporting Group selections properly it will not report any readings. If you're switching from another driver, and your Reporting Group options look different - see Know Issues.
Quick reference sample
All capabilities can be reported in total, as well as for each clamp separately.
Capability - Reports As
KWH - Energy
Watts - Power
Current - Current
Voltage - Voltage
Reporting Groups are the sets of information you would like sent to the hub at a given interval.
It is recommended NOT to chose a similar state type for separate Reporting Groups (shown below)
Wrong selection example - Will not work properly, results in kVarh listed - see Known Issues
Instead if you want a state reported for separate clamps, select them all in the same Reporting Group. To combine all similar state options in one Reporting Group by holding the CTRL key for Windows (Command key for Mac), and selecting each one. Unfortunately, since Hubitat doesn't support multi-select preferences in drivers you will have to select your Reporting Groups EVERY time you save preferences.
To get started we recommend choosing....
Reporting Group 1 - Watts HEM, Watts Clamp 1, Watts Clamp 2
Reporting Group 2 - Current HEM, Current (Amperes) Clamp 1, Current (Amperes) Clamp 2
Reporting Group 3 - KWH HEM, KWH Clamp 1, KWH Clamp2
Correct selection example - Will show state for all the given selections, both Clamps 1 - 2, and total independently. (state HEM selection not displayed, but selected above)
Once Cost, and Reporting Group selections have been made, click Save Preferences to apply.
Cost in $ / kWh - The amount you are charge by your provider for electricity.
CRC-16 Encapsulation - prevents partial messages from being misinterpreted as wrong values
Selective Reporting - Applies to watts only. When enabled instead of sending watts at the interval specified it will perform two checks;
~ The first check is to see if the watts have changed by the amount you specified in the numeric change preferences. If the watts have changed by more than this amount since the last report the report will be sent. Otherwise, the HEM does not communicate watts, to the hub.
~ The second check is exactly like the first except that instead of checking a number it checks by a percent.
Example - Reporting Group 1 selections is HEM Watts, and HEM Voltage, with Selective Reporting disabled
Mocked up data that is reported:
6:00 PM - 500 watts, 124 volts
6:01 PM - 503 watts, 123 volts
6:02 PM - 502 watts, 123 volts
6:03 PM - 575 watts, 124 volts
6:04 PM - 579 watts, 125 volts
6:05 PM - 569 watts, 122 volts
Example - Reporting group 1 is setup with HEM watts, and HEM voltage, with Selective Reporting enabled. "Whole HEM Watts Change" is set to 50.
Mocked up data that is reported:
6:00 PM - 500 watts, 124 volts (500 saved internally as last watts report)
6:01 PM - 123 volts (503 watts report suppressed because 503 - 500 = 3 which is less than 50)
6:02 PM - 123 volts (502 watts report suppressed because 502 - 500 = 2 which is less than 50)
6:03 PM - 575 watts, 124 volts (575 saved internally as last watts report)
6:04 PM - 125 volts (579 watts report suppressed because 579 - 575 = 4 which is less than 50)
6:05 PM - 122 volts (569 watts report suppressed because 569 - 575 = -6 which is less than 50. they absolute value the difference)
Whole HEM Watts Change - The amount of numeric change +/- in Watts HEM needed to trigger a report when selective reporting is enabled
Clamp 1 Watts Change - The amount of numeric change +/- in Clamp 1 Watts needed to trigger a report when selective reporting is enabled
Clamp 2 Watts Change - The amount of numeric change +/- in Clamp 2 Watts needed to trigger a report when selective reporting is enabled
Whole HEM Watts Percentage Change - The percentage of change +/- needed in Watts HEM to trigger a report when selective reporting is enabled
Clamp 1 Watts Percentage Change - The percentage of change +/- needed in Clamp 1 to trigger a report when selective reporting is enabled
Clamp 2 Watts Percentage Change - The percentage of change +/- needed in Clamp 2 to trigger a report when selective reporting is enabled
Hubitat doesn't support multi-select preferences in devices. There is nothing we can do about this. We need the HE devs to fix this. They sort of work but the limitations are:
They always reset after the page reloads, and do not populate values
They start as single select until you save once
- If you're switching from another driver you may see the screen below. Chose one from each group then click "Save Preferences". After the first save you will have the option to select multiple states for each group.
Reporting Group Error - some combinations don't save correctly and kVarh (an unimplemented report) is defaulted to the report groups instead. It is not known, why or what combinations will result in this error. However we have found that if see "kVarh" in the Reporting Group list, that is most likely a bad combo. Please post bad combos, so we can create a list here.
- Reporting Group Error will occur when using the same state type in different Reporting Groups. If you want a state reported on separate clamps, select them all in the same Reporting Group. Do this by holding the CTRL key, and selecting each one.
Devices with firmware 1.35 do not adhere to Selective Reporting settings properly.