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