File tree Expand file tree Collapse file tree 1 file changed +17
-0
lines changed
proto/frequenz/api/dispatch/v1 Expand file tree Collapse file tree 1 file changed +17
-0
lines changed Original file line number Diff line number Diff line change @@ -197,6 +197,23 @@ message DispatchData {
197197 // - The data should not contain executable code or scripts.
198198 // - Ensure all data is properly sanitized and encoded.
199199 // - The total size of the payload should not exceed 50 KB.
200+ //
201+ // The payload is expected to follow a specific format that the downstream applications consuming the dispatch API
202+ // are responsible for understanding and processing.
203+ //
204+ // Example JSON payload:
205+ // {
206+ // "settings": {
207+ // "power_max": 10, // Maximum power level for the dispatch (in kW)
208+ // "soc_min": 20, // Minimum state of charge for battery storage (in %)
209+ // "soc_max": 80 // Maximum state of charge for battery storage (in %)
210+ // }
211+ // }
212+ //
213+ // In this example, a microgrid could use this payload to set operational parameters such as the maximum power output
214+ // of a solar PV array or the charge/discharge limits of a battery storage system. This flexibility allows the microgrid
215+ // to dynamically adjust its behavior based on the current needs or conditions, such as optimizing battery usage or
216+ // limiting PV output during low demand periods.
200217 google.protobuf.Struct payload = 7 ;
201218
202219 // The recurrence rule
You can’t perform that action at this time.
0 commit comments