repositories / e-mobility-charging-stations-simulator.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
docs: fix typo in README.md
[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 />resourceLimits?: ResourceLimits;<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)<br />- _authentication_: authentication type configuration section |
111 | performanceStorage | | {<br />"enabled": false,<br />"type": "jsonfile",<br />"uri": "file:///performance/performanceRecords.json"<br />} | {<br />enabled?: boolean;<br />type?: string;<br />uri?: string;<br />} | Performance storage configuration section:<br />- _enabled_: enable performance storage<br />- _type_: 'jsonfile' or 'mongodb'<br />- _uri_: storage URI |
112 | stationTemplateUrls | | {}[] | {<br />file: string;<br />numberOfStations: number;<br />}[] | array of charging station configuration templates URIs configuration section (charging station configuration template file name and number of stations) |
113
114 #### Worker process model
115
116 - **workerSet**:
117 Worker set executing each a fixed number (elementsPerWorker) of simulated charging stations from the total
118
119 - **fixedPool**:
120 Fixedly sized worker pool executing a fixed total number of simulated charging stations
121
122 - **dynamicPool** (experimental):
123 Dynamically sized worker pool executing a fixed total number of simulated charging stations
124
125 ### Charging station configuration template
126
127 **src/assets/station-templates/\<name\>.json**:
128
129 | Key | Value(s) | Default Value | Value type | Description |
130 | ---------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
131 | supervisionUrls | | [] | string \| string[] | string or strings array containing connection URIs to OCPP-J servers |
132 | supervisionUser | | undefined | string | basic HTTP authentication user to OCPP-J server |
133 | supervisionPassword | | undefined | string | basic HTTP authentication password to OCPP-J server |
134 | supervisionUrlOcppConfiguration | true/false | false | boolean | allow supervision URL configuration via a vendor OCPP parameter key |
135 | supervisionUrlOcppKey | | 'ConnectionUrl' | string | the vendor string that will be used as a vendor OCPP parameter key to set the supervision URL |
136 | ocppVersion | 1.6/2.0/2.0.1 | 1.6 | string | OCPP version |
137 | ocppProtocol | json | json | string | OCPP protocol |
138 | ocppStrictCompliance | true/false | true | boolean | strict adherence to the OCPP version and protocol specifications with OCPP commands PDU validation against [OCA](https://www.openchargealliance.org/) JSON schemas |
139 | ocppPersistentConfiguration | true/false | true | boolean | enable persistent OCPP parameters storage by charging stations 'hashId'. The persistency is ensured by the charging stations configuration files in [dist/assets/configurations](dist/assets/configurations) |
140 | stationInfoPersistentConfiguration | true/false | true | boolean | enable persistent station information and specifications storage by charging stations 'hashId'. The persistency is ensured by the charging stations configuration files in [dist/assets/configurations](dist/assets/configurations) |
141 | automaticTransactionGeneratorPersistentConfiguration | true/false | true | boolean | enable persistent automatic transaction generator configuration storage by charging stations 'hashId'. The persistency is ensured by the charging stations configuration files in [dist/assets/configurations](dist/assets/configurations) |
142 | wsOptions | | {} | ClientOptions & ClientRequestArgs | [ws](https://github.com/websockets/ws) and node.js [http](https://nodejs.org/api/http.html) clients options intersection |
143 | idTagsFile | | undefined | string | RFID tags list file relative to [src/assets](src/assets) path |
144 | baseName | | undefined | string | base name to build charging stations id |
145 | nameSuffix | | undefined | string | name suffix to build charging stations id |
146 | fixedName | true/false | false | boolean | use the 'baseName' as the charging stations unique name |
147 | chargePointModel | | undefined | string | charging stations model |
148 | chargePointVendor | | undefined | string | charging stations vendor |
149 | chargePointSerialNumberPrefix | | undefined | string | charge point serial number prefix |
150 | chargeBoxSerialNumberPrefix | | undefined | string | charge box serial number prefix (deprecated since OCPP 1.6) |
151 | firmwareVersionPattern | | Semantic versioning regular expression: https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string | string | charging stations firmware version pattern |
152 | firmwareVersion | | undefined | string | charging stations firmware version |
153 | power | | | float \| float[] | charging stations maximum power value(s) |
154 | powerSharedByConnectors | true/false | false | boolean | charging stations power shared by its connectors |
155 | powerUnit | W/kW | W | string | charging stations power unit |
156 | currentOutType | AC/DC | AC | string | charging stations current out type |
157 | voltageOut | | AC:230/DC:400 | integer | charging stations voltage out |
158 | numberOfPhases | 0/1/3 | AC:3/DC:0 | integer | charging stations number of phase(s) |
159 | numberOfConnectors | | | integer \| integer[] | charging stations number of connector(s) |
160 | useConnectorId0 | true/false | true | boolean | use connector id 0 definition from the charging station configuration template |
161 | randomConnectors | true/false | false | boolean | randomize runtime connector id affectation from the connector id definition in charging station configuration template |
162 | resetTime | | 60 | integer | seconds to wait before the charging stations come back at reset |
163 | autoRegister | true/false | false | boolean | set charging stations as registered at boot notification for testing purpose |
164 | autoReconnectMaxRetries | | -1 (unlimited) | integer | connection retries to the OCPP-J server |
165 | reconnectExponentialDelay | true/false | false | boolean | connection delay retry to the OCPP-J server |
166 | registrationMaxRetries | | -1 (unlimited) | integer | charging stations boot notification retries |
167 | amperageLimitationOcppKey | | undefined | string | charging stations OCPP parameter key used to set the amperage limit, per phase for each connector on AC and global for DC |
168 | amperageLimitationUnit | A/cA/dA/mA | A | string | charging stations amperage limit unit |
169 | enableStatistics | true/false | false | boolean | enable charging stations statistics |
170 | remoteAuthorization | true/false | true | boolean | enable RFID tags remote authorization |
171 | beginEndMeterValues | true/false | false | boolean | enable Transaction.{Begin,End} MeterValues |
172 | outOfOrderEndMeterValues | true/false | false | boolean | send Transaction.End MeterValues out of order. Need to relax OCPP specifications strict compliance ('ocppStrictCompliance' parameter) |
173 | meteringPerTransaction | true/false | true | boolean | enable metering history on a per transaction basis |
174 | transactionDataMeterValues | true/false | false | boolean | enable transaction data MeterValues at stop transaction |
175 | stopTransactionsOnStopped | true/false | true | boolean | enable stop transactions on charging station stop |
176 | mainVoltageMeterValues | true/false | true | boolean | include charging stations main voltage MeterValues on three phased charging stations |
177 | phaseLineToLineVoltageMeterValues | true/false | false | boolean | include charging stations line to line voltage MeterValues on three phased charging stations |
178 | customValueLimitationMeterValues | true/false | true | boolean | enable limitation on custom fluctuated value in MeterValues |
179 | firmwareUpgrade | | {<br />"versionUpgrade": {<br />"step": 1<br />},<br />"reset": true<br />} | {<br />versionUpgrade?: {<br />patternGroup?: number;<br />step?: number;<br />};<br />reset?: boolean;<br />failureStatus?: 'DownloadFailed' \| 'InstallationFailed';<br />} | Configuration section for simulating firmware upgrade support. |
180 | commandsSupport | | {<br />"incomingCommands": {},<br />"outgoingCommands": {}<br />} | {<br /> incomingCommands: Record<IncomingRequestCommand, boolean>;<br />outgoingCommands?: Record<RequestCommand, boolean>;<br />} | Configuration section for OCPP commands support. Empty section or subsections means all implemented OCPP commands are supported |
181 | messageTriggerSupport | | {} | Record<MessageTrigger, boolean> | Configuration section for OCPP commands trigger support. Empty section means all implemented OCPP trigger commands are supported |
182 | Configuration | | | ChargingStationOcppConfiguration | charging stations OCPP parameters configuration section |
183 | AutomaticTransactionGenerator | | | AutomaticTransactionGeneratorConfiguration | charging stations ATG configuration section |
184 | Connectors | | | Record<string, ConnectorStatus> | charging stations connectors configuration section |
185 | Evses | | | Record<string, EvseTemplate> | charging stations EVSEs configuration section |
186
187 #### Configuration section syntax example
188
189 ```json
190 "Configuration": {
191 "configurationKey": [
192 ...
193 {
194 "key": "StandardKey",
195 "readonly": false,
196 "value": "StandardValue",
197 "visible": true,
198 "reboot": false
199 },
200 ...
201 {
202 "key": "VendorKey",
203 "readonly": false,
204 "value": "VendorValue",
205 "visible": false,
206 "reboot": true
207 },
208 ...
209 ]
210 }
211 ```
212
213 #### AutomaticTransactionGenerator section syntax example
214
215 ##### Type definition:
216
217 ```ts
218 type AutomaticTransactionGeneratorConfiguration = {
219 enable: boolean
220 minDuration: number
221 maxDuration: number
222 minDelayBetweenTwoTransactions: number
223 maxDelayBetweenTwoTransactions: number
224 probabilityOfStart: number
225 stopAfterHours: number
226 stopAbsoluteDuration: boolean
227 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 "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 (optional)
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 That section is overwritten on matching charging station configuration template file changes.
333
334 #### connectorsStatus section
335
336 The syntax is similar to charging station configuration template 'Connectors' section with some added fields.
337
338 That section is overwritten on matching charging station configuration template file changes.
339
340 #### evsesStatus section
341
342 The syntax is similar to charging station configuration template 'Evses' section with some added fields.
343
344 That section is overwritten on matching charging station configuration template file changes.
345
346 #### automaticTransactionGenerator section (optional)
347
348 The syntax is similar to the charging station configuration template 'AutomaticTransactionGenerator' section.
349
350 That section is overwritten on matching charging station configuration template file changes.
351
352 #### automaticTransactionGeneratorStatuses section
353
354 That section is not overwritten on matching charging station configuration template file changes.
355
356 #### configurationKey section (optional)
357
358 The syntax is similar to the charging station configuration template 'Configuration' section.
359
360 That section is not overwritten on matching charging station configuration template file changes.
361
362 ## Docker
363
364 In the [docker](./docker) folder:
365
366 ```shell
367 make
368 ```
369
370 <!-- Or with the optional git submodules:
371
372 ```shell
373 make SUBMODULES_INIT=true
374 ``` -->
375
376 ## OCPP-J commands supported
377
378 ### Version 1.6
379
380 #### Core Profile
381
382 - :white_check_mark: Authorize
383 - :white_check_mark: BootNotification
384 - :white_check_mark: ChangeAvailability
385 - :white_check_mark: ChangeConfiguration
386 - :white_check_mark: ClearCache
387 - :white_check_mark: DataTransfer
388 - :white_check_mark: GetConfiguration
389 - :white_check_mark: Heartbeat
390 - :white_check_mark: MeterValues
391 - :white_check_mark: RemoteStartTransaction
392 - :white_check_mark: RemoteStopTransaction
393 - :white_check_mark: Reset
394 - :white_check_mark: StartTransaction
395 - :white_check_mark: StatusNotification
396 - :white_check_mark: StopTransaction
397 - :white_check_mark: UnlockConnector
398
399 #### Firmware Management Profile
400
401 - :white_check_mark: GetDiagnostics
402 - :white_check_mark: DiagnosticsStatusNotification
403 - :white_check_mark: FirmwareStatusNotification
404 - :white_check_mark: UpdateFirmware
405
406 #### Local Auth List Management Profile
407
408 - :x: GetLocalListVersion
409 - :x: SendLocalList
410
411 #### Reservation Profile
412
413 - :white_check_mark: CancelReservation
414 - :white_check_mark: ReserveNow
415
416 #### Smart Charging Profile
417
418 - :white_check_mark: ClearChargingProfile
419 - :white_check_mark: GetCompositeSchedule
420 - :white_check_mark: SetChargingProfile
421
422 #### Remote Trigger Profile
423
424 - :white_check_mark: TriggerMessage
425
426 ### Version 2.x.x
427
428 #### Provisioning
429
430 - :white_check_mark: BootNotification
431
432 #### Authorization
433
434 - :white_check_mark: ClearCache
435
436 #### Availability
437
438 - :white_check_mark: StatusNotification
439 - :white_check_mark: Heartbeat
440
441 ## OCPP-J standard parameters supported
442
443 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.
444
445 ### Version 1.6
446
447 #### Core Profile
448
449 - :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -)
450 - :x: ClockAlignedDataInterval (type: integer) (units: seconds)
451 - :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds)
452 - :x: GetConfigurationMaxKeys (type: integer) (units: -)
453 - :white_check_mark: HeartbeatInterval (type: integer) (units: seconds)
454 - :x: LocalAuthorizeOffline (type: boolean) (units: -)
455 - :x: LocalPreAuthorize (type: boolean) (units: -)
456 - :x: MeterValuesAlignedData (type: CSL) (units: -)
457 - :white_check_mark: MeterValuesSampledData (type: CSL) (units: -)
458 - :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds)
459 - :white_check_mark: NumberOfConnectors (type: integer) (units: -)
460 - :x: ResetRetries (type: integer) (units: times)
461 - :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -)
462 - :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -)
463 - :x: StopTransactionOnInvalidId (type: boolean) (units: -)
464 - :x: StopTxnAlignedData (type: CSL) (units: -)
465 - :x: StopTxnSampledData (type: CSL) (units: -)
466 - :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -)
467 - :x: TransactionMessageAttempts (type: integer) (units: times)
468 - :x: TransactionMessageRetryInterval (type: integer) (units: seconds)
469 - :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -)
470 - :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds)
471
472 #### Firmware Management Profile
473
474 - _none_
475
476 #### Local Auth List Management Profile
477
478 - :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
479 - :x: LocalAuthListMaxLength (type: integer) (units: -)
480 - :x: SendLocalListMaxLength (type: integer) (units: -)
481
482 #### Reservation Profile
483
484 - :white_check_mark: ReserveConnectorZeroSupported (type: boolean) (units: -)
485
486 #### Smart Charging Profile
487
488 - :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
489 - :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
490 - :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
491 - :x: MaxChargingProfilesInstalled (type: integer) (units: -)
492
493 #### Remote Trigger Profile
494
495 - _none_
496
497 ### Version 2.x.x
498
499 ## UI protocol
500
501 Protocol to control the simulator via a Websocket or HTTP server.
502
503 ### HTTP Protocol
504
505 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.
506
507 ### Websocket Protocol
508
509 SRPC protocol over Websocket. PDU stands for 'Protocol Data Unit'.
510
511 - Request:
512 [`uuid`, `ProcedureName`, `PDU`]
513 `uuid`: String uniquely representing this request
514 `ProcedureName`: The procedure to run on the simulator
515 `PDU`: The parameters for said procedure
516
517 - Response:
518 [`uuid`, `PDU`]
519 `uuid`: String uniquely linking the response to the request
520 `PDU`: Response parameters to requested procedure
521
522 An [Insomnia](https://insomnia.rest/) WebSocket requests collection is available in [src/assets/ui-protocol](./src/assets/ui-protocol) directory.
523
524 #### Version 0.0.1
525
526 Set the Websocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
527
528 ##### Procedures
529
530 ###### Start Simulator
531
532 - Request:
533 `ProcedureName`: 'startSimulator'
534 `PDU`: {}
535
536 - Response:
537 `PDU`: {
538 `status`: 'success' | 'failure'
539 }
540
541 ###### Stop Simulator
542
543 - Request:
544 `ProcedureName`: 'stopSimulator'
545 `PDU`: {}
546
547 - Response:
548 `PDU`: {
549 `status`: 'success' | 'failure'
550 }
551
552 ###### List Charging Stations
553
554 - Request:
555 `ProcedureName`: 'listChargingStations'
556 `PDU`: {}
557
558 - Response:
559 `PDU`: {
560 `status`: 'success' | 'failure',
561 `chargingStations`: ChargingStationData[]
562 }
563
564 ###### Start Charging Station
565
566 - Request:
567 `ProcedureName`: 'startChargingStation'
568 `PDU`: {
569 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
570 }
571
572 - Response:
573 `PDU`: {
574 `status`: 'success' | 'failure',
575 `hashIdsSucceeded`: charging station unique identifier strings array,
576 `hashIdsFailed`: charging station unique identifier strings array (optional)
577 `responsesFailed`: failed responses payload array (optional)
578 }
579
580 ###### Stop Charging Station
581
582 - Request:
583 `ProcedureName`: 'stopChargingStation'
584 `PDU`: {
585 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
586 }
587
588 - Response:
589 `PDU`: {
590 `status`: 'success' | 'failure',
591 `hashIdsSucceeded`: charging station unique identifier strings array,
592 `hashIdsFailed`: charging station unique identifier strings array (optional),
593 `responsesFailed`: failed responses payload array (optional)
594 }
595
596 ###### Open Connection
597
598 - Request:
599 `ProcedureName`: 'openConnection'
600 `PDU`: {
601 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
602 }
603
604 - Response:
605 `PDU`: {
606 `status`: 'success' | 'failure',
607 `hashIdsSucceeded`: charging station unique identifier strings array,
608 `hashIdsFailed`: charging station unique identifier strings array (optional),
609 `responsesFailed`: failed responses payload array (optional)
610 }
611
612 ###### Close Connection
613
614 - Request:
615 `ProcedureName`: 'closeConnection'
616 `PDU`: {
617 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
618 }
619
620 - Response:
621 `PDU`: {
622 `status`: 'success' | 'failure',
623 `hashIdsSucceeded`: charging station unique identifier strings array,
624 `hashIdsFailed`: charging station unique identifier strings array (optional),
625 `responsesFailed`: failed responses payload array (optional)
626 }
627
628 ###### Start Automatic Transaction Generator
629
630 - Request:
631 `ProcedureName`: 'startAutomaticTransactionGenerator'
632 `PDU`: {
633 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
634 `connectorIds`: connector id integer array (optional, default: all connectors)
635 }
636
637 - Response:
638 `PDU`: {
639 `status`: 'success' | 'failure',
640 `hashIdsSucceeded`: charging station unique identifier strings array,
641 `hashIdsFailed`: charging station unique identifier strings array (optional),
642 `responsesFailed`: failed responses payload array (optional)
643 }
644
645 ###### Stop Automatic Transaction Generator
646
647 - Request:
648 `ProcedureName`: 'stopAutomaticTransactionGenerator'
649 `PDU`: {
650 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
651 `connectorIds`: connector id integer array (optional, default: all connectors)
652 }
653
654 - Response:
655 `PDU`: {
656 `status`: 'success' | 'failure',
657 `hashIdsSucceeded`: charging station unique identifier strings array,
658 `hashIdsFailed`: charging station unique identifier strings array (optional),
659 `responsesFailed`: failed responses payload array (optional)
660 }
661
662 ###### OCPP commands trigger
663
664 - Request:
665 `ProcedureName`: 'commandName' (the OCPP command name in camel case)
666 `PDU`: {
667 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
668 ...`commandPayload`
669 } (the OCPP command payload with some optional fields added to target the simulated charging stations)
670
671 - Response:
672 `PDU`: {
673 `status`: 'success' | 'failure',
674 `hashIdsSucceeded`: charging station unique identifier strings array,
675 `hashIdsFailed`: charging station unique identifier strings array (optional),
676 `responsesFailed`: failed responses payload array (optional)
677 }
678
679 Examples:
680
681 - **Start Transaction**
682
683 - Request:
684 `ProcedureName`: 'startTransaction'
685 `PDU`: {
686 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
687 `connectorId`: connector id integer,
688 `idTag`: RFID tag string
689 }
690
691 - Response:
692 `PDU`: {
693 `status`: 'success' | 'failure',
694 `hashIdsSucceeded`: charging station unique identifier strings array,
695 `hashIdsFailed`: charging station unique identifier strings array (optional),
696 `responsesFailed`: failed responses payload array (optional)
697 }
698
699 - **Stop Transaction**
700
701 - Request:
702 `ProcedureName`: 'stopTransaction'
703 `PDU`: {
704 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
705 `transactionId`: transaction id integer
706 }
707
708 - Response:
709 `PDU`: {
710 `status`: 'success' | 'failure',
711 `hashIdsSucceeded`: charging station unique identifier strings array,
712 `hashIdsFailed`: charging station unique identifier strings array (optional),
713 `responsesFailed`: failed responses payload array (optional)
714 }
715
716 - **Status Notification**
717
718 - Request:
719 `ProcedureName`: 'statusNotification'
720 `PDU`: {
721 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
722 `connectorId`: connector id integer,
723 `errorCode`: connector error code,
724 `status`: connector status
725 }
726
727 - Response:
728 `PDU`: {
729 `status`: 'success' | 'failure',
730 `hashIdsSucceeded`: charging station unique identifier strings array,
731 `hashIdsFailed`: charging station unique identifier strings array (optional),
732 `responsesFailed`: failed responses payload array (optional)
733 }
734
735 - **Heartbeat**
736
737 - Request:
738 `ProcedureName`: 'heartbeat'
739 `PDU`: {
740 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
741 }
742
743 - Response:
744 `PDU`: {
745 `status`: 'success' | 'failure',
746 `hashIdsSucceeded`: charging station unique identifier strings array,
747 `hashIdsFailed`: charging station unique identifier strings array (optional),
748 `responsesFailed`: failed responses payload array (optional)
749 }
750
751 ## Support, Feedback, Contributing
752
753 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).
754
755 ## Code of Conduct
756
757 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.
758
759 ## Licensing
760
761 Copyright 2020-2024 SAP SE or an SAP affiliate company and e-mobility-charging-stations-simulator contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/e-mobility-charging-stations-simulator).
Charging stations simulator mirror - https://github.com/SAP/e-mobility-charging-stations-simulator