repositories / e-mobility-charging-stations-simulator.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
docs: refine UI Protocol section in README.md
[e-mobility-charging-stations-simulator.git] / README.md
diff --git a/README.md b/README.md
index e171b3e8bf5ac4fa95a532e7906f85ebaebeb92a..a2cf6264ad7e4186be9b45ce6084e7a3c8faebcf 100644 (file)
--- a/README.md
+++ b/README.md
@@ -498,11 +498,14 @@ All kind of OCPP parameters are supported in charging station configuration or c
 
 ## UI protocol
 
-Protocol to control the simulator via a Websocket or HTTP server.
+Protocol to control the simulator via a Websocket or HTTP server:
 
-### HTTP Protocol
-
-To learn how to use the HTTP protocol to pilot the simulator, an [Insomnia](https://insomnia.rest/) HTTP requests collection is available in [src/assets/ui-protocol](./src/assets/ui-protocol) directory.
+```mermaid
+sequenceDiagram
+Client->>UI Server: request
+UI Server->>Client: response
+Note over UI Server,Client: Transport protocol: HTTP, Websocket
+```
 
 ### Websocket Protocol
 
@@ -519,7 +522,7 @@ SRPC protocol over Websocket. PDU stands for 'Protocol Data Unit'.
   `uuid`: String uniquely linking the response to the request  
   `PDU`: Response parameters to requested procedure
 
-An [Insomnia](https://insomnia.rest/) WebSocket requests collection is available in [src/assets/ui-protocol](./src/assets/ui-protocol) directory.
+To learn how to use the Websocket protocol to pilot the simulator, an [Insomnia](https://insomnia.rest/) Websocket requests collection is available in [src/assets/ui-protocol](./src/assets/ui-protocol) directory.
 
 #### Version 0.0.1
 
@@ -535,7 +538,7 @@ Set the Websocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
 
 - Response:  
   `PDU`: {  
-  `status`: 'success' | 'failure'  
+   `status`: 'success' | 'failure'  
   }
 
 ###### Stop Simulator
@@ -546,7 +549,33 @@ Set the Websocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
 
 - Response:  
   `PDU`: {  
-  `status`: 'success' | 'failure'  
+   `status`: 'success' | 'failure'  
+  }
+
+###### List Charging Station Templates
+
+- Request:  
+  `ProcedureName`: 'listTemplates'  
+  `PDU`: {}
+
+- Response:  
+  `PDU`: {  
+   `status`: 'success' | 'failure',  
+   `templates`: string[]  
+  }
+
+###### Add Charging Stations
+
+- Request:  
+  `ProcedureName`: 'addChargingStations'  
+  `PDU`: {  
+   `template`: string,  
+   `numberOfStations`: number  
+  }
+
+- Response:  
+  `PDU`: {  
+   `status`: 'success' | 'failure'  
   }
 
 ###### List Charging Stations
@@ -557,8 +586,8 @@ Set the Websocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
 
 - Response:  
   `PDU`: {  
-  `status`: 'success' | 'failure',  
-  `chargingStations`: ChargingStationData[]  
+   `status`: 'success' | 'failure',  
+   `chargingStations`: ChargingStationData[]  
   }
 
 ###### Start Charging Station
@@ -566,15 +595,15 @@ Set the Websocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
 - Request:  
   `ProcedureName`: 'startChargingStation'  
   `PDU`: {  
-  `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)  
+   `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)  
   }
 
 - Response:  
   `PDU`: {  
-  `status`: 'success' | 'failure',  
-  `hashIdsSucceeded`: charging station unique identifier strings array,  
-  `hashIdsFailed`: charging station unique identifier strings array (optional)  
-  `responsesFailed`: failed responses payload array (optional)  
+   `status`: 'success' | 'failure',  
+   `hashIdsSucceeded`: charging station unique identifier strings array,  
+   `hashIdsFailed`: charging station unique identifier strings array (optional),  
+   `responsesFailed`: failed responses payload array (optional)  
   }
 
 ###### Stop Charging Station
@@ -582,15 +611,15 @@ Set the Websocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
 - Request:  
   `ProcedureName`: 'stopChargingStation'  
   `PDU`: {  
-  `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)  
+   `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)  
   }
 
 - Response:  
   `PDU`: {  
-  `status`: 'success' | 'failure',  
-  `hashIdsSucceeded`: charging station unique identifier strings array,  
-  `hashIdsFailed`: charging station unique identifier strings array (optional),  
-  `responsesFailed`: failed responses payload array (optional)  
+   `status`: 'success' | 'failure',  
+   `hashIdsSucceeded`: charging station unique identifier strings array,  
+   `hashIdsFailed`: charging station unique identifier strings array (optional),  
+   `responsesFailed`: failed responses payload array (optional)  
   }
 
 ###### Open Connection
@@ -598,15 +627,15 @@ Set the Websocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
 - Request:  
   `ProcedureName`: 'openConnection'  
   `PDU`: {  
-  `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)  
+   `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)  
   }
 
 - Response:  
   `PDU`: {  
-  `status`: 'success' | 'failure',  
-  `hashIdsSucceeded`: charging station unique identifier strings array,  
-  `hashIdsFailed`: charging station unique identifier strings array (optional),  
-  `responsesFailed`: failed responses payload array (optional)  
+   `status`: 'success' | 'failure',  
+   `hashIdsSucceeded`: charging station unique identifier strings array,  
+   `hashIdsFailed`: charging station unique identifier strings array (optional),  
+   `responsesFailed`: failed responses payload array (optional)  
   }
 
 ###### Close Connection
@@ -614,15 +643,15 @@ Set the Websocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
 - Request:  
   `ProcedureName`: 'closeConnection'  
   `PDU`: {  
-  `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)  
+   `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)  
   }
 
 - Response:  
   `PDU`: {  
-  `status`: 'success' | 'failure',  
-  `hashIdsSucceeded`: charging station unique identifier strings array,  
-  `hashIdsFailed`: charging station unique identifier strings array (optional),  
-  `responsesFailed`: failed responses payload array (optional)  
+   `status`: 'success' | 'failure',  
+   `hashIdsSucceeded`: charging station unique identifier strings array,  
+   `hashIdsFailed`: charging station unique identifier strings array (optional),  
+   `responsesFailed`: failed responses payload array (optional)  
   }
 
 ###### Start Automatic Transaction Generator
@@ -630,16 +659,16 @@ Set the Websocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
 - Request:  
   `ProcedureName`: 'startAutomaticTransactionGenerator'  
   `PDU`: {  
-  `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),  
-  `connectorIds`: connector id integer array (optional, default: all connectors)  
+   `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),  
+   `connectorIds`: connector id integer array (optional, default: all connectors)  
   }
 
 - Response:  
   `PDU`: {  
-  `status`: 'success' | 'failure',  
-  `hashIdsSucceeded`: charging station unique identifier strings array,  
-  `hashIdsFailed`: charging station unique identifier strings array (optional),  
-  `responsesFailed`: failed responses payload array (optional)  
+   `status`: 'success' | 'failure',  
+   `hashIdsSucceeded`: charging station unique identifier strings array,  
+   `hashIdsFailed`: charging station unique identifier strings array (optional),  
+   `responsesFailed`: failed responses payload array (optional)  
   }
 
 ###### Stop Automatic Transaction Generator
@@ -647,16 +676,16 @@ Set the Websocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
 - Request:  
   `ProcedureName`: 'stopAutomaticTransactionGenerator'  
   `PDU`: {  
-  `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),  
-  `connectorIds`: connector id integer array (optional, default: all connectors)  
+   `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),  
+   `connectorIds`: connector id integer array (optional, default: all connectors)  
   }
 
 - Response:  
   `PDU`: {  
-  `status`: 'success' | 'failure',  
-  `hashIdsSucceeded`: charging station unique identifier strings array,  
-  `hashIdsFailed`: charging station unique identifier strings array (optional),  
-  `responsesFailed`: failed responses payload array (optional)  
+   `status`: 'success' | 'failure',  
+   `hashIdsSucceeded`: charging station unique identifier strings array,  
+   `hashIdsFailed`: charging station unique identifier strings array (optional),  
+   `responsesFailed`: failed responses payload array (optional)  
   }
 
 ###### OCPP commands trigger
@@ -683,17 +712,17 @@ Examples:
   - Request:  
     `ProcedureName`: 'startTransaction'  
     `PDU`: {  
-    `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),  
-    `connectorId`: connector id integer,  
-    `idTag`: RFID tag string  
+     `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),  
+     `connectorId`: connector id integer,  
+     `idTag`: RFID tag string  
     }
 
   - Response:  
     `PDU`: {  
-    `status`: 'success' | 'failure',  
-    `hashIdsSucceeded`: charging station unique identifier strings array,  
-    `hashIdsFailed`: charging station unique identifier strings array (optional),  
-    `responsesFailed`: failed responses payload array (optional)  
+     `status`: 'success' | 'failure',  
+     `hashIdsSucceeded`: charging station unique identifier strings array,  
+     `hashIdsFailed`: charging station unique identifier strings array (optional),  
+     `responsesFailed`: failed responses payload array (optional)  
     }
 
 - **Stop Transaction**
@@ -701,16 +730,16 @@ Examples:
   - Request:  
     `ProcedureName`: 'stopTransaction'  
     `PDU`: {  
-    `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),  
-    `transactionId`: transaction id integer  
+     `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),  
+     `transactionId`: transaction id integer  
     }
 
   - Response:  
     `PDU`: {  
     `status`: 'success' | 'failure',  
-    `hashIdsSucceeded`: charging station unique identifier strings array,  
-    `hashIdsFailed`: charging station unique identifier strings array (optional),  
-    `responsesFailed`: failed responses payload array (optional)  
+     `hashIdsSucceeded`: charging station unique identifier strings array,  
+     `hashIdsFailed`: charging station unique identifier strings array (optional),  
+     `responsesFailed`: failed responses payload array (optional)  
     }
 
 - **Status Notification**
@@ -718,18 +747,18 @@ Examples:
   - Request:  
     `ProcedureName`: 'statusNotification'  
     `PDU`: {  
-    `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),  
-    `connectorId`: connector id integer,  
-    `errorCode`: connector error code,  
-    `status`: connector status  
+     `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),  
+     `connectorId`: connector id integer,  
+     `errorCode`: connector error code,  
+     `status`: connector status  
     }
 
   - Response:  
     `PDU`: {  
-    `status`: 'success' | 'failure',  
-    `hashIdsSucceeded`: charging station unique identifier strings array,  
-    `hashIdsFailed`: charging station unique identifier strings array (optional),  
-    `responsesFailed`: failed responses payload array (optional)  
+     `status`: 'success' | 'failure',  
+     `hashIdsSucceeded`: charging station unique identifier strings array,  
+     `hashIdsFailed`: charging station unique identifier strings array (optional),  
+     `responsesFailed`: failed responses payload array (optional)  
     }
 
 - **Heartbeat**
@@ -737,17 +766,21 @@ Examples:
   - Request:  
     `ProcedureName`: 'heartbeat'  
     `PDU`: {  
-    `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),  
+     `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),  
     }
 
   - Response:  
     `PDU`: {  
-    `status`: 'success' | 'failure',  
-    `hashIdsSucceeded`: charging station unique identifier strings array,  
-    `hashIdsFailed`: charging station unique identifier strings array (optional),  
-    `responsesFailed`: failed responses payload array (optional)  
+     `status`: 'success' | 'failure',  
+     `hashIdsSucceeded`: charging station unique identifier strings array,  
+     `hashIdsFailed`: charging station unique identifier strings array (optional),  
+     `responsesFailed`: failed responses payload array (optional)  
     }
 
+### HTTP Protocol
+
+To learn how to use the HTTP protocol to pilot the simulator, an [Insomnia](https://insomnia.rest/) HTTP requests collection is available in [src/assets/ui-protocol](./src/assets/ui-protocol) directory.
+
 ## 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).
Charging stations simulator mirror - https://github.com/SAP/e-mobility-charging-stations-simulator