From 1f51c2b336f6749055c46134346ef125f7ed527f Mon Sep 17 00:00:00 2001 From: Imeon-Energy Date: Wed, 20 Nov 2024 14:40:43 +0100 Subject: [PATCH 01/12] Add imeon inverter integration documentation --- source/_integrations/imeon_inverter.markdown | 34 ++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 source/_integrations/imeon_inverter.markdown diff --git a/source/_integrations/imeon_inverter.markdown b/source/_integrations/imeon_inverter.markdown new file mode 100644 index 000000000000..738163bf9de6 --- /dev/null +++ b/source/_integrations/imeon_inverter.markdown @@ -0,0 +1,34 @@ +--- +title: Imeon Inverter +description: Instructions on Imeon Energy Integration for Imeon inverters with Home Assistant. +ha_release: 2024.12 +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: integration +--- + +The Imeon Energy Inverter integration will poll a [Imeon](https://imeon-energy.com/) solar inverter in Home Assistant. + +**Please take a look at [extra ressources](https://github.com/Imeon-Inverters-for-Home-Assistant/imeon-integration-extras) for custom dashboards for this integration**. + +## Configuration + +The Imeon Inverter integration supports configuration via the Home Assistant UI. To set it up: + +1. **Access Integrations:** + - Go to the Home Assistant UI, navigate to `Configuration` > `Integrations`. + +2. **Add Integration:** + - Click the "+" button to add a new integration and search for "Imeon Inverter". + +3. **Follow Setup Wizard:** + - Follow the on-screen instructions to complete the integration setup. \ No newline at end of file From d5e547b8844bdd36176ed69b46bc08cf4a96e959 Mon Sep 17 00:00:00 2001 From: Imeon-Energy Date: Thu, 19 Dec 2024 11:14:12 +0100 Subject: [PATCH 02/12] Add requirements, extra and removing instructions --- source/_integrations/imeon_inverter.markdown | 36 ++++++++++++++++++-- 1 file changed, 34 insertions(+), 2 deletions(-) diff --git a/source/_integrations/imeon_inverter.markdown b/source/_integrations/imeon_inverter.markdown index 738163bf9de6..1fa2bcca249e 100644 --- a/source/_integrations/imeon_inverter.markdown +++ b/source/_integrations/imeon_inverter.markdown @@ -20,7 +20,13 @@ The Imeon Energy Inverter integration will poll a [Imeon](https://imeon-energy.c **Please take a look at [extra ressources](https://github.com/Imeon-Inverters-for-Home-Assistant/imeon-integration-extras) for custom dashboards for this integration**. -## Configuration +## Requirements + +- The Imeon 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. + +## Configurating the integration The Imeon Inverter integration supports configuration via the Home Assistant UI. To set it up: @@ -31,4 +37,30 @@ The Imeon Inverter integration supports configuration via the Home Assistant UI. - Click the "+" button to add a new integration and search for "Imeon Inverter". 3. **Follow Setup Wizard:** - - Follow the on-screen instructions to complete the integration setup. \ No newline at end of file + - Follow the on-screen instructions to complete the integration setup. + +## 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. + +1. **Access Lovelace Dashboard**: Click on the "Overview" tab on the sidebar to access Lovelace, Home Assistant's dashboard interface. +2. **Edit the Dashboard**: Click on the three-dot menu in the top right corner and select "Edit Dashboard." +3. **Manage Dashboards**: Click on the three-dot menu again and select "Manage Dashboards." +4. **Create a New Dashboard**: Click on "Add Dashboard" to create a new one. +5. **Enable YAML Mode**: When creating the new dashboard, toggle the "YAML Mode" option to enable it. +6. **Paste the template**: Copy and paste the contents of `/dashboard/dashboard.yaml` in the editor. +7. **Replace the keys**: Search and replace `#INVERTER#` with the domain name of your inverter, for example `imeon_84`. + +### 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 ressource on your installation. + +## Removing the integration + +This integration follows standard integration removal. No extra steps are required. + +{% include integrations/remove_device_service.md %} From 3494c687d169e04b83822200005eced4cdc8b87a Mon Sep 17 00:00:00 2001 From: Imeon-Energy Date: Thu, 19 Dec 2024 11:21:05 +0100 Subject: [PATCH 03/12] Correct removing --- source/_integrations/imeon_inverter.markdown | 2 -- 1 file changed, 2 deletions(-) diff --git a/source/_integrations/imeon_inverter.markdown b/source/_integrations/imeon_inverter.markdown index 1fa2bcca249e..9eb78ab79333 100644 --- a/source/_integrations/imeon_inverter.markdown +++ b/source/_integrations/imeon_inverter.markdown @@ -62,5 +62,3 @@ Custom dashboard templates for the custom [Imeon Integration](https://github.com ## Removing the integration This integration follows standard integration removal. No extra steps are required. - -{% include integrations/remove_device_service.md %} From 7dbdafdadaebdab2eea462883903741deb751b09 Mon Sep 17 00:00:00 2001 From: Imeon-Energy Date: Thu, 19 Dec 2024 11:33:43 +0100 Subject: [PATCH 04/12] Correct typo --- source/_integrations/imeon_inverter.markdown | 30 ++++++++++++-------- 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/source/_integrations/imeon_inverter.markdown b/source/_integrations/imeon_inverter.markdown index 9eb78ab79333..204923e24b1a 100644 --- a/source/_integrations/imeon_inverter.markdown +++ b/source/_integrations/imeon_inverter.markdown @@ -18,7 +18,7 @@ ha_integration_type: integration The Imeon Energy Inverter integration will poll a [Imeon](https://imeon-energy.com/) solar inverter in Home Assistant. -**Please take a look at [extra ressources](https://github.com/Imeon-Inverters-for-Home-Assistant/imeon-integration-extras) for custom dashboards for this integration**. +**Please take a look at [extra resources](https://github.com/Imeon-Inverters-for-Home-Assistant/imeon-integration-extras) for custom dashboards for this integration**. ## Requirements @@ -26,7 +26,7 @@ The Imeon Energy Inverter integration will poll a [Imeon](https://imeon-energy.c - [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. -## Configurating the integration +## Configuring the integration The Imeon Inverter integration supports configuration via the Home Assistant UI. To set it up: @@ -43,19 +43,25 @@ The Imeon Inverter integration supports configuration via the Home Assistant UI. 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. -1. **Access Lovelace Dashboard**: Click on the "Overview" tab on the sidebar to access Lovelace, Home Assistant's dashboard interface. -2. **Edit the Dashboard**: Click on the three-dot menu in the top right corner and select "Edit Dashboard." -3. **Manage Dashboards**: Click on the three-dot menu again and select "Manage Dashboards." -4. **Create a New Dashboard**: Click on "Add Dashboard" to create a new one. -5. **Enable YAML Mode**: When creating the new dashboard, toggle the "YAML Mode" option to enable it. -6. **Paste the template**: Copy and paste the contents of `/dashboard/dashboard.yaml` in the editor. -7. **Replace the keys**: Search and replace `#INVERTER#` with the domain name of your inverter, for example `imeon_84`. +1. **Access Lovelace Dashboard:** Click on the "Overview" tab on the sidebar to access Lovelace, Home Assistant's dashboard interface. + +2. **Edit the Dashboard:** Click on the three-dot menu in the top right corner and select "Edit Dashboard." + +3. **Manage Dashboards:** Click on the three-dot menu again and select "Manage Dashboards." + +4. **Create a New Dashboard:** Click on "Add Dashboard" to create a new one. + +5. **Enable YAML Mode:** When creating the new dashboard, toggle the "YAML Mode" option to enable it. + +6. **Paste the template**: Copy and paste the contents of the `dashboard.yaml` file from the [imeon-integration-extras repository](https://github.com/Imeon-Inverters-for-Home-Assistant/imeon-integration-extras/tree/master/dashboard) into the editor. + +7. **Replace the keys:** Search and replace `#INVERTER#` with the domain name of your inverter, for example `imeon_84`. ### 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`. +- **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 ressource on your installation. From 7623ccaad3f8c3a35d8ff5d2a9dcd046084296e3 Mon Sep 17 00:00:00 2001 From: Imeon-Energy Date: Thu, 19 Dec 2024 11:43:06 +0100 Subject: [PATCH 05/12] Add detail to enable 'ModuleAPI' --- source/_integrations/imeon_inverter.markdown | 1 + 1 file changed, 1 insertion(+) diff --git a/source/_integrations/imeon_inverter.markdown b/source/_integrations/imeon_inverter.markdown index 204923e24b1a..a8c2d61a5c31 100644 --- a/source/_integrations/imeon_inverter.markdown +++ b/source/_integrations/imeon_inverter.markdown @@ -25,6 +25,7 @@ The Imeon Energy Inverter integration will poll a [Imeon](https://imeon-energy.c - The Imeon 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. + > To do so, connect to `OS One` > `Applications` and by hovering over *ModuleAPI*, click on "Activate". ## Configuring the integration From c1bfe50a5b3c96623a7bb6f48ad76e2cee22dcd0 Mon Sep 17 00:00:00 2001 From: Imeon-Energy Date: Thu, 2 Jan 2025 10:08:13 +0100 Subject: [PATCH 06/12] Add sensors' descriptions --- source/_integrations/imeon_inverter.markdown | 122 ++++++++++++++++++- 1 file changed, 120 insertions(+), 2 deletions(-) diff --git a/source/_integrations/imeon_inverter.markdown b/source/_integrations/imeon_inverter.markdown index a8c2d61a5c31..a3698f4999a5 100644 --- a/source/_integrations/imeon_inverter.markdown +++ b/source/_integrations/imeon_inverter.markdown @@ -13,7 +13,7 @@ ha_domain: imeon_inverter related: - url: https://imeon-energy.com/ title: Imeon Energy website -ha_integration_type: integration +ha_integration_type: device --- The Imeon Energy Inverter integration will poll a [Imeon](https://imeon-energy.com/) solar inverter in Home Assistant. @@ -40,10 +40,120 @@ The Imeon Inverter integration supports configuration via the Home Assistant UI. 3. **Follow Setup Wizard:** - Follow the on-screen instructions to complete the integration setup. +## Imeon Inverter Sensors Documentation + +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. +### Requirements + +- Required HACS installation +- APEXCharts-card installation steps + 1. **Access Lovelace Dashboard:** Click on the "Overview" tab on the sidebar to access Lovelace, Home Assistant's dashboard interface. 2. **Edit the Dashboard:** Click on the three-dot menu in the top right corner and select "Edit Dashboard." @@ -68,4 +178,12 @@ Custom dashboard templates for the custom [Imeon Integration](https://github.com ## Removing the integration -This integration follows standard integration removal. No extra steps are required. +1. Navigate to `Configuration` > `Integrations` + +2. Find the Imeon Inverter integration + +3. Click on the three dots menu + +4. Select `Delete` + +5. Confirm the removal From 79454292e0088b820bd89b8834917a23f774e51e Mon Sep 17 00:00:00 2001 From: Imeon-Energy Date: Wed, 16 Apr 2025 09:23:32 +0200 Subject: [PATCH 07/12] Use glossary and reuse element, clear and make fixes --- source/_integrations/imeon_inverter.markdown | 56 ++++---------------- 1 file changed, 9 insertions(+), 47 deletions(-) diff --git a/source/_integrations/imeon_inverter.markdown b/source/_integrations/imeon_inverter.markdown index a3698f4999a5..d26dc1847459 100644 --- a/source/_integrations/imeon_inverter.markdown +++ b/source/_integrations/imeon_inverter.markdown @@ -1,7 +1,7 @@ --- title: Imeon Inverter -description: Instructions on Imeon Energy Integration for Imeon inverters with Home Assistant. -ha_release: 2024.12 +description: Instructions on Imeon Inverter Integration for Imeon inverters with Home Assistant. +ha_release: 2025.5 ha_category: - Energy - Sensor @@ -12,33 +12,20 @@ ha_codeowners: ha_domain: imeon_inverter related: - url: https://imeon-energy.com/ -title: Imeon Energy website +- title: Imeon Energy website ha_integration_type: device --- The Imeon Energy Inverter integration will poll a [Imeon](https://imeon-energy.com/) solar inverter in Home Assistant. -**Please take a look at [extra resources](https://github.com/Imeon-Inverters-for-Home-Assistant/imeon-integration-extras) for custom dashboards for this integration**. +## Prerequisites -## Requirements - -- The Imeon must be connected to the local network. +- 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. +- *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*, click on "Activate". -## Configuring the integration - -The Imeon Inverter integration supports configuration via the Home Assistant UI. To set it up: - -1. **Access Integrations:** - - Go to the Home Assistant UI, navigate to `Configuration` > `Integrations`. - -2. **Add Integration:** - - Click the "+" button to add a new integration and search for "Imeon Inverter". - -3. **Follow Setup Wizard:** - - Follow the on-screen instructions to complete the integration setup. +{% include integrations/config_flow.md %} ## Imeon Inverter Sensors Documentation @@ -149,25 +136,6 @@ This document provides an overview of the sensors available in the Imeon Inverte 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. -### Requirements - -- Required HACS installation -- APEXCharts-card installation steps - -1. **Access Lovelace Dashboard:** Click on the "Overview" tab on the sidebar to access Lovelace, Home Assistant's dashboard interface. - -2. **Edit the Dashboard:** Click on the three-dot menu in the top right corner and select "Edit Dashboard." - -3. **Manage Dashboards:** Click on the three-dot menu again and select "Manage Dashboards." - -4. **Create a New Dashboard:** Click on "Add Dashboard" to create a new one. - -5. **Enable YAML Mode:** When creating the new dashboard, toggle the "YAML Mode" option to enable it. - -6. **Paste the template**: Copy and paste the contents of the `dashboard.yaml` file from the [imeon-integration-extras repository](https://github.com/Imeon-Inverters-for-Home-Assistant/imeon-integration-extras/tree/master/dashboard) into the editor. - -7. **Replace the keys:** Search and replace `#INVERTER#` with the domain name of your inverter, for example `imeon_84`. - ### 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. @@ -178,12 +146,6 @@ Custom dashboard templates for the custom [Imeon Integration](https://github.com ## Removing the integration -1. Navigate to `Configuration` > `Integrations` - -2. Find the Imeon Inverter integration - -3. Click on the three dots menu - -4. Select `Delete` +This integration follows standard integration removal. No extra steps are required. -5. Confirm the removal +{% include integrations/remove_device_service.md %} From f22d7d8a6e1a1aa45d7893cea8a3554fe301f878 Mon Sep 17 00:00:00 2001 From: "t.david" Date: Wed, 23 Apr 2025 15:59:44 +0200 Subject: [PATCH 08/12] Use of glossary --- source/_integrations/imeon_inverter.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/imeon_inverter.markdown b/source/_integrations/imeon_inverter.markdown index d26dc1847459..b059b4ec34b8 100644 --- a/source/_integrations/imeon_inverter.markdown +++ b/source/_integrations/imeon_inverter.markdown @@ -16,7 +16,7 @@ related: ha_integration_type: device --- -The Imeon Energy Inverter integration will poll a [Imeon](https://imeon-energy.com/) solar inverter in Home Assistant. +The Imeon Energy Inverter {% term integrations %} will poll an [Imeon](https://imeon-energy.com/) solar inverter in Home Assistant. ## Prerequisites From b6ddcb309e7b82af1bd05ad91a70148fb7ca6ec8 Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Wed, 30 Apr 2025 13:41:34 +0200 Subject: [PATCH 09/12] Apply sentence-style capitalization --- source/_integrations/imeon_inverter.markdown | 51 +++++++++++--------- 1 file changed, 28 insertions(+), 23 deletions(-) diff --git a/source/_integrations/imeon_inverter.markdown b/source/_integrations/imeon_inverter.markdown index b059b4ec34b8..19e4c1c61e32 100644 --- a/source/_integrations/imeon_inverter.markdown +++ b/source/_integrations/imeon_inverter.markdown @@ -23,17 +23,17 @@ The Imeon Energy Inverter {% term integrations %} will poll an [Imeon](https://i - 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*, click on "Activate". + - To do so, connect to **OS One** > **Applications** and by hovering over *ModuleAPI*, select **Activate**. {% include integrations/config_flow.md %} -## Imeon Inverter Sensors Documentation +## Imeon inverter sensors documentation This document provides an overview of the sensors available in the Imeon Inverter integration and details their functionality, units, and purpose. -### Battery Sensors +### Battery sensors -| Sensor Key | Description | Unit | +| Sensor key | Description | Unit | |----------------------|--------------------------------------------------------|--------| | `battery_autonomy` | Indicates the battery autonomy. | None | | `battery_charge_time`| Time required to fully charge the battery. | None | @@ -41,9 +41,9 @@ This document provides an overview of the sensors available in the Imeon Inverte | `battery_soc` | State of charge of the battery. | % | | `battery_stored` | Total energy stored in the battery. | Wh | -### Grid Sensors +### Grid sensors -| Sensor Key | Description | Unit | +| Sensor key | Description | Unit | |----------------------|-------------------------------|--------| | `grid_current_l1` | Current on grid line 1. | A | | `grid_current_l2` | Current on grid line 2. | A | @@ -53,7 +53,7 @@ This document provides an overview of the sensors available in the Imeon Inverte | `grid_voltage_l2` | Voltage on grid line 2. | V | | `grid_voltage_l3` | Voltage on grid line 3. | V | -### AC Input Sensors +### AC input sensors | Sensor Key | Description | Unit | |----------------------|------------------------|--------| @@ -62,23 +62,23 @@ This document provides an overview of the sensors available in the Imeon Inverte | `input_power_l3` | Power input on line 3. | W | | `input_power_total` | Total power input. | W | -### Inverter Settings Sensors +### Inverter settings sensors -| Sensor Key | Description | Unit | +| 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 +### Electric meter sensors -| Sensor Key | Description | Unit | +| Sensor key | Description | Unit | |----------------------|-----------------------------------|--------| | `meter_power` | Power measured by the meter. | W | | `meter_power_protocol`| Power measurement protocol type. | None | -### AC Output Sensors +### AC output sensors -| Sensor Key | Description | Unit | +| Sensor key | Description | Unit | |----------------------|---------------------------|--------| | `output_current_l1` | Current output on line 1. | A | | `output_current_l2` | Current output on line 2. | A | @@ -92,7 +92,7 @@ This document provides an overview of the sensors available in the Imeon Inverte | `output_voltage_l2` | Voltage output on line 2. | V | | `output_voltage_l3` | Voltage output on line 3. | V | -### Solar Panel Sensors +### Solar panel sensors | Sensor Key | Description | Unit | |----------------------|------------------------------------|--------| @@ -102,16 +102,16 @@ This document provides an overview of the sensors available in the Imeon Inverte | `pv_power_2` | Power from solar panel 2. | W | | `pv_power_total` | Total power from solar panels. | W | -### Temperature Sensors +### Temperature sensors -| Sensor Key | Description | Unit | +| 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) +### Monitoring sensors (last 24 hours) -| Sensor Key | Description | Unit | +| Sensor key | Description | Unit | |----------------------------------|----------------------------------------|--------| | `monitoring_building_consumption`| Total energy consumed by the building. | Wh | | `monitoring_economy_factor` | Economy factor for energy usage. | None | @@ -122,7 +122,7 @@ This document provides an overview of the sensors available in the Imeon Inverte | `monitoring_self_production` | Self-produced energy percentage. | % | | `monitoring_solar_production` | Total solar energy produced. | Wh | -### Monitoring Sensors (Instant Minute Data) +### Monitoring sensors (instant minute data) | Sensor Key | Description | Unit | |---------------------------------------|---------------------------------------------|--------| @@ -132,17 +132,22 @@ This document provides an overview of the sensors available in the Imeon Inverte | `monitoring_minute_grid_power_flow` | Power flow through the grid (minute). | W | | `monitoring_minute_solar_production` | Solar energy produced (minute). | W | -## Imeon Integration Extras +## 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 +###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. + +### 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 ressource on your installation. +### 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 From 6bc3ce2dc54a6222ac45468e9d766ec5e091604b Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Wed, 30 Apr 2025 13:42:05 +0200 Subject: [PATCH 10/12] Markdown tweak --- source/_integrations/imeon_inverter.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/imeon_inverter.markdown b/source/_integrations/imeon_inverter.markdown index 19e4c1c61e32..ece1359170ef 100644 --- a/source/_integrations/imeon_inverter.markdown +++ b/source/_integrations/imeon_inverter.markdown @@ -136,7 +136,7 @@ This document provides an overview of the sensors available in the Imeon Inverte 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 +### Troubleshooting ### What is my domain name? From c6e98def6280aba75b5bde12b819c9102a194f3e Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Wed, 30 Apr 2025 13:42:29 +0200 Subject: [PATCH 11/12] Update source/_integrations/imeon_inverter.markdown --- source/_integrations/imeon_inverter.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/imeon_inverter.markdown b/source/_integrations/imeon_inverter.markdown index ece1359170ef..9931df0b9436 100644 --- a/source/_integrations/imeon_inverter.markdown +++ b/source/_integrations/imeon_inverter.markdown @@ -124,7 +124,7 @@ This document provides an overview of the sensors available in the Imeon Inverte ### Monitoring sensors (instant minute data) -| Sensor Key | Description | Unit | +| 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 | From 92c34538aec484d33e8e3d9ca92f76e79637befd Mon Sep 17 00:00:00 2001 From: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> Date: Wed, 30 Apr 2025 13:43:40 +0200 Subject: [PATCH 12/12] align title with other integrations --- source/_integrations/imeon_inverter.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_integrations/imeon_inverter.markdown b/source/_integrations/imeon_inverter.markdown index 9931df0b9436..0e0b4cb3d1a2 100644 --- a/source/_integrations/imeon_inverter.markdown +++ b/source/_integrations/imeon_inverter.markdown @@ -27,7 +27,7 @@ The Imeon Energy Inverter {% term integrations %} will poll an [Imeon](https://i {% include integrations/config_flow.md %} -## Imeon inverter sensors documentation +## Supported functionality This document provides an overview of the sensors available in the Imeon Inverter integration and details their functionality, units, and purpose.