repositories / e-mobility-charging-stations-simulator.git / blob
? search:


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