From: Jérôme Benoit <jerome.benoit@sap.com>
Date: Wed, 24 Aug 2022 14:40:13 +0000 (+0200)
Subject: Document some more the UI protocol
X-Git-Tag: v1.1.66~14
X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=80a3704cc3ad4464570322d816690afb6f1deee6;p=e-mobility-charging-stations-simulator.git

Document some more the UI protocol

Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
---

diff --git a/README.md b/README.md
index 0e02383d..a4103c0e 100644
--- a/README.md
+++ b/README.md
@@ -416,7 +416,9 @@ Request:
 Response:
 `PDU`: {
 `status`,
-`Indexed ChargingStationData as described in ChargingStationWorker.ts file`
+`index`: ChargingStationData,
+...
+`index`: ChargingStationData
 }
 
 ##### Start Transaction
@@ -448,6 +450,32 @@ Response:
 `status`
 }
 
+##### Start Charging Station
+
+Request:
+`ProcedureName`: 'startChargingStation'
+`PDU`: {
+`hashId`: the unique identifier of a charging station
+}
+
+Response:
+`PDU`: {
+`status`
+}
+
+##### Stop Charging Station
+
+Request:
+`ProcedureName`: 'stopChargingStation'
+`PDU`: {
+`hashId`: the unique identifier of a charging station
+}
+
+Response:
+`PDU`: {
+`status`
+}
+
 ## Support, Feedback, Contributing
 
 This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/e-mobility-charging-stations-simulator/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).