repositories / e-mobility-charging-stations-simulator.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Run 'npm run format'
[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
b8cc885d
JB		 56See Web UI [README.md](src/ui/web/README.md) for more information.
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
0191e17a
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 |
9e0845f7 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 |
0191e17a
JB		 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 |
db7d7aa6 173| commandsSupport | | {<br />"incomingCommands": {},<br />"outgoingCommands": {}<br />} | {<br /> incomingCommands: Record<IncomingRequestCommand, boolean>;<br />outgoingCommands?: Record<RequestCommand, boolean>;<br />} | Configuration section for OCPP commands support. Empty section or subsections means all implemented commands are supported |
65554cc3
JB		 174| Configuration | | | ChargingStationConfiguration | charging stations OCPP parameters configuration section |
175| AutomaticTransactionGenerator | | | AutomaticTransactionGenerator | charging stations ATG configuration section |
176| Connectors | | | Connectors | charging stations connectors configuration section |
c94a349a
JB		 177
178#### Configuration section
179
180```json
0302da79 181 "Configuration": {
c94a349a
JB		 182 "configurationKey": [
183 ...
184 {
185 "key": "StandardKey",
186 "readonly": false,
187 "value": "StandardValue",
188 "visible": true,
189 "reboot": false
190 },
191 ...
192 {
193 "key": "VendorKey",
194 "readonly": false,
195 "value": "VendorValue",
196 "visible": false,
197 "reboot": true
198 },
199 ...
200 ]
201 }
202```
203
204#### AutomaticTransactionGenerator section
205
c72f6634
JB		 206Section type definition:
207
208```ts
209type AutomaticTransactionGeneratorConfiguration = {
210 enable: boolean;
211 minDuration: number;
212 maxDuration: number;
213 minDelayBetweenTwoTransactions: number;
214 maxDelayBetweenTwoTransactions: number;
215 probabilityOfStart: number;
216 stopAfterHours: number;
217 stopOnConnectionFailure: boolean;
218 requireAuthorize?: boolean;
219 idTagDistribution?: 'random' | 'round-robin' | 'connector-affinity';
220};
221```
222
223Section example:
224
c94a349a 225```json
0302da79 226 "AutomaticTransactionGenerator": {
c94a349a
JB		 227 "enable": false,
228 "minDuration": 60,
229 "maxDuration": 80,
230 "minDelayBetweenTwoTransactions": 15,
231 "maxDelayBetweenTwoTransactions": 30,
232 "probabilityOfStart": 1,
233 "stopAfterHours": 0.3,
234 "stopOnConnectionFailure": true,
c72f6634
JB		 235 "requireAuthorize": true,
236 "idTagDistribution": "random"
c94a349a
JB		 237 }
238```
e7aeea18 239
c94a349a
JB		 240#### Connectors section
241
242```json
0302da79 243 "Connectors": {
c94a349a
JB		 244 "0": {},
245 "1": {
246 "bootStatus": "Available",
247 "MeterValues": [
9bd87386
JB		 248 ...
249 {
250 "unit": "W",
251 "measurand": "Power.Active.Import",
252 "phase": "L1-N",
253 "value": "5000",
254 "fluctuationPercent": "10"
255 },
c94a349a
JB		 256 ...
257 {
258 "unit": "A",
259 "measurand": "Current.Import"
260 },
261 ...
262 {
263 "unit": "Wh"
264 },
265 ...
266 ]
267 }
268 },
269```
270
1816f743
JB		 271### Charging station configuration
272
1c51fd1d 273**dist/assets/configurations/\<hashId\>.json**:
1816f743 274
a9ec2018 275The charging station configuration file is automatically generated at startup from the charging station configuration template file and is persistent.
1816f743
JB		 276
277The charging station configuration file content can be regenerated partially on matching charging station configuration template file changes. The charging station serial number is kept unchanged.
278
279#### stationInfo section
280
281The syntax is similar to charging station configuration template with some added fields like the charging station id (name) and the 'Configuration' section removed.
282
283#### configurationKey section
284
285The syntax is similar to the charging station configuration template 'Configuration' section.
286
6f0ec20e
JB		 287## Docker
288
289In the [docker](./docker) folder:
290
291```bash
292make
293```
294
bfcad885 295Or with the optional git submodules:
6f0ec20e
JB		 296
297```bash
bfcad885 298make SUBMODULES_INIT=true
6f0ec20e
JB		 299```
300
301## OCPP-J commands supported
c94a349a
JB		 302
303### Version 1.6
304
c56d42f1 305#### Core Profile
6f0ec20e 306
778f7924
JB		 307- :white_check_mark: Authorize
308- :white_check_mark: BootNotification
309- :white_check_mark: ChangeAvailability
310- :white_check_mark: ChangeConfiguration
311- :white_check_mark: ClearCache
9e1b12e4 312- :x: DataTransfer
778f7924
JB		 313- :white_check_mark: GetConfiguration
314- :white_check_mark: Heartbeat
315- :white_check_mark: MeterValues
316- :white_check_mark: RemoteStartTransaction
317- :white_check_mark: RemoteStopTransaction
318- :white_check_mark: Reset
319- :white_check_mark: StartTransaction
320- :white_check_mark: StatusNotification
321- :white_check_mark: StopTransaction
322- :white_check_mark: UnlockConnector
6f0ec20e 323
c56d42f1 324#### Firmware Management Profile
6f0ec20e 325
b652b0c3 326- :white_check_mark: GetDiagnostics
d50343bd 327- :white_check_mark: DiagnosticsStatusNotification
9e1b12e4
JB		 328- :x: FirmwareStatusNotification
329- :x: UpdateFirmware
6f0ec20e 330
c56d42f1 331#### Local Auth List Management Profile
6f0ec20e 332
9e1b12e4
JB		 333- :x: GetLocalListVersion
334- :x: SendLocalList
6f0ec20e 335
c56d42f1 336#### Reservation Profile
6f0ec20e 337
9e1b12e4
JB		 338- :x: CancelReservation
339- :x: ReserveNow
6f0ec20e 340
c56d42f1 341#### Smart Charging Profile
6f0ec20e 342
778f7924 343- :white_check_mark: ClearChargingProfile
68cb8b91 344- :x: GetCompositeSchedule
778f7924 345- :white_check_mark: SetChargingProfile
6f0ec20e 346
c56d42f1 347#### Remote Trigger Profile
6f0ec20e 348
802cfa13 349- :white_check_mark: TriggerMessage
7dde0b73 350
7e1dc878
JB		 351## OCPP-J standard parameters supported
352
1816f743 353All 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		 354
355### Version 1.6
356
c56d42f1 357#### Core Profile
7e1dc878
JB		 358
359- :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -)
360- :x: ClockAlignedDataInterval (type: integer) (units: seconds)
291cb255 361- :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds)
7e1dc878
JB		 362- :x: GetConfigurationMaxKeys (type: integer) (units: -)
363- :white_check_mark: HeartbeatInterval (type: integer) (units: seconds)
364- :x: LocalAuthorizeOffline (type: boolean) (units: -)
365- :x: LocalPreAuthorize (type: boolean) (units: -)
366- :x: MeterValuesAlignedData (type: CSL) (units: -)
367- :white_check_mark: MeterValuesSampledData (type: CSL) (units: -)
368- :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds)
369- :white_check_mark: NumberOfConnectors (type: integer) (units: -)
370- :x: ResetRetries (type: integer) (units: times)
371- :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -)
372- :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -)
373- :x: StopTransactionOnInvalidId (type: boolean) (units: -)
374- :x: StopTxnAlignedData (type: CSL) (units: -)
375- :x: StopTxnSampledData (type: CSL) (units: -)
36f6a92e 376- :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -)
7e1dc878
JB		 377- :x: TransactionMessageAttempts (type: integer) (units: times)
378- :x: TransactionMessageRetryInterval (type: integer) (units: seconds)
379- :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -)
36f6a92e 380- :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds)
7e1dc878 381
c56d42f1 382#### Firmware Management Profile
7e1dc878 383
e7aeea18 384- _none_
7e1dc878 385
c56d42f1 386#### Local Auth List Management Profile
7e1dc878 387
36f6a92e 388- :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
7e1dc878
JB		 389- :x: LocalAuthListMaxLength (type: integer) (units: -)
390- :x: SendLocalListMaxLength (type: integer) (units: -)
391
c56d42f1 392#### Reservation Profile
7e1dc878 393
e7aeea18 394- _none_
7e1dc878 395
c56d42f1 396#### Smart Charging Profile
7e1dc878
JB		 397
398- :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
399- :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
400- :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
401- :x: MaxChargingProfilesInstalled (type: integer) (units: -)
402
c56d42f1 403#### Remote Trigger Profile
7e1dc878 404
e7aeea18 405- _none_
7e1dc878 406
32de5a57
LM		 407## UI protocol
408
03ebf4c1 409Protocol to control the simulator via a Websocket or HTTP server.
32de5a57 410
4df14d3a
JB		 411### HTTP Protocol
412
2a61222f 413To 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 414
02cde3b7 415### Websocket Protocol
32de5a57 416
02cde3b7 417SRPC protocol over Websocket. PDU stands for 'Protocol Data Unit'.
32de5a57 418
03ebf4c1
JB		 419- Request:
420 [`uuid`, `ProcedureName`, `PDU`]
421 `uuid`: String uniquely representing this request
422 `ProcedureName`: The procedure to run on the simulator
423 `PDU`: The parameters for said procedure
32de5a57 424
03ebf4c1
JB		 425- Response:
426 [`uuid`, `PDU`]
427 `uuid`: String uniquely linking the response to the request
02cde3b7 428 `PDU`: Response parameters to requested procedure
32de5a57 429
d3140adc 430#### Version 0.0.1
4e3ff94d 431
02cde3b7 432Set the Websocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
4e3ff94d 433
d3140adc 434##### Procedures
32de5a57 435
d3140adc 436###### Start Simulator
5612b691 437
03ebf4c1
JB		 438- Request:
439 `ProcedureName`: 'startSimulator'
440 `PDU`: {}
5612b691 441
03ebf4c1
JB		 442- Response:
443 `PDU`: {
853ed24a 444 `status`: 'success' | 'failure'
03ebf4c1 445 }
5612b691 446
d3140adc 447###### Stop Simulator
5612b691 448
03ebf4c1
JB		 449- Request:
450 `ProcedureName`: 'stopSimulator'
451 `PDU`: {}
5612b691 452
03ebf4c1
JB		 453- Response:
454 `PDU`: {
853ed24a 455 `status`: 'success' | 'failure'
03ebf4c1 456 }
5612b691 457
d3140adc 458###### List Charging Stations
32de5a57 459
03ebf4c1
JB		 460- Request:
461 `ProcedureName`: 'listChargingStations'
462 `PDU`: {}
32de5a57 463
03ebf4c1
JB		 464- Response:
465 `PDU`: {
853ed24a 466 `status`: 'success' | 'failure',
02cde3b7 467 `chargingStations`: ChargingStationData[]
03ebf4c1 468 }
32de5a57 469
d3140adc 470###### Start Transaction
32de5a57 471
03ebf4c1
JB		 472- Request:
473 `ProcedureName`: 'startTransaction'
474 `PDU`: {
853ed24a 475 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
03ebf4c1
JB		 476 `connectorId`: connector id integer,
477 `idTag`: RFID tag string
478 }
32de5a57 479
03ebf4c1
JB		 480- Response:
481 `PDU`: {
853ed24a
JB		 482 `status`: 'success' | 'failure',
483 `hashIdsSucceeded`: charging station unique identifier strings array,
a9ed42b2
JB		 484 `hashIdsFailed`: charging station unique identifier strings array (optional),
485 `responsesFailed`: failed responses payload array (optional)
03ebf4c1 486 }
32de5a57 487
d3140adc 488###### Stop Transaction
32de5a57 489
03ebf4c1
JB		 490- Request:
491 `ProcedureName`: 'stopTransaction'
492 `PDU`: {
853ed24a 493 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
03ebf4c1
JB		 494 `transactionId`: transaction id integer
495 }
32de5a57 496
03ebf4c1
JB		 497- Response:
498 `PDU`: {
853ed24a
JB		 499 `status`: 'success' | 'failure',
500 `hashIdsSucceeded`: charging station unique identifier strings array,
5566ca3e
JB		 501 `hashIdsFailed`: charging station unique identifier strings array (optional),
502 `responsesFailed`: failed responses payload array (optional)
03ebf4c1 503 }
32de5a57 504
d3140adc 505###### Start Charging Station
80a3704c 506
03ebf4c1
JB		 507- Request:
508 `ProcedureName`: 'startChargingStation'
509 `PDU`: {
94abe068
JB		 510 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
511 `responsesFailed`: failed responses payload array (optional)
03ebf4c1 512 }
80a3704c 513
03ebf4c1
JB		 514- Response:
515 `PDU`: {
853ed24a
JB		 516 `status`: 'success' | 'failure',
517 `hashIdsSucceeded`: charging station unique identifier strings array,
518 `hashIdsFailed`: charging station unique identifier strings array (optional)
03ebf4c1 519 }
80a3704c 520
d3140adc 521###### Stop Charging Station
80a3704c 522
03ebf4c1
JB		 523- Request:
524 `ProcedureName`: 'stopChargingStation'
525 `PDU`: {
853ed24a 526 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
03ebf4c1 527 }
80a3704c 528
03ebf4c1
JB		 529- Response:
530 `PDU`: {
853ed24a
JB		 531 `status`: 'success' | 'failure',
532 `hashIdsSucceeded`: charging station unique identifier strings array,
94abe068
JB		 533 `hashIdsFailed`: charging station unique identifier strings array (optional),
534 `responsesFailed`: failed responses payload array (optional)
03ebf4c1 535 }
80a3704c 536
d3140adc 537###### Open Connection
e4df816e 538
03ebf4c1
JB		 539- Request:
540 `ProcedureName`: 'openConnection'
541 `PDU`: {
853ed24a 542 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
03ebf4c1 543 }
e4df816e 544
03ebf4c1
JB		 545- Response:
546 `PDU`: {
853ed24a
JB		 547 `status`: 'success' | 'failure',
548 `hashIdsSucceeded`: charging station unique identifier strings array,
94abe068
JB		 549 `hashIdsFailed`: charging station unique identifier strings array (optional),
550 `responsesFailed`: failed responses payload array (optional)
03ebf4c1 551 }
e4df816e 552
d3140adc 553###### Close Connection
e4df816e 554
03ebf4c1
JB		 555- Request:
556 `ProcedureName`: 'closeConnection'
557 `PDU`: {
853ed24a 558 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
03ebf4c1
JB		 559 }
560
561- Response:
562 `PDU`: {
853ed24a
JB		 563 `status`: 'success' | 'failure',
564 `hashIdsSucceeded`: charging station unique identifier strings array,
94abe068
JB		 565 `hashIdsFailed`: charging station unique identifier strings array (optional),
566 `responsesFailed`: failed responses payload array (optional)
853ed24a
JB		 567 }
568
569###### Start Automatic Transaction Generator
570
571- Request:
572 `ProcedureName`: 'startAutomaticTransactionGenerator'
573 `PDU`: {
574 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
a38bc315 575 `connectorIds`: connector id integer array (optional, default: all connectors)
853ed24a
JB		 576 }
577
578- Response:
579 `PDU`: {
580 `status`: 'success' | 'failure',
581 `hashIdsSucceeded`: charging station unique identifier strings array,
5566ca3e
JB		 582 `hashIdsFailed`: charging station unique identifier strings array (optional),
583 `responsesFailed`: failed responses payload array (optional)
853ed24a
JB		 584 }
585
586###### Stop Automatic Transaction Generator
587
588- Request:
589 `ProcedureName`: 'stopAutomaticTransactionGenerator'
590 `PDU`: {
591 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
a38bc315 592 `connectorIds`: connector id integer array (optional, default: all connectors)
853ed24a
JB		 593 }
594
595- Response:
596 `PDU`: {
597 `status`: 'success' | 'failure',
598 `hashIdsSucceeded`: charging station unique identifier strings array,
5566ca3e
JB		 599 `hashIdsFailed`: charging station unique identifier strings array (optional),
600 `responsesFailed`: failed responses payload array (optional)
03ebf4c1
JB		 601 }
602
5566ca3e 603###### Status Notification
a9ed42b2
JB		 604
605- Request:
606 `ProcedureName`: 'StatusNotification'
607 `PDU`: {
608 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
10db00b2
JB		 609 `connectorId`: connector id integer,
610 `errorCode`: connector error code,
611 `status`: connector status
612 }
613
614- Response:
615 `PDU`: {
616 `status`: 'success' | 'failure',
617 `hashIdsSucceeded`: charging station unique identifier strings array,
618 `hashIdsFailed`: charging station unique identifier strings array (optional),
619 `responsesFailed`: failed responses payload array (optional)
620 }
621
622###### Heartbeat
623
624- Request:
625 `ProcedureName`: 'Heartbeat'
626 `PDU`: {
627 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
a9ed42b2
JB		 628 }
629
630- Response:
631 `PDU`: {
632 `status`: 'success' | 'failure',
633 `hashIdsSucceeded`: charging station unique identifier strings array,
5566ca3e 634 `hashIdsFailed`: charging station unique identifier strings array (optional),
a9ed42b2
JB		 635 `responsesFailed`: failed responses payload array (optional)
636 }
637
251fff5c 638## Support, Feedback, Contributing
7dde0b73 639
7f774a55 640This 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 641
251fff5c
JB		 642## Code of Conduct
643
644We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](CODE_OF_CONDUCT.md) at all times.
645
646## Licensing
647
7f774a55 648Copyright 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