2025-12-30 22:08:21 +01:00
import json
2026-03-11 17:18:45 +01:00
import re
2025-12-30 22:08:21 +01:00
from typing import Any , Callable , Optional , Union
2025-01-22 23:47:28 +01:00
2025-12-30 22:08:21 +01:00
from fasthtml . common import H1 , Button , Div , Li , Select
2025-04-05 13:08:12 +02:00
from monsterui . daisy import (
Alert ,
AlertT ,
)
2025-01-22 23:47:28 +01:00
from monsterui . foundations import stringify
2025-12-30 22:08:21 +01:00
from monsterui . franken import ( # Select: Does not work - using Select from FastHTML instead;; Button: Does not pass hx_vals - using Button from FastHTML instead
2025-04-05 13:08:12 +02:00
H3 ,
2025-12-30 22:08:21 +01:00
ButtonT ,
2025-01-22 23:47:28 +01:00
Card ,
2025-12-30 22:08:21 +01:00
Code ,
2025-01-22 23:47:28 +01:00
Container ,
ContainerT ,
Details ,
2025-12-30 22:08:21 +01:00
DivHStacked ,
2025-01-22 23:47:28 +01:00
DivLAligned ,
DivRAligned ,
2025-03-27 21:53:01 +01:00
Form ,
2025-01-22 23:47:28 +01:00
Grid ,
Input ,
2025-12-30 22:08:21 +01:00
Option ,
2025-01-22 23:47:28 +01:00
P ,
2025-12-30 22:08:21 +01:00
Pre ,
2025-01-22 23:47:28 +01:00
Summary ,
TabContainer ,
UkIcon ,
)
2025-12-30 22:08:21 +01:00
from akkudoktoreos . server . dash . context import request_url_for
2025-01-22 23:47:28 +01:00
scrollbar_viewport_styles = (
" scrollbar-width: none; -ms-overflow-style: none; -webkit-overflow-scrolling: touch; "
)
scrollbar_cls = " flex touch-none select-none transition-colors p-[1px] "
def ScrollArea (
* c : Any , cls : Optional [ Union [ str , tuple ] ] = None , orientation : str = " vertical " , * * kwargs : Any
) - > Div :
""" Creates a styled scroll area.
Args :
orientation ( str ) : The orientation of the scroll area . Defaults to vertical .
"""
new_cls = " relative overflow-hidden "
if cls :
new_cls + = f " { stringify ( cls ) } "
kwargs [ " cls " ] = new_cls
content = Div (
Div ( * c , style = " min-width:100 % ;display:table; " ) ,
style = f " overflow: { ' hidden scroll ' if orientation == ' vertical ' else ' scroll ' } ; { scrollbar_viewport_styles } " ,
cls = " w-full h-full rounded-[inherit] " ,
data_ref = " viewport " ,
)
scrollbar = Div (
Div ( cls = " bg-border rounded-full hidden relative flex-1 " , data_ref = " thumb " ) ,
cls = f " { scrollbar_cls } flex-col h-2.5 w-full border-t border-t-transparent "
if orientation == " horizontal "
else f " { scrollbar_cls } w-2.5 h-full border-l border-l-transparent " ,
data_ref = " scrollbar " ,
style = f " position: absolute; { ' right:0; top:0; ' if orientation == ' vertical ' else ' bottom:0; left:0; ' } " ,
)
return Div (
content ,
scrollbar ,
role = " region " ,
tabindex = " 0 " ,
data_orientation = orientation ,
data_ref_scrollarea = True ,
aria_label = " Scrollable content " ,
* * kwargs ,
)
2025-12-30 22:08:21 +01:00
def JsonView ( data : Any ) - > Pre :
""" Render structured data as formatted JSON inside a styled <pre> block.
The data is serialized to JSON using indentation for readability and
UTF - 8 characters are preserved . The JSON is wrapped in a < code > element
with a JSON language class to support syntax highlighting , and then
placed inside a < pre > container with MonsterUI - compatible styling .
The JSON output is height - constrained and scrollable to safely display
large payloads without breaking the page layout .
Args :
data : Any JSON - serializable Python object to render .
Returns :
A FastHTML ` Pre ` element containing a formatted JSON representation
of the input data .
"""
code_str = json . dumps ( data , indent = 2 , ensure_ascii = False )
return Pre (
Code ( code_str , cls = " language-json " ) ,
cls = " rounded-lg bg-muted p-3 max-h-[30vh] overflow-y-auto overflow-x-hidden whitespace-pre-wrap " ,
)
def TextView ( * c : Any , cls : Optional [ Union [ str , tuple ] ] = None , * * kwargs : Any ) - > Pre :
""" Render plain text with preserved line breaks and wrapped long lines.
This view uses a < pre > element with whitespace wrapping enabled so that
newline characters are respected while long lines are wrapped instead
of causing horizontal scrolling .
Args :
* c ( Any ) : Positional arguments representing the TextView content .
cls ( Optional [ Union [ str , tuple ] ] ) : Additional CSS classes for styling . Defaults to None .
* * kwargs ( Any ) : Additional keyword arguments passed to the ` Pre ` .
Returns :
A FastHTML ` Pre ` element that displays the text with preserved
formatting and line wrapping .
"""
new_cls = " whitespace-pre-wrap "
if cls :
new_cls + = f " { stringify ( cls ) } "
kwargs [ " cls " ] = new_cls
return Pre ( * c , * * kwargs )
2025-04-05 13:08:12 +02:00
def Success ( * c : Any ) - > Alert :
return Alert (
DivLAligned (
UkIcon ( " check " ) ,
2025-12-30 22:08:21 +01:00
TextView ( * c ) ,
2025-04-05 13:08:12 +02:00
) ,
cls = AlertT . success ,
)
def Error ( * c : Any ) - > Alert :
return Alert (
DivLAligned (
UkIcon ( " triangle-alert " ) ,
2025-12-30 22:08:21 +01:00
TextView ( * c ) ,
2025-04-05 13:08:12 +02:00
) ,
cls = AlertT . error ,
)
2025-12-30 22:08:21 +01:00
def ConfigButton ( * c : Any , cls : Optional [ Union [ str , tuple ] ] = None , * * kwargs : Any ) - > Button :
""" Creates a styled button for configuration actions.
Args :
* c ( Any ) : Positional arguments representing the button ' s content.
cls ( Optional [ Union [ str , tuple ] ] ) : Additional CSS classes for styling . Defaults to None .
* * kwargs ( Any ) : Additional keyword arguments passed to the ` Button ` .
Returns :
Button : A styled ` Button ` component for configuration actions .
"""
new_cls = f " px-4 py-2 rounded { ButtonT . primary } "
if cls :
new_cls + = f " { stringify ( cls ) } "
kwargs [ " cls " ] = new_cls
return Button ( * c , submit = False , * * kwargs )
2026-03-11 17:18:45 +01:00
def UpdateError ( error_text : str ) - > Alert :
""" Renders a compact error with collapsible full detail.
Extracts the short pydantic validation message ( text after
' validation error for ... ' ) as the summary . Falls back to
the first line if no match is found .
Args :
error_text : The full error string from a config update failure .
Returns :
Alert : A collapsible error element with error styling .
"""
short = None
match = re . search ( r " validation error for [^ \ n]+ \ n([^ \ n]+) \ n \ s+([^ \ []+) " , error_text )
if match :
short = f " Validation error: { match . group ( 1 ) . strip ( ) } : { match . group ( 2 ) . strip ( ) } "
if not short :
short = error_text . splitlines ( ) [ 0 ] . strip ( )
return Alert (
Details (
Summary (
DivLAligned (
UkIcon ( " triangle-alert " ) ,
P ( short , cls = " text-sm ml-2 " ) ,
) ,
cls = " list-none cursor-pointer " ,
) ,
Pre (
Code ( error_text , cls = " language-python " ) ,
cls = " rounded-lg bg-muted p-3 mt-2 max-h-[30vh] overflow-y-auto overflow-x-hidden whitespace-pre-wrap text-xs " ,
) ,
) ,
cls = AlertT . error ,
)
2025-12-30 22:08:21 +01:00
def make_config_update_form ( ) - > Callable [ [ str , str ] , Grid ] :
""" Factory for a form that sets a single configuration value.
Returns :
A function ( config_name : str , value : str ) - > Grid
"""
def ConfigUpdateForm ( config_name : str , value : str ) - > Grid :
config_id = config_name . lower ( ) . replace ( " . " , " - " )
return Grid (
DivRAligned ( P ( " update " ) ) ,
Grid (
Form (
Input ( value = " update " , type = " hidden " , id = " action " ) ,
Input ( value = config_name , type = " hidden " , id = " key " ) ,
Input ( value = value , type = " text " , id = " value " ) ,
hx_put = request_url_for ( " /eosdash/configuration " ) ,
hx_target = " #page-content " ,
hx_swap = " innerHTML " ,
) ,
) ,
id = f " { config_id } -update-form " ,
)
return ConfigUpdateForm
def make_config_update_value_form (
available_values : list [ str ] ,
) - > Callable [ [ str , str ] , Grid ] :
""" Factory for a form that sets a single configuration value with pre-set avaliable values.
Args :
available_values : Allowed values for the configuration
Returns :
A function ( config_name : str , value : str ) - > Grid
"""
def ConfigUpdateValueForm ( config_name : str , value : str ) - > Grid :
config_id = config_name . lower ( ) . replace ( " . " , " - " )
return Grid (
DivRAligned ( P ( " update value " ) ) ,
DivHStacked (
ConfigButton (
" Set " ,
hx_put = request_url_for ( " /eosdash/configuration " ) ,
hx_target = " #page-content " ,
hx_swap = " innerHTML " ,
hx_vals = f """ js: {{
action : " update " ,
key : " {config_name} " ,
value : document
. querySelector ( " [name= ' {config_id} _selected_value ' ] " )
. value
} } """ ,
) ,
Select (
Option ( " Select a value... " , value = " " , selected = True , disabled = True ) ,
* [
Option (
val ,
value = val ,
selected = ( val == value ) ,
)
for val in available_values
] ,
id = f " { config_id } -value-select " ,
name = f " { config_id } _selected_value " ,
required = True ,
cls = " border rounded px-3 py-2 mr-2 col-span-4 " ,
) ,
) ,
id = f " { config_id } -update-value-form " ,
)
return ConfigUpdateValueForm
def make_config_update_list_form ( available_values : list [ str ] ) - > Callable [ [ str , str ] , Grid ] :
""" Factory function that creates a ConfigUpdateListForm with pre-set available values.
Args :
available_values : List of available values to choose from
Returns :
A function that creates ConfigUpdateListForm instances with the given available_values .
The returned function takes ( config_name : str , value : str ) and returns a Grid .
"""
def ConfigUpdateListForm ( config_name : str , value : str ) - > Grid :
""" Creates a card with a form to add/remove values from a list.
Sends to " /eosdash/configuration " :
The form sends an HTTP PUT request with the following parameters :
- key ( str ) : The configuration key name ( value of config_name parameter )
- value ( str ) : A JSON string representing the updated list of values
The value parameter will always be a valid JSON string representation of a list .
Args :
config_name : The name of the configuration
value ( str ) : The current value of the configuration , a list of values in json format .
"""
current_values = json . loads ( value )
if current_values is None :
current_values = [ ]
config_id = config_name . lower ( ) . replace ( " . " , " - " )
return Grid (
DivRAligned ( P ( " update list " ) ) ,
Grid (
# Form to add new value to list
DivHStacked (
ConfigButton (
" Add " ,
hx_put = request_url_for ( " /eosdash/configuration " ) ,
hx_target = " #page-content " ,
hx_swap = " innerHTML " ,
hx_vals = f """ js: {{
action : " update " ,
key : " {config_name} " ,
value : JSON . stringify (
[ . . . new Set ( [
. . . { json . dumps ( current_values ) } ,
document . querySelector ( " [name= ' {config_id} _selected_add_value ' ] " ) . value . trim ( )
] ) ] . filter ( v = > v != = " " )
)
} } """ ,
) ,
Select (
Option ( " Select a value... " , value = " " , selected = True , disabled = True ) ,
* [
Option ( val , value = val , disabled = val in current_values )
for val in available_values
] ,
id = f " { config_id } -add-value-select " ,
name = f " { config_id } _selected_add_value " , # Name of hidden input with selected value
required = True ,
cls = " border rounded px-3 py-2 mr-2 col-span-4 " ,
) ,
) ,
# Form to delete value from list
DivHStacked (
ConfigButton (
" Delete " ,
hx_put = request_url_for ( " /eosdash/configuration " ) ,
hx_target = " #page-content " ,
hx_swap = " innerHTML " ,
hx_vals = f """ js: {{
action : " update " ,
key : " {config_name} " ,
value : JSON . stringify (
[ . . . new Set ( [
. . . { json . dumps ( current_values ) }
] ) ] . filter ( v = > v != = document . querySelector ( " [name= ' {config_id} _selected_delete_value ' ] " ) . value . trim ( ) )
)
} } """ ,
) ,
Select (
Option ( " Select a value... " , value = " " , selected = True , disabled = True ) ,
* [ Option ( val , value = val ) for val in current_values ] ,
id = f " { config_id } -delete-value-select " ,
name = f " { config_id } _selected_delete_value " , # Name of hidden input with selected value
required = True ,
cls = " border rounded px-3 py-2 mr-2 col-span-4 " ,
) ,
) ,
cols = 1 ,
) ,
id = f " { config_id } -update-list-form " ,
)
# Return the function that creates a ConfigUpdateListForm instance
return ConfigUpdateListForm
def make_config_update_map_form (
available_keys : list [ str ] | None = None ,
available_values : list [ str ] | None = None ,
) - > Callable [ [ str , str ] , Grid ] :
""" Factory function that creates a ConfigUpdateMapForm.
Args :
available_keys : Optional list of allowed keys ( None = free text )
available_values : Optional list of allowed values ( None = free text )
Returns :
A function that creates ConfigUpdateMapForm instances .
The returned function takes ( config_name : str , value : str ) and returns a Grid .
"""
def ConfigUpdateMapForm ( config_name : str , value : str ) - > Grid :
""" Creates a card with a form to add/update/delete entries in a map. """
current_map : dict [ str , str ] = json . loads ( value ) or { }
config_id = config_name . lower ( ) . replace ( " . " , " - " )
return Grid (
DivRAligned ( P ( " update map " ) ) ,
Grid (
# Add / update key-value pair
DivHStacked (
ConfigButton (
" Set " ,
hx_put = request_url_for ( " /eosdash/configuration " ) ,
hx_target = " #page-content " ,
hx_swap = " innerHTML " ,
hx_vals = f """ js: {{
action : " update " ,
key : " {config_name} " ,
value : JSON . stringify (
Object . assign (
{ json . dumps ( current_map ) } ,
{ {
[ document . querySelector ( " [name= ' {config_id} _set_key ' ] " ) . value . trim ( ) ] :
document . querySelector ( " [name= ' {config_id} _set_value ' ] " ) . value . trim ( )
} }
)
)
} } """ ,
) ,
(
Select (
Option ( " Select key... " , value = " " , selected = True , disabled = True ) ,
* [ Option ( k , value = k ) for k in ( sorted ( available_keys ) or [ ] ) ] ,
name = f " { config_id } _set_key " ,
cls = " border rounded px-3 py-2 col-span-2 " ,
)
if available_keys
else Input (
name = f " { config_id } _set_key " ,
placeholder = " Key " ,
required = True ,
cls = " border rounded px-3 py-2 col-span-2 " ,
) ,
) ,
(
Select (
Option ( " Select value... " , value = " " , selected = True , disabled = True ) ,
* [ Option ( k , value = k ) for k in ( sorted ( available_values ) or [ ] ) ] ,
name = f " { config_id } _set_value " ,
cls = " border rounded px-3 py-2 col-span-2 " ,
)
if available_values
else Input (
name = f " { config_id } _set_value " ,
placeholder = " Value " ,
required = True ,
cls = " border rounded px-3 py-2 col-span-2 " ,
) ,
) ,
) ,
# Delete key
DivHStacked (
ConfigButton (
" Delete " ,
hx_put = request_url_for ( " /eosdash/configuration " ) ,
hx_target = " #page-content " ,
hx_swap = " innerHTML " ,
hx_vals = f """ js: {{
action : " update " ,
key : " {config_name} " ,
value : JSON . stringify (
Object . fromEntries (
Object . entries ( { json . dumps ( current_map ) } )
. filter ( ( [ k ] ) = >
k != = document . querySelector ( " [name= ' {config_id} _delete_key ' ] " ) . value
)
)
)
} } """ ,
) ,
Select (
Option ( " Select key... " , value = " " , selected = True , disabled = True ) ,
* [ Option ( k , value = k ) for k in sorted ( current_map . keys ( ) ) ] ,
name = f " { config_id } _delete_key " ,
required = True ,
cls = " border rounded px-3 py-2 col-span-4 " ,
) ,
) ,
cols = 1 ,
) ,
id = f " { config_id } -update-map-form " ,
)
return ConfigUpdateMapForm
2026-03-11 17:18:45 +01:00
def make_config_update_time_windows_windows_form (
value_description : Optional [ str ] = None ,
) - > Callable [ [ str , str ] , Grid ] :
""" Factory for a form that edits the windows field of a TimeWindowSequence.
Args :
value_description : If given , a numeric value field is included in the form
and shown in the column header ( e . g . " electricity_price_kwh [Amt/kWh] " ) .
If None , no value field is rendered .
"""
def ConfigUpdateTimeWindowsWindowsForm ( config_name : str , value : str ) - > Grid :
config_id = config_name . lower ( ) . replace ( " . " , " - " )
try :
parsed = json . loads ( value )
current_windows : list [ dict ] = parsed if isinstance ( parsed , list ) else [ ]
except ( json . JSONDecodeError , AttributeError ) :
current_windows = [ ]
DOW_LABELS = [
" 0 – Monday " ,
" 1 – Tuesday " ,
" 2 – Wednesday " ,
" 3 – Thursday " ,
" 4 – Friday " ,
" 5 – Saturday " ,
" 6 – Sunday " ,
]
# ---- Existing windows rows ----
window_rows = [ ]
for idx , win in enumerate ( current_windows ) :
start_time = win . get ( " start_time " , " " )
duration = win . get ( " duration " , " " )
dow = win . get ( " day_of_week " )
date_val = win . get ( " date " )
locale_val = win . get ( " locale " )
dow_str = f " dow= { dow } " if dow is not None else " "
date_str = f " date= { date_val } " if date_val else " "
locale_str = f " locale= { locale_val } " if locale_val else " "
if value_description is not None :
val = win . get ( " value " , " " )
val_str = f " | { val } { value_description } "
else :
val_str = " "
label = f " { start_time } | { duration } { val_str } { dow_str } { date_str } { locale_str } "
remaining = [ w for i , w in enumerate ( current_windows ) if i != idx ]
remaining_json = json . dumps ( json . dumps ( remaining ) )
window_rows . append (
DivHStacked (
ConfigButton (
UkIcon ( " trash-2 " ) ,
hx_put = request_url_for ( " /eosdash/configuration " ) ,
hx_target = " #page-content " ,
hx_swap = " innerHTML " ,
hx_vals = f ' js: {{ action: " update " , key: " { config_name } " , value: { remaining_json } }} ' ,
cls = " px-2 py-1 " ,
) ,
P ( label , cls = " ml-2 text-sm font-mono " ) ,
)
)
# ---- Column headers and inputs ----
num_cols = 5 + ( 1 if value_description is not None else 0 )
header_cols = [
P ( " start_time * " , cls = " text-xs text-muted-foreground font-semibold " ) ,
P ( " duration * " , cls = " text-xs text-muted-foreground font-semibold " ) ,
]
input_cols = [
Input (
placeholder = " e.g. 08:00 Europe/Berlin " ,
name = f " { config_id } _tw_start_time " ,
cls = " border rounded px-2 py-1 text-sm " ,
) ,
Input (
placeholder = " e.g. 8 hours " ,
name = f " { config_id } _tw_duration " ,
cls = " border rounded px-2 py-1 text-sm " ,
) ,
]
if value_description is not None :
header_cols . append (
P ( f " { value_description } * " , cls = " text-xs text-muted-foreground font-semibold " )
)
input_cols . append (
Input (
placeholder = " e.g. 0.288 " ,
name = f " { config_id } _tw_value " ,
type = " number " ,
step = " 0.001 " ,
cls = " border rounded px-2 py-1 text-sm " ,
)
)
header_cols + = [
P ( " day_of_week " , cls = " text-xs text-muted-foreground font-semibold " ) ,
P ( " date (YYYY-MM-DD) " , cls = " text-xs text-muted-foreground font-semibold " ) ,
P ( " locale " , cls = " text-xs text-muted-foreground font-semibold " ) ,
]
input_cols + = [
Select (
Option ( " — any day — " , value = " " , selected = True ) ,
* [ Option ( lbl , value = str ( i ) ) for i , lbl in enumerate ( DOW_LABELS ) ] ,
name = f " { config_id } _tw_dow " ,
cls = " border rounded px-2 py-1 text-sm " ,
) ,
Input (
placeholder = " e.g. 2025-12-24 " ,
name = f " { config_id } _tw_date " ,
cls = " border rounded px-2 py-1 text-sm " ,
) ,
Input (
placeholder = " e.g. de " ,
name = f " { config_id } _tw_locale " ,
cls = " border rounded px-2 py-1 text-sm " ,
) ,
]
# ---- JS for Add button ----
current_json = json . dumps ( json . dumps ( current_windows ) )
if value_description is not None :
val_js_read = f " const val = parseFloat(document.querySelector( \" [name= ' { config_id } _tw_value ' ] \" ).value); "
val_js_guard = " isNaN(val) "
val_js_field = " value: val, "
else :
val_js_read = " "
val_js_guard = " false "
val_js_field = " "
add_section = Grid (
Grid ( * header_cols , cols = num_cols ) ,
Grid ( * input_cols , cols = num_cols ) ,
ConfigButton (
UkIcon ( " plus " ) ,
" Add window " ,
hx_put = request_url_for ( " /eosdash/configuration " ) ,
hx_target = " #page-content " ,
hx_swap = " innerHTML " ,
hx_vals = f """ js: {{
action : " update " ,
key : " {config_name} " ,
value : ( ( ) = > { {
const start = document . querySelector ( " [name= ' {config_id} _tw_start_time ' ] " ) . value . trim ( ) ;
const dur = document . querySelector ( " [name= ' {config_id} _tw_duration ' ] " ) . value . trim ( ) ;
{ val_js_read }
const dowRaw = document . querySelector ( " [name= ' {config_id} _tw_dow ' ] " ) . value ;
const date = document . querySelector ( " [name= ' {config_id} _tw_date ' ] " ) . value . trim ( ) ;
const locale = document . querySelector ( " [name= ' {config_id} _tw_locale ' ] " ) . value . trim ( ) ;
if ( ! start | | ! dur | | { val_js_guard } ) return { current_json } ;
const newWin = { {
start_time : start ,
duration : dur ,
{ val_js_field }
day_of_week : dowRaw != = " " ? parseInt ( dowRaw ) : null ,
date : date != = " " ? date : null ,
locale : locale != = " " ? locale : null ,
} } ;
const existing = { json . dumps ( current_windows ) } ;
existing . push ( newWin ) ;
return JSON . stringify ( existing ) ;
} } ) ( )
} } """ ,
) ,
cols = 1 ,
cls = " gap-2 mt-2 " ,
)
return Grid (
DivRAligned ( P ( " update time windows " ) ) ,
Grid (
* window_rows ,
P ( " Add new window " , cls = " text-sm font-semibold mt-3 mb-1 " ) ,
P (
" * required | day_of_week: overridden by date if both set " ,
cls = " text-xs text-muted-foreground mb-1 " ,
) ,
add_section ,
cols = 1 ,
cls = " gap-1 " ,
) ,
id = f " { config_id } -update-time-windows-windows-form " ,
)
return ConfigUpdateTimeWindowsWindowsForm
2025-01-22 23:47:28 +01:00
def ConfigCard (
2025-03-27 21:53:01 +01:00
config_name : str ,
config_type : str ,
read_only : str ,
value : str ,
default : str ,
description : str ,
2025-06-10 22:00:28 +02:00
deprecated : Optional [ Union [ str , bool ] ] ,
2025-03-27 21:53:01 +01:00
update_error : Optional [ str ] ,
update_value : Optional [ str ] ,
update_open : Optional [ bool ] ,
2025-12-30 22:08:21 +01:00
update_form_factory : Optional [ Callable [ [ str , str ] , Grid ] ] = None ,
2025-01-22 23:47:28 +01:00
) - > Card :
2025-04-05 13:08:12 +02:00
""" Creates a styled configuration card for displaying configuration details.
This function generates a configuration card that is displayed in the UI with
various sections such as configuration name , type , description , default value ,
current value , and error details . It supports both read - only and editable modes .
Args :
config_name ( str ) : The name of the configuration .
config_type ( str ) : The type of the configuration .
read_only ( str ) : Indicates if the configuration is read - only ( " rw " for read - write ,
2025-12-30 22:08:21 +01:00
any other value indicates read - only ) .
2025-04-05 13:08:12 +02:00
value ( str ) : The current value of the configuration .
default ( str ) : The default value of the configuration .
description ( str ) : A description of the configuration .
2025-06-10 22:00:28 +02:00
deprecated ( Optional [ Union [ str , bool ] ] ) : The deprecated marker of the configuration .
2025-04-05 13:08:12 +02:00
update_error ( Optional [ str ] ) : The error message , if any , during the update process .
update_value ( Optional [ str ] ) : The value to be updated , if different from the current value .
update_open ( Optional [ bool ] ) : A flag indicating whether the update section of the card
2025-12-30 22:08:21 +01:00
should be initially expanded .
update_form_factory ( Optional [ Callable [ [ str , str ] , Grid ] ] ) : The factory to create a form to
use to update the configuration value . Defaults to simple text input .
2025-04-05 13:08:12 +02:00
Returns :
Card : A styled Card component containing the configuration details .
"""
2025-03-27 21:53:01 +01:00
config_id = config_name . replace ( " . " , " - " )
if not update_value :
update_value = value
if not update_open :
update_open = False
2025-12-30 22:08:21 +01:00
if not update_form_factory :
# Default update form
update_form = make_config_update_form ( ) ( config_name , update_value )
else :
update_form = update_form_factory ( config_name , update_value )
2025-06-10 22:00:28 +02:00
if deprecated :
if isinstance ( deprecated , bool ) :
deprecated = " Deprecated "
2025-01-22 23:47:28 +01:00
return Card (
Details (
Summary (
Grid (
Grid (
DivLAligned (
UkIcon ( icon = " play " ) ,
P ( config_name ) ,
) ,
DivRAligned (
P ( read_only ) ,
) ,
) ,
2025-12-30 22:08:21 +01:00
JsonView ( json . loads ( value ) ) ,
2025-01-22 23:47:28 +01:00
) ,
cls = " list-none " ,
) ,
Grid (
2025-12-30 22:08:21 +01:00
TextView ( description ) ,
2025-01-22 23:47:28 +01:00
P ( config_type ) ,
2025-06-10 22:00:28 +02:00
)
if not deprecated
else None ,
Grid (
P ( deprecated ) ,
P ( " DEPRECATED! " ) ,
)
if deprecated
else None ,
2025-03-27 21:53:01 +01:00
# Default
Grid (
DivRAligned ( P ( " default " ) ) ,
P ( default ) ,
)
2025-06-10 22:00:28 +02:00
if read_only == " rw " and not deprecated
2025-03-27 21:53:01 +01:00
else None ,
# Set value
2025-12-30 22:08:21 +01:00
update_form if read_only == " rw " and not deprecated else None ,
2025-03-27 21:53:01 +01:00
# Last error
Grid (
DivRAligned ( P ( " update error " ) ) ,
2026-03-11 17:18:45 +01:00
UpdateError ( update_error ) ,
2025-03-27 21:53:01 +01:00
)
if update_error
else None ,
2025-12-30 22:08:21 +01:00
# Provide minimal update form on error if complex update_form is used
make_config_update_form ( ) ( config_name , update_value )
if update_error and update_form_factory is not None
else None ,
2025-01-22 23:47:28 +01:00
cls = " space-y-4 gap-4 " ,
2025-03-27 21:53:01 +01:00
open = update_open ,
2025-01-22 23:47:28 +01:00
) ,
cls = " w-full " ,
)
def DashboardHeader ( title : Optional [ str ] ) - > Div :
""" Creates a styled header with a title.
Args :
title ( Optional [ str ] ) : The title text for the header .
Returns :
Div : A styled ` Div ` element containing the header .
"""
if title is None :
return Div ( " " , cls = " header " )
return Div ( H1 ( title , cls = " text-2xl font-bold mb-4 " ) , cls = " header " )
def DashboardFooter ( * c : Any , path : str ) - > Card :
""" Creates a styled footer with the provided information.
The footer content is reloaded every 5 seconds from path .
Args :
path ( str ) : Path to reload footer content from
Returns :
Card : A styled ` Card ` element containing the footer .
"""
return Card (
Container ( * c , id = " footer-content " ) ,
2025-12-30 22:08:21 +01:00
hx_get = request_url_for ( path ) ,
2025-01-22 23:47:28 +01:00
hx_trigger = " every 5s " ,
hx_target = " #footer-content " ,
hx_swap = " innerHTML " ,
)
def DashboardTrigger ( * c : Any , cls : Optional [ Union [ str , tuple ] ] = None , * * kwargs : Any ) - > Button :
""" Creates a styled button for the dashboard trigger.
Args :
* c : Positional arguments to pass to the button .
cls ( Optional [ str ] ) : Additional CSS classes for styling . Defaults to None .
* * kwargs : Additional keyword arguments for the button .
Returns :
Button : A styled ` Button ` component .
"""
fix: automatic optimization (#596)
This fix implements the long term goal to have the EOS server run optimization (or
energy management) on regular intervals automatically. Thus clients can request
the current energy management plan at any time and it is updated on regular
intervals without interaction by the client.
This fix started out to "only" make automatic optimization (or energy management)
runs working. It turned out there are several endpoints that in some way
update predictions or run the optimization. To lock against such concurrent attempts
the code had to be refactored to allow control of execution. During refactoring it
became clear that some classes and files are named without a proper reference
to their usage. Thus not only refactoring but also renaming became necessary.
The names are still not the best, but I hope they are more intuitive.
The fix includes several bug fixes that are not directly related to the automatic optimization
but are necessary to keep EOS running properly to do the automatic optimization and
to test and document the changes.
This is a breaking change as the configuration structure changed once again and
the server API was also enhanced and streamlined. The server API that is used by
Andreas and Jörg in their videos has not changed.
* fix: automatic optimization
Allow optimization to automatically run on configured intervals gathering all
optimization parameters from configuration and predictions. The automatic run
can be configured to only run prediction updates skipping the optimization.
Extend documentaion to also cover automatic optimization. Lock automatic runs
against runs initiated by the /optimize or other endpoints. Provide new
endpoints to retrieve the energy management plan and the genetic solution
of the latest automatic optimization run. Offload energy management to thread
pool executor to keep the app more responsive during the CPU heavy optimization
run.
* fix: EOS servers recognize environment variables on startup
Force initialisation of EOS configuration on server startup to assure
all sources of EOS configuration are properly set up and read. Adapt
server tests and configuration tests to also test for environment
variable configuration.
* fix: Remove 0.0.0.0 to localhost translation under Windows
EOS imposed a 0.0.0.0 to localhost translation under Windows for
convenience. This caused some trouble in user configurations. Now, as the
default IP address configuration is 127.0.0.1, the user is responsible
for to set up the correct Windows compliant IP address.
* fix: allow names for hosts additional to IP addresses
* fix: access pydantic model fields by class
Access by instance is deprecated.
* fix: down sampling key_to_array
* fix: make cache clear endpoint clear all cache files
Make /v1/admin/cache/clear clear all cache files. Before it only cleared
expired cache files by default. Add new endpoint /v1/admin/clear-expired
to only clear expired cache files.
* fix: timezonefinder returns Europe/Paris instead of Europe/Berlin
timezonefinder 8.10 got more inaccurate for timezones in europe as there is
a common timezone. Use new package tzfpy instead which is still returning
Europe/Berlin if you are in Germany. tzfpy also claims to be faster than
timezonefinder.
* fix: provider settings configuration
Provider configuration used to be a union holding the settings for several
providers. Pydantic union handling does not always find the correct type
for a provider setting. This led to exceptions in specific configurations.
Now provider settings are explicit comfiguration items for each possible
provider. This is a breaking change as the configuration structure was
changed.
* fix: ClearOutside weather prediction irradiance calculation
Pvlib needs a pandas time index. Convert time index.
* fix: test config file priority
Do not use config_eos fixture as this fixture already creates a config file.
* fix: optimization sample request documentation
Provide all data in documentation of optimization sample request.
* fix: gitlint blocking pip dependency resolution
Replace gitlint by commitizen. Gitlint is not actively maintained anymore.
Gitlint dependencies blocked pip from dependency resolution.
* fix: sync pre-commit config to actual dependency requirements
.pre-commit-config.yaml was out of sync, also requirements-dev.txt.
* fix: missing babel in requirements.txt
Add babel to requirements.txt
* feat: setup default device configuration for automatic optimization
In case the parameters for automatic optimization are not fully defined a
default configuration is setup to allow the automatic energy management
run. The default configuration may help the user to correctly define
the device configuration.
* feat: allow configuration of genetic algorithm parameters
The genetic algorithm parameters for number of individuals, number of
generations, the seed and penalty function parameters are now avaliable
as configuration options.
* feat: allow configuration of home appliance time windows
The time windows a home appliance is allowed to run are now configurable
by the configuration (for /v1 API) and also by the home appliance parameters
(for the classic /optimize API). If there is no such configuration the
time window defaults to optimization hours, which was the standard before
the change. Documentation on how to configure time windows is added.
* feat: standardize mesaurement keys for battery/ ev SoC measurements
The standardized measurement keys to report battery SoC to the device
simulations can now be retrieved from the device configuration as a
read-only config option.
* feat: feed in tariff prediction
Add feed in tarif predictions needed for automatic optimization. The feed in
tariff can be retrieved as fixed feed in tarif or can be imported. Also add
tests for the different feed in tariff providers. Extend documentation to
cover the feed in tariff providers.
* feat: add energy management plan based on S2 standard instructions
EOS can generate an energy management plan as a list of simple instructions.
May be retrieved by the /v1/energy-management/plan endpoint. The instructions
loosely follow the S2 energy management standard.
* feat: make measurement keys configurable by EOS configuration.
The fixed measurement keys are replaced by configurable measurement keys.
* feat: make pendulum DateTime, Date, Duration types usable for pydantic models
Use pydantic_extra_types.pendulum_dt to get pydantic pendulum types. Types are
added to the datetimeutil utility. Remove custom made pendulum adaptations
from EOS pydantic module. Make EOS modules use the pydantic pendulum types
managed by the datetimeutil module instead of the core pendulum types.
* feat: Add Time, TimeWindow, TimeWindowSequence and to_time to datetimeutil.
The time windows are are added to support home appliance time window
configuration. All time classes are also pydantic models. Time is the base
class for time definition derived from pendulum.Time.
* feat: Extend DataRecord by configurable field like data.
Configurable field like data was added to support the configuration of
measurement records.
* feat: Add additional information to health information
Version information is added to the health endpoints of eos and eosDash.
The start time of the last optimization and the latest run time of the energy
management is added to the EOS health information.
* feat: add pydantic merge model tests
* feat: add plan tab to EOSdash
The plan tab displays the current energy management instructions.
* feat: add predictions tab to EOSdash
The predictions tab displays the current predictions.
* feat: add cache management to EOSdash admin tab
The admin tab is extended by a section for cache management. It allows to
clear the cache.
* feat: add about tab to EOSdash
The about tab resembles the former hello tab and provides extra information.
* feat: Adapt changelog and prepare for release management
Release management using commitizen is added. The changelog file is adapted and
teh changelog and a description for release management is added in the
documentation.
* feat(doc): Improve install and devlopment documentation
Provide a more concise installation description in Readme.md and add extra
installation page and development page to documentation.
* chore: Use memory cache for interpolation instead of dict in inverter
Decorate calculate_self_consumption() with @cachemethod_until_update to cache
results in memory during an energy management/ optimization run. Replacement
of dict type caching in inverter is now possible because all optimization
runs are properly locked and the memory cache CacheUntilUpdateStore is properly
cleared at the start of any energy management/ optimization operation.
* chore: refactor genetic
Refactor the genetic algorithm modules for enhanced module structure and better
readability. Removed unnecessary and overcomplex devices singleton. Also
split devices configuration from genetic algorithm parameters to allow further
development independently from genetic algorithm parameter format. Move
charge rates configuration for electric vehicles from optimization to devices
configuration to allow to have different charge rates for different cars in
the future.
* chore: Rename memory cache to CacheEnergyManagementStore
The name better resembles the task of the cache to chache function and method
results for an energy management run. Also the decorator functions are renamed
accordingly: cachemethod_energy_management, cache_energy_management
* chore: use class properties for config/ems/prediction mixin classes
* chore: skip debug logs from mathplotlib
Mathplotlib is very noisy in debug mode.
* chore: automatically sync bokeh js to bokeh python package
bokeh was updated to 3.8.0, make JS CDN automatically follow the package version.
* chore: rename hello.py to about.py
Make hello.py the adapted EOSdash about page.
* chore: remove demo page from EOSdash
As no the plan and prediction pages are working without configuration, the demo
page is no longer necessary
* chore: split test_server.py for system test
Split test_server.py to create explicit test_system.py for system tests.
* chore: move doc utils to generate_config_md.py
The doc utils are only used in scripts/generate_config_md.py. Move it there to
attribute for strong cohesion.
* chore: improve pydantic merge model documentation
* chore: remove pendulum warning from readme
* chore: remove GitHub discussions from contributing documentation
Github discussions is to be replaced by Akkudoktor.net.
* chore(release): bump version to 0.1.0+dev for development
* build(deps): bump fastapi[standard] from 0.115.14 to 0.117.1
bump fastapi and make coverage version (for pytest-cov) explicit to avoid pip break.
* build(deps): bump uvicorn from 0.36.0 to 0.37.0
BREAKING CHANGE: EOS configuration changed. V1 API changed.
- The available_charge_rates_percent configuration is removed from optimization.
Use the new charge_rate configuration for the electric vehicle
- Optimization configuration parameter hours renamed to horizon_hours
- Device configuration now has to provide the number of devices and device
properties per device.
- Specific prediction provider configuration to be provided by explicit
configuration item (no union for all providers).
- Measurement keys to be provided as a list.
- New feed in tariff providers have to be configured.
- /v1/measurement/loadxxx endpoints are removed. Use generic mesaurement endpoints.
- /v1/admin/cache/clear now clears all cache files. Use
/v1/admin/cache/clear-expired to only clear all expired cache files.
Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
2025-10-28 02:50:31 +01:00
# new_cls = f"{ButtonT.primary} uk-border-rounded uk-padding-small"
new_cls = " uk-btn uk-btn-primary uk-border-rounded uk-padding-medium "
2025-01-22 23:47:28 +01:00
if cls :
new_cls + = f " { stringify ( cls ) } "
kwargs [ " cls " ] = new_cls
return Button ( * c , submit = False , * * kwargs )
def DashboardTabs ( dashboard_items : dict [ str , str ] ) - > Card :
""" Creates a dashboard tab with dynamic dashboard items.
Args :
dashboard_items ( dict [ str , str ] ) : A dictionary of dashboard items where keys are item names
and values are paths for navigation .
Returns :
Card : A styled ` Card ` component containing the dashboard tabs .
"""
dash_items = [
Li (
DashboardTrigger (
2025-04-05 13:08:12 +02:00
H3 ( menu ) ,
2025-12-30 22:08:21 +01:00
hx_get = request_url_for ( path ) ,
2025-01-22 23:47:28 +01:00
hx_target = " #page-content " ,
hx_swap = " innerHTML " ,
fix: automatic optimization (#596)
This fix implements the long term goal to have the EOS server run optimization (or
energy management) on regular intervals automatically. Thus clients can request
the current energy management plan at any time and it is updated on regular
intervals without interaction by the client.
This fix started out to "only" make automatic optimization (or energy management)
runs working. It turned out there are several endpoints that in some way
update predictions or run the optimization. To lock against such concurrent attempts
the code had to be refactored to allow control of execution. During refactoring it
became clear that some classes and files are named without a proper reference
to their usage. Thus not only refactoring but also renaming became necessary.
The names are still not the best, but I hope they are more intuitive.
The fix includes several bug fixes that are not directly related to the automatic optimization
but are necessary to keep EOS running properly to do the automatic optimization and
to test and document the changes.
This is a breaking change as the configuration structure changed once again and
the server API was also enhanced and streamlined. The server API that is used by
Andreas and Jörg in their videos has not changed.
* fix: automatic optimization
Allow optimization to automatically run on configured intervals gathering all
optimization parameters from configuration and predictions. The automatic run
can be configured to only run prediction updates skipping the optimization.
Extend documentaion to also cover automatic optimization. Lock automatic runs
against runs initiated by the /optimize or other endpoints. Provide new
endpoints to retrieve the energy management plan and the genetic solution
of the latest automatic optimization run. Offload energy management to thread
pool executor to keep the app more responsive during the CPU heavy optimization
run.
* fix: EOS servers recognize environment variables on startup
Force initialisation of EOS configuration on server startup to assure
all sources of EOS configuration are properly set up and read. Adapt
server tests and configuration tests to also test for environment
variable configuration.
* fix: Remove 0.0.0.0 to localhost translation under Windows
EOS imposed a 0.0.0.0 to localhost translation under Windows for
convenience. This caused some trouble in user configurations. Now, as the
default IP address configuration is 127.0.0.1, the user is responsible
for to set up the correct Windows compliant IP address.
* fix: allow names for hosts additional to IP addresses
* fix: access pydantic model fields by class
Access by instance is deprecated.
* fix: down sampling key_to_array
* fix: make cache clear endpoint clear all cache files
Make /v1/admin/cache/clear clear all cache files. Before it only cleared
expired cache files by default. Add new endpoint /v1/admin/clear-expired
to only clear expired cache files.
* fix: timezonefinder returns Europe/Paris instead of Europe/Berlin
timezonefinder 8.10 got more inaccurate for timezones in europe as there is
a common timezone. Use new package tzfpy instead which is still returning
Europe/Berlin if you are in Germany. tzfpy also claims to be faster than
timezonefinder.
* fix: provider settings configuration
Provider configuration used to be a union holding the settings for several
providers. Pydantic union handling does not always find the correct type
for a provider setting. This led to exceptions in specific configurations.
Now provider settings are explicit comfiguration items for each possible
provider. This is a breaking change as the configuration structure was
changed.
* fix: ClearOutside weather prediction irradiance calculation
Pvlib needs a pandas time index. Convert time index.
* fix: test config file priority
Do not use config_eos fixture as this fixture already creates a config file.
* fix: optimization sample request documentation
Provide all data in documentation of optimization sample request.
* fix: gitlint blocking pip dependency resolution
Replace gitlint by commitizen. Gitlint is not actively maintained anymore.
Gitlint dependencies blocked pip from dependency resolution.
* fix: sync pre-commit config to actual dependency requirements
.pre-commit-config.yaml was out of sync, also requirements-dev.txt.
* fix: missing babel in requirements.txt
Add babel to requirements.txt
* feat: setup default device configuration for automatic optimization
In case the parameters for automatic optimization are not fully defined a
default configuration is setup to allow the automatic energy management
run. The default configuration may help the user to correctly define
the device configuration.
* feat: allow configuration of genetic algorithm parameters
The genetic algorithm parameters for number of individuals, number of
generations, the seed and penalty function parameters are now avaliable
as configuration options.
* feat: allow configuration of home appliance time windows
The time windows a home appliance is allowed to run are now configurable
by the configuration (for /v1 API) and also by the home appliance parameters
(for the classic /optimize API). If there is no such configuration the
time window defaults to optimization hours, which was the standard before
the change. Documentation on how to configure time windows is added.
* feat: standardize mesaurement keys for battery/ ev SoC measurements
The standardized measurement keys to report battery SoC to the device
simulations can now be retrieved from the device configuration as a
read-only config option.
* feat: feed in tariff prediction
Add feed in tarif predictions needed for automatic optimization. The feed in
tariff can be retrieved as fixed feed in tarif or can be imported. Also add
tests for the different feed in tariff providers. Extend documentation to
cover the feed in tariff providers.
* feat: add energy management plan based on S2 standard instructions
EOS can generate an energy management plan as a list of simple instructions.
May be retrieved by the /v1/energy-management/plan endpoint. The instructions
loosely follow the S2 energy management standard.
* feat: make measurement keys configurable by EOS configuration.
The fixed measurement keys are replaced by configurable measurement keys.
* feat: make pendulum DateTime, Date, Duration types usable for pydantic models
Use pydantic_extra_types.pendulum_dt to get pydantic pendulum types. Types are
added to the datetimeutil utility. Remove custom made pendulum adaptations
from EOS pydantic module. Make EOS modules use the pydantic pendulum types
managed by the datetimeutil module instead of the core pendulum types.
* feat: Add Time, TimeWindow, TimeWindowSequence and to_time to datetimeutil.
The time windows are are added to support home appliance time window
configuration. All time classes are also pydantic models. Time is the base
class for time definition derived from pendulum.Time.
* feat: Extend DataRecord by configurable field like data.
Configurable field like data was added to support the configuration of
measurement records.
* feat: Add additional information to health information
Version information is added to the health endpoints of eos and eosDash.
The start time of the last optimization and the latest run time of the energy
management is added to the EOS health information.
* feat: add pydantic merge model tests
* feat: add plan tab to EOSdash
The plan tab displays the current energy management instructions.
* feat: add predictions tab to EOSdash
The predictions tab displays the current predictions.
* feat: add cache management to EOSdash admin tab
The admin tab is extended by a section for cache management. It allows to
clear the cache.
* feat: add about tab to EOSdash
The about tab resembles the former hello tab and provides extra information.
* feat: Adapt changelog and prepare for release management
Release management using commitizen is added. The changelog file is adapted and
teh changelog and a description for release management is added in the
documentation.
* feat(doc): Improve install and devlopment documentation
Provide a more concise installation description in Readme.md and add extra
installation page and development page to documentation.
* chore: Use memory cache for interpolation instead of dict in inverter
Decorate calculate_self_consumption() with @cachemethod_until_update to cache
results in memory during an energy management/ optimization run. Replacement
of dict type caching in inverter is now possible because all optimization
runs are properly locked and the memory cache CacheUntilUpdateStore is properly
cleared at the start of any energy management/ optimization operation.
* chore: refactor genetic
Refactor the genetic algorithm modules for enhanced module structure and better
readability. Removed unnecessary and overcomplex devices singleton. Also
split devices configuration from genetic algorithm parameters to allow further
development independently from genetic algorithm parameter format. Move
charge rates configuration for electric vehicles from optimization to devices
configuration to allow to have different charge rates for different cars in
the future.
* chore: Rename memory cache to CacheEnergyManagementStore
The name better resembles the task of the cache to chache function and method
results for an energy management run. Also the decorator functions are renamed
accordingly: cachemethod_energy_management, cache_energy_management
* chore: use class properties for config/ems/prediction mixin classes
* chore: skip debug logs from mathplotlib
Mathplotlib is very noisy in debug mode.
* chore: automatically sync bokeh js to bokeh python package
bokeh was updated to 3.8.0, make JS CDN automatically follow the package version.
* chore: rename hello.py to about.py
Make hello.py the adapted EOSdash about page.
* chore: remove demo page from EOSdash
As no the plan and prediction pages are working without configuration, the demo
page is no longer necessary
* chore: split test_server.py for system test
Split test_server.py to create explicit test_system.py for system tests.
* chore: move doc utils to generate_config_md.py
The doc utils are only used in scripts/generate_config_md.py. Move it there to
attribute for strong cohesion.
* chore: improve pydantic merge model documentation
* chore: remove pendulum warning from readme
* chore: remove GitHub discussions from contributing documentation
Github discussions is to be replaced by Akkudoktor.net.
* chore(release): bump version to 0.1.0+dev for development
* build(deps): bump fastapi[standard] from 0.115.14 to 0.117.1
bump fastapi and make coverage version (for pytest-cov) explicit to avoid pip break.
* build(deps): bump uvicorn from 0.36.0 to 0.37.0
BREAKING CHANGE: EOS configuration changed. V1 API changed.
- The available_charge_rates_percent configuration is removed from optimization.
Use the new charge_rate configuration for the electric vehicle
- Optimization configuration parameter hours renamed to horizon_hours
- Device configuration now has to provide the number of devices and device
properties per device.
- Specific prediction provider configuration to be provided by explicit
configuration item (no union for all providers).
- Measurement keys to be provided as a list.
- New feed in tariff providers have to be configured.
- /v1/measurement/loadxxx endpoints are removed. Use generic mesaurement endpoints.
- /v1/admin/cache/clear now clears all cache files. Use
/v1/admin/cache/clear-expired to only clear all expired cache files.
Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
2025-10-28 02:50:31 +01:00
hx_vals = ' js: { " dark " : window.matchMedia( " (prefers-color-scheme: dark) " ).matches } ' ,
2025-01-22 23:47:28 +01:00
) ,
)
for menu , path in dashboard_items . items ( )
]
return Card ( TabContainer ( * dash_items , cls = " gap-4 " ) , alt = True )
def DashboardContent ( content : Any ) - > Card :
""" Creates a content section within a styled card.
Args :
content ( Any ) : The content to display .
Returns :
Card : A styled ` Card ` element containing the content .
"""
fix: automatic optimization (#596)
This fix implements the long term goal to have the EOS server run optimization (or
energy management) on regular intervals automatically. Thus clients can request
the current energy management plan at any time and it is updated on regular
intervals without interaction by the client.
This fix started out to "only" make automatic optimization (or energy management)
runs working. It turned out there are several endpoints that in some way
update predictions or run the optimization. To lock against such concurrent attempts
the code had to be refactored to allow control of execution. During refactoring it
became clear that some classes and files are named without a proper reference
to their usage. Thus not only refactoring but also renaming became necessary.
The names are still not the best, but I hope they are more intuitive.
The fix includes several bug fixes that are not directly related to the automatic optimization
but are necessary to keep EOS running properly to do the automatic optimization and
to test and document the changes.
This is a breaking change as the configuration structure changed once again and
the server API was also enhanced and streamlined. The server API that is used by
Andreas and Jörg in their videos has not changed.
* fix: automatic optimization
Allow optimization to automatically run on configured intervals gathering all
optimization parameters from configuration and predictions. The automatic run
can be configured to only run prediction updates skipping the optimization.
Extend documentaion to also cover automatic optimization. Lock automatic runs
against runs initiated by the /optimize or other endpoints. Provide new
endpoints to retrieve the energy management plan and the genetic solution
of the latest automatic optimization run. Offload energy management to thread
pool executor to keep the app more responsive during the CPU heavy optimization
run.
* fix: EOS servers recognize environment variables on startup
Force initialisation of EOS configuration on server startup to assure
all sources of EOS configuration are properly set up and read. Adapt
server tests and configuration tests to also test for environment
variable configuration.
* fix: Remove 0.0.0.0 to localhost translation under Windows
EOS imposed a 0.0.0.0 to localhost translation under Windows for
convenience. This caused some trouble in user configurations. Now, as the
default IP address configuration is 127.0.0.1, the user is responsible
for to set up the correct Windows compliant IP address.
* fix: allow names for hosts additional to IP addresses
* fix: access pydantic model fields by class
Access by instance is deprecated.
* fix: down sampling key_to_array
* fix: make cache clear endpoint clear all cache files
Make /v1/admin/cache/clear clear all cache files. Before it only cleared
expired cache files by default. Add new endpoint /v1/admin/clear-expired
to only clear expired cache files.
* fix: timezonefinder returns Europe/Paris instead of Europe/Berlin
timezonefinder 8.10 got more inaccurate for timezones in europe as there is
a common timezone. Use new package tzfpy instead which is still returning
Europe/Berlin if you are in Germany. tzfpy also claims to be faster than
timezonefinder.
* fix: provider settings configuration
Provider configuration used to be a union holding the settings for several
providers. Pydantic union handling does not always find the correct type
for a provider setting. This led to exceptions in specific configurations.
Now provider settings are explicit comfiguration items for each possible
provider. This is a breaking change as the configuration structure was
changed.
* fix: ClearOutside weather prediction irradiance calculation
Pvlib needs a pandas time index. Convert time index.
* fix: test config file priority
Do not use config_eos fixture as this fixture already creates a config file.
* fix: optimization sample request documentation
Provide all data in documentation of optimization sample request.
* fix: gitlint blocking pip dependency resolution
Replace gitlint by commitizen. Gitlint is not actively maintained anymore.
Gitlint dependencies blocked pip from dependency resolution.
* fix: sync pre-commit config to actual dependency requirements
.pre-commit-config.yaml was out of sync, also requirements-dev.txt.
* fix: missing babel in requirements.txt
Add babel to requirements.txt
* feat: setup default device configuration for automatic optimization
In case the parameters for automatic optimization are not fully defined a
default configuration is setup to allow the automatic energy management
run. The default configuration may help the user to correctly define
the device configuration.
* feat: allow configuration of genetic algorithm parameters
The genetic algorithm parameters for number of individuals, number of
generations, the seed and penalty function parameters are now avaliable
as configuration options.
* feat: allow configuration of home appliance time windows
The time windows a home appliance is allowed to run are now configurable
by the configuration (for /v1 API) and also by the home appliance parameters
(for the classic /optimize API). If there is no such configuration the
time window defaults to optimization hours, which was the standard before
the change. Documentation on how to configure time windows is added.
* feat: standardize mesaurement keys for battery/ ev SoC measurements
The standardized measurement keys to report battery SoC to the device
simulations can now be retrieved from the device configuration as a
read-only config option.
* feat: feed in tariff prediction
Add feed in tarif predictions needed for automatic optimization. The feed in
tariff can be retrieved as fixed feed in tarif or can be imported. Also add
tests for the different feed in tariff providers. Extend documentation to
cover the feed in tariff providers.
* feat: add energy management plan based on S2 standard instructions
EOS can generate an energy management plan as a list of simple instructions.
May be retrieved by the /v1/energy-management/plan endpoint. The instructions
loosely follow the S2 energy management standard.
* feat: make measurement keys configurable by EOS configuration.
The fixed measurement keys are replaced by configurable measurement keys.
* feat: make pendulum DateTime, Date, Duration types usable for pydantic models
Use pydantic_extra_types.pendulum_dt to get pydantic pendulum types. Types are
added to the datetimeutil utility. Remove custom made pendulum adaptations
from EOS pydantic module. Make EOS modules use the pydantic pendulum types
managed by the datetimeutil module instead of the core pendulum types.
* feat: Add Time, TimeWindow, TimeWindowSequence and to_time to datetimeutil.
The time windows are are added to support home appliance time window
configuration. All time classes are also pydantic models. Time is the base
class for time definition derived from pendulum.Time.
* feat: Extend DataRecord by configurable field like data.
Configurable field like data was added to support the configuration of
measurement records.
* feat: Add additional information to health information
Version information is added to the health endpoints of eos and eosDash.
The start time of the last optimization and the latest run time of the energy
management is added to the EOS health information.
* feat: add pydantic merge model tests
* feat: add plan tab to EOSdash
The plan tab displays the current energy management instructions.
* feat: add predictions tab to EOSdash
The predictions tab displays the current predictions.
* feat: add cache management to EOSdash admin tab
The admin tab is extended by a section for cache management. It allows to
clear the cache.
* feat: add about tab to EOSdash
The about tab resembles the former hello tab and provides extra information.
* feat: Adapt changelog and prepare for release management
Release management using commitizen is added. The changelog file is adapted and
teh changelog and a description for release management is added in the
documentation.
* feat(doc): Improve install and devlopment documentation
Provide a more concise installation description in Readme.md and add extra
installation page and development page to documentation.
* chore: Use memory cache for interpolation instead of dict in inverter
Decorate calculate_self_consumption() with @cachemethod_until_update to cache
results in memory during an energy management/ optimization run. Replacement
of dict type caching in inverter is now possible because all optimization
runs are properly locked and the memory cache CacheUntilUpdateStore is properly
cleared at the start of any energy management/ optimization operation.
* chore: refactor genetic
Refactor the genetic algorithm modules for enhanced module structure and better
readability. Removed unnecessary and overcomplex devices singleton. Also
split devices configuration from genetic algorithm parameters to allow further
development independently from genetic algorithm parameter format. Move
charge rates configuration for electric vehicles from optimization to devices
configuration to allow to have different charge rates for different cars in
the future.
* chore: Rename memory cache to CacheEnergyManagementStore
The name better resembles the task of the cache to chache function and method
results for an energy management run. Also the decorator functions are renamed
accordingly: cachemethod_energy_management, cache_energy_management
* chore: use class properties for config/ems/prediction mixin classes
* chore: skip debug logs from mathplotlib
Mathplotlib is very noisy in debug mode.
* chore: automatically sync bokeh js to bokeh python package
bokeh was updated to 3.8.0, make JS CDN automatically follow the package version.
* chore: rename hello.py to about.py
Make hello.py the adapted EOSdash about page.
* chore: remove demo page from EOSdash
As no the plan and prediction pages are working without configuration, the demo
page is no longer necessary
* chore: split test_server.py for system test
Split test_server.py to create explicit test_system.py for system tests.
* chore: move doc utils to generate_config_md.py
The doc utils are only used in scripts/generate_config_md.py. Move it there to
attribute for strong cohesion.
* chore: improve pydantic merge model documentation
* chore: remove pendulum warning from readme
* chore: remove GitHub discussions from contributing documentation
Github discussions is to be replaced by Akkudoktor.net.
* chore(release): bump version to 0.1.0+dev for development
* build(deps): bump fastapi[standard] from 0.115.14 to 0.117.1
bump fastapi and make coverage version (for pytest-cov) explicit to avoid pip break.
* build(deps): bump uvicorn from 0.36.0 to 0.37.0
BREAKING CHANGE: EOS configuration changed. V1 API changed.
- The available_charge_rates_percent configuration is removed from optimization.
Use the new charge_rate configuration for the electric vehicle
- Optimization configuration parameter hours renamed to horizon_hours
- Device configuration now has to provide the number of devices and device
properties per device.
- Specific prediction provider configuration to be provided by explicit
configuration item (no union for all providers).
- Measurement keys to be provided as a list.
- New feed in tariff providers have to be configured.
- /v1/measurement/loadxxx endpoints are removed. Use generic mesaurement endpoints.
- /v1/admin/cache/clear now clears all cache files. Use
/v1/admin/cache/clear-expired to only clear all expired cache files.
Signed-off-by: Bobby Noelte <b0661n0e17e@gmail.com>
2025-10-28 02:50:31 +01:00
return Card (
ScrollArea ( Container ( content , id = " page-content " ) , cls = " h-[75vh] w-full rounded-md " ) ,
)
2025-01-22 23:47:28 +01:00
def Page (
title : Optional [ str ] ,
dashboard_items : dict [ str , str ] ,
content : Any ,
footer_content : Any ,
footer_path : str ,
) - > Div :
""" Generates a full-page layout with a header, dashboard items, content, and footer.
Args :
title ( Optional [ str ] ) : The page title .
dashboard_items ( dict [ str , str ] ) : A dictionary of dashboard items .
content ( Any ) : The main content for the page .
footer_content ( Any ) : Footer content .
footer_path ( Any ) : Path to reload footer content from .
Returns :
Div : A ` Div ` element representing the entire page layout .
"""
return Container (
DashboardHeader ( title ) ,
DashboardTabs ( dashboard_items ) ,
DashboardContent ( content ) ,
DashboardFooter ( footer_content , path = footer_path ) ,
cls = ( " bg-background text-foreground w-screen p-4 space-y-4 " , ContainerT . xl ) ,
)