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