repositories / e-mobility-charging-stations-simulator.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Web UI: fix NPE on connectors
[e-mobility-charging-stations-simulator.git] / README.md
... / ...
CommitLineData
1# [e-mobility charging stations simulator](https://github.com/sap/e-mobility-charging-stations-simulator)
2
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
5## Summary
6
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.
8
9## Prerequisites
10
11Install the [node.js](https://nodejs.org/) LTS runtime environment:
12
13### Windows
14
15- [Chocolatey](https://chocolatey.org/):
16
17```powershell
18choco install -y nodejs-lts
19```
20
21### MacOSX
22
23- [Homebrew](https://brew.sh/):
24
25```shell
26brew install node@16
27```
28
29### GNU/Linux:
30
31- [NodeSource](https://github.com/nodesource/distributions) Node.js Binary Distributions for version >= 16.X
32
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).
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).
47
48## Start
49
50To start the program, run: `npm start`.
51
52## Start Web UI
53
54See Web UI [README.md](src/ui/web/README.md) for more information.
55
56## Configuration files syntax
57
58All configuration files are in the JSON standard format.
59
60**Configuration files locations**:
61
62- charging stations simulator configuration: [src/assets/config.json](src/assets/config.json);
63- charging station configuration templates: [src/assets/station-templates](src/assets/station-templates);
64- charging station configurations: [dist/assets/configurations](dist/assets/configurations);
65- charging station RFID tags lists: [src/assets](src/assets).
66
67The 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).
68
69All charging station configuration templates are in the directory [src/assets/station-templates](src/assets/station-templates).
70
71A 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).
72
73**Configuration files hierarchy and priority**:
74
751. charging station configuration: [dist/assets/configurations](dist/assets/configurations);
762. charging station configuration template: [src/assets/station-templates](src/assets/station-templates);
773. charging stations simulator configuration: [src/assets/config.json](src/assets/config.json).
78
79The charging stations simulator have an automatic configuration files reload feature at change for:
80
81- charging stations simulator configuration;
82- charging station configuration templates;
83- charging station authorization RFID tags lists.
84
85But 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.
86
87### Charging stations simulator configuration
88
89**src/assets/config.json**:
90
91| Key | Value(s) | Default Value | Value type | Description |
92| -------------------------- | ------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
93| supervisionUrls | | [] | string \| string[] | string or array of global connection URIs to OCPP-J servers |
94| supervisionUrlDistribution | round-robin/random/sequential | round-robin | boolean | supervision urls distribution policy to simulated charging stations |
95| logStatisticsInterval | | 60 | integer | seconds between charging stations statistics output in the logs |
96| logConsole | true/false | false | boolean | output logs on the console |
97| logFormat | | simple | string | winston log format |
98| logRotate | true/false | true | boolean | enable daily log files rotation |
99| logMaxFiles | | 7 | integer | maximum number of log files to keep |
100| logLevel | emerg/alert/crit/error/warning/notice/info/debug | info | string | winston logging level |
101| logFile | | combined.log | string | log file relative path |
102| logErrorFile | | error.log | string | error log file relative path |
103| 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 |
104| uiServer | | {<br />"enabled": true,<br />"type": "ws",<br />"options": {<br />"host: "localhost",<br />"port": 8080<br />}<br />} | {<br />enabled: boolean;<br />type: ApplicationProtocol;<br />options: ServerOptions;<br />} | UI server configuration section |
105| 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 |
106| 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) |
107
108#### Worker process model:
109
110- **workerSet**:
111 Worker set executing each a static number (elementsPerWorker) of simulated charging stations from the total
112
113- **staticPool**:
114 Statically sized worker pool executing a static total number of simulated charging stations
115
116- **dynamicPool**:
117 Dynamically sized worker pool executing a static total number of simulated charging stations
118
119### Charging station configuration template
120
121**src/assets/station-templates/\<name\>.json**:
122
123| Key | Value(s) | Default Value | Value type | Description |
124| ---------------------------------- | ---------- | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
125| supervisionUrls | | '' | string \| string[] | string or array of connection URIs to OCPP-J servers |
126| supervisionUser | | '' | string | basic HTTP authentication user to OCPP-J server |
127| supervisionPassword | | '' | string | basic HTTP authentication password to OCPP-J server |
128| supervisionUrlOcppConfiguration | true/false | false | boolean | allow supervision URL configuration via a vendor OCPP parameter key |
129| supervisionUrlOcppKey | | 'ConnectionUrl' | string | the vendor string that will be used as a vendor OCPP parameter key to set the supervision URL |
130| ocppVersion | 1.6 | 1.6 | string | OCPP version |
131| ocppProtocol | json | json | string | OCPP protocol |
132| ocppStrictCompliance | true/false | false | boolean | strict adherence to the OCPP version and protocol specifications |
133| 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 |
134| 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 |
135| wsOptions | | {} | ClientOptions & ClientRequestArgs | [ws](https://github.com/websockets/ws) and node.js [http](https://nodejs.org/api/http.html) clients options intersection |
136| authorizationFile | | '' | string | RFID tags list file relative to src/assets path |
137| baseName | | '' | string | base name to build charging stations id |
138| nameSuffix | | '' | string | name suffix to build charging stations id |
139| fixedName | true/false | false | boolean | use the baseName as the charging stations unique name |
140| chargePointModel | | '' | string | charging stations model |
141| chargePointVendor | | '' | string | charging stations vendor |
142| chargePointSerialNumberPrefix | | '' | string | charge point serial number prefix |
143| chargeBoxSerialNumberPrefix | | '' | string | charge box serial number prefix (deprecated in OCPP 1.6) |
144| firmwareVersion | | '' | string | charging stations firmware version |
145| power | | | float \| float[] | charging stations maximum power value(s) |
146| powerSharedByConnectors | true/false | false | boolean | charging stations power shared by its connectors |
147| powerUnit | W/kW | W | string | charging stations power unit |
148| currentOutType | AC/DC | AC | string | charging stations current out type |
149| voltageOut | | AC:230/DC:400 | integer | charging stations voltage out |
150| numberOfPhases | 0/1/3 | AC:3/DC:0 | integer | charging stations number of phase(s) |
151| numberOfConnectors | | | integer \| integer[] | charging stations number of connector(s) |
152| useConnectorId0 | true/false | true | boolean | use connector id 0 definition from the charging station configuration template |
153| randomConnectors | true/false | false | boolean | randomize runtime connector id affectation from the connector id definition in charging station configuration template |
154| resetTime | | 60 | integer | seconds to wait before the charging stations come back at reset |
155| autoRegister | true/false | false | boolean | set charging stations as registered at boot notification for testing purpose |
156| autoReconnectMaxRetries | | -1 (unlimited) | integer | connection retries to the OCPP-J server |
157| reconnectExponentialDelay | true/false | false | boolean | connection delay retry to the OCPP-J server |
158| registrationMaxRetries | | -1 (unlimited) | integer | charging stations boot notification retries |
159| 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 |
160| amperageLimitationUnit | A/cA/dA/mA | A | string | charging stations amperage limit unit |
161| enableStatistics | true/false | true | boolean | enable charging stations statistics |
162| mayAuthorizeAtRemoteStart | true/false | true | boolean | always send authorize at remote start transaction when AuthorizeRemoteTxRequests is enabled |
163| payloadSchemaValidation | true/false | true | boolean | validate OCPP commands PDU against OCA JSON schemas |
164| beginEndMeterValues | true/false | false | boolean | enable Transaction.{Begin,End} MeterValues |
165| outOfOrderEndMeterValues | true/false | false | boolean | send Transaction.End MeterValues out of order. Need to relax OCPP specifications strict compliance ('ocppStrictCompliance' parameter) |
166| meteringPerTransaction | true/false | true | boolean | enable metering history on a per transaction basis |
167| transactionDataMeterValues | true/false | false | boolean | enable transaction data MeterValues at stop transaction |
168| mainVoltageMeterValues | true/false | true | boolean | include charging stations main voltage MeterValues on three phased charging stations |
169| phaseLineToLineVoltageMeterValues | true/false | true | boolean | include charging stations line to line voltage MeterValues on three phased charging stations |
170| customValueLimitationMeterValues | true/false | true | boolean | enable limitation on custom fluctuated value in MeterValues |
171| 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 |
172| Configuration | | | ChargingStationConfiguration | charging stations OCPP parameters configuration section |
173| AutomaticTransactionGenerator | | | AutomaticTransactionGenerator | charging stations ATG configuration section |
174| Connectors | | | Connectors | charging stations connectors configuration section |
175
176#### Configuration section
177
178```json
179 "Configuration": {
180 "configurationKey": [
181 ...
182 {
183 "key": "StandardKey",
184 "readonly": false,
185 "value": "StandardValue",
186 "visible": true,
187 "reboot": false
188 },
189 ...
190 {
191 "key": "VendorKey",
192 "readonly": false,
193 "value": "VendorValue",
194 "visible": false,
195 "reboot": true
196 },
197 ...
198 ]
199 }
200```
201
202#### AutomaticTransactionGenerator section
203
204```json
205 "AutomaticTransactionGenerator": {
206 "enable": false,
207 "minDuration": 60,
208 "maxDuration": 80,
209 "minDelayBetweenTwoTransactions": 15,
210 "maxDelayBetweenTwoTransactions": 30,
211 "probabilityOfStart": 1,
212 "stopAfterHours": 0.3,
213 "stopOnConnectionFailure": true,
214 "requireAuthorize": true
215 }
216```
217
218#### Connectors section
219
220```json
221 "Connectors": {
222 "0": {},
223 "1": {
224 "bootStatus": "Available",
225 "MeterValues": [
226 ...
227 {
228 "unit": "W",
229 "measurand": "Power.Active.Import",
230 "phase": "L1-N",
231 "value": "5000",
232 "fluctuationPercent": "10"
233 },
234 ...
235 {
236 "unit": "A",
237 "measurand": "Current.Import"
238 },
239 ...
240 {
241 "unit": "Wh"
242 },
243 ...
244 ]
245 }
246 },
247```
248
249### Charging station configuration
250
251**dist/assets/configurations/\<hashId\>.json**:
252
253The charging station configuration file is automatically generated at startup from the charging station configuration template file and is persistent.
254
255The 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.
256
257#### stationInfo section
258
259The syntax is similar to charging station configuration template with some added fields like the charging station id (name) and the 'Configuration' section removed.
260
261#### configurationKey section
262
263The syntax is similar to the charging station configuration template 'Configuration' section.
264
265## Docker
266
267In the [docker](./docker) folder:
268
269```bash
270make
271```
272
273Or with the optional git submodules:
274
275```bash
276make SUBMODULES_INIT=true
277```
278
279## OCPP-J commands supported
280
281### Version 1.6
282
283#### Core Profile
284
285- :white_check_mark: Authorize
286- :white_check_mark: BootNotification
287- :white_check_mark: ChangeAvailability
288- :white_check_mark: ChangeConfiguration
289- :white_check_mark: ClearCache
290- :x: DataTransfer
291- :white_check_mark: GetConfiguration
292- :white_check_mark: Heartbeat
293- :white_check_mark: MeterValues
294- :white_check_mark: RemoteStartTransaction
295- :white_check_mark: RemoteStopTransaction
296- :white_check_mark: Reset
297- :white_check_mark: StartTransaction
298- :white_check_mark: StatusNotification
299- :white_check_mark: StopTransaction
300- :white_check_mark: UnlockConnector
301
302#### Firmware Management Profile
303
304- :white_check_mark: GetDiagnostics
305- :white_check_mark: DiagnosticsStatusNotification
306- :x: FirmwareStatusNotification
307- :x: UpdateFirmware
308
309#### Local Auth List Management Profile
310
311- :x: GetLocalListVersion
312- :x: SendLocalList
313
314#### Reservation Profile
315
316- :x: CancelReservation
317- :x: ReserveNow
318
319#### Smart Charging Profile
320
321- :white_check_mark: ClearChargingProfile
322- :x: GetCompositeSchedule
323- :white_check_mark: SetChargingProfile
324
325#### Remote Trigger Profile
326
327- :white_check_mark: TriggerMessage
328
329## OCPP-J standard parameters supported
330
331All 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.
332
333### Version 1.6
334
335#### Core Profile
336
337- :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -)
338- :x: ClockAlignedDataInterval (type: integer) (units: seconds)
339- :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds)
340- :x: GetConfigurationMaxKeys (type: integer) (units: -)
341- :white_check_mark: HeartbeatInterval (type: integer) (units: seconds)
342- :x: LocalAuthorizeOffline (type: boolean) (units: -)
343- :x: LocalPreAuthorize (type: boolean) (units: -)
344- :x: MeterValuesAlignedData (type: CSL) (units: -)
345- :white_check_mark: MeterValuesSampledData (type: CSL) (units: -)
346- :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds)
347- :white_check_mark: NumberOfConnectors (type: integer) (units: -)
348- :x: ResetRetries (type: integer) (units: times)
349- :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -)
350- :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -)
351- :x: StopTransactionOnInvalidId (type: boolean) (units: -)
352- :x: StopTxnAlignedData (type: CSL) (units: -)
353- :x: StopTxnSampledData (type: CSL) (units: -)
354- :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -)
355- :x: TransactionMessageAttempts (type: integer) (units: times)
356- :x: TransactionMessageRetryInterval (type: integer) (units: seconds)
357- :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -)
358- :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds)
359
360#### Firmware Management Profile
361
362- _none_
363
364#### Local Auth List Management Profile
365
366- :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
367- :x: LocalAuthListMaxLength (type: integer) (units: -)
368- :x: SendLocalListMaxLength (type: integer) (units: -)
369
370#### Reservation Profile
371
372- _none_
373
374#### Smart Charging Profile
375
376- :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
377- :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
378- :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
379- :x: MaxChargingProfilesInstalled (type: integer) (units: -)
380
381#### Remote Trigger Profile
382
383- _none_
384
385## UI protocol
386
387Protocol to control the simulator via a Websocket
388
389### Protocol
390
391PDU stands for Protocol Data Unit
392
393Request:
394[`uuid`, `ProcedureName`, `PDU`]
395
396`uuid`: String uniquely representing this request
397`ProcedureName`: The procedure to run on the simulator
398`PDU`: The parameters for said procedure
399
400Response:
401[`uuid`, `PDU`]
402
403`uuid`: String uniquely linking the response to the request
404`PDU`: Response data to requested procedure
405
406### Version 0.0.1
407
408Set the HTTP header _Sec-Websocket-Protocol_ to `ui0.0.1`
409
410#### Procedures
411
412##### Start Simulator
413
414Request:
415`ProcedureName`: 'startSimulator'
416`PDU`: {}
417
418Response:
419`PDU`: {
420`status`
421}
422
423##### Stop Simulator
424
425Request:
426`ProcedureName`: 'stopSimulator'
427`PDU`: {}
428
429Response:
430`PDU`: {
431`status`
432}
433
434##### List Charging Stations
435
436Request:
437`ProcedureName`: 'listChargingStations'
438`PDU`: {}
439
440Response:
441`PDU`: {
442`status`,
443`index`: ChargingStationData,
444...
445`index`: ChargingStationData
446}
447
448##### Start Transaction
449
450Request:
451`ProcedureName`: 'startTransaction'
452`PDU`: {
453`hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array,
454`connectorId`: connector id integer,
455`idTag`: RFID tag string
456}
457
458Response:
459`PDU`: {
460`status`
461}
462
463##### Stop Transaction
464
465Request:
466`ProcedureName`: 'stopTransaction'
467`PDU`: {
468`hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array,
469`transactionId`: transaction id integer
470}
471
472Response:
473`PDU`: {
474`status`
475}
476
477##### Start Charging Station
478
479Request:
480`ProcedureName`: 'startChargingStation'
481`PDU`: {
482`hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array
483}
484
485Response:
486`PDU`: {
487`status`
488}
489
490##### Stop Charging Station
491
492Request:
493`ProcedureName`: 'stopChargingStation'
494`PDU`: {
495`hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array
496}
497
498Response:
499`PDU`: {
500`status`
501}
502
503##### Open Connection
504
505Request:
506`ProcedureName`: 'openConnection'
507`PDU`: {
508`hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array
509}
510
511Response:
512`PDU`: {
513`status`
514}
515
516##### Close Connection
517
518Request:
519`ProcedureName`: 'closeConnection'
520`PDU`: {
521`hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array
522}
523
524Response:
525`PDU`: {
526`status`
527}
528
529## Support, Feedback, Contributing
530
531This 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).
532
533## Code of Conduct
534
535We 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.
536
537## Licensing
538
539Copyright 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