EOS/docs/_generated/configdevices.md at 8344974c16cc278c9fc75db9a8c14e40e8c5fbf7

Mirrors/EOS

Fork 0

mirror of https://github.com/Akkudoktor-EOS/EOS.git synced 2026-08-01 06:36:11 +00:00

Files

T

Bobby NoelteandGitHub 7e5aa2f218

Bump Version / Bump Version Workflow (push) Has been cancelled

Details

CodeQL Advanced / Analyze (actions) (push) Has been cancelled

Details

CodeQL Advanced / Analyze (python) (push) Has been cancelled

Details

docker-build / platform-excludes (push) Has been cancelled

Details

pre-commit / pre-commit (push) Has been cancelled

Details

Run Pytest on Pull Request / test (push) Has been cancelled

Details

docker-build / build (push) Has been cancelled

Details

docker-build / merge (push) Has been cancelled

Details

Close stale pull requests/issues / Find Stale issues and PRs (push) Has been cancelled

Details

feat: add Tibber feed-in tariff provider (#1189 )

The `FeedInTariffTibber` provider requests `priceInfo` and `priceInfoRange` with
`resolution: QUARTER_HOURLY` and preserves the native 15-minute timestamps. It uses Tibber's
`energy` spot-price component without the `tax` part or EOS electricity-price charges. The
end-customer `total` component is deliberately ignored.

The provider deliberately rejects hourly API responses instead of silently repeating them. It
reuses `elecprice.tibber.access_token` and `elecprice.tibber.home_id`, so no duplicate credentials
are needed.

Signed-off-by: Andreas Schmitz <akkudoktor.net>
Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>

2026-07-24 15:52:26 +02:00

21 KiB

Raw Blame History

Base configuration for devices simulation settings

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

Name	Environment Variable	Type	Read-Only	Default	Description
batteries	`EOS_DEVICES__BATTERIES`	`list[akkudoktoreos.devices.devices.BatteriesCommonSettings]	None`	`rw`	`None`
electric_vehicles	`EOS_DEVICES__ELECTRIC_VEHICLES`	`list[akkudoktoreos.devices.devices.BatteriesCommonSettings]	None`	`rw`	`None`
home_appliances	`EOS_DEVICES__HOME_APPLIANCES`	`list[akkudoktoreos.devices.devices.HomeApplianceCommonSettings]	None`	`rw`	`None`
inverters	`EOS_DEVICES__INVERTERS`	`list[akkudoktoreos.devices.devices.InverterCommonSettings]	None`	`rw`	`None`
max_batteries	`EOS_DEVICES__MAX_BATTERIES`	`int	None`	`rw`	`None`
max_electric_vehicles	`EOS_DEVICES__MAX_ELECTRIC_VEHICLES`	`int	None`	`rw`	`None`
max_home_appliances	`EOS_DEVICES__MAX_HOME_APPLIANCES`	`int	None`	`rw`	`None`
max_inverters	`EOS_DEVICES__MAX_INVERTERS`	`int	None`	`rw`	`None`
measurement_keys		`list[str]	None`	`ro`	`N/A`
:::

Example Input

   {
       "devices": {
           "batteries": [
               {
                   "device_id": "battery1",
                   "capacity_wh": 8000,
                   "charging_efficiency": 0.88,
                   "discharging_efficiency": 0.88,
                   "levelized_cost_of_storage_kwh": 0.0,
                   "max_charge_power_w": 5000,
                   "min_charge_power_w": 50,
                   "charge_rates": [
                       0.0,
                       0.1,
                       0.2,
                       0.3,
                       0.4,
                       0.5,
                       0.6,
                       0.7,
                       0.8,
                       0.9,
                       1.0
                   ],
                   "min_soc_percentage": 0,
                   "max_soc_percentage": 100
               }
           ],
           "max_batteries": 1,
           "electric_vehicles": [
               {
                   "device_id": "battery1",
                   "capacity_wh": 8000,
                   "charging_efficiency": 0.88,
                   "discharging_efficiency": 0.88,
                   "levelized_cost_of_storage_kwh": 0.0,
                   "max_charge_power_w": 5000,
                   "min_charge_power_w": 50,
                   "charge_rates": [
                       0.0,
                       0.1,
                       0.2,
                       0.3,
                       0.4,
                       0.5,
                       0.6,
                       0.7,
                       0.8,
                       0.9,
                       1.0
                   ],
                   "min_soc_percentage": 0,
                   "max_soc_percentage": 100
               }
           ],
           "max_electric_vehicles": 1,
           "inverters": [],
           "max_inverters": 1,
           "home_appliances": [],
           "max_home_appliances": 1
       }
   }

Example Output

   {
       "devices": {
           "batteries": [
               {
                   "device_id": "battery1",
                   "capacity_wh": 8000,
                   "charging_efficiency": 0.88,
                   "discharging_efficiency": 0.88,
                   "levelized_cost_of_storage_kwh": 0.0,
                   "max_charge_power_w": 5000,
                   "min_charge_power_w": 50,
                   "charge_rates": [
                       0.0,
                       0.1,
                       0.2,
                       0.3,
                       0.4,
                       0.5,
                       0.6,
                       0.7,
                       0.8,
                       0.9,
                       1.0
                   ],
                   "min_soc_percentage": 0,
                   "max_soc_percentage": 100,
                   "measurement_key_soc_factor": "battery1-soc-factor",
                   "measurement_key_power_l1_w": "battery1-power-l1-w",
                   "measurement_key_power_l2_w": "battery1-power-l2-w",
                   "measurement_key_power_l3_w": "battery1-power-l3-w",
                   "measurement_key_power_3_phase_sym_w": "battery1-power-3-phase-sym-w",
                   "measurement_keys": [
                       "battery1-soc-factor",
                       "battery1-power-l1-w",
                       "battery1-power-l2-w",
                       "battery1-power-l3-w",
                       "battery1-power-3-phase-sym-w"
                   ]
               }
           ],
           "max_batteries": 1,
           "electric_vehicles": [
               {
                   "device_id": "battery1",
                   "capacity_wh": 8000,
                   "charging_efficiency": 0.88,
                   "discharging_efficiency": 0.88,
                   "levelized_cost_of_storage_kwh": 0.0,
                   "max_charge_power_w": 5000,
                   "min_charge_power_w": 50,
                   "charge_rates": [
                       0.0,
                       0.1,
                       0.2,
                       0.3,
                       0.4,
                       0.5,
                       0.6,
                       0.7,
                       0.8,
                       0.9,
                       1.0
                   ],
                   "min_soc_percentage": 0,
                   "max_soc_percentage": 100,
                   "measurement_key_soc_factor": "battery1-soc-factor",
                   "measurement_key_power_l1_w": "battery1-power-l1-w",
                   "measurement_key_power_l2_w": "battery1-power-l2-w",
                   "measurement_key_power_l3_w": "battery1-power-l3-w",
                   "measurement_key_power_3_phase_sym_w": "battery1-power-3-phase-sym-w",
                   "measurement_keys": [
                       "battery1-soc-factor",
                       "battery1-power-l1-w",
                       "battery1-power-l2-w",
                       "battery1-power-l3-w",
                       "battery1-power-3-phase-sym-w"
                   ]
               }
           ],
           "max_electric_vehicles": 1,
           "inverters": [],
           "max_inverters": 1,
           "home_appliances": [],
           "max_home_appliances": 1,
           "measurement_keys": [
               "battery1-soc-factor",
               "battery1-power-l1-w",
               "battery1-power-l2-w",
               "battery1-power-l3-w",
               "battery1-power-3-phase-sym-w",
               "battery1-soc-factor",
               "battery1-power-l1-w",
               "battery1-power-l2-w",
               "battery1-power-l3-w",
               "battery1-power-3-phase-sym-w"
           ]
       }
   }

Inverter devices base settings

:::{table} devices::inverters::list :widths: 10 10 5 5 30 :align: left

Name	Type	Read-Only	Default	Description
ac_to_dc_efficiency	`float`	`rw`	`1.0`	Efficiency of AC to DC conversion for grid-to-battery AC charging (0-1). Set to 0 to disable AC charging. Default 1.0 (no additional inverter loss).
battery_id	`str	None`	`rw`	`None`
dc_to_ac_efficiency	`float`	`rw`	`1.0`	Efficiency of DC to AC conversion for battery discharging to AC load/grid (0-1). Default 1.0 (no additional inverter loss).
device_id	`str`	`rw`	`<unknown>`	ID of device
max_ac_charge_power_w	`float	None`	`rw`	`None`
max_power_w	`float	None`	`rw`	`None`
measurement_keys	`list[str]	None`	`ro`	`N/A`
:::

Example Input

   {
       "devices": {
           "inverters": [
               {
                   "device_id": "battery1",
                   "max_power_w": 10000.0,
                   "battery_id": null,
                   "ac_to_dc_efficiency": 0.95,
                   "dc_to_ac_efficiency": 0.95,
                   "max_ac_charge_power_w": null
               }
           ]
       }
   }

Example Output

   {
       "devices": {
           "inverters": [
               {
                   "device_id": "battery1",
                   "max_power_w": 10000.0,
                   "battery_id": null,
                   "ac_to_dc_efficiency": 0.95,
                   "dc_to_ac_efficiency": 0.95,
                   "max_ac_charge_power_w": null,
                   "measurement_keys": []
               }
           ]
       }
   }

Model defining a daily or date time window with optional localization support

Represents a time interval starting at start_time and lasting for duration. Can restrict applicability to a specific day of the week or a specific calendar date. Supports day names in multiple languages via locale-aware parsing.

Timezone contract:

start_time is always naive (no tzinfo). It is interpreted as a local wall-clock time in whatever timezone the caller's date_time or reference_date carries. When those arguments are timezone-aware the window boundaries are evaluated in that timezone; when they are naive, arithmetic is performed as-is (no timezone conversion occurs).

date, being a calendar Date object, is inherently timezone-free.

This design avoids the ambiguity that arises when a stored start_time carries its own timezone that differs from the caller's timezone, and keeps the model serialisable without timezone state.

:::{table} devices::home_appliances::list::time_windows::windows::list :widths: 10 10 5 5 30 :align: left

Name	Type	Read-Only	Default	Description
date	`pydantic_extra_types.pendulum_dt.Date	None`	`rw`	`None`
day_of_week	`int	str	None`	`rw`
duration	`Duration`	`rw`	`required`	Duration of the time window starting from `start_time`.
locale	`str	None`	`rw`	`None`
start_time	`Time`	`rw`	`required`	Naive start time of the time window (time of day, no timezone). Interpreted in the timezone of the datetime passed to contains() or earliest_start_time().
:::

Example Input/Output

   {
       "devices": {
           "home_appliances": [
               {
                   "time_windows": {
                       "windows": [
                           {
                               "start_time": "00:00:00.000000",
                               "duration": "2 hours",
                               "day_of_week": null,
                               "date": null,
                               "locale": null
                           }
                       ]
                   }
               }
           ]
       }
   }

Model representing a sequence of time windows with collective operations

Manages multiple TimeWindow objects and provides methods to work with them as a cohesive unit for scheduling and availability checking.

:::{table} devices::home_appliances::list::time_windows :widths: 10 10 5 5 30 :align: left

Name	Type	Read-Only	Default	Description
windows	`list[akkudoktoreos.config.configabc.TimeWindow]`	`rw`	`required`	List of TimeWindow objects that make up this sequence.
:::

Example Input/Output

   {
       "devices": {
           "home_appliances": [
               {
                   "time_windows": {
                       "windows": []
                   }
               }
           ]
       }
   }

Home Appliance devices base settings

:::{table} devices::home_appliances::list :widths: 10 10 5 5 30 :align: left

Name	Type	Read-Only	Default	Description
consumption_wh	`int`	`rw`	`required`	Energy consumption [Wh].
device_id	`str`	`rw`	`<unknown>`	ID of device
duration_h	`int`	`rw`	`required`	Usage duration in hours [0 ... 24].
measurement_keys	`list[str]	None`	`ro`	`N/A`
time_windows	`akkudoktoreos.config.configabc.TimeWindowSequence	None`	`rw`	`None`
:::

Example Input

   {
       "devices": {
           "home_appliances": [
               {
                   "device_id": "battery1",
                   "consumption_wh": 2000,
                   "duration_h": 1,
                   "time_windows": {
                       "windows": [
                           {
                               "start_time": "10:00:00.000000",
                               "duration": "2 hours",
                               "day_of_week": null,
                               "date": null,
                               "locale": null
                           }
                       ]
                   }
               }
           ]
       }
   }

Example Output

   {
       "devices": {
           "home_appliances": [
               {
                   "device_id": "battery1",
                   "consumption_wh": 2000,
                   "duration_h": 1,
                   "time_windows": {
                       "windows": [
                           {
                               "start_time": "10:00:00.000000",
                               "duration": "2 hours",
                               "day_of_week": null,
                               "date": null,
                               "locale": null
                           }
                       ]
                   },
                   "measurement_keys": []
               }
           ]
       }
   }

Battery devices base settings

:::{table} devices::batteries::list :widths: 10 10 5 5 30 :align: left

Name	Type	Read-Only	Default	Description
capacity_wh	`int`	`rw`	`8000`	Capacity [Wh].
charge_rates	`list[float]	None`	`rw`	`[0.0, 0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1.0]`
charging_efficiency	`float`	`rw`	`0.88`	Charging efficiency [0.01 ... 1.00].
device_id	`str`	`rw`	`<unknown>`	ID of device
discharging_efficiency	`float`	`rw`	`0.88`	Discharge efficiency [0.01 ... 1.00].
levelized_cost_of_storage_kwh	`float`	`rw`	`0.0`	Levelized cost of storage (LCOS), the average lifetime cost of delivering one kWh [amount/kWh].
max_charge_power_w	`float	None`	`rw`	`5000`
max_soc_percentage	`int`	`rw`	`100`	Maximum state of charge (SOC) as percentage of capacity [%].
measurement_key_power_3_phase_sym_w	`str`	`ro`	`N/A`	Measurement key for the symmetric 3 phase power the battery is charged or discharged with [W].
measurement_key_power_l1_w	`str`	`ro`	`N/A`	Measurement key for the L1 power the battery is charged or discharged with [W].
measurement_key_power_l2_w	`str`	`ro`	`N/A`	Measurement key for the L2 power the battery is charged or discharged with [W].
measurement_key_power_l3_w	`str`	`ro`	`N/A`	Measurement key for the L3 power the battery is charged or discharged with [W].
measurement_key_soc_factor	`str`	`ro`	`N/A`	Measurement key for the battery state of charge (SoC) as factor of total capacity [0.0 ... 1.0].
measurement_keys	`list[str]	None`	`ro`	`N/A`
min_charge_power_w	`float	None`	`rw`	`50`
min_soc_percentage	`int`	`rw`	`0`	Minimum state of charge (SOC) as percentage of capacity [%]. This is the target SoC for charging
:::

Example Input

   {
       "devices": {
           "batteries": [
               {
                   "device_id": "battery1",
                   "capacity_wh": 8000,
                   "charging_efficiency": 0.88,
                   "discharging_efficiency": 0.88,
                   "levelized_cost_of_storage_kwh": 0.12,
                   "max_charge_power_w": 5000.0,
                   "min_charge_power_w": 50.0,
                   "charge_rates": [
                       0.0,
                       0.25,
                       0.5,
                       0.75,
                       1.0
                   ],
                   "min_soc_percentage": 10,
                   "max_soc_percentage": 100
               }
           ]
       }
   }

Example Output

   {
       "devices": {
           "batteries": [
               {
                   "device_id": "battery1",
                   "capacity_wh": 8000,
                   "charging_efficiency": 0.88,
                   "discharging_efficiency": 0.88,
                   "levelized_cost_of_storage_kwh": 0.12,
                   "max_charge_power_w": 5000.0,
                   "min_charge_power_w": 50.0,
                   "charge_rates": [
                       0.0,
                       0.25,
                       0.5,
                       0.75,
                       1.0
                   ],
                   "min_soc_percentage": 10,
                   "max_soc_percentage": 100,
                   "measurement_key_soc_factor": "battery1-soc-factor",
                   "measurement_key_power_l1_w": "battery1-power-l1-w",
                   "measurement_key_power_l2_w": "battery1-power-l2-w",
                   "measurement_key_power_l3_w": "battery1-power-l3-w",
                   "measurement_key_power_3_phase_sym_w": "battery1-power-3-phase-sym-w",
                   "measurement_keys": [
                       "battery1-soc-factor",
                       "battery1-power-l1-w",
                       "battery1-power-l2-w",
                       "battery1-power-l3-w",
                       "battery1-power-3-phase-sym-w"
                   ]
               }
           ]
       }
   }

21 KiB Raw Blame History

Base configuration for devices simulation settings

Inverter devices base settings

Model defining a daily or date time window with optional localization support

Model representing a sequence of time windows with collective operations

Home Appliance devices base settings

Battery devices base settings

21 KiB

Raw Blame History