chore: improve Home Assistant adapter

Add documentation for home assistant adapter.
Make adapter correctly set the measurement keys for PV production.
Add adapter configuration for grid import and export measurements.

Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>

Author: b0661

.env

@@ -11,7 +11,7 @@ DOCKER_COMPOSE_DATA_DIR=${HOME}/.local/share/net.akkudoktor.eos
 # -----------------------------------------------------------------------------
 # Image / build
 # -----------------------------------------------------------------------------
-VERSION=0.2.0.dev81236039
+VERSION=0.2.0.dev40329975
 PYTHON_VERSION=3.13.9
 
 # -----------------------------------------------------------------------------

config.yaml

@@ -6,7 +6,7 @@
 # the root directory (no add-on folder as usual).
 
 name: "Akkudoktor-EOS"
-version: "0.2.0.dev81236039"
+version: "0.2.0.dev40329975"
 slug: "eos"
 description: "Akkudoktor-EOS add-on"
 url: "https://github.com/Akkudoktor-EOS/EOS"

docs/_generated/configadapter.md

@@ -28,6 +28,8 @@
            "homeassistant": {
                "config_entity_ids": null,
                "load_emr_entity_ids": null,
+               "grid_export_emr_entity_ids": null,
+               "grid_import_emr_entity_ids": null,
                "pv_production_emr_entity_ids": null,
                "device_measurement_entity_ids": null,
                "device_instruction_entity_ids": null,
@@ -59,6 +61,8 @@
            "homeassistant": {
                "config_entity_ids": null,
                "load_emr_entity_ids": null,
+               "grid_export_emr_entity_ids": null,
+               "grid_import_emr_entity_ids": null,
                "pv_production_emr_entity_ids": null,
                "device_measurement_entity_ids": null,
                "device_instruction_entity_ids": null,
@@ -142,9 +146,11 @@ E.g. The instruction for device id 'battery1' becomes the entity_id 'sensor.eos_
 | device_measurement_entity_ids | `Optional[dict[str, str]]` | `rw` | `None` | Mapping of EOS measurement keys used by device (resource) simulations to Home Assistant entity IDs. |
 | eos_device_instruction_entity_ids | `list[str]` | `ro` | `N/A` | Entity IDs for energy management instructions available at EOS. |
 | eos_solution_entity_ids | `list[str]` | `ro` | `N/A` | Entity IDs for optimization solution available at EOS. |
+| grid_export_emr_entity_ids | `Optional[list[str]]` | `rw` | `None` | Entity ID(s) of export to grid energy meter readings [kWh] |
+| grid_import_emr_entity_ids | `Optional[list[str]]` | `rw` | `None` | Entity ID(s) of import from grid energy meter readings [kWh] |
 | homeassistant_entity_ids | `list[str]` | `ro` | `N/A` | Entity IDs available at Home Assistant. |
-| load_emr_entity_ids | `Optional[list[str]]` | `rw` | `None` | Entity ID(s) of load energy meter reading [kWh] |
-| pv_production_emr_entity_ids | `Optional[list[str]]` | `rw` | `None` | Entity ID(s) of PV production energy meter reading [kWh] |
+| load_emr_entity_ids | `Optional[list[str]]` | `rw` | `None` | Entity ID(s) of load energy meter readings [kWh] |
+| pv_production_emr_entity_ids | `Optional[list[str]]` | `rw` | `None` | Entity ID(s) of PV production energy meter readings [kWh] |
 | solution_entity_ids | `Optional[list[str]]` | `rw` | `None` | Entity IDs for optimization solution keys to be updated by EOS.
 The solution keys have to be prepended by 'sensor.eos_' to build the entity_id.
 E.g. solution key 'battery1_idle_op_mode' becomes the entity_id 'sensor.eos_battery1_idle_op_mode'. |
@@ -166,6 +172,12 @@ E.g. solution key 'battery1_idle_op_mode' becomes the entity_id 'sensor.eos_batt
                "load_emr_entity_ids": [
                    "sensor.load_energy_total_kwh"
                ],
+               "grid_export_emr_entity_ids": [
+                   "sensor.grid_export_energy_total_kwh"
+               ],
+               "grid_import_emr_entity_ids": [
+                   "sensor.grid_import_energy_total_kwh"
+               ],
                "pv_production_emr_entity_ids": [
                    "sensor.pv_energy_total_kwh"
                ],
@@ -200,6 +212,12 @@ E.g. solution key 'battery1_idle_op_mode' becomes the entity_id 'sensor.eos_batt
                "load_emr_entity_ids": [
                    "sensor.load_energy_total_kwh"
                ],
+               "grid_export_emr_entity_ids": [
+                   "sensor.grid_export_energy_total_kwh"
+               ],
+               "grid_import_emr_entity_ids": [
+                   "sensor.grid_import_energy_total_kwh"
+               ],
                "pv_production_emr_entity_ids": [
                    "sensor.pv_energy_total_kwh"
                ],

docs/_generated/configexample.md

@@ -10,6 +10,8 @@
            "homeassistant": {
                "config_entity_ids": null,
                "load_emr_entity_ids": null,
+               "grid_export_emr_entity_ids": null,
+               "grid_import_emr_entity_ids": null,
                "pv_production_emr_entity_ids": null,
                "device_measurement_entity_ids": null,
                "device_instruction_entity_ids": null,
@@ -136,7 +138,7 @@
            }
        },
        "general": {
-           "version": "0.2.0.dev81236039",
+           "version": "0.2.0.dev40329975",
            "data_folder_path": null,
            "data_output_subpath": "output",
            "latitude": 52.52,

docs/_generated/configgeneral.md

@@ -16,7 +16,7 @@
 | latitude | `EOS_GENERAL__LATITUDE` | `Optional[float]` | `rw` | `52.52` | Latitude in decimal degrees between -90 and 90. North is positive (ISO 19115) (°) |
 | longitude | `EOS_GENERAL__LONGITUDE` | `Optional[float]` | `rw` | `13.405` | Longitude in decimal degrees within -180 to 180 (°) |
 | timezone | | `Optional[str]` | `ro` | `N/A` | Computed timezone based on latitude and longitude. |
-| version | `EOS_GENERAL__VERSION` | `str` | `rw` | `0.2.0.dev81236039` | Configuration file version. Used to check compatibility. |
+| version | `EOS_GENERAL__VERSION` | `str` | `rw` | `0.2.0.dev40329975` | Configuration file version. Used to check compatibility. |
 :::
 <!-- pyml enable line-length -->
 
@@ -28,7 +28,7 @@
 ```json
    {
        "general": {
-           "version": "0.2.0.dev81236039",
+           "version": "0.2.0.dev40329975",
            "data_folder_path": null,
            "data_output_subpath": "output",
            "latitude": 52.52,
@@ -46,7 +46,7 @@
 ```json
    {
        "general": {
-           "version": "0.2.0.dev81236039",
+           "version": "0.2.0.dev40329975",
            "data_folder_path": null,
            "data_output_subpath": "output",
            "latitude": 52.52,

docs/_generated/openapi.md

@@ -1,6 +1,6 @@
 # Akkudoktor-EOS
 
-**Version**: `v0.2.0.dev81236039`
+**Version**: `v0.2.0.dev40329975`
 
 <!-- pyml disable line-length -->
 **Description**: This project provides a comprehensive solution for simulating and optimizing an energy system based on renewable energy sources. With a focus on photovoltaic (PV) systems, battery storage (batteries), load management (consumer requirements), heat pumps, electric vehicles, and consideration of electricity price data, this system enables forecasting and optimization of energy flow and costs over a specified period.