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