Switch to current node.js LTS version

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

diff --git a/README.md b/README.md
index 47ae68cd587afe1c7ef66185d24ab0fce6bb4d31..89ef987a50f24a10535df1f6c70a1825c3ddef29 100644 (file)
--- a/README.md
+++ b/README.md
@@ -64,8 +64,9 @@ logRotate | true/false | true | boolean | enable daily log files rotation
 logMaxFiles | | 7 | integer | maximum number of log files to keep
 logLevel | emerg/alert/crit/error/warning/notice/info/debug | info | string | winston logging level
 logFile | | combined.log | string | log file relative path
-logErrorFile | | error.log | string | error log file relative path 
-performanceStorage | | { "enabled": false, "type": "jsonfile", "file:///performanceRecords.json" } | { enabled: string; type: string; URI: string; } where type can be 'jsonfile' or 'mongodb' | performance storage configuration section
+logErrorFile | | error.log | string | error log file relative path
+uiWebSocketServer | | { "enabled": true, "options": { "host: "localhost", "port": 8080 } } | { enabled: boolean; options: ServerOptions; } | UI WebSocket server configuration section 
+performanceStorage | | { "enabled": false, "type": "jsonfile", "file:///performanceRecords.json" } | { enabled: boolean; type: string; URI: string; } where type can be 'jsonfile' or 'mongodb' | performance storage configuration section
 stationTemplateURLs | | {}[] | { file: string; numberOfStations: number; }[] | array of charging station templates URIs configuration section (template file name and number of stations)
 
 #### Worker process model: 
@@ -86,8 +87,8 @@ 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 | | '' | boolean | Allow supervision URL configuration via a vendor OCPP parameter key
-supervisionURLOCPPKey | | '' | string | The vendor string that will be used as a vendor OCPP parameter key to set the supervision URL
+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