From 2c28fc83794a74ee53d4d60e88e11b49949db9a2 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=B4me=20Benoit?= Date: Tue, 4 May 2021 22:07:41 +0200 Subject: [PATCH] Initial work on configuration files syntax. MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Jérôme Benoit --- README.md | 39 +++++++++++++++++++++++++++++++++++++-- 1 file changed, 37 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 578ae381..2695cb80 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,46 @@ Simple node program to simulate a set of charging stations based on the OCPP-J 1.6 protocol. +## Start + To start the program, run: `npm start`. -All the configuration parameters of the program 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). +## 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 -All charging station templates are in [src/assets/station-templates](src/assets/station-templates). +Key | Value(s) | Default Value | Value type | Description +--- | -------| --------------| ---------- | ------------ +authorizationFile | | '' | string | RFID tags list file relative to src/assets path ## License -- 2.34.1