Release 1.0.3

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

diff --git a/README.md b/README.md
index e63f32f6b4b5f08a9c1dbb371d99e9f49bc21730..e377862aadb842a8e7261d163c1768fab1fc9eb6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -27,14 +27,16 @@ Key | Value(s) | Default Value | Value type | Description
 supervisionURLs | | [] | string[] |  array of connection URIs to OCPP-J servers
 distributeStationsToTenantsEqually | true/false | true | boolean | distribute charging stations uniformly to the OCPP-J servers
 statisticsDisplayInterval | | 60 | integer | seconds between charging stations statistics output in the logs 
-workerProcess | workerSet/staticPool/dynamicPool | workerSet | string | worker threads process type           
+workerProcess | workerSet/staticPool/dynamicPool | workerSet | string | worker threads process type
+workerStartDelay | | 500 | integer | milliseconds to wait at charging station worker threads startup
 workerPoolMinSize | | 4 | integer | worker threads pool minimum number of threads
 workerPoolMaxSize | | 16 | integer | worker threads pool maximum number of threads
+workerPoolStrategy | ROUND_ROBIN/LESS_RECENTLY_USED/... | [poolifier](https://github.com/pioardi/poolifier) default: ROUND_ROBBIN | string | worker threads pool [poolifier](https://github.com/pioardi/poolifier) worker choice strategy
 chargingStationsPerWorker | | 1 | integer | number of charging stations per worker threads for the `workerSet` process type
 logConsole | true/false | false | boolean | output logs on the console 
 logFormat | | simple | string | winston log format
 logRotate | true/false | true | boolean | enable daily log files rotation
-logMaxFiles | | 7 | integer | maximum number of files to keep
+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 
@@ -59,17 +61,90 @@ power | | | integer\|integer[] | charging stations maximum power value(s)
 powerSharedByConnectors | true/false | false | boolean | charging stations power shared by its connectors
 powerUnit | W/kW | W | string | charging stations power unit
 currentOutType | AC/DC | AC | string | charging stations current out type
-numberOfPhases | 1/3 | AC:3/DC:0 | integer | charging stations number of phase(s) 
+numberOfPhases | 0/1/3 | AC:3/DC:0 | integer | charging stations number of phase(s) 
 numberOfConnectors | | | integer\|integer[] | charging stations number of connector(s)
 useConnectorId0 | true/false | true | boolean | use connector id 0 definition from the template
-randomConnectors | true/false | false | boolean | randomize the connector id
+randomConnectors | true/false | false | boolean | randomize runtime connector id affectation from the connector id definition in template
 resetTime | | 60 | integer | seconds to wait before the charging stations come back at reset
 connectionTimeout | | 30 | integer | connection timeout to the OCPP-J server
 autoReconnectMaxRetries | | -1 (unlimited) | integer | connection retries to the OCPP-J server
 reconnectExponentialDelay | true/false | false | boolean | connection delay retry to the OCPP-J server
-registrationMaxRetries | | -1 (unlimited) | boolean | charging stations boot notification retries
+registrationMaxRetries | | -1 (unlimited) | integer | charging stations boot notification retries
 enableStatistics | true/false | true | boolean | enable charging stations statistics   
-voltageOut | | AC:230/DC:400 | number | charging stations voltage out 
+voltageOut | | AC:230/DC:400 | integer | charging stations voltage out
+Configuration | | | ChargingStationConfiguration | charging stations OCPP configuration parameters
+AutomaticTransactionGenerator | | | AutomaticTransactionGenerator | charging stations ATG configuration
+Connectors | | | Connectors | charging stations connectors configuration
+
+#### Configuration section
+
+```json
+  "Configuration": {
+    "configurationKey": [
+       ...
+       {
+        "key": "StandardKey",
+        "readonly": false,
+        "value": "StandardValue",
+        "visible": true,
+        "reboot": false
+      },
+      ...
+      {
+        "key": "VendorKey",
+        "readonly": false,
+        "value": "VendorValue",
+        "visible": false,
+        "reboot": true
+      },
+      ...
+    ]
+  }
+```
+
+#### AutomaticTransactionGenerator section
+
+```json
+  "AutomaticTransactionGenerator": {
+    "enable": false,
+    "minDuration": 60,
+    "maxDuration": 80,
+    "minDelayBetweenTwoTransactions": 15,
+    "maxDelayBetweenTwoTransactions": 30,
+    "probabilityOfStart": 1,
+    "stopAfterHours": 0.3,
+    "stopOnConnectionFailure": true,
+    "requireAuthorize": false
+  }
+```
+#### Connectors section
+
+```json
+  "Connectors": {
+    "0": {},
+    "1": {
+      "bootStatus": "Available",
+      "MeterValues": [
+        ...
+        {
+          "unit": "A",
+          "measurand": "Current.Import"
+        },
+        ...
+        {
+          "unit": "Wh"
+        },
+        ...
+      ]
+    }
+  },
+```
+
+## OCPP commands
+
+### Version 1.6
+
+TODO
 
 ## License