X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=README.md;h=87ec784a1b91cdefd87a5edf21c36c7b8d6bbae1;hb=9ad71cd4647c0fd9ef24a565f1b170c7db686cdf;hp=95198791c35377694b45ba64735eeb2f0eed1ab1;hpb=9f5030ff24b70d9cedebf6acd92aa88d225632c0;p=e-mobility-charging-stations-simulator.git

diff --git a/README.md b/README.md
index 95198791..87ec784a 100644
--- a/README.md
+++ b/README.md
@@ -2,11 +2,48 @@
 
 ## Summary
 
-Simple node program to simulate a set of charging stations based on OCPP 1.6 protocol.
+Simple [node.js](https://nodejs.org/) program to simulate a set of charging stations based on the OCPP-J 1.6 protocol.
 
-To run the program start: `npm start`.
+## Start
 
-All the parameters and control of the program are within the src/assets/config.json file. A configuration template file is available at src/assets/config-template.json.
+To start the program, run: `npm start`.
+
+## Configuration syntax
+
+All configuration files are in the JSON standard format.  
+
+The program's global configuration parameters must be within the src/assets/config.json file. A configuration template file is available at [src/assets/config-template.json](src/assets/config-template.json).
+
+All charging station templates are in the directory [src/assets/station-templates](src/assets/station-templates).
+
+A list of RFID tags must be defined for the automatic transaction generator with the default location and name src/assets/authorization-tags.json. A template file is available at [src/assets/authorization-tags-template.json](src/assets/authorization-tags-template.json).
+
+### Global configuration 
+
+_src/assets/config.json_
+
+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           
+workerPoolMinSize | | 4 | integer | worker threads pool minimum number of threads
+workerPoolMaxSize | | 16 | integer | worker threads pool maximum number of threads
+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
+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 
+ 
+### Charging station template
+
+Key | Value(s) | Default Value | Value type | Description 
+--- | -------| --------------| ---------- | ------------
+authorizationFile | | '' | string | RFID tags list file relative to src/assets path
 
 ## License