EOS/docs/_generated/configadapter.md at 886c93c92bafe178ced39babd0a3d0ea903a525e

mirror of https://github.com/Akkudoktor-EOS/EOS.git synced 2026-08-25 17:56:37 +00:00

Files

T

Bobby NoelteandGitHub 886c93c92b fix: default server settings prevent env var config (#1234 )

Change configuration source priorities to:

- cli
- environment vars
- dotenv settings
- config file settings
- init settings

By this the environment vars supersede any configuration var
provided by the configuration file or by the initialisation
with pydantic.

The test_config.py::test_computed_path was fixed to to not
use the defaul env var overwrite defined by conftest.py.
This seemed to indicate non working env vars, but in fact
was a test setupt fault.

Besides this fix there are other fixes and changes added:

* fix: exclude computed fields when merging settings

  Pydantic may overwrite settings by values given for computed
  fields and use these values instead of re-computing the field.
  Avoid computed fields in merging settings.

* chore: improve Windows compatability of development setup

  Improve scripts to better run also on Windows. When doing path
  checks keep compatibility also to Windows pathes. A lot of
  changes to avoid the famous Windows CRLF handling and keep
  line endings to LF.

* chore: add development hint for Windows

  Windows developers should set core.autocrlf to false.

* chore: update version

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

2026-08-16 13:56:25 +02:00

8.6 KiB

Raw Blame History

Adapter Configuration

:::{table} adapter :widths: 10 20 10 5 5 30 :align: left

Name	Environment Variable	Type	Read-Only	Default	Description
homeassistant	`EOS_ADAPTER__HOMEASSISTANT`	`HomeAssistantAdapterCommonSettings`	`rw`	`required`	Home Assistant adapter settings.
nodered	`EOS_ADAPTER__NODERED`	`NodeREDAdapterCommonSettings`	`rw`	`required`	NodeRED adapter settings.
provider	`EOS_ADAPTER__PROVIDER`	`list[str]	None`	`rw`	`None`
providers		`list[str]`	`ro`	`N/A`	Available adapter provider ids.
:::

Example Input

   {
       "adapter": {
           "provider": [
               "HomeAssistant"
           ],
           "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,
               "solution_entity_ids": null
           },
           "nodered": {
               "host": "127.0.0.1",
               "port": 1880
           }
       }
   }

Example Output

   {
       "adapter": {
           "provider": [
               "HomeAssistant"
           ],
           "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,
               "solution_entity_ids": null,
               "homeassistant_entity_ids": [],
               "eos_solution_entity_ids": [],
               "eos_device_instruction_entity_ids": []
           },
           "nodered": {
               "host": "127.0.0.1",
               "port": 1880
           },
           "providers": [
               "HomeAssistant",
               "NodeRED"
           ]
       }
   }

Common settings for the NodeRED adapter

The Node-RED adapter sends to HTTP IN nodes.

This is the example flow:

[HTTP In <URL>] -> [Function (parse payload)] -> [Debug] -> [HTTP Response]

There are two URLs that are used:

GET /eos/data_aquisition The GET is issued before the optimization.
POST /eos/control_dispatch The POST is issued after the optimization.

:::{table} adapter::nodered :widths: 10 10 5 5 30 :align: left

Name	Type	Read-Only	Default	Description
host	`str	None`	`rw`	`127.0.0.1`
port	`int	None`	`rw`	`1880`
:::

Example Input/Output

   {
       "adapter": {
           "nodered": {
               "host": "127.0.0.1",
               "port": 1880
           }
       }
   }

Common settings for the home assistant adapter

:::{table} adapter::homeassistant :widths: 10 10 5 5 30 :align: left

Name	Type	Read-Only	Default	Description
config_entity_ids	`dict[str, str]	None`	`rw`	`None`
The config key has to be given by a ‘/’-separated path
e.g. devices/batteries/0/capacity_wh
device_instruction_entity_ids	`list[str]	None`	`rw`	`None`
The device ids (resource ids) have to be prepended by 'sensor.eos_' to build the entity_id.
E.g. The instruction for device id 'battery1' becomes the entity_id 'sensor.eos_battery1'.
device_measurement_entity_ids	`dict[str, str]	None`	`rw`	`None`
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	`list[str]	None`	`rw`	`None`
grid_import_emr_entity_ids	`list[str]	None`	`rw`	`None`
homeassistant_entity_ids	`list[str]`	`ro`	`N/A`	Entity IDs available at Home Assistant.
load_emr_entity_ids	`list[str]	None`	`rw`	`None`
pv_production_emr_entity_ids	`list[str]	None`	`rw`	`None`
solution_entity_ids	`list[str]	None`	`rw`	`None`
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'.
:::