repositories / e-mobility-charging-stations-simulator.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Small integer parsing optimization
[e-mobility-charging-stations-simulator.git] / README.md
CommitLineData
d6b76da3 1<!-- markdownlint-disable-file MD033 MD024 -->
9e0845f7 2
1ea2264a 3# [e-mobility charging stations simulator](https://github.com/sap/e-mobility-charging-stations-simulator)
7dde0b73 4
0a3d08ef
SW		 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
7dde0b73
JB		 7## Summary
8
ccb1d6e9 9Simple [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.
7dde0b73 10
696ce53a
JB		 11## Prerequisites
12
007ee642
JB		 13Install the [node.js](https://nodejs.org/) LTS runtime environment:
14
696ce53a
JB		 15### Windows
16
e7aeea18 17- [Chocolatey](https://chocolatey.org/):
696ce53a
JB		 18
19```powershell
20choco install -y nodejs-lts
21```
22
23### MacOSX
24
e7aeea18 25- [Homebrew](https://brew.sh/):
696ce53a
JB		 26
27```shell
8f3d04b0 28brew install node@16
696ce53a
JB		 29```
30
d6b76da3 31### GNU/Linux
511780c3 32
7e901376 33- [NodeSource](https://github.com/nodesource/distributions) Node.js Binary Distributions for version >= 16.X
511780c3 34
007ee642
JB		 35## Installation
36
37In the repository root, run the following command:
38
39```shell
40npm install
41```
42
43## Initial configuration
44
db70b600
JB		 45Copy the configuration template file [src/assets/config-template.json](src/assets/config-template.json) to [src/assets/config.json](src/assets/config.json).
46Copy 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
48Tweak them to your needs by following the section [configuration files syntax](README.md#configuration-files-syntax).
007ee642
JB		 49
50## Start
51
52To start the program, run: `npm start`.
53
4e3ff94d 54## Start Web UI
007ee642 55
ebbfbf1c 56See Web UI [README.md](ui/web/README.md) for more information.
b8cc885d 57
4d3821a2 58## Configuration files syntax
2c28fc83 59
e7aeea18 60All configuration files are in the JSON standard format.
2c28fc83 61
ff82dc5f 62**Configuration files locations**:
2c28fc83 63
170bec53 64- charging stations simulator configuration: [src/assets/config.json](src/assets/config.json);
1816f743 65- charging station configuration templates: [src/assets/station-templates](src/assets/station-templates);
1c51fd1d 66- charging station configurations: [dist/assets/configurations](dist/assets/configurations);
7f818162 67- charging station RFID tags lists: [src/assets](src/assets).
2c28fc83 68
1816f743
JB		 69The 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
71All charging station configuration templates are in the directory [src/assets/station-templates](src/assets/station-templates).
72
73A 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
1c51fd1d 771. charging station configuration: [dist/assets/configurations](dist/assets/configurations);
1816f743 782. charging station configuration template: [src/assets/station-templates](src/assets/station-templates);
170bec53 793. charging stations simulator configuration: [src/assets/config.json](src/assets/config.json).
511780c3 80
e7aeea18 81The charging stations simulator have an automatic configuration files reload feature at change for:
511780c3 82
170bec53 83- charging stations simulator configuration;
1816f743 84- charging station configuration templates;
170bec53 85- charging station authorization RFID tags lists.
2c28fc83 86
c645fe94 87But 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.
e7aeea18 88
170bec53 89### Charging stations simulator configuration
2c28fc83 90
b1d6e944 91**src/assets/config.json**:
2c28fc83 92
19dbb570
JB		 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) |
e7aeea18 109
d6b76da3 110#### Worker process model
a6b3c6c3
JB		 111
112- **workerSet**:
4c6ed1d7 113 Worker set executing each a static number (elementsPerWorker) of simulated charging stations from the total
a6b3c6c3
JB		 114
115- **staticPool**:
e7aeea18 116 Statically sized worker pool executing a static total number of simulated charging stations
a6b3c6c3
JB		 117
118- **dynamicPool**:
e7aeea18 119 Dynamically sized worker pool executing a static total number of simulated charging stations
a6b3c6c3 120
1816f743
JB		 121### Charging station configuration template
122
afccb423 123**src/assets/station-templates/\<name\>.json**:
1816f743 124
65554cc3
JB		 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 |
03ebf4c1
JB		 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 |
65554cc3
JB		 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 |
c60ed4b8
JB		 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 OCPP commands are supported |
174| messageTriggerSupport | | {} | Record<MessageTrigger, boolean> | Configuration section for OCPP commands trigger support. Empty section means all implemented OCPP trigger commands are supported |
65554cc3
JB		 175| Configuration | | | ChargingStationConfiguration | charging stations OCPP parameters configuration section |
176| AutomaticTransactionGenerator | | | AutomaticTransactionGenerator | charging stations ATG configuration section |
177| Connectors | | | Connectors | charging stations connectors configuration section |
c94a349a
JB		 178
179#### Configuration section
180
181```json
0302da79 182 "Configuration": {
c94a349a
JB		 183 "configurationKey": [
184 ...
185 {
186 "key": "StandardKey",
187 "readonly": false,
188 "value": "StandardValue",
189 "visible": true,
190 "reboot": false
191 },
192 ...
193 {
194 "key": "VendorKey",
195 "readonly": false,
196 "value": "VendorValue",
197 "visible": false,
198 "reboot": true
199 },
200 ...
201 ]
202 }
203```
204
205#### AutomaticTransactionGenerator section
206
c72f6634
JB		 207Section type definition:
208
209```ts
210type AutomaticTransactionGeneratorConfiguration = {
211 enable: boolean;
212 minDuration: number;
213 maxDuration: number;
214 minDelayBetweenTwoTransactions: number;
215 maxDelayBetweenTwoTransactions: number;
216 probabilityOfStart: number;
217 stopAfterHours: number;
218 stopOnConnectionFailure: boolean;
219 requireAuthorize?: boolean;
220 idTagDistribution?: 'random' | 'round-robin' | 'connector-affinity';
221};
222```
223
224Section example:
225
c94a349a 226```json
0302da79 227 "AutomaticTransactionGenerator": {
c94a349a
JB		 228 "enable": false,
229 "minDuration": 60,
230 "maxDuration": 80,
231 "minDelayBetweenTwoTransactions": 15,
232 "maxDelayBetweenTwoTransactions": 30,
233 "probabilityOfStart": 1,
234 "stopAfterHours": 0.3,
235 "stopOnConnectionFailure": true,
c72f6634
JB		 236 "requireAuthorize": true,
237 "idTagDistribution": "random"
c94a349a
JB		 238 }
239```
e7aeea18 240
c94a349a
JB		 241#### Connectors section
242
243```json
0302da79 244 "Connectors": {
c94a349a
JB		 245 "0": {},
246 "1": {
247 "bootStatus": "Available",
248 "MeterValues": [
9bd87386
JB		 249 ...
250 {
251 "unit": "W",
252 "measurand": "Power.Active.Import",
253 "phase": "L1-N",
254 "value": "5000",
255 "fluctuationPercent": "10"
256 },
c94a349a
JB		 257 ...
258 {
259 "unit": "A",
260 "measurand": "Current.Import"
261 },
262 ...
263 {
264 "unit": "Wh"
265 },
266 ...
267 ]
268 }
269 },
270```
271
1816f743
JB		 272### Charging station configuration
273
1c51fd1d 274**dist/assets/configurations/\<hashId\>.json**:
1816f743 275
a9ec2018 276The charging station configuration file is automatically generated at startup from the charging station configuration template file and is persistent.
1816f743
JB		 277
278The 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.
279
280#### stationInfo section
281
282The syntax is similar to charging station configuration template with some added fields like the charging station id (name) and the 'Configuration' section removed.
283
284#### configurationKey section
285
286The syntax is similar to the charging station configuration template 'Configuration' section.
287
6f0ec20e
JB		 288## Docker
289
290In the [docker](./docker) folder:
291
292```bash
293make
294```
295
bfcad885 296Or with the optional git submodules:
6f0ec20e
JB		 297
298```bash
bfcad885 299make SUBMODULES_INIT=true
6f0ec20e
JB		 300```
301
302## OCPP-J commands supported
c94a349a
JB		 303
304### Version 1.6
305
c56d42f1 306#### Core Profile
6f0ec20e 307
778f7924
JB		 308- :white_check_mark: Authorize
309- :white_check_mark: BootNotification
310- :white_check_mark: ChangeAvailability
311- :white_check_mark: ChangeConfiguration
312- :white_check_mark: ClearCache
9e1b12e4 313- :x: DataTransfer
778f7924
JB		 314- :white_check_mark: GetConfiguration
315- :white_check_mark: Heartbeat
316- :white_check_mark: MeterValues
317- :white_check_mark: RemoteStartTransaction
318- :white_check_mark: RemoteStopTransaction
319- :white_check_mark: Reset
320- :white_check_mark: StartTransaction
321- :white_check_mark: StatusNotification
322- :white_check_mark: StopTransaction
323- :white_check_mark: UnlockConnector
6f0ec20e 324
c56d42f1 325#### Firmware Management Profile
6f0ec20e 326
b652b0c3 327- :white_check_mark: GetDiagnostics
d50343bd 328- :white_check_mark: DiagnosticsStatusNotification
9e1b12e4
JB		 329- :x: FirmwareStatusNotification
330- :x: UpdateFirmware
6f0ec20e 331
c56d42f1 332#### Local Auth List Management Profile
6f0ec20e 333
9e1b12e4
JB		 334- :x: GetLocalListVersion
335- :x: SendLocalList
6f0ec20e 336
c56d42f1 337#### Reservation Profile
6f0ec20e 338
9e1b12e4
JB		 339- :x: CancelReservation
340- :x: ReserveNow
6f0ec20e 341
c56d42f1 342#### Smart Charging Profile
6f0ec20e 343
778f7924 344- :white_check_mark: ClearChargingProfile
68cb8b91 345- :x: GetCompositeSchedule
778f7924 346- :white_check_mark: SetChargingProfile
6f0ec20e 347
c56d42f1 348#### Remote Trigger Profile
6f0ec20e 349
802cfa13 350- :white_check_mark: TriggerMessage
7dde0b73 351
7e1dc878
JB		 352## OCPP-J standard parameters supported
353
1816f743 354All 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.
7e1dc878
JB		 355
356### Version 1.6
357
c56d42f1 358#### Core Profile
7e1dc878
JB		 359
360- :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -)
361- :x: ClockAlignedDataInterval (type: integer) (units: seconds)
291cb255 362- :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds)
7e1dc878
JB		 363- :x: GetConfigurationMaxKeys (type: integer) (units: -)
364- :white_check_mark: HeartbeatInterval (type: integer) (units: seconds)
365- :x: LocalAuthorizeOffline (type: boolean) (units: -)
366- :x: LocalPreAuthorize (type: boolean) (units: -)
367- :x: MeterValuesAlignedData (type: CSL) (units: -)
368- :white_check_mark: MeterValuesSampledData (type: CSL) (units: -)
369- :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds)
370- :white_check_mark: NumberOfConnectors (type: integer) (units: -)
371- :x: ResetRetries (type: integer) (units: times)
372- :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -)
373- :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -)
374- :x: StopTransactionOnInvalidId (type: boolean) (units: -)
375- :x: StopTxnAlignedData (type: CSL) (units: -)
376- :x: StopTxnSampledData (type: CSL) (units: -)
36f6a92e 377- :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -)
7e1dc878
JB		 378- :x: TransactionMessageAttempts (type: integer) (units: times)
379- :x: TransactionMessageRetryInterval (type: integer) (units: seconds)
380- :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -)
36f6a92e 381- :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds)
7e1dc878 382
c56d42f1 383#### Firmware Management Profile
7e1dc878 384
e7aeea18 385- _none_
7e1dc878 386
c56d42f1 387#### Local Auth List Management Profile
7e1dc878 388
36f6a92e 389- :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
7e1dc878
JB		 390- :x: LocalAuthListMaxLength (type: integer) (units: -)
391- :x: SendLocalListMaxLength (type: integer) (units: -)
392
c56d42f1 393#### Reservation Profile
7e1dc878 394
e7aeea18 395- _none_
7e1dc878 396
c56d42f1 397#### Smart Charging Profile
7e1dc878
JB		 398
399- :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
400- :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
401- :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
402- :x: MaxChargingProfilesInstalled (type: integer) (units: -)
403
c56d42f1 404#### Remote Trigger Profile
7e1dc878 405
e7aeea18 406- _none_
7e1dc878 407
32de5a57
LM		 408## UI protocol
409
03ebf4c1 410Protocol to control the simulator via a Websocket or HTTP server.
32de5a57 411
4df14d3a
JB		 412### HTTP Protocol
413
2a61222f 414To 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.
4df14d3a 415
02cde3b7 416### Websocket Protocol
32de5a57 417
02cde3b7 418SRPC protocol over Websocket. PDU stands for 'Protocol Data Unit'.
32de5a57 419
03ebf4c1
JB		 420- Request:
421 [`uuid`, `ProcedureName`, `PDU`]
422 `uuid`: String uniquely representing this request
423 `ProcedureName`: The procedure to run on the simulator
424 `PDU`: The parameters for said procedure
32de5a57 425
03ebf4c1
JB		 426- Response:
427 [`uuid`, `PDU`]
428 `uuid`: String uniquely linking the response to the request
02cde3b7 429 `PDU`: Response parameters to requested procedure
32de5a57 430
d3140adc 431#### Version 0.0.1
4e3ff94d 432
02cde3b7 433Set the Websocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
4e3ff94d 434
d3140adc 435##### Procedures
32de5a57 436
d3140adc 437###### Start Simulator
5612b691 438
03ebf4c1
JB		 439- Request:
440 `ProcedureName`: 'startSimulator'
441 `PDU`: {}
5612b691 442
03ebf4c1
JB		 443- Response:
444 `PDU`: {
853ed24a 445 `status`: 'success' | 'failure'
03ebf4c1 446 }
5612b691 447
d3140adc 448###### Stop Simulator
5612b691 449
03ebf4c1
JB		 450- Request:
451 `ProcedureName`: 'stopSimulator'
452 `PDU`: {}
5612b691 453
03ebf4c1
JB		 454- Response:
455 `PDU`: {
853ed24a 456 `status`: 'success' | 'failure'
03ebf4c1 457 }
5612b691 458
d3140adc 459###### List Charging Stations
32de5a57 460
03ebf4c1
JB		 461- Request:
462 `ProcedureName`: 'listChargingStations'
463 `PDU`: {}
32de5a57 464
03ebf4c1
JB		 465- Response:
466 `PDU`: {
853ed24a 467 `status`: 'success' | 'failure',
02cde3b7 468 `chargingStations`: ChargingStationData[]
03ebf4c1 469 }
32de5a57 470
d3140adc 471###### Start Transaction
32de5a57 472
03ebf4c1
JB		 473- Request:
474 `ProcedureName`: 'startTransaction'
475 `PDU`: {
853ed24a 476 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
03ebf4c1
JB		 477 `connectorId`: connector id integer,
478 `idTag`: RFID tag string
479 }
32de5a57 480
03ebf4c1
JB		 481- Response:
482 `PDU`: {
853ed24a
JB		 483 `status`: 'success' | 'failure',
484 `hashIdsSucceeded`: charging station unique identifier strings array,
a9ed42b2
JB		 485 `hashIdsFailed`: charging station unique identifier strings array (optional),
486 `responsesFailed`: failed responses payload array (optional)
03ebf4c1 487 }
32de5a57 488
d3140adc 489###### Stop Transaction
32de5a57 490
03ebf4c1
JB		 491- Request:
492 `ProcedureName`: 'stopTransaction'
493 `PDU`: {
853ed24a 494 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
03ebf4c1
JB		 495 `transactionId`: transaction id integer
496 }
32de5a57 497
03ebf4c1
JB		 498- Response:
499 `PDU`: {
853ed24a
JB		 500 `status`: 'success' | 'failure',
501 `hashIdsSucceeded`: charging station unique identifier strings array,
5566ca3e
JB		 502 `hashIdsFailed`: charging station unique identifier strings array (optional),
503 `responsesFailed`: failed responses payload array (optional)
03ebf4c1 504 }
32de5a57 505
d3140adc 506###### Start Charging Station
80a3704c 507
03ebf4c1
JB		 508- Request:
509 `ProcedureName`: 'startChargingStation'
510 `PDU`: {
94abe068
JB		 511 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
512 `responsesFailed`: failed responses payload array (optional)
03ebf4c1 513 }
80a3704c 514
03ebf4c1
JB		 515- Response:
516 `PDU`: {
853ed24a
JB		 517 `status`: 'success' | 'failure',
518 `hashIdsSucceeded`: charging station unique identifier strings array,
519 `hashIdsFailed`: charging station unique identifier strings array (optional)
03ebf4c1 520 }
80a3704c 521
d3140adc 522###### Stop Charging Station
80a3704c 523
03ebf4c1
JB		 524- Request:
525 `ProcedureName`: 'stopChargingStation'
526 `PDU`: {
853ed24a 527 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
03ebf4c1 528 }
80a3704c 529
03ebf4c1
JB		 530- Response:
531 `PDU`: {
853ed24a
JB		 532 `status`: 'success' | 'failure',
533 `hashIdsSucceeded`: charging station unique identifier strings array,
94abe068
JB		 534 `hashIdsFailed`: charging station unique identifier strings array (optional),
535 `responsesFailed`: failed responses payload array (optional)
03ebf4c1 536 }
80a3704c 537
d3140adc 538###### Open Connection
e4df816e 539
03ebf4c1
JB		 540- Request:
541 `ProcedureName`: 'openConnection'
542 `PDU`: {
853ed24a 543 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
03ebf4c1 544 }
e4df816e 545
03ebf4c1
JB		 546- Response:
547 `PDU`: {
853ed24a
JB		 548 `status`: 'success' | 'failure',
549 `hashIdsSucceeded`: charging station unique identifier strings array,
94abe068
JB		 550 `hashIdsFailed`: charging station unique identifier strings array (optional),
551 `responsesFailed`: failed responses payload array (optional)
03ebf4c1 552 }
e4df816e 553
d3140adc 554###### Close Connection
e4df816e 555
03ebf4c1
JB		 556- Request:
557 `ProcedureName`: 'closeConnection'
558 `PDU`: {
853ed24a 559 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
03ebf4c1
JB		 560 }
561
562- Response:
563 `PDU`: {
853ed24a
JB		 564 `status`: 'success' | 'failure',
565 `hashIdsSucceeded`: charging station unique identifier strings array,
94abe068
JB		 566 `hashIdsFailed`: charging station unique identifier strings array (optional),
567 `responsesFailed`: failed responses payload array (optional)
853ed24a
JB		 568 }
569
570###### Start Automatic Transaction Generator
571
572- Request:
573 `ProcedureName`: 'startAutomaticTransactionGenerator'
574 `PDU`: {
575 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
a38bc315 576 `connectorIds`: connector id integer array (optional, default: all connectors)
853ed24a
JB		 577 }
578
579- Response:
580 `PDU`: {
581 `status`: 'success' | 'failure',
582 `hashIdsSucceeded`: charging station unique identifier strings array,
5566ca3e
JB		 583 `hashIdsFailed`: charging station unique identifier strings array (optional),
584 `responsesFailed`: failed responses payload array (optional)
853ed24a
JB		 585 }
586
587###### Stop Automatic Transaction Generator
588
589- Request:
590 `ProcedureName`: 'stopAutomaticTransactionGenerator'
591 `PDU`: {
592 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
a38bc315 593 `connectorIds`: connector id integer array (optional, default: all connectors)
853ed24a
JB		 594 }
595
596- Response:
597 `PDU`: {
598 `status`: 'success' | 'failure',
599 `hashIdsSucceeded`: charging station unique identifier strings array,
5566ca3e
JB		 600 `hashIdsFailed`: charging station unique identifier strings array (optional),
601 `responsesFailed`: failed responses payload array (optional)
03ebf4c1
JB		 602 }
603
5566ca3e 604###### Status Notification
a9ed42b2
JB		 605
606- Request:
607 `ProcedureName`: 'StatusNotification'
608 `PDU`: {
609 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
10db00b2
JB		 610 `connectorId`: connector id integer,
611 `errorCode`: connector error code,
612 `status`: connector status
613 }
614
615- Response:
616 `PDU`: {
617 `status`: 'success' | 'failure',
618 `hashIdsSucceeded`: charging station unique identifier strings array,
619 `hashIdsFailed`: charging station unique identifier strings array (optional),
620 `responsesFailed`: failed responses payload array (optional)
621 }
622
623###### Heartbeat
624
625- Request:
626 `ProcedureName`: 'Heartbeat'
627 `PDU`: {
628 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
a9ed42b2
JB		 629 }
630
631- Response:
632 `PDU`: {
633 `status`: 'success' | 'failure',
634 `hashIdsSucceeded`: charging station unique identifier strings array,
5566ca3e 635 `hashIdsFailed`: charging station unique identifier strings array (optional),
a9ed42b2
JB		 636 `responsesFailed`: failed responses payload array (optional)
637 }
638
251fff5c 639## Support, Feedback, Contributing
7dde0b73 640
7f774a55 641This 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).
7dde0b73 642
251fff5c
JB		 643## Code of Conduct
644
645We 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.
646
647## Licensing
648
7f774a55 649Copyright 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