repositories / e-mobility-charging-stations-simulator.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Merge dependabot/github_actions/docker/setup-buildx-action-3 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=success&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)](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';<br />poolMinSize: number;<br />poolMaxSize: number;<br />} | Worker configuration section:<br />- _processType_: worker threads process type (`workerSet`/`staticPool`/`dynamicPool`)<br />- _startDelay_: milliseconds to wait at worker threads startup (only for `workerSet` 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)<br />- _poolMinSize_: worker threads pool minimum number of threads</br >- _poolMaxSize_: worker threads pool maximum number of threads |
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 static number (elementsPerWorker) of simulated charging stations from the total
117
118 - **staticPool**:
119 Statically sized worker pool executing a static total number of simulated charging stations
120
121 - **dynamicPool** (experimental):
122 Dynamically sized worker pool executing a static 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 | mainVoltageMeterValues | true/false | true | boolean | include charging stations main voltage MeterValues on three phased charging stations |
175 | phaseLineToLineVoltageMeterValues | true/false | false | boolean | include charging stations line to line voltage MeterValues on three phased charging stations |
176 | customValueLimitationMeterValues | true/false | true | boolean | enable limitation on custom fluctuated value in MeterValues |
177 | 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. |
178 | 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 |
179 | messageTriggerSupport | | {} | Record<MessageTrigger, boolean> | Configuration section for OCPP commands trigger support. Empty section means all implemented OCPP trigger commands are supported |
180 | Configuration | | | ChargingStationOcppConfiguration | charging stations OCPP parameters configuration section |
181 | AutomaticTransactionGenerator | | | AutomaticTransactionGeneratorConfiguration | charging stations ATG configuration section |
182 | Connectors | | | Record<string, ConnectorStatus> | charging stations connectors configuration section |
183 | Evses | | | Record<string, EvseTemplate> | charging stations EVSEs configuration section |
184
185 #### Configuration section syntax example
186
187 ```json
188 "Configuration": {
189 "configurationKey": [
190 ...
191 {
192 "key": "StandardKey",
193 "readonly": false,
194 "value": "StandardValue",
195 "visible": true,
196 "reboot": false
197 },
198 ...
199 {
200 "key": "VendorKey",
201 "readonly": false,
202 "value": "VendorValue",
203 "visible": false,
204 "reboot": true
205 },
206 ...
207 ]
208 }
209 ```
210
211 #### AutomaticTransactionGenerator section syntax example
212
213 ##### Type definition:
214
215 ```ts
216 type AutomaticTransactionGeneratorConfiguration = {
217 enable: boolean;
218 minDuration: number;
219 maxDuration: number;
220 minDelayBetweenTwoTransactions: number;
221 maxDelayBetweenTwoTransactions: number;
222 probabilityOfStart: number;
223 stopAfterHours: number;
224 stopOnConnectionFailure: boolean;
225 requireAuthorize?: boolean;
226 idTagDistribution?: 'random' | 'round-robin' | 'connector-affinity';
227 };
228 ```
229
230 ##### Example:
231
232 ```json
233 "AutomaticTransactionGenerator": {
234 "enable": false,
235 "minDuration": 60,
236 "maxDuration": 80,
237 "minDelayBetweenTwoTransactions": 15,
238 "maxDelayBetweenTwoTransactions": 30,
239 "probabilityOfStart": 1,
240 "stopAfterHours": 0.3,
241 "stopOnConnectionFailure": true,
242 "requireAuthorize": true,
243 "idTagDistribution": "random"
244 }
245 ```
246
247 #### Connectors section syntax example
248
249 ```json
250 "Connectors": {
251 "0": {},
252 "1": {
253 "bootStatus": "Available",
254 "MeterValues": [
255 ...
256 {
257 "unit": "W",
258 "measurand": "Power.Active.Import",
259 "phase": "L1-N",
260 "value": "5000",
261 "fluctuationPercent": "10"
262 },
263 ...
264 {
265 "unit": "A",
266 "measurand": "Current.Import",
267 "minimum": "0.5"
268 },
269 ...
270 {
271 "unit": "Wh"
272 },
273 ...
274 ]
275 }
276 },
277 ```
278
279 #### Evses section syntax example
280
281 ```json
282 "Evses": {
283 "0": {
284 "Connectors": {
285 "0": {}
286 }
287 },
288 "1": {
289 "Connectors": {
290 "1": {
291 "bootStatus": "Available",
292 "MeterValues": [
293 ...
294 {
295 "unit": "W",
296 "measurand": "Power.Active.Import",
297 "phase": "L1-N",
298 "value": "5000",
299 "fluctuationPercent": "10"
300 },
301 ...
302 {
303 "unit": "A",
304 "measurand": "Current.Import",
305 "minimum": "0.5"
306 },
307 ...
308 {
309 "unit": "Wh"
310 },
311 ...
312 ]
313 }
314 }
315 }
316 },
317 ```
318
319 ### Charging station configuration
320
321 **dist/assets/configurations/\<hashId\>.json**:
322
323 The charging station configuration file is automatically generated at startup from the charging station configuration template file and is persistent.
324
325 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.
326
327 #### stationInfo section
328
329 The syntax is similar to charging station configuration template with some added fields like the charging station id (name) and the 'Configuration' section removed.
330
331 #### configurationKey section
332
333 The syntax is similar to the charging station configuration template 'Configuration' section.
334
335 #### automaticTransactionGenerator section
336
337 The syntax is similar to the charging station configuration template 'AutomaticTransactionGenerator' section.
338
339 ## Docker
340
341 In the [docker](./docker) folder:
342
343 ```bash
344 make
345 ```
346
347 <!-- Or with the optional git submodules:
348
349 ```bash
350 make SUBMODULES_INIT=true
351 ``` -->
352
353 ## OCPP-J commands supported
354
355 ### Version 1.6
356
357 #### Core Profile
358
359 - :white_check_mark: Authorize
360 - :white_check_mark: BootNotification
361 - :white_check_mark: ChangeAvailability
362 - :white_check_mark: ChangeConfiguration
363 - :white_check_mark: ClearCache
364 - :white_check_mark: DataTransfer
365 - :white_check_mark: GetConfiguration
366 - :white_check_mark: Heartbeat
367 - :white_check_mark: MeterValues
368 - :white_check_mark: RemoteStartTransaction
369 - :white_check_mark: RemoteStopTransaction
370 - :white_check_mark: Reset
371 - :white_check_mark: StartTransaction
372 - :white_check_mark: StatusNotification
373 - :white_check_mark: StopTransaction
374 - :white_check_mark: UnlockConnector
375
376 #### Firmware Management Profile
377
378 - :white_check_mark: GetDiagnostics
379 - :white_check_mark: DiagnosticsStatusNotification
380 - :white_check_mark: FirmwareStatusNotification
381 - :white_check_mark: UpdateFirmware
382
383 #### Local Auth List Management Profile
384
385 - :x: GetLocalListVersion
386 - :x: SendLocalList
387
388 #### Reservation Profile
389
390 - :white_check_mark: CancelReservation
391 - :white_check_mark: ReserveNow
392
393 #### Smart Charging Profile
394
395 - :white_check_mark: ClearChargingProfile
396 - :white_check_mark: GetCompositeSchedule
397 - :white_check_mark: SetChargingProfile
398
399 #### Remote Trigger Profile
400
401 - :white_check_mark: TriggerMessage
402
403 ### Version 2.x.x
404
405 #### Provisioning
406
407 - :white_check_mark: BootNotification
408
409 #### Authorization
410
411 - :white_check_mark: ClearCache
412
413 #### Availability
414
415 - :white_check_mark: StatusNotification
416 - :white_check_mark: Heartbeat
417
418 ## OCPP-J standard parameters supported
419
420 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.
421
422 ### Version 1.6
423
424 #### Core Profile
425
426 - :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -)
427 - :x: ClockAlignedDataInterval (type: integer) (units: seconds)
428 - :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds)
429 - :x: GetConfigurationMaxKeys (type: integer) (units: -)
430 - :white_check_mark: HeartbeatInterval (type: integer) (units: seconds)
431 - :x: LocalAuthorizeOffline (type: boolean) (units: -)
432 - :x: LocalPreAuthorize (type: boolean) (units: -)
433 - :x: MeterValuesAlignedData (type: CSL) (units: -)
434 - :white_check_mark: MeterValuesSampledData (type: CSL) (units: -)
435 - :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds)
436 - :white_check_mark: NumberOfConnectors (type: integer) (units: -)
437 - :x: ResetRetries (type: integer) (units: times)
438 - :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -)
439 - :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -)
440 - :x: StopTransactionOnInvalidId (type: boolean) (units: -)
441 - :x: StopTxnAlignedData (type: CSL) (units: -)
442 - :x: StopTxnSampledData (type: CSL) (units: -)
443 - :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -)
444 - :x: TransactionMessageAttempts (type: integer) (units: times)
445 - :x: TransactionMessageRetryInterval (type: integer) (units: seconds)
446 - :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -)
447 - :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds)
448
449 #### Firmware Management Profile
450
451 - _none_
452
453 #### Local Auth List Management Profile
454
455 - :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
456 - :x: LocalAuthListMaxLength (type: integer) (units: -)
457 - :x: SendLocalListMaxLength (type: integer) (units: -)
458
459 #### Reservation Profile
460
461 - :white_check_mark: ReserveConnectorZeroSupported (type: boolean) (units: -)
462
463 #### Smart Charging Profile
464
465 - :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
466 - :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
467 - :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
468 - :x: MaxChargingProfilesInstalled (type: integer) (units: -)
469
470 #### Remote Trigger Profile
471
472 - _none_
473
474 ### Version 2.x.x
475
476 ## UI protocol
477
478 Protocol to control the simulator via a Websocket or HTTP server.
479
480 ### HTTP Protocol
481
482 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.
483
484 ### Websocket Protocol
485
486 SRPC protocol over Websocket. PDU stands for 'Protocol Data Unit'.
487
488 - Request:
489 [`uuid`, `ProcedureName`, `PDU`]
490 `uuid`: String uniquely representing this request
491 `ProcedureName`: The procedure to run on the simulator
492 `PDU`: The parameters for said procedure
493
494 - Response:
495 [`uuid`, `PDU`]
496 `uuid`: String uniquely linking the response to the request
497 `PDU`: Response parameters to requested procedure
498
499 An [Insomnia](https://insomnia.rest/) WebSocket requests collection is available in [src/assets/ui-protocol](./src/assets/ui-protocol) directory.
500
501 #### Version 0.0.1
502
503 Set the Websocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
504
505 ##### Procedures
506
507 ###### Start Simulator
508
509 - Request:
510 `ProcedureName`: 'startSimulator'
511 `PDU`: {}
512
513 - Response:
514 `PDU`: {
515 `status`: 'success' | 'failure'
516 }
517
518 ###### Stop Simulator
519
520 - Request:
521 `ProcedureName`: 'stopSimulator'
522 `PDU`: {}
523
524 - Response:
525 `PDU`: {
526 `status`: 'success' | 'failure'
527 }
528
529 ###### List Charging Stations
530
531 - Request:
532 `ProcedureName`: 'listChargingStations'
533 `PDU`: {}
534
535 - Response:
536 `PDU`: {
537 `status`: 'success' | 'failure',
538 `chargingStations`: ChargingStationData[]
539 }
540
541 ###### Start Charging Station
542
543 - Request:
544 `ProcedureName`: 'startChargingStation'
545 `PDU`: {
546 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
547 }
548
549 - Response:
550 `PDU`: {
551 `status`: 'success' | 'failure',
552 `hashIdsSucceeded`: charging station unique identifier strings array,
553 `hashIdsFailed`: charging station unique identifier strings array (optional)
554 `responsesFailed`: failed responses payload array (optional)
555 }
556
557 ###### Stop Charging Station
558
559 - Request:
560 `ProcedureName`: 'stopChargingStation'
561 `PDU`: {
562 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
563 }
564
565 - Response:
566 `PDU`: {
567 `status`: 'success' | 'failure',
568 `hashIdsSucceeded`: charging station unique identifier strings array,
569 `hashIdsFailed`: charging station unique identifier strings array (optional),
570 `responsesFailed`: failed responses payload array (optional)
571 }
572
573 ###### Open Connection
574
575 - Request:
576 `ProcedureName`: 'openConnection'
577 `PDU`: {
578 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
579 }
580
581 - Response:
582 `PDU`: {
583 `status`: 'success' | 'failure',
584 `hashIdsSucceeded`: charging station unique identifier strings array,
585 `hashIdsFailed`: charging station unique identifier strings array (optional),
586 `responsesFailed`: failed responses payload array (optional)
587 }
588
589 ###### Close Connection
590
591 - Request:
592 `ProcedureName`: 'closeConnection'
593 `PDU`: {
594 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
595 }
596
597 - Response:
598 `PDU`: {
599 `status`: 'success' | 'failure',
600 `hashIdsSucceeded`: charging station unique identifier strings array,
601 `hashIdsFailed`: charging station unique identifier strings array (optional),
602 `responsesFailed`: failed responses payload array (optional)
603 }
604
605 ###### Start Automatic Transaction Generator
606
607 - Request:
608 `ProcedureName`: 'startAutomaticTransactionGenerator'
609 `PDU`: {
610 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
611 `connectorIds`: connector id integer array (optional, default: all connectors)
612 }
613
614 - Response:
615 `PDU`: {
616 `status`: 'success' | 'failure',
617 `hashIdsSucceeded`: charging station unique identifier strings array,
618 `hashIdsFailed`: charging station unique identifier strings array (optional),
619 `responsesFailed`: failed responses payload array (optional)
620 }
621
622 ###### Stop Automatic Transaction Generator
623
624 - Request:
625 `ProcedureName`: 'stopAutomaticTransactionGenerator'
626 `PDU`: {
627 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
628 `connectorIds`: connector id integer array (optional, default: all connectors)
629 }
630
631 - Response:
632 `PDU`: {
633 `status`: 'success' | 'failure',
634 `hashIdsSucceeded`: charging station unique identifier strings array,
635 `hashIdsFailed`: charging station unique identifier strings array (optional),
636 `responsesFailed`: failed responses payload array (optional)
637 }
638
639 ###### OCPP commands trigger
640
641 - Request:
642 `ProcedureName`: 'commandName' (the OCPP command name in camel case)
643 `PDU`: {
644 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
645 ...`commandPayload`
646 } (the OCPP command payload with some optional fields added to target the simulated charging stations)
647
648 - Response:
649 `PDU`: {
650 `status`: 'success' | 'failure',
651 `hashIdsSucceeded`: charging station unique identifier strings array,
652 `hashIdsFailed`: charging station unique identifier strings array (optional),
653 `responsesFailed`: failed responses payload array (optional)
654 }
655
656 Examples:
657
658 - **Start Transaction**
659
660 - Request:
661 `ProcedureName`: 'startTransaction'
662 `PDU`: {
663 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
664 `connectorId`: connector id integer,
665 `idTag`: RFID tag string
666 }
667
668 - Response:
669 `PDU`: {
670 `status`: 'success' | 'failure',
671 `hashIdsSucceeded`: charging station unique identifier strings array,
672 `hashIdsFailed`: charging station unique identifier strings array (optional),
673 `responsesFailed`: failed responses payload array (optional)
674 }
675
676 - **Stop Transaction**
677
678 - Request:
679 `ProcedureName`: 'stopTransaction'
680 `PDU`: {
681 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
682 `transactionId`: transaction id integer
683 }
684
685 - Response:
686 `PDU`: {
687 `status`: 'success' | 'failure',
688 `hashIdsSucceeded`: charging station unique identifier strings array,
689 `hashIdsFailed`: charging station unique identifier strings array (optional),
690 `responsesFailed`: failed responses payload array (optional)
691 }
692
693 - **Status Notification**
694
695 - Request:
696 `ProcedureName`: 'statusNotification'
697 `PDU`: {
698 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
699 `connectorId`: connector id integer,
700 `errorCode`: connector error code,
701 `status`: connector status
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 - **Heartbeat**
713
714 - Request:
715 `ProcedureName`: 'heartbeat'
716 `PDU`: {
717 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
718 }
719
720 - Response:
721 `PDU`: {
722 `status`: 'success' | 'failure',
723 `hashIdsSucceeded`: charging station unique identifier strings array,
724 `hashIdsFailed`: charging station unique identifier strings array (optional),
725 `responsesFailed`: failed responses payload array (optional)
726 }
727
728 ## Support, Feedback, Contributing
729
730 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).
731
732 ## Code of Conduct
733
734 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.
735
736 ## Licensing
737
738 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