Add initial code for WebSocket server to pilot remotely the simulator

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

diff --git a/README.md b/README.md
index 212c8e29c13a00107e6f3a4e538091150f938d0c..7a54bf208443a863e7f41339e969a5f024eac1c8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -22,7 +22,7 @@ choco install -y nodejs-lts
 brew install node@14
 ```
 
-###  GNU/Linux: 
+### GNU/Linux: 
 
 * [NodeSource](https://github.com/nodesource/distributions) Node.js Binary Distributions for version 14.X
 
@@ -43,7 +43,7 @@ The charging stations simulator have an automatic configuration files reload fea
 
 But the modifications to test have to be done to the files in the build result directory [dist/assets](dist/assets). Once the modifications are finished, they have to be reported or copied to the matching files in the build source directory [src/assets](src/assets) to ensure they will be taken into account at next build. 
 
-### Global configuration 
+### Main configuration 
 
 **src/assets/config.json**:
 
@@ -86,8 +86,11 @@ Key | Value(s) | Default Value | Value type | Description
 supervisionURL | | '' | string | connection URI to OCPP-J server
 supervisionUser | | '' | string | basic HTTP authentication user to OCPP-J server
 supervisionPassword | | '' | string | basic HTTP authentication password to OCPP-J server
+supervisionURLOCPPConfiguration | true/false | false | boolean | Allow supervision URL configuration via a vendor OCPP parameter key
+supervisionURLOCPPKey | | 'ConnectionUrl' | string | The vendor string that will be used as a vendor OCPP parameter key to set the supervision URL
 ocppVersion | 1.6 | 1.6 | string | OCPP version 
 ocppProtocol | json | json | string | OCPP protocol
+wsOptions | | {} | ClientOptions & ClientRequestArgs | [ws](https://github.com/websockets/ws) and node.js [http](https://nodejs.org/api/http.html) clients options intersection
 authorizationFile | | '' | string | RFID tags list file relative to src/assets path
 baseName | | '' | string | base name to build charging stations name
 nameSuffix | | '' | string | name suffix to build charging stations name
@@ -238,7 +241,7 @@ make SUBMODULES_INIT=true
 #### Firmware Management Profile
 
 - :white_check_mark: GetDiagnostics
-- :x: DiagnosticsStatusNotification
+- :white_check_mark: DiagnosticsStatusNotification
 - :x: FirmwareStatusNotification
 - :x: UpdateFirmware