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