Myenergi for Home Assistant

Myenergi custom component for Home Assistant.
This component will make all supported myenergi devices connected to your myenergi hub accessible in Home Assistant.
The energy sensors are fully compatible with the energy dashboard in Home Assistant.

It will create HA devices depending on what you have installed:

• Hub

  • Grid power sensor (W)
  • Grid voltage sensor (V)
  • Grid frequency sensor (Hz)
  • Generation power sensor (W)
  • Charging/heating power sensor (W)
  • Home power sensor (W); consumed power that is not charging, heating, generation and export
  • Energy generated today sensor (kWh)
  • Energy exported today sensor (kWh)
  • Energy imported today sensor (kWh)
  • Green energy today sensor (kWh); this is the amount of generated energy that was used for charging or heating instead of being exported

• Zappi

  • Charge mode selector (Stopped, Fast, Eco and Eco+)
  • Phase setting (Automatic, 1 phase, 3 phase); Used in Eco+ charge mode
  • Charge added this session sensor (kWh)
  • Energy consumed today sensor (kWh)
  • Energy diverted today sensor (kWh)
  • Power sensors for internal and external CT clamps (W)
  • Plug status sensor (EV Connected, Waiting for EV, Charging, EV Disconnected)
  • Charger status sensor (Paused, Charging, Boosting, Completed)
  • Minimum green level number input (%); how much power must be sourced from green sources (local generation) to do diversion charging
  • Service to start boost (provide boost amount in kWh as parameter)
  • Service to start smart boost (provide boost amount in kWh and desired finished time as parameters)
  • Service to stop boost
  • Service to unlock the Zappi
  • Sensor for PIN Lock Status (This is not very useful in the real world)
  • Sensor for Charge when Locked Status (This is the sensor that relates to the "unlock" service call and is the one you will want to use)
  • Sensor for lock when plugged in status
  • Sensor for lock when unplugged status

• Eddi

  • Operating mode selector that let you switch between Stopped (no heating will take place) and Normal modes
  • Power sensors for internal and external CT clamps (W)
  • Temperature sensors if fitted
  • Service to start boost (provide boost amount in minutes as parameter)
  • Heater priority; whether the first or second heater should be used first

• Harvi

  • Power sensors for internal and external CT clamps (W)

• Libbi

  • With API Key only
    • Battery discharge today (kWh)
    • Battery size (kW)
    • Frequency (Hz)
    • Grid CT2
    • Grid export today (kWh)
    • Grid import today (kWh)
    • Internal Load CT1
    • Inverter size
    • Operating Mode
    • power ct dcpv (W)
    • power ct internal load (W)
    • SoC (State of Charge) (%)
    • Solar generation today (kWh)
    • Status
    • Voltage (V)
  • With App Credentials (assumed)
    • Battery charge today (kWh)
    • Charge from grid (kWh)
    • Charge target (kWh)

Common sensor entities may also include:

• Serial number
• Firmware version
• Device priority; used for deciding which gets power first

This Home Assistant integration talks to the myenergi API using the pymyenergi python library.

This component will set up the following platforms.

HACS Installation

1. Search for myenergi in HACS.
2. Install.
3. Restart Home Assistant.

Configuration

Request an API key from myenergi. You can generate one at your myenergi account page.
See the myenergi support article for more information.

1. Go to Settings > Devices & Services > + Add Integration button at bottom right
2. Search for myenergi and select it.
3. Enter the Serial numer (12345678) and API key.

Ther serial number and API key can both be found under Products at
myenergi account page

Commonly used helpers and automations

Plugged in (binary sensor)

Helpers > Create Helper > Template > Template a binary sensor

• Name: Zappi Plugged in
• Template: {{ is_state('sensor.zappi_plug_status', ['Waiting for EV', 'EV Connected', 'Charging']) }}
• Device class: Plug
• Device: Myenergi Zappi

Charging (binary sensor)

Helpers > Create Helper > Template > Template a binary sensor

• Name: Charging
• Template: {{ is_state('sensor.zappi_charger_status', 'Charging') or ( is_state('sensor.zappi_charger_status', 'Boosting') and is_state('binary_sensor.zappi_plugged_in', 'on'))}}
• Device class: Charging
• Device: Myenergi Zappi

Troubleshooting

Perform all of the following steps before submitting an issue:

Pick up the phone

1. Check the MyEnergi app first to ensure everything works in the MyEnergi eco system.
2. No support can be provided when Octopus is used. Maybe it works, but it can cause unexpected issues which cannot be fixed.

Have you tried turning it off and on again?

3. Update the integration to the latest (beta) version
4. Restart Home Assistant.

Have you tried forcing an unexpected reboot?

5. Disconnect the Zappi from the car.
6. Force a device reboot: https://support.myenergi.com/hc/en-gb/articles/26093410495121-How-do-I-Reboot-zappi

If all else fails

7. Check the (closed) issues and Community Forum

Updating to the latest (beta) version

go to:

• HACS > Myenergi.
• from the 3-dot menu, select Redownload.
• slecht Need a different version.
• Choose the latest (beta) version.

Updating API key

If you need to change your API key for any reason, you will need to remove the device from "Integration entries", and re-add it again with the new API key.

If the master device is changed or replaced, a new API key is needed.

If an additional device is added, it can take a few hours before it shows up.

This integration is incompatible with Octopus. If Octopus controls your devices, this integration will no longer function correctly.

Contributions are welcome!

If you want to contribute to this please read the Contribution guidelines.

Credits

This project was generated from @oncleben31's Home Assistant Custom Component Cookiecutter template.

Code template was mainly taken from @Ludeeus's integration_blueprint template.