EOS/docs/_generated/configadapter.md at 1abdd345c47b3db5b59b7989491ee1f43fd0fa49

Mirrors/EOS

Fork 0

mirror of https://github.com/Akkudoktor-EOS/EOS.git synced 2026-09-11 10:26:38 +00:00

Files

T

1abdd345c4 fix: unify mypy environments for local checks and CI (#1291 )

The isolated pre-commit mypy hook previously omitted runtime type information that
make mypy used, hiding errors involving dependencies such as Pydantic and Pendulum.
Makefile, pre-commit and CI now run the same full-project typing policy in the
development environment defined by uv.lock.

- Use uv run --locked --exact --extra dev and the same mypy arguments for Makefile
and the local hook. Check all of src and tests, including on configuration-only
changes.
- Pin Python 3.13 for local development and the pre-commit CI job, and install the
locked pre-commit version in CI.
- Disable incremental analysis because existing Pendulum cache state changes mypy 2.3.1
diagnostics. Document the policy, the performance tradeoff and the existing typing debt.
- Add a regression test that exercises Makefile, the hook and the CI command in a
temporary project, accepting valid dependency types and detecting deliberate
Pydantic/Pendulum assignment errors.

Resolve the newly detected mypy diagnostics.

- Enable the numpydantic and Pydantic mypy plugins, retaining strict Pydantic
constructor typing with init_typed = true. Validate raw/coercible payloads through model_validate.
- Propagate concrete record, provider and time-window types through generic collections,
factories and lookup methods. Preserve runtime field inspection and generated time-window
documentation.
- Align Pendulum annotations with actual factory/arithmetic results while retaining Pydantic
validation adapters at runtime. Correct optional values, array boundaries, REST handlers
and plotting interfaces.
- Add pinned scipy-stubs and types-psutil, update uv.lock, and supply the plugins' dependencies.
- Add runtime regression coverage for validated path defaults, normalized time-series metadata,
generic field inspection, invalid timestamps and unsupported provider imports.

Runtime and compatibility details:

- Validate path defaults as Path objects while retaining raw string defaults needed by
migration serialization with exclude_defaults.
- Normalize feed-in tariff lists and default charge rates to NumPy arrays; reject missing
timestamps/uninitialized values explicitly. Importing into a provider without import support
returns HTTP 400.
- Public JSON schemas and OpenAPI structure match main (excluding the generated version).

Signed-off-by: dr-dimitry

Signed-off-by: dr-dimitry
Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
Co-authored-by: dr-dimitri <87113560+dr-dimitri@users.noreply.github.com>
Co-authored-by: Normann <github@koldrack.com>

2026-09-10 23:20:35 +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`	`Optional[list[str]]`	`rw`	`None`	List of adapter provider id(s) of provider(s) to be used.
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	`Optional[str]`	`rw`	`127.0.0.1`	Node-RED server IP address. Defaults to 127.0.0.1.
port	`Optional[int]`	`rw`	`1880`	Node-RED server IP port number. Defaults to 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	`Optional[dict[str, str]]`	`rw`	`None`	Mapping of EOS config keys to Home Assistant entity IDs.
The config key has to be given by a ‘/’-separated path
e.g. devices/batteries/0/capacity_wh
device_instruction_entity_ids	`Optional[list[str]]`	`rw`	`None`	Entity IDs for device (resource) instructions to be updated by EOS.
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	`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 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'.
:::