repositories / e-mobility-charging-stations-simulator.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Version 1.1.60
[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
e7aeea18 11- [Chocolatey](https://chocolatey.org/):
696ce53a
JB		 12
13```powershell
14choco install -y nodejs-lts
15```
16
17### MacOSX
18
e7aeea18 19- [Homebrew](https://brew.sh/):
696ce53a
JB		 20
21```shell
8f3d04b0 22brew install node@16
696ce53a
JB		 23```
24
e7aeea18 25### GNU/Linux:
511780c3 26
11d8f3e9 27- [NodeSource](https://github.com/nodesource/distributions) Node.js Binary Distributions for version 16.X
511780c3 28
4d3821a2 29## Configuration files syntax
2c28fc83 30
e7aeea18 31All configuration files are in the JSON standard format.
2c28fc83 32
1816f743 33**Configuration files list**:
2c28fc83 34
170bec53 35- charging stations simulator configuration: [src/assets/config.json](src/assets/config.json);
1816f743 36- charging station configuration templates: [src/assets/station-templates](src/assets/station-templates);
1c51fd1d 37- charging station configurations: [dist/assets/configurations](dist/assets/configurations);
7f818162 38- charging station RFID tags lists: [src/assets](src/assets).
2c28fc83 39
1816f743
JB		 40The charging stations simulator's configuration parameters must be within the `src/assets/config.json` file. A charging station simulator configuration template file is available at [src/assets/config-template.json](src/assets/config-template.json).
41
42All charging station configuration templates are in the directory [src/assets/station-templates](src/assets/station-templates).
43
44A list of RFID tags must be defined for the automatic transaction generator with a 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).
45
46**Configuration files hierarchy and priority**:
47
1c51fd1d 481. charging station configuration: [dist/assets/configurations](dist/assets/configurations);
1816f743 492. charging station configuration template: [src/assets/station-templates](src/assets/station-templates);
170bec53 503. charging stations simulator configuration: [src/assets/config.json](src/assets/config.json).
511780c3 51
e7aeea18 52The charging stations simulator have an automatic configuration files reload feature at change for:
511780c3 53
170bec53 54- charging stations simulator configuration;
1816f743 55- charging station configuration templates;
170bec53 56- charging station authorization RFID tags lists.
2c28fc83 57
e7aeea18
JB		 58But 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.
59
170bec53 60### Charging stations simulator configuration
2c28fc83 61
b1d6e944 62**src/assets/config.json**:
2c28fc83 63
1816f743
JB		 64| Key | Value(s) | Default Value | Value type | Description |
65| -------------------------- | ------------------------------------------------ | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
66| supervisionUrls | | [] | string \| string[] | string or array of global connection URIs to OCPP-J servers |
67| supervisionUrlDistribution | round-robin/random/sequential | round-robin | boolean | supervision urls distribution policy to simulated charging stations |
68| workerProcess | workerSet/staticPool/dynamicPool | workerSet | string | worker threads process type |
69| workerStartDelay | | 500 | integer | milliseconds to wait at worker threads startup (only for workerSet threads process type) |
70| elementStartDelay | | 0 | integer | milliseconds to wait at charging station startup |
71| workerPoolMinSize | | 4 | integer | worker threads pool minimum number of threads |
72| workerPoolMaxSize | | 16 | integer | worker threads pool maximum number of threads |
73| workerPoolStrategy | 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 |
74| chargingStationsPerWorker | | 1 | integer | number of charging stations per worker threads for the `workerSet` process type |
75| logStatisticsInterval | | 60 | integer | seconds between charging stations statistics output in the logs |
76| logConsole | true/false | false | boolean | output logs on the console |
77| logFormat | | simple | string | winston log format |
78| logRotate | true/false | true | boolean | enable daily log files rotation |
79| logMaxFiles | | 7 | integer | maximum number of log files to keep |
80| logLevel | emerg/alert/crit/error/warning/notice/info/debug | info | string | winston logging level |
81| logFile | | combined.log | string | log file relative path |
82| logErrorFile | | error.log | string | error log file relative path |
675fa8e3 83| uiServer | | { "enabled": true, "options": { "host: "localhost", "port": 8080 } } | { enabled: boolean; options: ServerOptions; } | UI WebSocket server configuration section |
1816f743
JB		 84| performanceStorage | | { "enabled": false, "type": "jsonfile", "file:///performanceRecords.json" } | { enabled: boolean; type: string; URI: string; } where type can be 'jsonfile' or 'mongodb' | performance storage configuration section |
85| stationTemplateUrls | | {}[] | { file: string; numberOfStations: number; }[] | array of charging station configuration templates URIs configuration section (charging station configuration template file name and number of stations) |
e7aeea18
JB		 86
87#### Worker process model:
a6b3c6c3
JB		 88
89- **workerSet**:
90 Worker set executing each a static number (chargingStationsPerWorker) of simulated charging stations from the total
91
92- **staticPool**:
e7aeea18 93 Statically sized worker pool executing a static total number of simulated charging stations
a6b3c6c3
JB		 94
95- **dynamicPool**:
e7aeea18 96 Dynamically sized worker pool executing a static total number of simulated charging stations
a6b3c6c3 97
1816f743
JB		 98### Charging station configuration template
99
afccb423 100**src/assets/station-templates/\<name\>.json**:
1816f743 101
170bec53
JB		 102| Key | Value(s) | Default Value | Value type | Description |
103| --------------------------------- | ---------- | --------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
104| supervisionUrls | | '' | string \| string[] | string or array of connection URIs to OCPP-J servers |
105| supervisionUser | | '' | string | basic HTTP authentication user to OCPP-J server |
106| supervisionPassword | | '' | string | basic HTTP authentication password to OCPP-J server |
107| supervisionUrlOcppConfiguration | true/false | false | boolean | allow supervision URL configuration via a vendor OCPP parameter key |
108| supervisionUrlOcppKey | | 'ConnectionUrl' | string | the vendor string that will be used as a vendor OCPP parameter key to set the supervision URL |
109| ocppVersion | 1.6 | 1.6 | string | OCPP version |
110| ocppProtocol | json | json | string | OCPP protocol |
111| ocppStrictCompliance | true/false | false | boolean | strict adherence to the OCPP version and protocol specifications |
112| ocppPersistentConfiguration | true/false | true | boolean | enable persistent OCPP parameters storage by charging stations 'hashId'. The persistency is ensured by the charging stations configuration files in dist/assets/configurations |
113| wsOptions | | {} | ClientOptions & ClientRequestArgs | [ws](https://github.com/websockets/ws) and node.js [http](https://nodejs.org/api/http.html) clients options intersection |
114| authorizationFile | | '' | string | RFID tags list file relative to src/assets path |
115| baseName | | '' | string | base name to build charging stations id |
116| nameSuffix | | '' | string | name suffix to build charging stations id |
117| fixedName | true/false | false | boolean | use the baseName as the charging stations unique name |
118| chargePointModel | | '' | string | charging stations model |
119| chargePointVendor | | '' | string | charging stations vendor |
120| chargePointSerialNumberPrefix | | '' | string | charge point serial number prefix |
121| chargeBoxSerialNumberPrefix | | '' | string | charge box serial number prefix (deprecated in OCPP 1.6) |
122| firmwareVersion | | '' | string | charging stations firmware version |
123| power | | | float \| float[] | charging stations maximum power value(s) |
124| powerSharedByConnectors | true/false | false | boolean | charging stations power shared by its connectors |
125| powerUnit | W/kW | W | string | charging stations power unit |
126| currentOutType | AC/DC | AC | string | charging stations current out type |
127| voltageOut | | AC:230/DC:400 | integer | charging stations voltage out |
128| numberOfPhases | 0/1/3 | AC:3/DC:0 | integer | charging stations number of phase(s) |
129| numberOfConnectors | | | integer \| integer[] | charging stations number of connector(s) |
130| useConnectorId0 | true/false | true | boolean | use connector id 0 definition from the charging station configuration template |
131| randomConnectors | true/false | false | boolean | randomize runtime connector id affectation from the connector id definition in charging station configuration template |
132| resetTime | | 60 | integer | seconds to wait before the charging stations come back at reset |
133| autoRegister | true/false | false | boolean | set charging stations as registered at boot notification for testing purpose |
134| autoReconnectMaxRetries | | -1 (unlimited) | integer | connection retries to the OCPP-J server |
135| reconnectExponentialDelay | true/false | false | boolean | connection delay retry to the OCPP-J server |
136| registrationMaxRetries | | -1 (unlimited) | integer | charging stations boot notification retries |
cc6e8ab5
JB		 137| amperageLimitationOcppKey | | undefined | string | charging stations OCPP parameter key used to set the amperage limit, per phase for each connector on AC and global for DC |
138| amperageLimitationUnit | A/cA/dA/mA | A | string | charging stations amperage limit unit |
170bec53
JB		 139| enableStatistics | true/false | true | boolean | enable charging stations statistics |
140| mayAuthorizeAtRemoteStart | true/false | true | boolean | always send authorize at remote start transaction when AuthorizeRemoteTxRequests is enabled |
141| beginEndMeterValues | true/false | false | boolean | enable Transaction.{Begin,End} MeterValues |
142| outOfOrderEndMeterValues | true/false | false | boolean | send Transaction.End MeterValues out of order. Need to relax OCPP specifications strict compliance ('ocppStrictCompliance' parameter) |
143| meteringPerTransaction | true/false | true | boolean | enable metering history on a per transaction basis |
144| transactionDataMeterValues | true/false | false | boolean | enable transaction data MeterValues at stop transaction |
145| mainVoltageMeterValues | true/false | true | boolean | include charging stations main voltage MeterValues on three phased charging stations |
146| phaseLineToLineVoltageMeterValues | true/false | true | boolean | include charging stations line to line voltage MeterValues on three phased charging stations |
7bc31f9c 147| customValueLimitationMeterValues | true/false | true | boolean | enable limitation on custom fluctuated value in MeterValues |
170bec53
JB		 148| Configuration | | | ChargingStationConfiguration | charging stations OCPP parameters configuration section |
149| AutomaticTransactionGenerator | | | AutomaticTransactionGenerator | charging stations ATG configuration section |
150| Connectors | | | Connectors | charging stations connectors configuration section |
c94a349a
JB		 151
152#### Configuration section
153
154```json
0302da79 155 "Configuration": {
c94a349a
JB		 156 "configurationKey": [
157 ...
158 {
159 "key": "StandardKey",
160 "readonly": false,
161 "value": "StandardValue",
162 "visible": true,
163 "reboot": false
164 },
165 ...
166 {
167 "key": "VendorKey",
168 "readonly": false,
169 "value": "VendorValue",
170 "visible": false,
171 "reboot": true
172 },
173 ...
174 ]
175 }
176```
177
178#### AutomaticTransactionGenerator section
179
180```json
0302da79 181 "AutomaticTransactionGenerator": {
c94a349a
JB		 182 "enable": false,
183 "minDuration": 60,
184 "maxDuration": 80,
185 "minDelayBetweenTwoTransactions": 15,
186 "maxDelayBetweenTwoTransactions": 30,
187 "probabilityOfStart": 1,
188 "stopAfterHours": 0.3,
189 "stopOnConnectionFailure": true,
e644918b 190 "requireAuthorize": true
c94a349a
JB		 191 }
192```
e7aeea18 193
c94a349a
JB		 194#### Connectors section
195
196```json
0302da79 197 "Connectors": {
c94a349a
JB		 198 "0": {},
199 "1": {
200 "bootStatus": "Available",
201 "MeterValues": [
9bd87386
JB		 202 ...
203 {
204 "unit": "W",
205 "measurand": "Power.Active.Import",
206 "phase": "L1-N",
207 "value": "5000",
208 "fluctuationPercent": "10"
209 },
c94a349a
JB		 210 ...
211 {
212 "unit": "A",
213 "measurand": "Current.Import"
214 },
215 ...
216 {
217 "unit": "Wh"
218 },
219 ...
220 ]
221 }
222 },
223```
224
1816f743
JB		 225### Charging station configuration
226
1c51fd1d 227**dist/assets/configurations/\<hashId\>.json**:
1816f743 228
a9ec2018 229The charging station configuration file is automatically generated at startup from the charging station configuration template file and is persistent.
1816f743
JB		 230
231The charging station configuration file content can be regenerated partially on matching charging station configuration template file changes. The charging station serial number is kept unchanged.
232
233#### stationInfo section
234
235The syntax is similar to charging station configuration template with some added fields like the charging station id (name) and the 'Configuration' section removed.
236
237#### configurationKey section
238
239The syntax is similar to the charging station configuration template 'Configuration' section.
240
6f0ec20e
JB		 241## Start
242
243To start the program, run: `npm start`.
244
175d4f46 245To start the program with a UI controller, run: `npm start:server`.
903becc3 246Then, start/stop the simulator by going to `https://<hostname:port>` in a browser. Localhost port will default to 8080. For Cloud Foundry, the port is assigned based on the `process.env.PORT` environment variable.
175d4f46 247
6f0ec20e
JB		 248## Docker
249
250In the [docker](./docker) folder:
251
252```bash
253make
254```
255
bfcad885 256Or with the optional git submodules:
6f0ec20e
JB		 257
258```bash
bfcad885 259make SUBMODULES_INIT=true
6f0ec20e
JB		 260```
261
262## OCPP-J commands supported
c94a349a
JB		 263
264### Version 1.6
265
c56d42f1 266#### Core Profile
6f0ec20e 267
778f7924
JB		 268- :white_check_mark: Authorize
269- :white_check_mark: BootNotification
270- :white_check_mark: ChangeAvailability
271- :white_check_mark: ChangeConfiguration
272- :white_check_mark: ClearCache
9e1b12e4 273- :x: DataTransfer
778f7924
JB		 274- :white_check_mark: GetConfiguration
275- :white_check_mark: Heartbeat
276- :white_check_mark: MeterValues
277- :white_check_mark: RemoteStartTransaction
278- :white_check_mark: RemoteStopTransaction
279- :white_check_mark: Reset
280- :white_check_mark: StartTransaction
281- :white_check_mark: StatusNotification
282- :white_check_mark: StopTransaction
283- :white_check_mark: UnlockConnector
6f0ec20e 284
c56d42f1 285#### Firmware Management Profile
6f0ec20e 286
b652b0c3 287- :white_check_mark: GetDiagnostics
d50343bd 288- :white_check_mark: DiagnosticsStatusNotification
9e1b12e4
JB		 289- :x: FirmwareStatusNotification
290- :x: UpdateFirmware
6f0ec20e 291
c56d42f1 292#### Local Auth List Management Profile
6f0ec20e 293
9e1b12e4
JB		 294- :x: GetLocalListVersion
295- :x: SendLocalList
6f0ec20e 296
c56d42f1 297#### Reservation Profile
6f0ec20e 298
9e1b12e4
JB		 299- :x: CancelReservation
300- :x: ReserveNow
6f0ec20e 301
c56d42f1 302#### Smart Charging Profile
6f0ec20e 303
778f7924 304- :white_check_mark: ClearChargingProfile
68cb8b91 305- :x: GetCompositeSchedule
778f7924 306- :white_check_mark: SetChargingProfile
6f0ec20e 307
c56d42f1 308#### Remote Trigger Profile
6f0ec20e 309
802cfa13 310- :white_check_mark: TriggerMessage
7dde0b73 311
7e1dc878
JB		 312## OCPP-J standard parameters supported
313
1816f743 314All kind of OCPP parameters are supported in a charging station configuration or a charging station configuration template file. The list here mention the standard ones also handled automatically in the simulator.
7e1dc878
JB		 315
316### Version 1.6
317
c56d42f1 318#### Core Profile
7e1dc878
JB		 319
320- :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -)
321- :x: ClockAlignedDataInterval (type: integer) (units: seconds)
291cb255 322- :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds)
7e1dc878
JB		 323- :x: GetConfigurationMaxKeys (type: integer) (units: -)
324- :white_check_mark: HeartbeatInterval (type: integer) (units: seconds)
325- :x: LocalAuthorizeOffline (type: boolean) (units: -)
326- :x: LocalPreAuthorize (type: boolean) (units: -)
327- :x: MeterValuesAlignedData (type: CSL) (units: -)
328- :white_check_mark: MeterValuesSampledData (type: CSL) (units: -)
329- :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds)
330- :white_check_mark: NumberOfConnectors (type: integer) (units: -)
331- :x: ResetRetries (type: integer) (units: times)
332- :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -)
333- :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -)
334- :x: StopTransactionOnInvalidId (type: boolean) (units: -)
335- :x: StopTxnAlignedData (type: CSL) (units: -)
336- :x: StopTxnSampledData (type: CSL) (units: -)
36f6a92e 337- :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -)
7e1dc878
JB		 338- :x: TransactionMessageAttempts (type: integer) (units: times)
339- :x: TransactionMessageRetryInterval (type: integer) (units: seconds)
340- :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -)
36f6a92e 341- :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds)
7e1dc878 342
c56d42f1 343#### Firmware Management Profile
7e1dc878 344
e7aeea18 345- _none_
7e1dc878 346
c56d42f1 347#### Local Auth List Management Profile
7e1dc878 348
36f6a92e 349- :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
7e1dc878
JB		 350- :x: LocalAuthListMaxLength (type: integer) (units: -)
351- :x: SendLocalListMaxLength (type: integer) (units: -)
352
c56d42f1 353#### Reservation Profile
7e1dc878 354
e7aeea18 355- _none_
7e1dc878 356
c56d42f1 357#### Smart Charging Profile
7e1dc878
JB		 358
359- :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
360- :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
361- :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
362- :x: MaxChargingProfilesInstalled (type: integer) (units: -)
363
c56d42f1 364#### Remote Trigger Profile
7e1dc878 365
e7aeea18 366- _none_
7e1dc878 367
7dde0b73
JB		 368## License
369
25c7bbb9 370This 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		 371
372Please 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.
Charging stations simulator mirror - https://github.com/SAP/e-mobility-charging-stations-simulator