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 9b18fed95d7df25bed80c712f6f87f09b9adff22..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
 
@@ -383,20 +382,18 @@ All kind of OCPP parameters are supported in a charging station configuration or
 
 ## UI protocol
 
-Protocol to control the simulator via a Websocket protocol
+Protocol to control the simulator via a Websocket
 
-### Version 0.0.1
-
-Set the HTTP header Sec-Websocket-Protocol to `ui0.0.1`
+### Protocol
 
-#### 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 (for Protocol Data Unit)`: The parameters (if any) for said procedure
+`PDU`: The parameters (if any) for said procedure
 
 Response:
 [`uuid`, `PDU`]
@@ -404,18 +401,22 @@ Response:
 `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`: 'listChargingStation'
+`ProcedureName`: 'listChargingStations'
 `PDU`: {}
 
 Response:
 `PDU`: {
 `status`,
-An array of ChargingStationData as described in `ChargingStationWorker.ts` file
+`Indexed ChargingStationData as described in ChargingStationWorker.ts file`
 }
 
 ##### Start Transaction
@@ -423,15 +424,14 @@ An array of ChargingStationData as described in `ChargingStationWorker.ts` file
 Request:
 `ProcedureName`: 'startTransaction'
 `PDU`: {
-`hashId`: the unique identifier of a chargingStation
+`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`,
-**null**
+`status`
 }
 
 ##### Stop Transaction
@@ -439,14 +439,13 @@ Response:
 Request:
 `ProcedureName`: 'stopTransaction'
 `PDU`: {
-`hashId`: the unique identifier of a chargingStation
+`hashId`: the unique identifier of a charging station
 `transactionId`: the id of the transaction
 }
 
 Response:
 `PDU`: {
-`status`,
-**null**
+`status`
 }
 
 ## Support, Feedback, Contributing