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