repositories / e-mobility-charging-stations-simulator.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
chore: update copyright years
[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 #### evsesStatus section
343
344 The syntax is similar to charging station configuration template 'Evses' section with some added fields.
345
346 That section is overwritten on matching charging station configuration template file changes.
347
348 #### automaticTransactionGenerator section
349
350 The syntax is similar to the charging station configuration template 'AutomaticTransactionGenerator' section.
351
352 That section is overwritten on matching charging station configuration template file changes.
353
354 #### automaticTransactionGeneratorStatuses section
355
356 That section is not overwritten on matching charging station configuration template file changes.
357
358 #### configurationKey section
359
360 The syntax is similar to the charging station configuration template 'Configuration' section.
361
362 That section is not overwritten on matching charging station configuration template file changes.
363
364 ## Docker
365
366 In the [docker](./docker) folder:
367
368 ```shell
369 make
370 ```
371
372 <!-- Or with the optional git submodules:
373
374 ```shell
375 make SUBMODULES_INIT=true
376 ``` -->
377
378 ## OCPP-J commands supported
379
380 ### Version 1.6
381
382 #### Core Profile
383
384 - :white_check_mark: Authorize
385 - :white_check_mark: BootNotification
386 - :white_check_mark: ChangeAvailability
387 - :white_check_mark: ChangeConfiguration
388 - :white_check_mark: ClearCache
389 - :white_check_mark: DataTransfer
390 - :white_check_mark: GetConfiguration
391 - :white_check_mark: Heartbeat
392 - :white_check_mark: MeterValues
393 - :white_check_mark: RemoteStartTransaction
394 - :white_check_mark: RemoteStopTransaction
395 - :white_check_mark: Reset
396 - :white_check_mark: StartTransaction
397 - :white_check_mark: StatusNotification
398 - :white_check_mark: StopTransaction
399 - :white_check_mark: UnlockConnector
400
401 #### Firmware Management Profile
402
403 - :white_check_mark: GetDiagnostics
404 - :white_check_mark: DiagnosticsStatusNotification
405 - :white_check_mark: FirmwareStatusNotification
406 - :white_check_mark: UpdateFirmware
407
408 #### Local Auth List Management Profile
409
410 - :x: GetLocalListVersion
411 - :x: SendLocalList
412
413 #### Reservation Profile
414
415 - :white_check_mark: CancelReservation
416 - :white_check_mark: ReserveNow
417
418 #### Smart Charging Profile
419
420 - :white_check_mark: ClearChargingProfile
421 - :white_check_mark: GetCompositeSchedule
422 - :white_check_mark: SetChargingProfile
423
424 #### Remote Trigger Profile
425
426 - :white_check_mark: TriggerMessage
427
428 ### Version 2.x.x
429
430 #### Provisioning
431
432 - :white_check_mark: BootNotification
433
434 #### Authorization
435
436 - :white_check_mark: ClearCache
437
438 #### Availability
439
440 - :white_check_mark: StatusNotification
441 - :white_check_mark: Heartbeat
442
443 ## OCPP-J standard parameters supported
444
445 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.
446
447 ### Version 1.6
448
449 #### Core Profile
450
451 - :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -)
452 - :x: ClockAlignedDataInterval (type: integer) (units: seconds)
453 - :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds)
454 - :x: GetConfigurationMaxKeys (type: integer) (units: -)
455 - :white_check_mark: HeartbeatInterval (type: integer) (units: seconds)
456 - :x: LocalAuthorizeOffline (type: boolean) (units: -)
457 - :x: LocalPreAuthorize (type: boolean) (units: -)
458 - :x: MeterValuesAlignedData (type: CSL) (units: -)
459 - :white_check_mark: MeterValuesSampledData (type: CSL) (units: -)
460 - :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds)
461 - :white_check_mark: NumberOfConnectors (type: integer) (units: -)
462 - :x: ResetRetries (type: integer) (units: times)
463 - :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -)
464 - :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -)
465 - :x: StopTransactionOnInvalidId (type: boolean) (units: -)
466 - :x: StopTxnAlignedData (type: CSL) (units: -)
467 - :x: StopTxnSampledData (type: CSL) (units: -)
468 - :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -)
469 - :x: TransactionMessageAttempts (type: integer) (units: times)
470 - :x: TransactionMessageRetryInterval (type: integer) (units: seconds)
471 - :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -)
472 - :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds)
473
474 #### Firmware Management Profile
475
476 - _none_
477
478 #### Local Auth List Management Profile
479
480 - :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
481 - :x: LocalAuthListMaxLength (type: integer) (units: -)
482 - :x: SendLocalListMaxLength (type: integer) (units: -)
483
484 #### Reservation Profile
485
486 - :white_check_mark: ReserveConnectorZeroSupported (type: boolean) (units: -)
487
488 #### Smart Charging Profile
489
490 - :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
491 - :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
492 - :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
493 - :x: MaxChargingProfilesInstalled (type: integer) (units: -)
494
495 #### Remote Trigger Profile
496
497 - _none_
498
499 ### Version 2.x.x
500
501 ## UI protocol
502
503 Protocol to control the simulator via a Websocket or HTTP server.
504
505 ### HTTP Protocol
506
507 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.
508
509 ### Websocket Protocol
510
511 SRPC protocol over Websocket. PDU stands for 'Protocol Data Unit'.
512
513 - Request:
514 [`uuid`, `ProcedureName`, `PDU`]
515 `uuid`: String uniquely representing this request
516 `ProcedureName`: The procedure to run on the simulator
517 `PDU`: The parameters for said procedure
518
519 - Response:
520 [`uuid`, `PDU`]
521 `uuid`: String uniquely linking the response to the request
522 `PDU`: Response parameters to requested procedure
523
524 An [Insomnia](https://insomnia.rest/) WebSocket requests collection is available in [src/assets/ui-protocol](./src/assets/ui-protocol) directory.
525
526 #### Version 0.0.1
527
528 Set the Websocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
529
530 ##### Procedures
531
532 ###### Start Simulator
533
534 - Request:
535 `ProcedureName`: 'startSimulator'
536 `PDU`: {}
537
538 - Response:
539 `PDU`: {
540 `status`: 'success' | 'failure'
541 }
542
543 ###### Stop Simulator
544
545 - Request:
546 `ProcedureName`: 'stopSimulator'
547 `PDU`: {}
548
549 - Response:
550 `PDU`: {
551 `status`: 'success' | 'failure'
552 }
553
554 ###### List Charging Stations
555
556 - Request:
557 `ProcedureName`: 'listChargingStations'
558 `PDU`: {}
559
560 - Response:
561 `PDU`: {
562 `status`: 'success' | 'failure',
563 `chargingStations`: ChargingStationData[]
564 }
565
566 ###### Start Charging Station
567
568 - Request:
569 `ProcedureName`: 'startChargingStation'
570 `PDU`: {
571 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
572 }
573
574 - Response:
575 `PDU`: {
576 `status`: 'success' | 'failure',
577 `hashIdsSucceeded`: charging station unique identifier strings array,
578 `hashIdsFailed`: charging station unique identifier strings array (optional)
579 `responsesFailed`: failed responses payload array (optional)
580 }
581
582 ###### Stop Charging Station
583
584 - Request:
585 `ProcedureName`: 'stopChargingStation'
586 `PDU`: {
587 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
588 }
589
590 - Response:
591 `PDU`: {
592 `status`: 'success' | 'failure',
593 `hashIdsSucceeded`: charging station unique identifier strings array,
594 `hashIdsFailed`: charging station unique identifier strings array (optional),
595 `responsesFailed`: failed responses payload array (optional)
596 }
597
598 ###### Open Connection
599
600 - Request:
601 `ProcedureName`: 'openConnection'
602 `PDU`: {
603 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
604 }
605
606 - Response:
607 `PDU`: {
608 `status`: 'success' | 'failure',
609 `hashIdsSucceeded`: charging station unique identifier strings array,
610 `hashIdsFailed`: charging station unique identifier strings array (optional),
611 `responsesFailed`: failed responses payload array (optional)
612 }
613
614 ###### Close Connection
615
616 - Request:
617 `ProcedureName`: 'closeConnection'
618 `PDU`: {
619 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
620 }
621
622 - Response:
623 `PDU`: {
624 `status`: 'success' | 'failure',
625 `hashIdsSucceeded`: charging station unique identifier strings array,
626 `hashIdsFailed`: charging station unique identifier strings array (optional),
627 `responsesFailed`: failed responses payload array (optional)
628 }
629
630 ###### Start Automatic Transaction Generator
631
632 - Request:
633 `ProcedureName`: 'startAutomaticTransactionGenerator'
634 `PDU`: {
635 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
636 `connectorIds`: connector id integer array (optional, default: all connectors)
637 }
638
639 - Response:
640 `PDU`: {
641 `status`: 'success' | 'failure',
642 `hashIdsSucceeded`: charging station unique identifier strings array,
643 `hashIdsFailed`: charging station unique identifier strings array (optional),
644 `responsesFailed`: failed responses payload array (optional)
645 }
646
647 ###### Stop Automatic Transaction Generator
648
649 - Request:
650 `ProcedureName`: 'stopAutomaticTransactionGenerator'
651 `PDU`: {
652 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
653 `connectorIds`: connector id integer array (optional, default: all connectors)
654 }
655
656 - Response:
657 `PDU`: {
658 `status`: 'success' | 'failure',
659 `hashIdsSucceeded`: charging station unique identifier strings array,
660 `hashIdsFailed`: charging station unique identifier strings array (optional),
661 `responsesFailed`: failed responses payload array (optional)
662 }
663
664 ###### OCPP commands trigger
665
666 - Request:
667 `ProcedureName`: 'commandName' (the OCPP command name in camel case)
668 `PDU`: {
669 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
670 ...`commandPayload`
671 } (the OCPP command payload with some optional fields added to target the simulated charging stations)
672
673 - Response:
674 `PDU`: {
675 `status`: 'success' | 'failure',
676 `hashIdsSucceeded`: charging station unique identifier strings array,
677 `hashIdsFailed`: charging station unique identifier strings array (optional),
678 `responsesFailed`: failed responses payload array (optional)
679 }
680
681 Examples:
682
683 - **Start Transaction**
684
685 - Request:
686 `ProcedureName`: 'startTransaction'
687 `PDU`: {
688 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
689 `connectorId`: connector id integer,
690 `idTag`: RFID tag string
691 }
692
693 - Response:
694 `PDU`: {
695 `status`: 'success' | 'failure',
696 `hashIdsSucceeded`: charging station unique identifier strings array,
697 `hashIdsFailed`: charging station unique identifier strings array (optional),
698 `responsesFailed`: failed responses payload array (optional)
699 }
700
701 - **Stop Transaction**
702
703 - Request:
704 `ProcedureName`: 'stopTransaction'
705 `PDU`: {
706 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
707 `transactionId`: transaction id integer
708 }
709
710 - Response:
711 `PDU`: {
712 `status`: 'success' | 'failure',
713 `hashIdsSucceeded`: charging station unique identifier strings array,
714 `hashIdsFailed`: charging station unique identifier strings array (optional),
715 `responsesFailed`: failed responses payload array (optional)
716 }
717
718 - **Status Notification**
719
720 - Request:
721 `ProcedureName`: 'statusNotification'
722 `PDU`: {
723 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
724 `connectorId`: connector id integer,
725 `errorCode`: connector error code,
726 `status`: connector status
727 }
728
729 - Response:
730 `PDU`: {
731 `status`: 'success' | 'failure',
732 `hashIdsSucceeded`: charging station unique identifier strings array,
733 `hashIdsFailed`: charging station unique identifier strings array (optional),
734 `responsesFailed`: failed responses payload array (optional)
735 }
736
737 - **Heartbeat**
738
739 - Request:
740 `ProcedureName`: 'heartbeat'
741 `PDU`: {
742 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
743 }
744
745 - Response:
746 `PDU`: {
747 `status`: 'success' | 'failure',
748 `hashIdsSucceeded`: charging station unique identifier strings array,
749 `hashIdsFailed`: charging station unique identifier strings array (optional),
750 `responsesFailed`: failed responses payload array (optional)
751 }
752
753 ## Support, Feedback, Contributing
754
755 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).
756
757 ## Code of Conduct
758
759 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.
760
761 ## Licensing
762
763 Copyright 2020-2024 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