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