Update dependency
[e-mobility-charging-stations-simulator.git] / README.md
CommitLineData
7dde0b73
JB
1# ev-simulator
2
3## Summary
4
1eabf6a9 5Simple [node.js](https://nodejs.org/) program to simulate a set of charging stations based on the OCPP-J 1.6 protocol.
7dde0b73 6
2c28fc83
JB
7## Start
8
a07b4408 9To start the program, run: `npm start`.
7dde0b73 10
2c28fc83
JB
11## Configuration syntax
12
13All configuration files are in the JSON standard format.
14
15The 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).
16
17All charging station templates are in the directory [src/assets/station-templates](src/assets/station-templates).
18
19A 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).
20
21### Global configuration
22
23_src/assets/config.json_
24
25Key | Value(s) | Default Value | Value type | Description
26--- | -------| --------------| ---------- | ------------
27supervisionURLs | | [] | string[] | array of connection URIs to OCPP-J servers
28distributeStationsToTenantsEqually | true/false | true | boolean | distribute charging stations uniformly to the OCPP-J servers
29statisticsDisplayInterval | | 60 | integer | seconds between charging stations statistics output in the logs
30workerProcess | workerSet/staticPool/dynamicPool | workerSet | string | worker threads process type
31workerPoolMinSize | | 4 | integer | worker threads pool minimum number of threads
32workerPoolMaxSize | | 16 | integer | worker threads pool maximum number of threads
33chargingStationsPerWorker | | 1 | integer | number of charging stations per worker threads for the `workerSet` process type
34logConsole | true/false | false | boolean | output logs on the console
35logFormat | | simple | string | winston log format
36logRotate | true/false | true | boolean | enable daily log files rotation
37logMaxFiles | | 7 | integer | maximum number of files to keep
38logLevel | emerg/alert/crit/error/warning/notice/info/debug | info | string | winston logging level
39logFile | | combined.log | string | log file relative path
40logErrorFile | | error.log | string | error log file relative path
41
42### Charging station template
2e6e52f3 43
2c28fc83
JB
44Key | Value(s) | Default Value | Value type | Description
45--- | -------| --------------| ---------- | ------------
46authorizationFile | | '' | string | RFID tags list file relative to src/assets path
7dde0b73
JB
47
48## License
49
9f5030ff 50This file and all other files in this repository are licensed under the Apache Software License, v.2 and copyrighted under the copyright in [NOTICE](NOTICE) file, except as noted otherwise in the [LICENSE](LICENSE) file.
7dde0b73
JB
51
52Please note that Docker images can contain other software which may be licensed under different licenses. This LICENSE and NOTICE files are also included in the Docker image. For any usage of built Docker images please make sure to check the licenses of the artifacts contained in the images.