Forward UI request UUID to broadcast channel request

[e-mobility-charging-stations-simulator.git] / README.md

diff --git a/README.md b/README.md
index eae3b3918f8b70e9807d8bf025ac8d0967861874..0e02383d54bd6374f7f14ef3174a3e14339539d3 100644 (file)
--- a/README.md
+++ b/README.md
@@ -49,8 +49,7 @@ Tweak them to your needs by following the section [configuration files syntax](R
 
 To start the program, run: `npm start`.
 
-To start the program with a UI controller, run: `npm run start:server`.
-Then, start/stop the simulator by going to `https://<hostname:port>` in a browser. Localhost port will default to 8080. For Cloud Foundry, the port is assigned based on the `process.env.PORT` environment variable.
+## Start Web UI
 
 ## Configuration files syntax
 
@@ -107,7 +106,7 @@ But the modifications to test have to be done to the files in the build target d
 #### Worker process model:
 
 - **workerSet**:
-  Worker set executing each a static number (chargingStationsPerWorker) of simulated charging stations from the total
+  Worker set executing each a static number (elementsPerWorker) of simulated charging stations from the total
 
 - **staticPool**:
   Statically sized worker pool executing a static total number of simulated charging stations
@@ -381,6 +380,74 @@ All kind of OCPP parameters are supported in a charging station configuration or
 
 - _none_
 
+## UI protocol
+
+Protocol to control the simulator via a Websocket
+
+### Protocol
+
+PDU stands for Protocol Data Unit
+
+Request:
+[`uuid`, `ProcedureName`, `PDU`]
+
+`uuid`: String uniquely representing this request
+`ProcedureName`: The procedure to run on the simulator
+`PDU`: The parameters (if any) for said procedure
+
+Response:
+[`uuid`, `PDU`]
+
+`uuid`: String uniquely linking the response to the request
+`PDU`: Response data to requested procedure
+
+### Version 0.0.1
+
+Set the HTTP header _Sec-Websocket-Protocol_ to `ui0.0.1`
+
+#### Procedures
+
+##### List Charging stations
+
+Request:
+`ProcedureName`: 'listChargingStations'
+`PDU`: {}
+
+Response:
+`PDU`: {
+`status`,
+`Indexed ChargingStationData as described in ChargingStationWorker.ts file`
+}
+
+##### Start Transaction
+
+Request:
+`ProcedureName`: 'startTransaction'
+`PDU`: {
+`hashId`: the unique identifier of a charging station
+`connectorId`: the id of the connector (start at 1)
+`idTag`: An allowed badge authetification ID
+}
+
+Response:
+`PDU`: {
+`status`
+}
+
+##### Stop Transaction
+
+Request:
+`ProcedureName`: 'stopTransaction'
+`PDU`: {
+`hashId`: the unique identifier of a charging station
+`transactionId`: the id of the transaction
+}
+
+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).