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