repositories / e-mobility-charging-stations-simulator.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
docs: improve configuration file documentation
[e-mobility-charging-stations-simulator.git] / README.md
1 <!-- markdownlint-disable-file MD033 MD024 -->
2
3 # [e-mobility charging stations simulator](https://github.com/sap/e-mobility-charging-stations-simulator)
4
5 [![GitHub Clones](https://img.shields.io/badge/dynamic/json?color=brightgreen&label=Clone&query=count&url=https://gist.githubusercontent.com/jerome-benoit/c7c669b881d5b27dc0b44a639504ff93/raw/clone.json&logo=github)](https://github.com/SAP/e-mobility-charging-stations-simulator/graphs/traffic)
6 [![GitHub commit activity (main)](https://img.shields.io/github/commit-activity/m/SAP/e-mobility-charging-stations-simulator/main?color=brightgreen&logo=github)](https://github.com/SAP/e-mobility-charging-stations-simulator/graphs/commit-activity)
7 [![CI workflow](https://github.com/SAP/e-mobility-charging-stations-simulator/actions/workflows/ci.yml/badge.svg)](https://github.com/SAP/e-mobility-charging-stations-simulator/actions/workflows/ci.yml)
8 [![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)
9 [![Javascript Standard Style Guide](<https://badgen.net/static/code style/standard/green>)](https://standardjs.com)
10
11 ## Summary
12
13 Simple [node.js](https://nodejs.org/) software to simulate and scale a set of charging stations based on the OCPP-J protocol as part of [SAP e-Mobility](https://www.sap.com/products/scm/e-mobility.html) solution.
14
15 ## Prerequisites
16
17 Install the [node.js](https://nodejs.org/) current LTS or superior version runtime environment:
18
19 ### Windows
20
21 - [Chocolatey](https://chocolatey.org/):
22
23 ```powershell
24 choco install -y nodejs
25 ```
26
27 ### MacOSX
28
29 - [Homebrew](https://brew.sh/):
30
31 ```shell
32 brew install node
33 ```
34
35 ### GNU/Linux
36
37 - [NodeSource](https://github.com/nodesource/distributions) Node.js Binary Distributions for all supported versions.
38
39 ## Installation
40
41 Enable corepack if not already done and install latest pnpm version:
42
43 ```shell
44 corepack enable
45 corepack prepare pnpm@latest --activate
46 ```
47
48 In the repository root, run the following command:
49
50 ```shell
51 pnpm install
52 ```
53
54 ## Initial configuration
55
56 Copy the configuration template file [src/assets/config-template.json](src/assets/config-template.json) to [src/assets/config.json](src/assets/config.json).
57 Copy the RFID tags template file [src/assets/idtags-template.json](src/assets/idtags-template.json) to [src/assets/idtags.json](src/assets/idtags.json).
58
59 Tweak them to your needs by following the section [configuration files syntax](README.md#configuration-files-syntax): OCPP server supervision URL(s), charging station templates, etc.
60
61 ## Start
62
63 To start the program, run: `pnpm start`.
64
65 ## Start Web UI
66
67 See Web UI [README.md](ui/web/README.md) for more information.
68
69 ## Configuration files syntax
70
71 All configuration files are in the JSON standard format.
72
73 **Configuration files locations**:
74
75 - charging stations simulator configuration: [src/assets/config.json](src/assets/config.json);
76 - charging station configuration templates: [src/assets/station-templates](src/assets/station-templates);
77 - charging station configurations: [dist/assets/configurations](dist/assets/configurations);
78 - charging station RFID tags lists: [src/assets](src/assets).
79
80 The 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).
81
82 All charging station configuration templates are in the directory [src/assets/station-templates](src/assets/station-templates).
83
84 A list of RFID tags must be defined for the automatic transaction generator in a file with the default location and name: `src/assets/idtags.json`. A template file is available at [src/assets/idtags-template.json](src/assets/idtags-template.json).
85
86 **Configuration files hierarchy and priority**:
87
88 1. charging station configuration: [dist/assets/configurations](dist/assets/configurations);
89 2. charging station configuration template: [src/assets/station-templates](src/assets/station-templates);
90 3. charging stations simulator configuration: [src/assets/config.json](src/assets/config.json).
91
92 The charging stations simulator has an automatic configuration files reload feature at change for:
93
94 - charging stations simulator configuration;
95 - charging station configuration templates;
96 - charging station authorization RFID tags lists.
97
98 But the modifications to test have to be done to the files in the build target directory [dist/assets](dist/assets). Once the modifications are done, they have to be reported to the matching files in the build source directory [src/assets](src/assets) to ensure they will be taken into account at next build.
99
100 ### Charging stations simulator configuration
101
102 **src/assets/config.json**:
103
104 | Key | Value(s) | Default Value | Value type | Description |
105 | -------------------------- | -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
106 | supervisionUrls | | [] | string \| string[] | string or strings array containing global connection URIs to OCPP-J servers |
107 | supervisionUrlDistribution | round-robin/random/charging-station-affinity | charging-station-affinity | string | supervision urls distribution policy to simulated charging stations |
108 | log | | {<br />"enabled": true,<br />"file": "logs/combined.log",<br />"errorFile": "logs/error.log",<br />"statisticsInterval": 60,<br />"level": "info",<br />"console": false,<br />"format": "simple",<br />"rotate": true<br />} | {<br />enabled: boolean;<br />file: string;<br />errorFile: string;<br />statisticsInterval: number;<br />level: string;<br />console: boolean;<br />format: string;<br />rotate: boolean;<br />maxFiles: string \| number;<br />maxSize: string \| number;<br />} | Log configuration section:<br />- _enabled_: enable logging<br />- _file_: log file relative path<br />- _errorFile_: error log file relative path<br />- _statisticsInterval_: seconds between charging stations statistics output in the logs<br />- _level_: emerg/alert/crit/error/warning/notice/info/debug [winston](https://github.com/winstonjs/winston) logging level</br >- _console_: output logs on the console<br />- _format_: [winston](https://github.com/winstonjs/winston) log format<br />- _rotate_: enable daily log files rotation<br />- _maxFiles_: maximum number of log files: https://github.com/winstonjs/winston-daily-rotate-file#options<br />- _maxSize_: maximum size of log files in bytes, or units of kb, mb, and gb: https://github.com/winstonjs/winston-daily-rotate-file#options |
109 | worker | | {<br />"processType": "workerSet",<br />"startDelay": 500,<br />"elementStartDelay": 0,<br />"elementsPerWorker": 'auto',<br />"poolMinSize": 4,<br />"poolMaxSize": 16<br />} | {<br />processType: WorkerProcessType;<br />startDelay: number;<br />elementStartDelay: number;<br />elementsPerWorker: number \| 'auto' \| 'all';<br />poolMinSize: number;<br />poolMaxSize: number;<br />} | Worker configuration section:<br />- _processType_: worker threads process type (`workerSet`/`fixedPool`/`dynamicPool`)<br />- _startDelay_: milliseconds to wait at worker threads startup (only for `workerSet` worker 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 (`auto` means (number of stations) / (number of CPUs) \* 1.5 if (number of stations) > (number of CPUs), otherwise 1; `all` means a unique worker will run all charging stations)<br />- _poolMinSize_: worker threads pool minimum number of threads</br >- _poolMaxSize_: worker threads pool maximum number of threads<br />- _resourceLimits_: worker threads [resource limits](https://nodejs.org/api/worker_threads.html#new-workerfilename-options) object option |
110 | uiServer | | {<br />"enabled": false,<br />"type": "ws",<br />"version": "1.1",<br />"options": {<br />"host": "localhost",<br />"port": 8080<br />}<br />} | {<br />enabled: boolean;<br />type: ApplicationProtocol;<br />version: ApplicationProtocolVersion;<br />options: ServerOptions;<br />authentication: {<br />enabled: boolean;<br />type: AuthenticationType;<br />username: string;<br />password: string;<br />}<br />} | UI server configuration section:<br />- _enabled_: enable UI server<br />- _type_: 'http' or 'ws'<br />- _version_: HTTP version '1.1' or '2.0'<br />- _options_: node.js net module [listen options](https://nodejs.org/api/net.html#serverlistenoptions-callback) |
111 | performanceStorage | | {<br />"enabled": false,<br />"type": "jsonfile",<br />"uri": "file:///performance/performanceRecords.json"<br />} | {<br />enabled: boolean;<br />type: string;<br />uri: string;<br />} | Performance storage configuration section:<br />- _enabled_: enable performance storage<br />- _type_: 'jsonfile' or 'mongodb'<br />- _uri_: storage URI |
112 | 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) |
113
114 #### Worker process model
115
116 - **workerSet**:
117 Worker set executing each a fixed number (elementsPerWorker) of simulated charging stations from the total
118
119 - **fixedPool**:
120 Fixedly sized worker pool executing a fixed total number of simulated charging stations
121
122 - **dynamicPool** (experimental):
123 Dynamically sized worker pool executing a fixed total number of simulated charging stations
124
125 ### Charging station configuration template
126
127 **src/assets/station-templates/\<name\>.json**:
128
129 | Key | Value(s) | Default Value | Value type | Description |
130 | ---------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
131 | supervisionUrls | | [] | string \| string[] | string or strings array containing connection URIs to OCPP-J servers |
132 | supervisionUser | | undefined | string | basic HTTP authentication user to OCPP-J server |
133 | supervisionPassword | | undefined | string | basic HTTP authentication password to OCPP-J server |
134 | supervisionUrlOcppConfiguration | true/false | false | boolean | allow supervision URL configuration via a vendor OCPP parameter key |
135 | supervisionUrlOcppKey | | 'ConnectionUrl' | string | the vendor string that will be used as a vendor OCPP parameter key to set the supervision URL |
136 | ocppVersion | 1.6/2.0/2.0.1 | 1.6 | string | OCPP version |
137 | ocppProtocol | json | json | string | OCPP protocol |
138 | ocppStrictCompliance | true/false | true | boolean | strict adherence to the OCPP version and protocol specifications with OCPP commands PDU validation against [OCA](https://www.openchargealliance.org/) JSON schemas |
139 | 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](dist/assets/configurations) |
140 | 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](dist/assets/configurations) |
141 | automaticTransactionGeneratorPersistentConfiguration | true/false | true | boolean | enable persistent automatic transaction generator configuration storage by charging stations 'hashId'. The persistency is ensured by the charging stations configuration files in [dist/assets/configurations](dist/assets/configurations) |
142 | wsOptions | | {} | ClientOptions & ClientRequestArgs | [ws](https://github.com/websockets/ws) and node.js [http](https://nodejs.org/api/http.html) clients options intersection |
143 | idTagsFile | | undefined | string | RFID tags list file relative to [src/assets](src/assets) path |
144 | baseName | | undefined | string | base name to build charging stations id |
145 | nameSuffix | | undefined | string | name suffix to build charging stations id |
146 | fixedName | true/false | false | boolean | use the baseName as the charging stations unique name |
147 | chargePointModel | | undefined | string | charging stations model |
148 | chargePointVendor | | undefined | string | charging stations vendor |
149 | chargePointSerialNumberPrefix | | undefined | string | charge point serial number prefix |
150 | chargeBoxSerialNumberPrefix | | undefined | string | charge box serial number prefix (deprecated since OCPP 1.6) |
151 | firmwareVersionPattern | | Semantic versioning regular expression: https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string | string | charging stations firmware version pattern |
152 | firmwareVersion | | undefined | string | charging stations firmware version |
153 | power | | | float \| float[] | charging stations maximum power value(s) |
154 | powerSharedByConnectors | true/false | false | boolean | charging stations power shared by its connectors |
155 | powerUnit | W/kW | W | string | charging stations power unit |
156 | currentOutType | AC/DC | AC | string | charging stations current out type |
157 | voltageOut | | AC:230/DC:400 | integer | charging stations voltage out |
158 | numberOfPhases | 0/1/3 | AC:3/DC:0 | integer | charging stations number of phase(s) |
159 | numberOfConnectors | | | integer \| integer[] | charging stations number of connector(s) |
160 | useConnectorId0 | true/false | true | boolean | use connector id 0 definition from the charging station configuration template |
161 | randomConnectors | true/false | false | boolean | randomize runtime connector id affectation from the connector id definition in charging station configuration template |
162 | resetTime | | 60 | integer | seconds to wait before the charging stations come back at reset |
163 | autoRegister | true/false | false | boolean | set charging stations as registered at boot notification for testing purpose |
164 | autoReconnectMaxRetries | | -1 (unlimited) | integer | connection retries to the OCPP-J server |
165 | reconnectExponentialDelay | true/false | false | boolean | connection delay retry to the OCPP-J server |
166 | registrationMaxRetries | | -1 (unlimited) | integer | charging stations boot notification retries |
167 | 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 |
168 | amperageLimitationUnit | A/cA/dA/mA | A | string | charging stations amperage limit unit |
169 | enableStatistics | true/false | false | boolean | enable charging stations statistics |
170 | remoteAuthorization | true/false | true | boolean | enable RFID tags remote authorization |
171 | beginEndMeterValues | true/false | false | boolean | enable Transaction.{Begin,End} MeterValues |
172 | outOfOrderEndMeterValues | true/false | false | boolean | send Transaction.End MeterValues out of order. Need to relax OCPP specifications strict compliance ('ocppStrictCompliance' parameter) |
173 | meteringPerTransaction | true/false | true | boolean | enable metering history on a per transaction basis |
174 | transactionDataMeterValues | true/false | false | boolean | enable transaction data MeterValues at stop transaction |
175 | stopTransactionsOnStopped | true/false | true | boolean | enable stop transactions on charging station stop |
176 | mainVoltageMeterValues | true/false | true | boolean | include charging stations main voltage MeterValues on three phased charging stations |
177 | phaseLineToLineVoltageMeterValues | true/false | false | boolean | include charging stations line to line voltage MeterValues on three phased charging stations |
178 | customValueLimitationMeterValues | true/false | true | boolean | enable limitation on custom fluctuated value in MeterValues |
179 | firmwareUpgrade | | {<br />"versionUpgrade": {<br />"step": 1<br />},<br />"reset": true<br />} | {<br />versionUpgrade: {<br />patternGroup: number;<br />step: number;<br />};<br />reset: boolean;<br />failureStatus: 'DownloadFailed' \| 'InstallationFailed';<br />} | Configuration section for simulating firmware upgrade support. |
180 | 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 OCPP commands are supported |
181 | messageTriggerSupport | | {} | Record<MessageTrigger, boolean> | Configuration section for OCPP commands trigger support. Empty section means all implemented OCPP trigger commands are supported |
182 | Configuration | | | ChargingStationOcppConfiguration | charging stations OCPP parameters configuration section |
183 | AutomaticTransactionGenerator | | | AutomaticTransactionGeneratorConfiguration | charging stations ATG configuration section |
184 | Connectors | | | Record<string, ConnectorStatus> | charging stations connectors configuration section |
185 | Evses | | | Record<string, EvseTemplate> | charging stations EVSEs configuration section |
186
187 #### Configuration section syntax example
188
189 ```json
190 "Configuration": {
191 "configurationKey": [
192 ...
193 {
194 "key": "StandardKey",
195 "readonly": false,
196 "value": "StandardValue",
197 "visible": true,
198 "reboot": false
199 },
200 ...
201 {
202 "key": "VendorKey",
203 "readonly": false,
204 "value": "VendorValue",
205 "visible": false,
206 "reboot": true
207 },
208 ...
209 ]
210 }
211 ```
212
213 #### AutomaticTransactionGenerator section syntax example
214
215 ##### Type definition:
216
217 ```ts
218 type AutomaticTransactionGeneratorConfiguration = {
219 enable: boolean
220 minDuration: number
221 maxDuration: number
222 minDelayBetweenTwoTransactions: number
223 maxDelayBetweenTwoTransactions: number
224 probabilityOfStart: number
225 stopAfterHours: number
226 stopAbsoluteDuration: boolean
227 stopOnConnectionFailure: boolean
228 requireAuthorize?: boolean
229 idTagDistribution?: 'random' | 'round-robin' | 'connector-affinity'
230 }
231 ```
232
233 ##### Example:
234
235 ```json
236 "AutomaticTransactionGenerator": {
237 "enable": false,
238 "minDuration": 60,
239 "maxDuration": 80,
240 "minDelayBetweenTwoTransactions": 15,
241 "maxDelayBetweenTwoTransactions": 30,
242 "probabilityOfStart": 1,
243 "stopAfterHours": 0.3,
244 "stopOnConnectionFailure": true,
245 "requireAuthorize": true,
246 "idTagDistribution": "random"
247 }
248 ```
249
250 #### Connectors section syntax example
251
252 ```json
253 "Connectors": {
254 "0": {},
255 "1": {
256 "bootStatus": "Available",
257 "MeterValues": [
258 ...
259 {
260 "unit": "W",
261 "measurand": "Power.Active.Import",
262 "phase": "L1-N",
263 "value": "5000",
264 "fluctuationPercent": "10"
265 },
266 ...
267 {
268 "unit": "A",
269 "measurand": "Current.Import",
270 "minimum": "0.5"
271 },
272 ...
273 {
274 "unit": "Wh"
275 },
276 ...
277 ]
278 }
279 },
280 ```
281
282 #### Evses section syntax example
283
284 ```json
285 "Evses": {
286 "0": {
287 "Connectors": {
288 "0": {}
289 }
290 },
291 "1": {
292 "Connectors": {
293 "1": {
294 "bootStatus": "Available",
295 "MeterValues": [
296 ...
297 {
298 "unit": "W",
299 "measurand": "Power.Active.Import",
300 "phase": "L1-N",
301 "value": "5000",
302 "fluctuationPercent": "10"
303 },
304 ...
305 {
306 "unit": "A",
307 "measurand": "Current.Import",
308 "minimum": "0.5"
309 },
310 ...
311 {
312 "unit": "Wh"
313 },
314 ...
315 ]
316 }
317 }
318 }
319 },
320 ```
321
322 ### Charging station configuration
323
324 **dist/assets/configurations/\<hashId\>.json**:
325
326 The charging station configuration file is automatically generated at startup from the charging station configuration template file and is persistent.
327
328 The 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.
329
330 #### stationInfo section
331
332 The syntax is similar to charging station configuration template with some added fields like the charging station id (name) and the 'Configuration' section removed.
333
334 That section is overwritten on matching charging station configuration template file changes.
335
336 #### connectorsStatus section
337
338 The syntax is similar to charging station configuration template 'Connectors' section with some added fields.
339
340 That section is overwritten on matching charging station configuration template file changes.
341
342 #### automaticTransactionGenerator section
343
344 The syntax is similar to the charging station configuration template 'AutomaticTransactionGenerator' section.
345
346 That section is overwritten on matching charging station configuration template file changes.
347
348 #### automaticTransactionGeneratorStatuses section
349
350 That section is not overwritten on matching charging station configuration template file changes.
351
352 #### configurationKey section
353
354 The syntax is similar to the charging station configuration template 'Configuration' section.
355
356 That section is not overwritten on matching charging station configuration template file changes.
357
358 ## Docker
359
360 In the [docker](./docker) folder:
361
362 ```shell
363 make
364 ```
365
366 <!-- Or with the optional git submodules:
367
368 ```shell
369 make SUBMODULES_INIT=true
370 ``` -->
371
372 ## OCPP-J commands supported
373
374 ### Version 1.6
375
376 #### Core Profile
377
378 - :white_check_mark: Authorize
379 - :white_check_mark: BootNotification
380 - :white_check_mark: ChangeAvailability
381 - :white_check_mark: ChangeConfiguration
382 - :white_check_mark: ClearCache
383 - :white_check_mark: DataTransfer
384 - :white_check_mark: GetConfiguration
385 - :white_check_mark: Heartbeat
386 - :white_check_mark: MeterValues
387 - :white_check_mark: RemoteStartTransaction
388 - :white_check_mark: RemoteStopTransaction
389 - :white_check_mark: Reset
390 - :white_check_mark: StartTransaction
391 - :white_check_mark: StatusNotification
392 - :white_check_mark: StopTransaction
393 - :white_check_mark: UnlockConnector
394
395 #### Firmware Management Profile
396
397 - :white_check_mark: GetDiagnostics
398 - :white_check_mark: DiagnosticsStatusNotification
399 - :white_check_mark: FirmwareStatusNotification
400 - :white_check_mark: UpdateFirmware
401
402 #### Local Auth List Management Profile
403
404 - :x: GetLocalListVersion
405 - :x: SendLocalList
406
407 #### Reservation Profile
408
409 - :white_check_mark: CancelReservation
410 - :white_check_mark: ReserveNow
411
412 #### Smart Charging Profile
413
414 - :white_check_mark: ClearChargingProfile
415 - :white_check_mark: GetCompositeSchedule
416 - :white_check_mark: SetChargingProfile
417
418 #### Remote Trigger Profile
419
420 - :white_check_mark: TriggerMessage
421
422 ### Version 2.x.x
423
424 #### Provisioning
425
426 - :white_check_mark: BootNotification
427
428 #### Authorization
429
430 - :white_check_mark: ClearCache
431
432 #### Availability
433
434 - :white_check_mark: StatusNotification
435 - :white_check_mark: Heartbeat
436
437 ## OCPP-J standard parameters supported
438
439 All kind of OCPP parameters are supported in charging station configuration or charging station configuration template file. The list here mention the standard ones also handled automatically in the simulator.
440
441 ### Version 1.6
442
443 #### Core Profile
444
445 - :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -)
446 - :x: ClockAlignedDataInterval (type: integer) (units: seconds)
447 - :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds)
448 - :x: GetConfigurationMaxKeys (type: integer) (units: -)
449 - :white_check_mark: HeartbeatInterval (type: integer) (units: seconds)
450 - :x: LocalAuthorizeOffline (type: boolean) (units: -)
451 - :x: LocalPreAuthorize (type: boolean) (units: -)
452 - :x: MeterValuesAlignedData (type: CSL) (units: -)
453 - :white_check_mark: MeterValuesSampledData (type: CSL) (units: -)
454 - :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds)
455 - :white_check_mark: NumberOfConnectors (type: integer) (units: -)
456 - :x: ResetRetries (type: integer) (units: times)
457 - :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -)
458 - :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -)
459 - :x: StopTransactionOnInvalidId (type: boolean) (units: -)
460 - :x: StopTxnAlignedData (type: CSL) (units: -)
461 - :x: StopTxnSampledData (type: CSL) (units: -)
462 - :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -)
463 - :x: TransactionMessageAttempts (type: integer) (units: times)
464 - :x: TransactionMessageRetryInterval (type: integer) (units: seconds)
465 - :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -)
466 - :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds)
467
468 #### Firmware Management Profile
469
470 - _none_
471
472 #### Local Auth List Management Profile
473
474 - :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
475 - :x: LocalAuthListMaxLength (type: integer) (units: -)
476 - :x: SendLocalListMaxLength (type: integer) (units: -)
477
478 #### Reservation Profile
479
480 - :white_check_mark: ReserveConnectorZeroSupported (type: boolean) (units: -)
481
482 #### Smart Charging Profile
483
484 - :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
485 - :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
486 - :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
487 - :x: MaxChargingProfilesInstalled (type: integer) (units: -)
488
489 #### Remote Trigger Profile
490
491 - _none_
492
493 ### Version 2.x.x
494
495 ## UI protocol
496
497 Protocol to control the simulator via a Websocket or HTTP server.
498
499 ### HTTP Protocol
500
501 To learn how to use the HTTP protocol to pilot the simulator, an [Insomnia](https://insomnia.rest/) HTTP requests collection is available in [src/assets/ui-protocol](./src/assets/ui-protocol) directory.
502
503 ### Websocket Protocol
504
505 SRPC protocol over Websocket. PDU stands for 'Protocol Data Unit'.
506
507 - Request:
508 [`uuid`, `ProcedureName`, `PDU`]
509 `uuid`: String uniquely representing this request
510 `ProcedureName`: The procedure to run on the simulator
511 `PDU`: The parameters for said procedure
512
513 - Response:
514 [`uuid`, `PDU`]
515 `uuid`: String uniquely linking the response to the request
516 `PDU`: Response parameters to requested procedure
517
518 An [Insomnia](https://insomnia.rest/) WebSocket requests collection is available in [src/assets/ui-protocol](./src/assets/ui-protocol) directory.
519
520 #### Version 0.0.1
521
522 Set the Websocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
523
524 ##### Procedures
525
526 ###### Start Simulator
527
528 - Request:
529 `ProcedureName`: 'startSimulator'
530 `PDU`: {}
531
532 - Response:
533 `PDU`: {
534 `status`: 'success' | 'failure'
535 }
536
537 ###### Stop Simulator
538
539 - Request:
540 `ProcedureName`: 'stopSimulator'
541 `PDU`: {}
542
543 - Response:
544 `PDU`: {
545 `status`: 'success' | 'failure'
546 }
547
548 ###### List Charging Stations
549
550 - Request:
551 `ProcedureName`: 'listChargingStations'
552 `PDU`: {}
553
554 - Response:
555 `PDU`: {
556 `status`: 'success' | 'failure',
557 `chargingStations`: ChargingStationData[]
558 }
559
560 ###### Start Charging Station
561
562 - Request:
563 `ProcedureName`: 'startChargingStation'
564 `PDU`: {
565 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
566 }
567
568 - Response:
569 `PDU`: {
570 `status`: 'success' | 'failure',
571 `hashIdsSucceeded`: charging station unique identifier strings array,
572 `hashIdsFailed`: charging station unique identifier strings array (optional)
573 `responsesFailed`: failed responses payload array (optional)
574 }
575
576 ###### Stop Charging Station
577
578 - Request:
579 `ProcedureName`: 'stopChargingStation'
580 `PDU`: {
581 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
582 }
583
584 - Response:
585 `PDU`: {
586 `status`: 'success' | 'failure',
587 `hashIdsSucceeded`: charging station unique identifier strings array,
588 `hashIdsFailed`: charging station unique identifier strings array (optional),
589 `responsesFailed`: failed responses payload array (optional)
590 }
591
592 ###### Open Connection
593
594 - Request:
595 `ProcedureName`: 'openConnection'
596 `PDU`: {
597 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
598 }
599
600 - Response:
601 `PDU`: {
602 `status`: 'success' | 'failure',
603 `hashIdsSucceeded`: charging station unique identifier strings array,
604 `hashIdsFailed`: charging station unique identifier strings array (optional),
605 `responsesFailed`: failed responses payload array (optional)
606 }
607
608 ###### Close Connection
609
610 - Request:
611 `ProcedureName`: 'closeConnection'
612 `PDU`: {
613 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
614 }
615
616 - Response:
617 `PDU`: {
618 `status`: 'success' | 'failure',
619 `hashIdsSucceeded`: charging station unique identifier strings array,
620 `hashIdsFailed`: charging station unique identifier strings array (optional),
621 `responsesFailed`: failed responses payload array (optional)
622 }
623
624 ###### Start Automatic Transaction Generator
625
626 - Request:
627 `ProcedureName`: 'startAutomaticTransactionGenerator'
628 `PDU`: {
629 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
630 `connectorIds`: connector id integer array (optional, default: all connectors)
631 }
632
633 - Response:
634 `PDU`: {
635 `status`: 'success' | 'failure',
636 `hashIdsSucceeded`: charging station unique identifier strings array,
637 `hashIdsFailed`: charging station unique identifier strings array (optional),
638 `responsesFailed`: failed responses payload array (optional)
639 }
640
641 ###### Stop Automatic Transaction Generator
642
643 - Request:
644 `ProcedureName`: 'stopAutomaticTransactionGenerator'
645 `PDU`: {
646 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
647 `connectorIds`: connector id integer array (optional, default: all connectors)
648 }
649
650 - Response:
651 `PDU`: {
652 `status`: 'success' | 'failure',
653 `hashIdsSucceeded`: charging station unique identifier strings array,
654 `hashIdsFailed`: charging station unique identifier strings array (optional),
655 `responsesFailed`: failed responses payload array (optional)
656 }
657
658 ###### OCPP commands trigger
659
660 - Request:
661 `ProcedureName`: 'commandName' (the OCPP command name in camel case)
662 `PDU`: {
663 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
664 ...`commandPayload`
665 } (the OCPP command payload with some optional fields added to target the simulated charging stations)
666
667 - Response:
668 `PDU`: {
669 `status`: 'success' | 'failure',
670 `hashIdsSucceeded`: charging station unique identifier strings array,
671 `hashIdsFailed`: charging station unique identifier strings array (optional),
672 `responsesFailed`: failed responses payload array (optional)
673 }
674
675 Examples:
676
677 - **Start Transaction**
678
679 - Request:
680 `ProcedureName`: 'startTransaction'
681 `PDU`: {
682 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
683 `connectorId`: connector id integer,
684 `idTag`: RFID tag string
685 }
686
687 - Response:
688 `PDU`: {
689 `status`: 'success' | 'failure',
690 `hashIdsSucceeded`: charging station unique identifier strings array,
691 `hashIdsFailed`: charging station unique identifier strings array (optional),
692 `responsesFailed`: failed responses payload array (optional)
693 }
694
695 - **Stop Transaction**
696
697 - Request:
698 `ProcedureName`: 'stopTransaction'
699 `PDU`: {
700 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
701 `transactionId`: transaction id integer
702 }
703
704 - Response:
705 `PDU`: {
706 `status`: 'success' | 'failure',
707 `hashIdsSucceeded`: charging station unique identifier strings array,
708 `hashIdsFailed`: charging station unique identifier strings array (optional),
709 `responsesFailed`: failed responses payload array (optional)
710 }
711
712 - **Status Notification**
713
714 - Request:
715 `ProcedureName`: 'statusNotification'
716 `PDU`: {
717 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
718 `connectorId`: connector id integer,
719 `errorCode`: connector error code,
720 `status`: connector status
721 }
722
723 - Response:
724 `PDU`: {
725 `status`: 'success' | 'failure',
726 `hashIdsSucceeded`: charging station unique identifier strings array,
727 `hashIdsFailed`: charging station unique identifier strings array (optional),
728 `responsesFailed`: failed responses payload array (optional)
729 }
730
731 - **Heartbeat**
732
733 - Request:
734 `ProcedureName`: 'heartbeat'
735 `PDU`: {
736 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
737 }
738
739 - Response:
740 `PDU`: {
741 `status`: 'success' | 'failure',
742 `hashIdsSucceeded`: charging station unique identifier strings array,
743 `hashIdsFailed`: charging station unique identifier strings array (optional),
744 `responsesFailed`: failed responses payload array (optional)
745 }
746
747 ## Support, Feedback, Contributing
748
749 This 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).
750
751 ## Code of Conduct
752
753 We 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.
754
755 ## Licensing
756
757 Copyright 2020-2023 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