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