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