Update README.md

This commit is contained in:
drbacke 2024-07-30 13:35:53 +02:00 committed by GitHub
parent ea68de70fb
commit 0428ec2906

154
README.md
View File

@ -136,3 +136,157 @@ Beschreibt die Struktur und Datentypen des JSON-Objekts, das an den Flask-Server
- **Beschreibung**: Ein Integer, der die Dauer der Nutzung des Haushaltsgeräts in Stunden darstellt.
- **Typ**: Integer
# JSON-Output Beschreibung
Dieses Dokument beschreibt die Struktur und Datentypen des JSON-Outputs, den der Flask-Server zurückgibt.
## Felder des JSON-Outputs (Stand 30.7.2024)
### discharge_hours_bin
- **Beschreibung**: Ein Array von Binärwerten (0 oder 1), das anzeigt, ob in einer bestimmten Stunde Energie entladen wird.
- **Typ**: Array
- **Element-Typ**: Integer (0 oder 1)
- **Länge**: 48
### eauto_obj
- **Beschreibung**: Ein Objekt, das Informationen über das Elektroauto enthält.
- **charge_array**: Ein Array von Binärwerten (0 oder 1), das anzeigt, ob das Elektroauto in einer bestimmten Stunde geladen wird.
- **Typ**: Array
- **Element-Typ**: Integer (0 oder 1)
- **Länge**: 48
- **discharge_array**: Ein Array von Binärwerten (0 oder 1), das anzeigt, ob das Elektroauto in einer bestimmten Stunde entladen wird.
- **Typ**: Array
- **Element-Typ**: Integer (0 oder 1)
- **Länge**: 48
- **entlade_effizienz**: Die Entladeeffizienz des Elektroautos.
- **Typ**: Float
- **hours**: Die Anzahl der Stunden, für die die Simulation durchgeführt wird.
- **Typ**: Integer
- **kapazitaet_wh**: Die Kapazität des Elektroauto-Akkus in Wattstunden.
- **Typ**: Integer
- **lade_effizienz**: Die Ladeeffizienz des Elektroautos.
- **Typ**: Float
- **max_ladeleistung_w**: Die maximale Ladeleistung des Elektroautos in Watt.
- **Typ**: Integer
- **soc_wh**: Der Ladezustand (State of Charge) des Elektroautos in Wattstunden.
- **Typ**: Integer
- **start_soc_prozent**: Der initiale Ladezustand (State of Charge) des Elektroautos in Prozent.
- **Typ**: Integer
### eautocharge_hours_float
- **Beschreibung**: Ein Array von Binärwerten (0 oder 1), das anzeigt, ob das Elektroauto in einer bestimmten Stunde geladen wird.
- **Typ**: Array
- **Element-Typ**: Integer (0 oder 1)
- **Länge**: 48
### result
- **Beschreibung**: Ein Objekt, das die Ergebnisse der Simulation enthält.
- **E-Auto_SoC_pro_Stunde**: Ein Array von Floats, das den Ladezustand des Elektroautos für jede Stunde darstellt.
- **Typ**: Array
- **Element-Typ**: Float
- **Länge**: bis zu 48
- **Eigenverbrauch_Wh_pro_Stunde**: Ein Array von Floats, das den Eigenverbrauch in Wattstunden pro Stunde darstellt.
- **Typ**: Array
- **Element-Typ**: Float
- **Länge**: bis zu 48
- **Einnahmen_Euro_pro_Stunde**: Ein Array von Floats, das die Einnahmen in Euro pro Stunde darstellt.
- **Typ**: Array
- **Element-Typ**: Float
- **Länge**: bis zu 48
- **Gesamt_Verluste**: Die gesamten Verluste in Wattstunden.
- **Typ**: Float
- **Gesamtbilanz_Euro**: Die gesamte Bilanz in Euro.
- **Typ**: Float
- **Gesamteinnahmen_Euro**: Die gesamten Einnahmen in Euro.
- **Typ**: Float
- **Gesamtkosten_Euro**: Die gesamten Kosten in Euro.
- **Typ**: Float
- **Haushaltsgeraet_wh_pro_stunde**: Ein Array von Floats, das den Energieverbrauch eines Haushaltsgeräts in Wattstunden pro Stunde darstellt.
- **Typ**: Array
- **Element-Typ**: Float
- **Länge**: bis zu 48
- **Kosten_Euro_pro_Stunde**: Ein Array von Floats, das die Kosten in Euro pro Stunde darstellt.
- **Typ**: Array
- **Element-Typ**: Float
- **Länge**: bis zu 48
- **Netzbezug_Wh_pro_Stunde**: Ein Array von Floats, das den Netzbezug in Wattstunden pro Stunde darstellt.
- **Typ**: Array
- **Element-Typ**: Float
- **Länge**: bis zu 48
- **Netzeinspeisung_Wh_pro_Stunde**: Ein Array von Floats, das die Netzeinspeisung in Wattstunden pro Stunde darstellt.
- **Typ**: Array
- **Element-Typ**: Float
- **Länge**: bis zu 48
- **Verluste_Pro_Stunde**: Ein Array von Floats, das die Verluste pro Stunde darstellt.
- **Typ**: Array
- **Element-Typ**: Float
- **Länge**: bis zu 48
- **akku_soc_pro_stunde**: Ein Array von Floats, das den Ladezustand des Akkus in Prozent pro Stunde darstellt.
- **Typ**: Array
- **Element-Typ**: Float
- **Länge**: bis zu 48
### simulation_data
- **Beschreibung**: Ein Objekt, das die simulierten Daten enthält.
- **E-Auto_SoC_pro_Stunde**: Ein Array von Floats, das den simulierten Ladezustand des Elektroautos pro Stunde darstellt.
- **Typ**: Array
- **Element-Typ**: Float
- **Länge**: bis zu 48
- **Eigenverbrauch_Wh_pro_Stunde**: Ein Array von Floats, das den simulierten Eigenverbrauch in Wattstunden pro Stunde darstellt.
- **Typ**: Array
- **Element-Typ**: Float
- **Länge**: bis zu 48
- **Einnahmen_Euro_pro_Stunde**: Ein Array von Floats, das die simulierten Einnahmen in Euro pro Stunde darstellt.
- **Typ**: Array
- **Element-Typ**: Float
- **Länge**: bis zu 48
- **Gesamt_Verluste**: Die gesamten simulierten Verluste in Wattstunden.
- **Typ**: Float
- **Gesamtbilanz_Euro**: Die gesamte simulierte Bilanz in Euro.
- **Typ**: Float
- **Gesamteinnahmen_Euro**: Die gesamten simulierten Einnahmen in Euro.
- **Typ**: Float
- **Gesamtkosten_Euro**: Die gesamten simulierten Kosten in Euro.
- **Typ**: Float
- **Haushaltsgeraet_wh_pro_stunde**: Ein Array von Floats, das den simulierten Energieverbrauch eines Haushaltsgeräts in Wattstunden pro Stunde darstellt.
- **Typ**: Array
- **Element-Typ**: Float
- **Länge**: bis zu 48
- **Kosten_Euro_pro_Stunde**: Ein Array von Floats, das die simulierten Kosten in Euro pro Stunde darstellt.
- **Typ**: Array
- **Element-Typ**: Float
- **Länge**: bis zu 48
- **Netzbezug_Wh_pro_Stunde**: Ein Array von Floats, das den simulierten Netzbezug in Wattstunden pro Stunde darstellt.
- **Typ**: Array
- **Element-Typ**: Float
- **Länge**: bis zu 48
- **Netzeinspeisung_Wh_pro_Stunde**: Ein Array von Floats, das die simulierte Netzeinspeisung in Wattstunden pro Stunde darstellt.
- **Typ**: Array
- **Element-Typ**: Float
- **Länge**: bis zu 48
- **Verluste_Pro_Stunde**: Ein Array von Floats, das die simulierten Verluste pro Stunde darstellt.
- **Typ**: Array
- **Element-Typ**: Float
- **Länge**: bis zu 48
- **akku_soc_pro_stunde**: Ein Array von Floats, das den simulierten Ladezustand des Akkus in Prozent pro Stunde darstellt.
- **Typ**: Array
- **Element-Typ**: Float
- **Länge**: bis zu 48
### spuelstart
- **Beschreibung**: Kann `null` sein oder ein Objekt enthalten, das den Spülstart darstellt (wenn vorhanden).
- **Typ**: null oder object
### start_solution
- **Beschreibung**: Ein Array von Binärwerten (0 oder 1), das eine mögliche Startlösung für die Simulation darstellt.
- **Typ**: Array
- **Element-Typ**: Integer (0 oder