Skip to content

Add imeon inverter integration documentation #35847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Apr 30, 2025
Merged

Add imeon inverter integration documentation #35847

Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
1f51c2b
Add imeon inverter integration documentation
Imeon-Energy Nov 20, 2024
d5e547b
Add requirements, extra and removing instructions
Imeon-Energy Dec 19, 2024
3494c68
Correct removing
Imeon-Energy Dec 19, 2024
7dbdafd
Correct typo
Imeon-Energy Dec 19, 2024
7623cca
Add detail to enable 'ModuleAPI'
Imeon-Energy Dec 19, 2024
c1bfe50
Add sensors' descriptions
Imeon-Energy Jan 2, 2025
b75722b
Merge branch 'next' into current
Imeon-Energy Apr 10, 2025
7945429
Use glossary and reuse element, clear and make fixes
Imeon-Energy Apr 16, 2025
cca51c1
Merge branch 'next' into current
Imeon-Energy Apr 16, 2025
d281d7e
Merge branch 'next' into current
Imeon-Energy Apr 23, 2025
f22d7d8
Use of glossary
Apr 23, 2025
b6ddcb3
Apply sentence-style capitalization
c0ffeeca7 Apr 30, 2025
6bc3ce2
Markdown tweak
c0ffeeca7 Apr 30, 2025
c6e98de
Update source/_integrations/imeon_inverter.markdown
c0ffeeca7 Apr 30, 2025
92c3453
align title with other integrations
c0ffeeca7 Apr 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
156 changes: 156 additions & 0 deletions source/_integrations/imeon_inverter.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,156 @@
---
title: Imeon Inverter
description: Instructions on Imeon Inverter Integration for Imeon inverters with Home Assistant.
ha_release: 2025.5
ha_category:
- Energy
- Sensor
ha_iot_class: Local Polling
ha_config_flow: true
ha_codeowners:
- '@Imeon-Energy'
ha_domain: imeon_inverter
related:
- url: https://imeon-energy.com/
- title: Imeon Energy website
ha_integration_type: device
---

The Imeon Energy Inverter {% term integrations %} will poll an [Imeon](https://imeon-energy.com/) solar inverter in Home Assistant.

## Prerequisites

- The Imeon inverter must be connected to the local network.
- [OS One](https://imeon-energy.com/os-one/) version must be **1.8.4** or higher.
- *ModuleAPI* application must be activated on the OS One pannel of your Imeon inverter.
- To do so, connect to **OS One** > **Applications** and by hovering over *ModuleAPI*, select **Activate**.

{% include integrations/config_flow.md %}

## Supported functionality

This document provides an overview of the sensors available in the Imeon Inverter integration and details their functionality, units, and purpose.

### Battery sensors

| Sensor key | Description | Unit |
|----------------------|--------------------------------------------------------|--------|
| `battery_autonomy` | Indicates the battery autonomy. | None |
| `battery_charge_time`| Time required to fully charge the battery. | None |
| `battery_power` | Power currently being used or supplied by the battery. | W |
| `battery_soc` | State of charge of the battery. | % |
| `battery_stored` | Total energy stored in the battery. | Wh |

### Grid sensors

| Sensor key | Description | Unit |
|----------------------|-------------------------------|--------|
| `grid_current_l1` | Current on grid line 1. | A |
| `grid_current_l2` | Current on grid line 2. | A |
| `grid_current_l3` | Current on grid line 3. | A |
| `grid_frequency` | Frequency of the grid supply. | Hz |
| `grid_voltage_l1` | Voltage on grid line 1. | V |
| `grid_voltage_l2` | Voltage on grid line 2. | V |
| `grid_voltage_l3` | Voltage on grid line 3. | V |

### AC input sensors

| Sensor Key | Description | Unit |
|----------------------|------------------------|--------|
| `input_power_l1` | Power input on line 1. | W |
| `input_power_l2` | Power input on line 2. | W |
| `input_power_l3` | Power input on line 3. | W |
| `input_power_total` | Total power input. | W |

### Inverter settings sensors

| Sensor key | Description | Unit |
|-----------------------------------|---------------------------------------|--------|
| `inverter_charging_current_limit` | Maximum charging current allowed. | A |
| `inverter_injection_power_limit` | Maximum power injected into the grid. | W |

### Electric meter sensors

| Sensor key | Description | Unit |
|----------------------|-----------------------------------|--------|
| `meter_power` | Power measured by the meter. | W |
| `meter_power_protocol`| Power measurement protocol type. | None |

### AC output sensors

| Sensor key | Description | Unit |
|----------------------|---------------------------|--------|
| `output_current_l1` | Current output on line 1. | A |
| `output_current_l2` | Current output on line 2. | A |
| `output_current_l3` | Current output on line 3. | A |
| `output_frequency` | Output frequency. | Hz |
| `output_power_l1` | Power output on line 1. | W |
| `output_power_l2` | Power output on line 2. | W |
| `output_power_l3` | Power output on line 3. | W |
| `output_power_total` | Total power output. | W |
| `output_voltage_l1` | Voltage output on line 1. | V |
| `output_voltage_l2` | Voltage output on line 2. | V |
| `output_voltage_l3` | Voltage output on line 3. | V |

### Solar panel sensors

| Sensor Key | Description | Unit |
|----------------------|------------------------------------|--------|
| `pv_consumed` | Energy consumed from solar panels. | Wh |
| `pv_injected` | Energy injected into the grid. | Wh |
| `pv_power_1` | Power from solar panel 1. | W |
| `pv_power_2` | Power from solar panel 2. | W |
| `pv_power_total` | Total power from solar panels. | W |

### Temperature sensors

| Sensor key | Description | Unit |
|----------------------------|----------------------------------------------|--------|
| `temp_air_temperature` | Ambient air temperature around the inverter. | °C |
| `temp_component_temperature`| Temperature of internal components. | °C |

### Monitoring sensors (last 24 hours)

| Sensor key | Description | Unit |
|----------------------------------|----------------------------------------|--------|
| `monitoring_building_consumption`| Total energy consumed by the building. | Wh |
| `monitoring_economy_factor` | Economy factor for energy usage. | None |
| `monitoring_grid_consumption` | Energy consumed from the grid. | Wh |
| `monitoring_grid_injection` | Energy injected into the grid. | Wh |
| `monitoring_grid_power_flow` | Power flow through the grid. | Wh |
| `monitoring_self_consumption` | Self-consumed energy percentage. | % |
| `monitoring_self_production` | Self-produced energy percentage. | % |
| `monitoring_solar_production` | Total solar energy produced. | Wh |

### Monitoring sensors (instant minute data)

| Sensor key | Description | Unit |
|---------------------------------------|---------------------------------------------|--------|
| `monitoring_minute_building_consumption`| Energy consumed by the building (minute). | W |
| `monitoring_minute_grid_consumption` | Energy consumed from the grid (minute). | W |
| `monitoring_minute_grid_injection` | Energy injected into the grid (minute). | W |
| `monitoring_minute_grid_power_flow` | Power flow through the grid (minute). | W |
| `monitoring_minute_solar_production` | Solar energy produced (minute). | W |

## Imeon integration extras

Custom dashboard templates for the custom [Imeon Integration](https://github.com/Imeon-Inverters-for-Home-Assistant/imeon-integration). Uses [APEXCharts-card](https://github.com/RomRider/apexcharts-card/blob/master/README.md#data_generator-option) for graphs and custom gauges.

### Troubleshooting


### What is my domain name?

The domain name is the internal name given to your inverter by Home Assistant. It's based on the initial name you gave to your device, albeit formatted to avoid internal issues.
- A name such as `Imeon Inverter number 57` would give you a domain name of `imeon_inverter_number_57`.
- If you're still struggling to find the domain name, check the internal name of the entities under the device. The name of each variable is `DOMAIN_variable-name`, for example `neo_110_inverter_software_version` tells us the domain name is `neo_110`.

### How to install APEXCharts-card?

[APEXCharts-card's README](https://github.com/RomRider/apexcharts-card/blob/master/README.md#data_generator-option) explains everything needed to install this custom resource on your installation.

## Removing the integration

This integration follows standard integration removal. No extra steps are required.

{% include integrations/remove_device_service.md %}