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

# ev-simulator

## Summary

Simple [node.js](https://nodejs.org/) program to simulate a set of charging stations based on the OCPP-J 1.6 protocol.

## Start

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 
stationTemplateURLs | | {}[] | { file: string; numberOfStations: number; }[] | array of charging template file URIs
 
### Charging station template

Key | Value(s) | Default Value | Value type | Description 
--- | -------| --------------| ---------- | ------------
supervisionURL | | '' | string | connection URI to OCPP-J server
ocppVersion | 1.6 | 1.6 | string | OCPP version 
ocppProtocol | json | json | string | OCPP protocol
authorizationFile | | '' | string | RFID tags list file relative to src/assets path
baseName | | '' | string | base name to build charging stations name
nameSuffix | | '' | string | name suffix to build charging stations name
fixedName | true/false | false | boolean | use the baseName as the charging stations unique name
chargePointModel | | '' | string | charging stations model
chargePointVendor | | '' | string | charging stations vendor
chargeBoxSerialNumberPrefix | | '' | string | charging stations serial number prefix
firmwareVersion | | '' | string | charging stations firmware version
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 | 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
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) | integer | charging stations boot notification retries
enableStatistics | true/false | true | boolean | enable charging stations statistics   
voltageOut | | AC:230/DC:400 | integer | charging stations voltage out

## License

This 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.

Please 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.
Commit	Line	Data
7dde0b73 JB	1	# ev-simulator
	2
	3	## Summary
	4
1eabf6a9	5	Simple [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
2c28fc83 JB	8
a07b4408	9	To start the program, run: `npm start`.
7dde0b73	10
2c28fc83 JB	11	## Configuration syntax
	12
	13	All configuration files are in the JSON standard format.
	14
	15	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).
	16
	17	All charging station templates are in the directory [src/assets/station-templates](src/assets/station-templates).
	18
	19	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).
	20
	21	### Global configuration
	22
b1d6e944	23	src/assets/config.json:
2c28fc83 JB	24
	25	Key \| Value(s) \| Default Value \| Value type \| Description
	26	--- \| -------\| --------------\| ---------- \| ------------
	27	supervisionURLs \| \| [] \| string[] \| array of connection URIs to OCPP-J servers
	28	distributeStationsToTenantsEqually \| true/false \| true \| boolean \| distribute charging stations uniformly to the OCPP-J servers
	29	statisticsDisplayInterval \| \| 60 \| integer \| seconds between charging stations statistics output in the logs
	30	workerProcess \| workerSet/staticPool/dynamicPool \| workerSet \| string \| worker threads process type
	31	workerPoolMinSize \| \| 4 \| integer \| worker threads pool minimum number of threads
	32	workerPoolMaxSize \| \| 16 \| integer \| worker threads pool maximum number of threads
	33	chargingStationsPerWorker \| \| 1 \| integer \| number of charging stations per worker threads for the `workerSet` process type
	34	logConsole \| true/false \| false \| boolean \| output logs on the console
	35	logFormat \| \| simple \| string \| winston log format
	36	logRotate \| true/false \| true \| boolean \| enable daily log files rotation
	37	logMaxFiles \| \| 7 \| integer \| maximum number of files to keep
	38	logLevel \| emerg/alert/crit/error/warning/notice/info/debug \| info \| string \| winston logging level
	39	logFile \| \| combined.log \| string \| log file relative path
	40	logErrorFile \| \| error.log \| string \| error log file relative path
a02da55f	41	stationTemplateURLs \| \| {}[] \| { file: string; numberOfStations: number; }[] \| array of charging template file URIs
2c28fc83 JB	42
2c28fc83 JB	43	### Charging station template
2e6e52f3	44
2c28fc83 JB	45	Key \| Value(s) \| Default Value \| Value type \| Description
2c28fc83 JB	46	--- \| -------\| --------------\| ---------- \| ------------
a02da55f JB	47	supervisionURL \| \| '' \| string \| connection URI to OCPP-J server
	48	ocppVersion \| 1.6 \| 1.6 \| string \| OCPP version
	49	ocppProtocol \| json \| json \| string \| OCPP protocol
2c28fc83	50	authorizationFile \| \| '' \| string \| RFID tags list file relative to src/assets path
a02da55f JB	51	baseName \| \| '' \| string \| base name to build charging stations name
	52	nameSuffix \| \| '' \| string \| name suffix to build charging stations name
	53	fixedName \| true/false \| false \| boolean \| use the baseName as the charging stations unique name
	54	chargePointModel \| \| '' \| string \| charging stations model
	55	chargePointVendor \| \| '' \| string \| charging stations vendor
	56	chargeBoxSerialNumberPrefix \| \| '' \| string \| charging stations serial number prefix
	57	firmwareVersion \| \| '' \| string \| charging stations firmware version
aa8cbc5c	58	power \| \| \| integer\\|integer[] \| charging stations maximum power value(s)
c6f76013	59	powerSharedByConnectors \| true/false \| false \| boolean \| charging stations power shared by its connectors
ef16e252	60	powerUnit \| W/kW \| W \| string \| charging stations power unit
7decf1b6	61	currentOutType \| AC/DC \| AC \| string \| charging stations current out type
c706280d	62	numberOfPhases \| 0/1/3 \| AC:3/DC:0 \| integer \| charging stations number of phase(s)
7decf1b6 JB	63	numberOfConnectors \| \| \| integer\\|integer[] \| charging stations number of connector(s)
	64	useConnectorId0 \| true/false \| true \| boolean \| use connector id 0 definition from the template
	65	randomConnectors \| true/false \| false \| boolean \| randomize the connector id
	66	resetTime \| \| 60 \| integer \| seconds to wait before the charging stations come back at reset
	67	connectionTimeout \| \| 30 \| integer \| connection timeout to the OCPP-J server
	68	autoReconnectMaxRetries \| \| -1 (unlimited) \| integer \| connection retries to the OCPP-J server
	69	reconnectExponentialDelay \| true/false \| false \| boolean \| connection delay retry to the OCPP-J server
0b13b85d	70	registrationMaxRetries \| \| -1 (unlimited) \| integer \| charging stations boot notification retries
7decf1b6	71	enableStatistics \| true/false \| true \| boolean \| enable charging stations statistics
0b13b85d	72	voltageOut \| \| AC:230/DC:400 \| integer \| charging stations voltage out
7dde0b73 JB	73
	74	## License
	75
9f5030ff	76	This 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	77
7dde0b73 JB	78	Please 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.