Release 1.0.20
[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## Configuration syntax
8
9All configuration files are in the JSON standard format.
10
11The 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).
12
13All charging station templates are in the directory [src/assets/station-templates](src/assets/station-templates).
14
15A 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).
16
17### Global configuration
18
b1d6e944 19**src/assets/config.json**:
2c28fc83
JB
20
21Key | Value(s) | Default Value | Value type | Description
22--- | -------| --------------| ---------- | ------------
23supervisionURLs | | [] | string[] | array of connection URIs to OCPP-J servers
24distributeStationsToTenantsEqually | true/false | true | boolean | distribute charging stations uniformly to the OCPP-J servers
25statisticsDisplayInterval | | 60 | integer | seconds between charging stations statistics output in the logs
326ab6fd
JB
26workerProcess | workerSet/staticPool/dynamicPool | workerSet | string | worker threads process type
27workerStartDelay | | 500 | integer | milliseconds to wait at charging station worker threads startup
2c28fc83
JB
28workerPoolMinSize | | 4 | integer | worker threads pool minimum number of threads
29workerPoolMaxSize | | 16 | integer | worker threads pool maximum number of threads
9efbac5b 30workerPoolStrategy | 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
2c28fc83
JB
31chargingStationsPerWorker | | 1 | integer | number of charging stations per worker threads for the `workerSet` process type
32logConsole | true/false | false | boolean | output logs on the console
33logFormat | | simple | string | winston log format
34logRotate | true/false | true | boolean | enable daily log files rotation
0302da79 35logMaxFiles | | 7 | integer | maximum number of log files to keep
2c28fc83
JB
36logLevel | emerg/alert/crit/error/warning/notice/info/debug | info | string | winston logging level
37logFile | | combined.log | string | log file relative path
38logErrorFile | | error.log | string | error log file relative path
a02da55f 39stationTemplateURLs | | {}[] | { file: string; numberOfStations: number; }[] | array of charging template file URIs
2c28fc83
JB
40
41### Charging station template
2e6e52f3 42
2c28fc83
JB
43Key | Value(s) | Default Value | Value type | Description
44--- | -------| --------------| ---------- | ------------
a02da55f
JB
45supervisionURL | | '' | string | connection URI to OCPP-J server
46ocppVersion | 1.6 | 1.6 | string | OCPP version
47ocppProtocol | json | json | string | OCPP protocol
2c28fc83 48authorizationFile | | '' | string | RFID tags list file relative to src/assets path
a02da55f
JB
49baseName | | '' | string | base name to build charging stations name
50nameSuffix | | '' | string | name suffix to build charging stations name
51fixedName | true/false | false | boolean | use the baseName as the charging stations unique name
52chargePointModel | | '' | string | charging stations model
53chargePointVendor | | '' | string | charging stations vendor
54chargeBoxSerialNumberPrefix | | '' | string | charging stations serial number prefix
55firmwareVersion | | '' | string | charging stations firmware version
4a1857a2 56power | | | float\|float[] | charging stations maximum power value(s)
c6f76013 57powerSharedByConnectors | true/false | false | boolean | charging stations power shared by its connectors
ef16e252 58powerUnit | W/kW | W | string | charging stations power unit
7decf1b6 59currentOutType | AC/DC | AC | string | charging stations current out type
6ed92bc1 60voltageOut | | AC:230/DC:400 | integer | charging stations voltage out
c706280d 61numberOfPhases | 0/1/3 | AC:3/DC:0 | integer | charging stations number of phase(s)
7decf1b6
JB
62numberOfConnectors | | | integer\|integer[] | charging stations number of connector(s)
63useConnectorId0 | true/false | true | boolean | use connector id 0 definition from the template
11b056bb 64randomConnectors | true/false | false | boolean | randomize runtime connector id affectation from the connector id definition in template
7decf1b6 65resetTime | | 60 | integer | seconds to wait before the charging stations come back at reset
7decf1b6
JB
66autoReconnectMaxRetries | | -1 (unlimited) | integer | connection retries to the OCPP-J server
67reconnectExponentialDelay | true/false | false | boolean | connection delay retry to the OCPP-J server
0b13b85d 68registrationMaxRetries | | -1 (unlimited) | integer | charging stations boot notification retries
6ed92bc1
JB
69enableStatistics | true/false | true | boolean | enable charging stations statistics
70beginEndMeterValues | true/false | false | boolean | enable Transaction.{Begin,End} MeterValues
71outOfOrderEndMeterValues | true/false | false | boolean | send Transaction.End MeterValues out of order
72meteringPerTransaction | true/false | true | boolean | disable metering on a per transaction basis
fd0c36fa 73transactionDataMeterValues | true/false | false | boolean | enable transaction data MeterValues at stop transaction
9ccca265 74mainVoltageMeterValues | true/false | true | boolean | include charging station main voltage MeterValues on three phased charging stations
c94a349a
JB
75Configuration | | | ChargingStationConfiguration | charging stations OCPP configuration parameters
76AutomaticTransactionGenerator | | | AutomaticTransactionGenerator | charging stations ATG configuration
77Connectors | | | Connectors | charging stations connectors configuration
78
79#### Configuration section
80
81```json
0302da79 82 "Configuration": {
c94a349a
JB
83 "configurationKey": [
84 ...
85 {
86 "key": "StandardKey",
87 "readonly": false,
88 "value": "StandardValue",
89 "visible": true,
90 "reboot": false
91 },
92 ...
93 {
94 "key": "VendorKey",
95 "readonly": false,
96 "value": "VendorValue",
97 "visible": false,
98 "reboot": true
99 },
100 ...
101 ]
102 }
103```
104
105#### AutomaticTransactionGenerator section
106
107```json
0302da79 108 "AutomaticTransactionGenerator": {
c94a349a
JB
109 "enable": false,
110 "minDuration": 60,
111 "maxDuration": 80,
112 "minDelayBetweenTwoTransactions": 15,
113 "maxDelayBetweenTwoTransactions": 30,
114 "probabilityOfStart": 1,
115 "stopAfterHours": 0.3,
116 "stopOnConnectionFailure": true,
e644918b 117 "requireAuthorize": true
c94a349a
JB
118 }
119```
120#### Connectors section
121
122```json
0302da79 123 "Connectors": {
c94a349a
JB
124 "0": {},
125 "1": {
126 "bootStatus": "Available",
127 "MeterValues": [
128 ...
129 {
130 "unit": "A",
131 "measurand": "Current.Import"
132 },
133 ...
134 {
135 "unit": "Wh"
136 },
137 ...
138 ]
139 }
140 },
141```
142
6f0ec20e
JB
143## Start
144
145To start the program, run: `npm start`.
146
147## Docker
148
149In the [docker](./docker) folder:
150
151```bash
152make
153```
154
155Or without the optional git submodules:
156
157```bash
158make SUBMODULES_INIT=false
159```
160
161## OCPP-J commands supported
c94a349a
JB
162
163### Version 1.6
164
c56d42f1 165#### Core Profile
6f0ec20e 166
778f7924
JB
167- :white_check_mark: Authorize
168- :white_check_mark: BootNotification
169- :white_check_mark: ChangeAvailability
170- :white_check_mark: ChangeConfiguration
171- :white_check_mark: ClearCache
9e1b12e4 172- :x: DataTransfer
778f7924
JB
173- :white_check_mark: GetConfiguration
174- :white_check_mark: Heartbeat
175- :white_check_mark: MeterValues
176- :white_check_mark: RemoteStartTransaction
177- :white_check_mark: RemoteStopTransaction
178- :white_check_mark: Reset
179- :white_check_mark: StartTransaction
180- :white_check_mark: StatusNotification
181- :white_check_mark: StopTransaction
182- :white_check_mark: UnlockConnector
6f0ec20e 183
c56d42f1 184#### Firmware Management Profile
6f0ec20e 185
9e1b12e4
JB
186- :x: GetDiagnostics
187- :x: DiagnosticsStatusNotification
188- :x: FirmwareStatusNotification
189- :x: UpdateFirmware
6f0ec20e 190
c56d42f1 191#### Local Auth List Management Profile
6f0ec20e 192
9e1b12e4
JB
193- :x: GetLocalListVersion
194- :x: SendLocalList
6f0ec20e 195
c56d42f1 196#### Reservation Profile
6f0ec20e 197
9e1b12e4
JB
198- :x: CancelReservation
199- :x: ReserveNow
6f0ec20e 200
c56d42f1 201#### Smart Charging Profile
6f0ec20e 202
778f7924
JB
203- :white_check_mark: ClearChargingProfile
204- :white_check_mark: GetCompositeSchedule
205- :white_check_mark: SetChargingProfile
6f0ec20e 206
c56d42f1 207#### Remote Trigger Profile
6f0ec20e 208
9e1b12e4 209- :x: TriggerMessage
7dde0b73 210
7e1dc878
JB
211## OCPP-J standard parameters supported
212
adf16e64 213All kind of OCPP parameters are supported in a charging station template. The list here mention the standard ones also handled automatically in the simulator.
7e1dc878
JB
214
215### Version 1.6
216
c56d42f1 217#### Core Profile
7e1dc878
JB
218
219- :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -)
220- :x: ClockAlignedDataInterval (type: integer) (units: seconds)
291cb255 221- :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds)
7e1dc878
JB
222- :x: GetConfigurationMaxKeys (type: integer) (units: -)
223- :white_check_mark: HeartbeatInterval (type: integer) (units: seconds)
224- :x: LocalAuthorizeOffline (type: boolean) (units: -)
225- :x: LocalPreAuthorize (type: boolean) (units: -)
226- :x: MeterValuesAlignedData (type: CSL) (units: -)
227- :white_check_mark: MeterValuesSampledData (type: CSL) (units: -)
228- :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds)
229- :white_check_mark: NumberOfConnectors (type: integer) (units: -)
230- :x: ResetRetries (type: integer) (units: times)
231- :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -)
232- :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -)
233- :x: StopTransactionOnInvalidId (type: boolean) (units: -)
234- :x: StopTxnAlignedData (type: CSL) (units: -)
235- :x: StopTxnSampledData (type: CSL) (units: -)
36f6a92e 236- :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -)
7e1dc878
JB
237- :x: TransactionMessageAttempts (type: integer) (units: times)
238- :x: TransactionMessageRetryInterval (type: integer) (units: seconds)
239- :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -)
36f6a92e 240- :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds)
7e1dc878 241
c56d42f1 242#### Firmware Management Profile
7e1dc878
JB
243
244- *none*
245
c56d42f1 246#### Local Auth List Management Profile
7e1dc878 247
36f6a92e 248- :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
7e1dc878
JB
249- :x: LocalAuthListMaxLength (type: integer) (units: -)
250- :x: SendLocalListMaxLength (type: integer) (units: -)
251
c56d42f1 252#### Reservation Profile
7e1dc878
JB
253
254- *none*
255
c56d42f1 256#### Smart Charging Profile
7e1dc878
JB
257
258- :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
259- :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
260- :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
261- :x: MaxChargingProfilesInstalled (type: integer) (units: -)
262
c56d42f1 263#### Remote Trigger Profile
7e1dc878
JB
264
265- *none*
266
7dde0b73
JB
267## License
268
9f5030ff 269This 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
270
271Please 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.