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