akkudoktoreos.server.eos

Functions

cache_cleanup_on_exception(e)

cache_cleanup_task()

Repeating task to clear cache from expired cache files.

cache_clear([clear_all])

Cleanup expired cache files.

cache_load()

Load cache from cachefilestore.json.

cache_save()

Save cache to cachefilestore.json.

energy_management_on_exception(e)

energy_management_task()

Repeating task for energy management.

fastapi_admin_cache_clear_expired_post()

Clear the cache from expired data.

fastapi_admin_cache_clear_post()

Clear the cache.

fastapi_admin_cache_get()

Current cache management data.

fastapi_admin_cache_load_post()

Load cache management data.

fastapi_admin_cache_save_post()

Save the current cache management data.

fastapi_admin_server_restart_post()

Restart the server.

fastapi_admin_server_shutdown_post()

Shutdown the server.

fastapi_config_backup_get()

Get the EOS configuration backup identifiers and backup metadata.

fastapi_config_file_put()

Save the current configuration to the EOS configuration file.

fastapi_config_get()

Get the current configuration.

fastapi_config_get_key([path])

Get the value of a nested key or index in the config model.

fastapi_config_put(settings)

Update the current config with the provided settings.

fastapi_config_put_key([path, value])

Update a nested key or index in the config model.

fastapi_config_reset_post()

Reset the configuration to the EOS configuration file.

fastapi_config_revert_put([backup_id])

Revert the configuration to a EOS configuration backup.

fastapi_devices_status_get(resource_id[, ...])

Get the latest status of a resource/ device.

fastapi_devices_status_put(resource_id, status)

Update the status of a resource/ device.

fastapi_energy_management_optimization_solution_get()

Get the latest solution of the optimization.

fastapi_energy_management_plan_get()

Get the latest energy management plan.

fastapi_gesamtlast(request)

Deprecated: Total Load Prediction with adjustment.

fastapi_gesamtlast_simple(year_energy)

Deprecated: Total Load Prediction.

fastapi_health_get()

Health check endpoint to verify that the EOS server is alive.

fastapi_logging_get_log([limit, level, ...])

Get structured log entries from the EOS log file.

fastapi_measurement_data_put(data)

Merge the measurement data given as datetime data into EOS measurements.

fastapi_measurement_dataframe_put(data)

Merge the measurement data given as dataframe into EOS measurements.

fastapi_measurement_keys_get()

Get a list of available measurement keys.

fastapi_measurement_series_get(key)

Get the measurements of given key as series.

fastapi_measurement_series_put(key, series)

Merge measurement given as series into given key.

fastapi_measurement_value_put(datetime, key, ...)

Merge the measurement of given key and value into EOS measurements at given datetime.

fastapi_optimize(parameters[, start_hour, ngen])

Deprecated: Optimize.

fastapi_prediction_dataframe_get(keys[, ...])

Get prediction for given key within given date range as series.

fastapi_prediction_import_provider([...])

Import prediction for given provider ID.

fastapi_prediction_keys_get()

Get a list of available prediction keys.

fastapi_prediction_list_get(key[, ...])

Get prediction for given key within given date range as value list.

fastapi_prediction_providers_get([enabled])

Get a list of available prediction providers.

fastapi_prediction_series_get(key[, ...])

Get prediction for given key within given date range as series.

fastapi_prediction_update([force_update, ...])

Update predictions for all providers.

fastapi_prediction_update_provider(provider_id)

Update predictions for given provider ID.

fastapi_pvforecast()

Deprecated: PV Forecast Prediction.

fastapi_strompreis()

Deprecated: Electricity Market Price Prediction per Wh (€/Wh).

get_pdf()

lifespan(app)

Lifespan manager for the app.

load_eos_state()

Load EOS state.

main()

Parse command-line arguments and start the EOS server with the specified options.

redirect(request, path)

redirect_delete(request, path)

redirect_get(request, path)

redirect_post(request, path)

redirect_put(request, path)

run_eos()

Run the EOS server with the specified configurations.

save_eos_state()

Save EOS state.

server_shutdown_task()

One-shot task for shutting down the EOS server.

site_map()

start_eosdash(host, port, eos_host, ...)

Start the EOSdash server as a subprocess.

terminate_eos()

Gracefully shut down the EOS server process.

Classes

ForecastResponse(*, temperature, pvpower)

GesamtlastRequest(*, year_energy, ...)

PdfResponse(path[, status_code, headers, ...])