Deployed 80e4521 to v0.16-dev with MkDocs 1.6.1 and mike 2.1.3

Author: github-actions[bot]

v0.16-dev/protobuf-reference/frequenz/api/dispatch/v1/dispatch/index.html

@@ -2355,7 +2355,10 @@ <h3 id="dispatchdata">DispatchData<a class="headerlink" href="#dispatchdata" tit
 | is_active | <a href="#bool">bool</a> |  | The &#34;active&#34; status An active dispatch is eligible for processing, either immediately or at a scheduled time in the future, including recurring dispatches. If a dispatch is set to inactive, it won&#39;t be processed even if it matches all other conditions, allowing for temporary disabling of dispatches without deletion. |
 | is_dry_run | <a href="#bool">bool</a> |  | The &#34;dry run&#34; status A dry run dispatch is executed for logging and monitoring purposes without affecting the microgrid components. This is useful, for example, in scenarios where a user may want to test dispatch behavior without actually affecting any component states. Notably, a dispatch can be both &#34;dry run&#34; and &#34;active,&#34; allowing for the system to generate logs and observe behavior without making actual changes. |
 | payload | <a href="#google-protobuf-Struct">google.protobuf.Struct</a> |  | The dispatch payload.</p>
-<p>Note!!! The payload field allows for flexible JSON data to be associated with this dispatch. The payload must adhere to the following constraints: - Maximum JSON nesting depth: 5 levels. - The data should not contain executable code or scripts. - Ensure all data is properly sanitized and encoded. - The total size of the payload should not exceed 50 KB. |
+<p>Note!!! The payload field allows for flexible JSON data to be associated with this dispatch. The payload must adhere to the following constraints: - Maximum JSON nesting depth: 5 levels. - The data should not contain executable code or scripts. - Ensure all data is properly sanitized and encoded. - The total size of the payload should not exceed 50 KB.</p>
+<p>The payload is expected to follow a specific format that the downstream applications consuming the dispatch API are responsible for understanding and processing.</p>
+<p>Example JSON payload: { &#34;settings&#34;: { &#34;power_max&#34;: 10, // Maximum power level for the dispatch (in kW) &#34;soc_min&#34;: 20, // Minimum state of charge for battery storage (in %) &#34;soc_max&#34;: 80 // Maximum state of charge for battery storage (in %) } }</p>
+<p>In this example, a microgrid could use this payload to set operational parameters such as the maximum power output of a solar PV array or the charge/discharge limits of a battery storage system. This flexibility allows the microgrid to dynamically adjust its behavior based on the current needs or conditions, such as optimizing battery usage or limiting PV output during low demand periods. |
 | recurrence | <a href="#frequenz-api-dispatch-v1-RecurrenceRule">RecurrenceRule</a> |  | The recurrence rule |</p>
 <p><a name="frequenz-api-dispatch-v1-DispatchFilter"></a></p>
 <h3 id="dispatchfilter">DispatchFilter<a class="headerlink" href="#dispatchfilter" title="Permanent link">¤</a></h3>

v0.16-dev/python-reference/frequenz/api/dispatch/v1/dispatch_pb2/index.html

@@ -4953,6 +4953,20 @@ <h6 id="frequenz.api.dispatch.v1.dispatch_pb2.DispatchData.payload" class="doc d
      - The data should not contain executable code or scripts.
      - Ensure all data is properly sanitized and encoded.
      - The total size of the payload should not exceed 50 KB.</p>
+<p>The payload is expected to follow a specific format that the downstream applications consuming the dispatch API
+are responsible for understanding and processing.</p>
+<p>Example JSON payload:
+{
+  "settings": {
+    "power_max": 10,   // Maximum power level for the dispatch (in kW)
+    "soc_min": 20,     // Minimum state of charge for battery storage (in %)
+    "soc_max": 80      // Maximum state of charge for battery storage (in %)
+  }
+}</p>
+<p>In this example, a microgrid could use this payload to set operational parameters such as the maximum power output
+of a solar PV array or the charge/discharge limits of a battery storage system. This flexibility allows the microgrid
+to dynamically adjust its behavior based on the current needs or conditions, such as optimizing battery usage or
+limiting PV output during low demand periods.</p>
 
     </div>
 

v0.16-dev/search/search_index.json

@@ -1 +1,66 @@
-[{"version":"next","title":"next","aliases":[]},{"version":"v1.0-pre","title":"v1.0.0-rc2","aliases":["latest-pre","v1-pre"]},{"version":"v0.16-dev","title":"v0.16-dev (22d30fa)","aliases":["v0-dev","latest-dev"]},{"version":"v0.15-dev","title":"v0.15-dev (e1f0978)","aliases":[]},{"version":"v0.15","title":"v0.15.1","aliases":["v0","latest"]},{"version":"v0.14-dev","title":"v0.14-dev (338bcdf)","aliases":[]},{"version":"v0.14","title":"v0.14.0","aliases":[]},{"version":"v0.13","title":"v0.13.0","aliases":[]},{"version":"v0.12","title":"v0.12","aliases":[]},{"version":"v0.11","title":"v0.11","aliases":[]},{"version":"v0.10","title":"v0.10","aliases":[]}]
+[
+  {
+    "version": "next",
+    "title": "next",
+    "aliases": []
+  },
+  {
+    "version": "v1.0-pre",
+    "title": "v1.0.0-rc2",
+    "aliases": [
+      "v1-pre",
+      "latest-pre"
+    ]
+  },
+  {
+    "version": "v0.16-dev",
+    "title": "v0.16-dev (80e4521)",
+    "aliases": [
+      "v0-dev",
+      "latest-dev"
+    ]
+  },
+  {
+    "version": "v0.15",
+    "title": "v0.15.1",
+    "aliases": [
+      "latest",
+      "v0"
+    ]
+  },
+  {
+    "version": "v0.15-dev",
+    "title": "v0.15-dev (e1f0978)",
+    "aliases": []
+  },
+  {
+    "version": "v0.14",
+    "title": "v0.14.0",
+    "aliases": []
+  },
+  {
+    "version": "v0.14-dev",
+    "title": "v0.14-dev (338bcdf)",
+    "aliases": []
+  },
+  {
+    "version": "v0.13",
+    "title": "v0.13.0",
+    "aliases": []
+  },
+  {
+    "version": "v0.12",
+    "title": "v0.12",
+    "aliases": []
+  },
+  {
+    "version": "v0.11",
+    "title": "v0.11",
+    "aliases": []
+  },
+  {
+    "version": "v0.10",
+    "title": "v0.10",
+    "aliases": []
+  }
+]