Aeotec Help Desk

This guide will go over installing the Home Energy Meter 8 Driver to Hubitat and utilizing it to get all valuable readings from your Home Energy Meter 8. 

2 Clamp Version

Endpoint 0 - Root device (Equal to Endpoint 5 for the sum of all clamp consumption)

• Does not automatically update, must send refresh command to update endpoint 0 value.

Endpoint 1 - Clamp 1 Consumption

Endpoint 2 - Clamp 1 Production

Endpoint 3 - Clamp 2 Consumption

Endpoint 4 - Clamp 2 Production

Endpoint 5 - (Algebraic Sum) Sum of Consumption for all Clamps (Clamp 1 + 2)

Endpoint 6 - (Algebraic Sum) Sum of Production for all Clamps (Clamp 1 + 2)

Endpoint 7 - Net power consumption of power and energy

• Watt Report = EP5 > EP6, then EP7=EP5-EP6
  
• kWh Report = deltaEP5 > deltaEP6, then EP7=EP7+(deltaEP5-deltaEP6), Else EP7=EP7 previous value
  

Endpoint 8 - Net power generation of power and energy

• Watt Report = EP5 < EP6, then EP8=EP6-EP5
  
• kWh Report = deltaEP5 < deltaEP6, then EP8=EP8+(deltaEP6-deltaEP5), Else EP8=EP8 previous value
  

Known Issues:

• No fingerprints included in driver, so initial pairing will not detect this device upon pairing the HEM 8, you will need to manually change the driver after pairing HEM 8.

Fixed Issues 

• V0.2.2 Release
  • Changed Parameter 101-106 to input decimal value rather than select - confirmed this resolves the wrong value sent.
  • Adjusted Association to only use Association Set/Get/Remove, removed Multichannel Association Set/Get/Remove commands.
• V0.2.3 Release
  • Added additional endpoint 0 refresh definition and command button to only update Endpoint 0 with button press for third party hub integration showing only endpoint 0

Pairing Home Energy Meter 8 to Hubitat

It doesn't matter if you pair the HEM 8 before or after you install the driver, but you may follow the steps below to pair your HEM 8 to Hubitat.

1. Open your Hubitat interface.

2. Click on Devices.

3. Click on Discover Devices.

4. Click on Z-Wave.

5. Click on Start Z-Wave Inclusion.

6. Now tap the Action Button on Home Energy Meter 8.
   

Installing the Hubitat Driver

In order to use the Home Energy Monitor 8 in Hubitat, you will need to install the driver into Hubitat and then change the driver type in Hubitat of your paired Home Energy Meter 8 device. 

1. Login to your Hubitat hub
2. Under Developer Tools, select "Drivers code"
3. Click "+ New driver"
4. Copy the code from the text file attached or at this link:
   https://aeotec.freshdesk.com/helpdesk/attachments/6214473616
   • Original HEM Gen5 driver developer - Taylor Vierrether
   • Modified for HEM 8
5. Paste the code into the new driver blank page.
6. Click on Save

Change the HEM 8 Driver

The HEM 8 won't automatically use the correct driver currently, but you can change the driver following the steps below.

1. Login to your Hubitat hub
2. Select "Devices"
3. Select your HEM 8
4. Scroll down to "Device Information", then find "Type*"
   
5. Open the drop-down for "Type*" and scroll all the way down and find "Aeotec Home Energy Monitor 8 (2 Clamp)" under user.
6. Click on "Save Device"
7. To get initial data, at the top, click on "Refresh"

Configure Parameter Settings

The default parameter settings will work to report all values, by default:

Parameter 101-103 (Consumption Reports)

• 101 = 50529024 (Default Setting)
  • Report kWh, W on Clamp 1, 2, and Total
    • Note - As long as TOTAL is set to report under Consumption for kWh or Watt, Endpoint 7 will update in sync.
  • Parameter 111 is set to report once every 3600 seconds / 1 hour
• 102 = 202116096 (Default Setting)
  • Report V, A on Clamp 1, 2, and Total
  • Parameter 112 is set to report once every 7200 seconds / 2 hour
• 103 = 4042321920 (Default Setting)
  • Report PF, kVah, kVar, kVarh on Clamp 1, 2, and Total
  • Parameter 113 is set to report once every 7200 seconds / 2 hour

Parameter 104-106 (Production Reports)

• 104 = 50529024 (Default Setting)
  
  • Report kWh, W on Clamp 1, 2, and Total
    • Note - As long as TOTAL is set to report under Production for kWh or Watt , Endpoint 8 will update in sync.
  • Parameter 114 is set to report once every 3600 seconds / 1 hour
• 105 = 202116096 (Default Setting)
  
  • Report V, A on Clamp 1, 2, and Total
  • Parameter 115 is set to report once every 7200 seconds / 2 hour 
• 106 = 4042321920 (Default Setting)
  
  • Report PF, kVah, kVar, kVarh on Clamp 1, 2, and Total
  • Parameter 116 is set to report once every 7200 seconds / 2 hour 

To calculate what parameter 101-106 you want to report, you can add the values of all the reports you want one of the groups to report. This would allow you to disable or remove reports that you don't care about, or reduce report speeds for some reports.

For example:

• kWh Total and W Total only to report on Parameter 101
• 256 + 512 = 768
• Parameter 101 [4 byte] = 768

Automate Endpoint 0 Reports with Rule Machine

Endpoint 0 does not update automatically, Home Energy Meter 8 has no settings for this so you won't be able to set the root to update on its own. With code version 0.2.3 or later, a new button command is available to update endpoint 0 / root which is useful for pushing this data to other third party hubs that can sync with Hubitat (such as Home Assistant). 

1. Go to Apps (in hubitat)

2. Click on Rule Machine and create a new rule (name it whatever, but we named it "HEM 8 Endpoint 0 Update")

3. Click on "Select Trigger Events"

• Under the dropdown, pick "Periodic schedule"
• Under the dropdown menu (select periodic frequency), select "Minutes"
• Enable "> Every n minutes"
• Set > Each selected minute = 4
• Click Done -> Done with this Trigger Event
• Then click Done with this Trigger Event again

4. Click on "Select Actions to run"

• At  the top under "Actions" click on + (next to <- Create New Action)
• Under the new action drop down menu, select "Set Variable, Mode or File, Run Custom Action"
• Select "Run Custom Action"
• Select capability of action device as "Energy Meter"
• Check-mark the Home Energy Meter 8, then click Update
• Select custom command as "endpoint0Refresh"
• Click on Done with action
• Click on Done with Actions again

5. Click on Done