Improve code readability
[e-mobility-charging-stations-simulator.git] / README.md
CommitLineData
ae8ee665 1# [charging-stations-simulator](https://github.com/jerome-benoit/charging-stations-simulator)
7dde0b73
JB
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
696ce53a
JB
7## Prerequisites
8
9### Windows
10
11* [Chocolatey](https://chocolatey.org/):
12
13```powershell
14choco install -y nodejs-lts
15```
16
17### MacOSX
18
19* [Homebrew](https://brew.sh/):
20
21```shell
22brew install node@14
23```
24
80c8112d 25### GNU/Linux:
511780c3
JB
26
27* [NodeSource](https://github.com/nodesource/distributions) Node.js Binary Distributions for version 14.X
28
2c28fc83
JB
29## Configuration syntax
30
31All configuration files are in the JSON standard format.
32
511780c3 33The charging stations simulator's main 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).
2c28fc83
JB
34
35All charging station templates are in the directory [src/assets/station-templates](src/assets/station-templates).
36
511780c3
JB
37A 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).
38
39The charging stations simulator have an automatic configuration files reload feature at change for:
40* main configuration;
41* charging station templates;
42* authorization RFID tags.
43
44But the modifications to test have to be done to the files in the build result directory [dist/assets](dist/assets). Once the modifications are finished, they have to be reported or copied to the matching files in the build source directory [src/assets](src/assets) to ensure they will be taken into account at next build.
2c28fc83 45
1b2bd828 46### Main configuration
2c28fc83 47
b1d6e944 48**src/assets/config.json**:
2c28fc83
JB
49
50Key | Value(s) | Default Value | Value type | Description
51--- | -------| --------------| ---------- | ------------
52supervisionURLs | | [] | string[] | array of connection URIs to OCPP-J servers
53distributeStationsToTenantsEqually | true/false | true | boolean | distribute charging stations uniformly to the OCPP-J servers
326ab6fd
JB
54workerProcess | workerSet/staticPool/dynamicPool | workerSet | string | worker threads process type
55workerStartDelay | | 500 | integer | milliseconds to wait at charging station worker threads startup
2c28fc83
JB
56workerPoolMinSize | | 4 | integer | worker threads pool minimum number of threads
57workerPoolMaxSize | | 16 | integer | worker threads pool maximum number of threads
4be5abe3 58workerPoolStrategy | ROUND_ROBIN/LESS_RECENTLY_USED/... | [poolifier](https://github.com/poolifier/poolifier) default: ROUND_ROBBIN | string | worker threads pool [poolifier](https://github.com/poolifier/poolifier) worker choice strategy
2c28fc83 59chargingStationsPerWorker | | 1 | integer | number of charging stations per worker threads for the `workerSet` process type
72f041bd 60logStatisticsInterval | | 60 | integer | seconds between charging stations statistics output in the logs
2c28fc83
JB
61logConsole | true/false | false | boolean | output logs on the console
62logFormat | | simple | string | winston log format
63logRotate | true/false | true | boolean | enable daily log files rotation
0302da79 64logMaxFiles | | 7 | integer | maximum number of log files to keep
2c28fc83
JB
65logLevel | emerg/alert/crit/error/warning/notice/info/debug | info | string | winston logging level
66logFile | | combined.log | string | log file relative path
67logErrorFile | | error.log | string | error log file relative path
312ff77c 68performanceStorage | | { "enabled": false, "type": "jsonfile", "file:///performanceRecords.json" } | { enabled: string; type: string; URI: string; } where type can be 'jsonfile' or 'mongodb' | performance storage configuration section
72f041bd 69stationTemplateURLs | | {}[] | { file: string; numberOfStations: number; }[] | array of charging station templates URIs configuration section (template file name and number of stations)
a6b3c6c3
JB
70
71#### Worker process model:
72
73- **workerSet**:
74 Worker set executing each a static number (chargingStationsPerWorker) of simulated charging stations from the total
75
76- **staticPool**:
77 Statically sized worker pool executing a static total number of simulated charging stations
78
79- **dynamicPool**:
80 Dynamically sized worker pool executing a static total number of simulated charging stations
81
2c28fc83 82### Charging station template
2e6e52f3 83
2c28fc83
JB
84Key | Value(s) | Default Value | Value type | Description
85--- | -------| --------------| ---------- | ------------
a02da55f 86supervisionURL | | '' | string | connection URI to OCPP-J server
15042c5f
JB
87supervisionUser | | '' | string | basic HTTP authentication user to OCPP-J server
88supervisionPassword | | '' | string | basic HTTP authentication password to OCPP-J server
a02da55f
JB
89ocppVersion | 1.6 | 1.6 | string | OCPP version
90ocppProtocol | json | json | string | OCPP protocol
cd8dd457 91wsOptions | | {} | ClientOptions & ClientRequestArgs | [ws](https://github.com/websockets/ws) and node.js [http](https://nodejs.org/api/http.html) clients options intersection
2c28fc83 92authorizationFile | | '' | string | RFID tags list file relative to src/assets path
a02da55f
JB
93baseName | | '' | string | base name to build charging stations name
94nameSuffix | | '' | string | name suffix to build charging stations name
95fixedName | true/false | false | boolean | use the baseName as the charging stations unique name
96chargePointModel | | '' | string | charging stations model
97chargePointVendor | | '' | string | charging stations vendor
98chargeBoxSerialNumberPrefix | | '' | string | charging stations serial number prefix
99firmwareVersion | | '' | string | charging stations firmware version
4a1857a2 100power | | | float\|float[] | charging stations maximum power value(s)
c6f76013 101powerSharedByConnectors | true/false | false | boolean | charging stations power shared by its connectors
ef16e252 102powerUnit | W/kW | W | string | charging stations power unit
7decf1b6 103currentOutType | AC/DC | AC | string | charging stations current out type
6ed92bc1 104voltageOut | | AC:230/DC:400 | integer | charging stations voltage out
c706280d 105numberOfPhases | 0/1/3 | AC:3/DC:0 | integer | charging stations number of phase(s)
7decf1b6
JB
106numberOfConnectors | | | integer\|integer[] | charging stations number of connector(s)
107useConnectorId0 | true/false | true | boolean | use connector id 0 definition from the template
11b056bb 108randomConnectors | true/false | false | boolean | randomize runtime connector id affectation from the connector id definition in template
7decf1b6 109resetTime | | 60 | integer | seconds to wait before the charging stations come back at reset
47e22477 110autoRegister | true/false | false | boolean | set the charging station as registered at boot notification for testing purpose
7decf1b6
JB
111autoReconnectMaxRetries | | -1 (unlimited) | integer | connection retries to the OCPP-J server
112reconnectExponentialDelay | true/false | false | boolean | connection delay retry to the OCPP-J server
0b13b85d 113registrationMaxRetries | | -1 (unlimited) | integer | charging stations boot notification retries
6ed92bc1 114enableStatistics | true/false | true | boolean | enable charging stations statistics
a7fc8211 115mayAuthorizeAtRemoteStart | true/false | true | boolean | always send authorize at remote start transaction when AuthorizeRemoteTxRequests is enabled
6ed92bc1
JB
116beginEndMeterValues | true/false | false | boolean | enable Transaction.{Begin,End} MeterValues
117outOfOrderEndMeterValues | true/false | false | boolean | send Transaction.End MeterValues out of order
a7fc8211 118meteringPerTransaction | true/false | true | boolean | enable metering history on a per transaction basis
fd0c36fa 119transactionDataMeterValues | true/false | false | boolean | enable transaction data MeterValues at stop transaction
9ccca265 120mainVoltageMeterValues | true/false | true | boolean | include charging station main voltage MeterValues on three phased charging stations
6b10669b 121phaseLineToLineVoltageMeterValues | true/false | true | boolean | include charging station line to line voltage MeterValues on three phased charging stations
72f041bd
JB
122Configuration | | | ChargingStationConfiguration | charging stations OCPP parameters configuration section
123AutomaticTransactionGenerator | | | AutomaticTransactionGenerator | charging stations ATG configuration section
124Connectors | | | Connectors | charging stations connectors configuration section
c94a349a
JB
125
126#### Configuration section
127
128```json
0302da79 129 "Configuration": {
c94a349a
JB
130 "configurationKey": [
131 ...
132 {
133 "key": "StandardKey",
134 "readonly": false,
135 "value": "StandardValue",
136 "visible": true,
137 "reboot": false
138 },
139 ...
140 {
141 "key": "VendorKey",
142 "readonly": false,
143 "value": "VendorValue",
144 "visible": false,
145 "reboot": true
146 },
147 ...
148 ]
149 }
150```
151
152#### AutomaticTransactionGenerator section
153
154```json
0302da79 155 "AutomaticTransactionGenerator": {
c94a349a
JB
156 "enable": false,
157 "minDuration": 60,
158 "maxDuration": 80,
159 "minDelayBetweenTwoTransactions": 15,
160 "maxDelayBetweenTwoTransactions": 30,
161 "probabilityOfStart": 1,
162 "stopAfterHours": 0.3,
163 "stopOnConnectionFailure": true,
e644918b 164 "requireAuthorize": true
c94a349a
JB
165 }
166```
167#### Connectors section
168
169```json
0302da79 170 "Connectors": {
c94a349a
JB
171 "0": {},
172 "1": {
173 "bootStatus": "Available",
174 "MeterValues": [
9bd87386
JB
175 ...
176 {
177 "unit": "W",
178 "measurand": "Power.Active.Import",
179 "phase": "L1-N",
180 "value": "5000",
181 "fluctuationPercent": "10"
182 },
c94a349a
JB
183 ...
184 {
185 "unit": "A",
186 "measurand": "Current.Import"
187 },
188 ...
189 {
190 "unit": "Wh"
191 },
192 ...
193 ]
194 }
195 },
196```
197
6f0ec20e
JB
198## Start
199
200To start the program, run: `npm start`.
201
202## Docker
203
204In the [docker](./docker) folder:
205
206```bash
207make
208```
209
bfcad885 210Or with the optional git submodules:
6f0ec20e
JB
211
212```bash
bfcad885 213make SUBMODULES_INIT=true
6f0ec20e
JB
214```
215
216## OCPP-J commands supported
c94a349a
JB
217
218### Version 1.6
219
c56d42f1 220#### Core Profile
6f0ec20e 221
778f7924
JB
222- :white_check_mark: Authorize
223- :white_check_mark: BootNotification
224- :white_check_mark: ChangeAvailability
225- :white_check_mark: ChangeConfiguration
226- :white_check_mark: ClearCache
9e1b12e4 227- :x: DataTransfer
778f7924
JB
228- :white_check_mark: GetConfiguration
229- :white_check_mark: Heartbeat
230- :white_check_mark: MeterValues
231- :white_check_mark: RemoteStartTransaction
232- :white_check_mark: RemoteStopTransaction
233- :white_check_mark: Reset
234- :white_check_mark: StartTransaction
235- :white_check_mark: StatusNotification
236- :white_check_mark: StopTransaction
237- :white_check_mark: UnlockConnector
6f0ec20e 238
c56d42f1 239#### Firmware Management Profile
6f0ec20e 240
b652b0c3 241- :white_check_mark: GetDiagnostics
d50343bd 242- :white_check_mark: DiagnosticsStatusNotification
9e1b12e4
JB
243- :x: FirmwareStatusNotification
244- :x: UpdateFirmware
6f0ec20e 245
c56d42f1 246#### Local Auth List Management Profile
6f0ec20e 247
9e1b12e4
JB
248- :x: GetLocalListVersion
249- :x: SendLocalList
6f0ec20e 250
c56d42f1 251#### Reservation Profile
6f0ec20e 252
9e1b12e4
JB
253- :x: CancelReservation
254- :x: ReserveNow
6f0ec20e 255
c56d42f1 256#### Smart Charging Profile
6f0ec20e 257
778f7924
JB
258- :white_check_mark: ClearChargingProfile
259- :white_check_mark: GetCompositeSchedule
260- :white_check_mark: SetChargingProfile
6f0ec20e 261
c56d42f1 262#### Remote Trigger Profile
6f0ec20e 263
802cfa13 264- :white_check_mark: TriggerMessage
7dde0b73 265
7e1dc878
JB
266## OCPP-J standard parameters supported
267
adf16e64 268All 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
269
270### Version 1.6
271
c56d42f1 272#### Core Profile
7e1dc878
JB
273
274- :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -)
275- :x: ClockAlignedDataInterval (type: integer) (units: seconds)
291cb255 276- :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds)
7e1dc878
JB
277- :x: GetConfigurationMaxKeys (type: integer) (units: -)
278- :white_check_mark: HeartbeatInterval (type: integer) (units: seconds)
279- :x: LocalAuthorizeOffline (type: boolean) (units: -)
280- :x: LocalPreAuthorize (type: boolean) (units: -)
281- :x: MeterValuesAlignedData (type: CSL) (units: -)
282- :white_check_mark: MeterValuesSampledData (type: CSL) (units: -)
283- :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds)
284- :white_check_mark: NumberOfConnectors (type: integer) (units: -)
285- :x: ResetRetries (type: integer) (units: times)
286- :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -)
287- :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -)
288- :x: StopTransactionOnInvalidId (type: boolean) (units: -)
289- :x: StopTxnAlignedData (type: CSL) (units: -)
290- :x: StopTxnSampledData (type: CSL) (units: -)
36f6a92e 291- :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -)
7e1dc878
JB
292- :x: TransactionMessageAttempts (type: integer) (units: times)
293- :x: TransactionMessageRetryInterval (type: integer) (units: seconds)
294- :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -)
36f6a92e 295- :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds)
7e1dc878 296
c56d42f1 297#### Firmware Management Profile
7e1dc878
JB
298
299- *none*
300
c56d42f1 301#### Local Auth List Management Profile
7e1dc878 302
36f6a92e 303- :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
7e1dc878
JB
304- :x: LocalAuthListMaxLength (type: integer) (units: -)
305- :x: SendLocalListMaxLength (type: integer) (units: -)
306
c56d42f1 307#### Reservation Profile
7e1dc878
JB
308
309- *none*
310
c56d42f1 311#### Smart Charging Profile
7e1dc878
JB
312
313- :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
314- :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
315- :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
316- :x: MaxChargingProfilesInstalled (type: integer) (units: -)
317
c56d42f1 318#### Remote Trigger Profile
7e1dc878
JB
319
320- *none*
321
7dde0b73
JB
322## License
323
25c7bbb9 324This 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 or the code source file header.
7dde0b73
JB
325
326Please 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.