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