Document some more the UI protocol
authorJérôme Benoit <jerome.benoit@sap.com>
Wed, 24 Aug 2022 14:40:13 +0000 (16:40 +0200)
committerJérôme Benoit <jerome.benoit@sap.com>
Wed, 24 Aug 2022 14:40:13 +0000 (16:40 +0200)
Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
README.md

index 0e02383d54bd6374f7f14ef3174a3e14339539d3..a4103c0ee5c7e9d4f2f82b3c6642820610498293 100644 (file)
--- 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).