repositories / e-mobility-charging-stations-simulator.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
fix: ensure the incremented firmware version is saved in configuration
[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 |
21899fc2 99| logFormat | | simple | string | [winston](https://github.com/winstonjs/winston) log format |
19dbb570 100| logRotate | true/false | true | boolean | enable daily log files rotation |
0205b291
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 |
21899fc2 103| logLevel | emerg/alert/crit/error/warning/notice/info/debug | info | string | [winston](https://github.com/winstonjs/winston) logging level |
19dbb570
JB		 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 |
a14885a3 107| uiServer | | {<br />"enabled": false,<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 |
19dbb570
JB		 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
1d495af5
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 | | undefined | string | basic HTTP authentication user to OCPP-J server |
130| supervisionPassword | | undefined | 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/2.0/2.0.1 | 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](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](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 | | undefined | string | RFID tags list file relative to src/assets path |
140| baseName | | undefined | string | base name to build charging stations id |
141| nameSuffix | | undefined | 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 | | undefined | string | charging stations model |
144| chargePointVendor | | undefined | string | charging stations vendor |
145| chargePointSerialNumberPrefix | | undefined | string | charge point serial number prefix |
146| chargeBoxSerialNumberPrefix | | undefined | string | charge box serial number prefix (deprecated in OCPP 1.6) |
147| firmwareVersionPattern | | Semantic versionning regular expression: https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string | string | charging stations firmware version pattern |
148| firmwareVersion | | undefined | string | charging stations firmware version |
149| power | | | float \| float[] | charging stations maximum power value(s) |
150| powerSharedByConnectors | true/false | false | boolean | charging stations power shared by its connectors |
151| powerUnit | W/kW | W | string | charging stations power unit |
152| currentOutType | AC/DC | AC | string | charging stations current out type |
153| voltageOut | | AC:230/DC:400 | integer | charging stations voltage out |
154| numberOfPhases | 0/1/3 | AC:3/DC:0 | integer | charging stations number of phase(s) |
155| numberOfConnectors | | | integer \| integer[] | charging stations number of connector(s) |
156| useConnectorId0 | true/false | true | boolean | use connector id 0 definition from the charging station configuration template |
157| randomConnectors | true/false | false | boolean | randomize runtime connector id affectation from the connector id definition in charging station configuration template |
158| resetTime | | 60 | integer | seconds to wait before the charging stations come back at reset |
159| autoRegister | true/false | false | boolean | set charging stations as registered at boot notification for testing purpose |
160| autoReconnectMaxRetries | | -1 (unlimited) | integer | connection retries to the OCPP-J server |
161| reconnectExponentialDelay | true/false | false | boolean | connection delay retry to the OCPP-J server |
162| registrationMaxRetries | | -1 (unlimited) | integer | charging stations boot notification retries |
163| 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 |
164| amperageLimitationUnit | A/cA/dA/mA | A | string | charging stations amperage limit unit |
165| enableStatistics | true/false | false | boolean | enable charging stations statistics |
166| mustAuthorizeAtRemoteStart | true/false | true | boolean | always send authorize at remote start transaction when AuthorizeRemoteTxRequests is enabled |
167| payloadSchemaValidation | true/false | true | boolean | validate OCPP commands PDU against [OCA](https://www.openchargealliance.org/) JSON schemas |
168| beginEndMeterValues | true/false | false | boolean | enable Transaction.{Begin,End} MeterValues |
169| outOfOrderEndMeterValues | true/false | false | boolean | send Transaction.End MeterValues out of order. Need to relax OCPP specifications strict compliance ('ocppStrictCompliance' parameter) |
170| meteringPerTransaction | true/false | true | boolean | enable metering history on a per transaction basis |
171| transactionDataMeterValues | true/false | false | boolean | enable transaction data MeterValues at stop transaction |
172| mainVoltageMeterValues | true/false | true | boolean | include charging stations main voltage MeterValues on three phased charging stations |
173| phaseLineToLineVoltageMeterValues | true/false | false | boolean | include charging stations line to line voltage MeterValues on three phased charging stations |
174| customValueLimitationMeterValues | true/false | true | boolean | enable limitation on custom fluctuated value in MeterValues |
175| firmwareUpgrade | | {<br />"versionUpgrade": {<br />"step": 1<br />},<br />"reset": true<br />} | {<br />versionUpgrade: {<br />patternGroup: number;<br />step: number;<br />};<br />reset: boolean;<br />failureStatus: 'DownloadFailed' \| 'InstallationFailed';<br />} | Configuration section for simulating firmware upgrade support. |
176| 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 |
177| messageTriggerSupport | | {} | Record<MessageTrigger, boolean> | Configuration section for OCPP commands trigger support. Empty section means all implemented OCPP trigger commands are supported |
178| Configuration | | | ChargingStationConfiguration | charging stations OCPP parameters configuration section |
179| AutomaticTransactionGenerator | | | AutomaticTransactionGenerator | charging stations ATG configuration section |
180| Connectors | | | Connectors | charging stations connectors configuration section |
c94a349a
JB		 181
182#### Configuration section
183
184```json
0302da79 185 "Configuration": {
c94a349a
JB		 186 "configurationKey": [
187 ...
188 {
189 "key": "StandardKey",
190 "readonly": false,
191 "value": "StandardValue",
192 "visible": true,
193 "reboot": false
194 },
195 ...
196 {
197 "key": "VendorKey",
198 "readonly": false,
199 "value": "VendorValue",
200 "visible": false,
201 "reboot": true
202 },
203 ...
204 ]
205 }
206```
207
208#### AutomaticTransactionGenerator section
209
c72f6634
JB		 210Section type definition:
211
212```ts
213type AutomaticTransactionGeneratorConfiguration = {
214 enable: boolean;
215 minDuration: number;
216 maxDuration: number;
217 minDelayBetweenTwoTransactions: number;
218 maxDelayBetweenTwoTransactions: number;
219 probabilityOfStart: number;
220 stopAfterHours: number;
221 stopOnConnectionFailure: boolean;
222 requireAuthorize?: boolean;
223 idTagDistribution?: 'random' | 'round-robin' | 'connector-affinity';
224};
225```
226
227Section example:
228
c94a349a 229```json
0302da79 230 "AutomaticTransactionGenerator": {
c94a349a
JB		 231 "enable": false,
232 "minDuration": 60,
233 "maxDuration": 80,
234 "minDelayBetweenTwoTransactions": 15,
235 "maxDelayBetweenTwoTransactions": 30,
236 "probabilityOfStart": 1,
237 "stopAfterHours": 0.3,
238 "stopOnConnectionFailure": true,
c72f6634
JB		 239 "requireAuthorize": true,
240 "idTagDistribution": "random"
c94a349a
JB		 241 }
242```
e7aeea18 243
c94a349a
JB		 244#### Connectors section
245
246```json
0302da79 247 "Connectors": {
c94a349a
JB		 248 "0": {},
249 "1": {
250 "bootStatus": "Available",
251 "MeterValues": [
9bd87386
JB		 252 ...
253 {
254 "unit": "W",
255 "measurand": "Power.Active.Import",
256 "phase": "L1-N",
257 "value": "5000",
258 "fluctuationPercent": "10"
259 },
c94a349a
JB		 260 ...
261 {
262 "unit": "A",
263 "measurand": "Current.Import"
264 },
265 ...
266 {
267 "unit": "Wh"
268 },
269 ...
270 ]
271 }
272 },
273```
274
1816f743
JB		 275### Charging station configuration
276
1c51fd1d 277**dist/assets/configurations/\<hashId\>.json**:
1816f743 278
a9ec2018 279The charging station configuration file is automatically generated at startup from the charging station configuration template file and is persistent.
1816f743
JB		 280
281The 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.
282
283#### stationInfo section
284
285The syntax is similar to charging station configuration template with some added fields like the charging station id (name) and the 'Configuration' section removed.
286
287#### configurationKey section
288
289The syntax is similar to the charging station configuration template 'Configuration' section.
290
6f0ec20e
JB		 291## Docker
292
293In the [docker](./docker) folder:
294
295```bash
296make
297```
298
bfcad885 299Or with the optional git submodules:
6f0ec20e
JB		 300
301```bash
bfcad885 302make SUBMODULES_INIT=true
6f0ec20e
JB		 303```
304
305## OCPP-J commands supported
c94a349a
JB		 306
307### Version 1.6
308
c56d42f1 309#### Core Profile
6f0ec20e 310
778f7924
JB		 311- :white_check_mark: Authorize
312- :white_check_mark: BootNotification
313- :white_check_mark: ChangeAvailability
314- :white_check_mark: ChangeConfiguration
315- :white_check_mark: ClearCache
91a7d3ea 316- :white_check_mark: DataTransfer
778f7924
JB		 317- :white_check_mark: GetConfiguration
318- :white_check_mark: Heartbeat
319- :white_check_mark: MeterValues
320- :white_check_mark: RemoteStartTransaction
321- :white_check_mark: RemoteStopTransaction
322- :white_check_mark: Reset
323- :white_check_mark: StartTransaction
324- :white_check_mark: StatusNotification
325- :white_check_mark: StopTransaction
326- :white_check_mark: UnlockConnector
6f0ec20e 327
c56d42f1 328#### Firmware Management Profile
6f0ec20e 329
b652b0c3 330- :white_check_mark: GetDiagnostics
d50343bd 331- :white_check_mark: DiagnosticsStatusNotification
c9a4f9ea
JB		 332- :white_check_mark: FirmwareStatusNotification
333- :white_check_mark: UpdateFirmware
6f0ec20e 334
c56d42f1 335#### Local Auth List Management Profile
6f0ec20e 336
9e1b12e4
JB		 337- :x: GetLocalListVersion
338- :x: SendLocalList
6f0ec20e 339
c56d42f1 340#### Reservation Profile
6f0ec20e 341
9e1b12e4
JB		 342- :x: CancelReservation
343- :x: ReserveNow
6f0ec20e 344
c56d42f1 345#### Smart Charging Profile
6f0ec20e 346
778f7924 347- :white_check_mark: ClearChargingProfile
68cb8b91 348- :x: GetCompositeSchedule
778f7924 349- :white_check_mark: SetChargingProfile
6f0ec20e 350
c56d42f1 351#### Remote Trigger Profile
6f0ec20e 352
802cfa13 353- :white_check_mark: TriggerMessage
7dde0b73 354
7e1dc878
JB		 355## OCPP-J standard parameters supported
356
1816f743 357All 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		 358
359### Version 1.6
360
c56d42f1 361#### Core Profile
7e1dc878
JB		 362
363- :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -)
364- :x: ClockAlignedDataInterval (type: integer) (units: seconds)
291cb255 365- :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds)
7e1dc878
JB		 366- :x: GetConfigurationMaxKeys (type: integer) (units: -)
367- :white_check_mark: HeartbeatInterval (type: integer) (units: seconds)
368- :x: LocalAuthorizeOffline (type: boolean) (units: -)
369- :x: LocalPreAuthorize (type: boolean) (units: -)
370- :x: MeterValuesAlignedData (type: CSL) (units: -)
371- :white_check_mark: MeterValuesSampledData (type: CSL) (units: -)
372- :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds)
373- :white_check_mark: NumberOfConnectors (type: integer) (units: -)
374- :x: ResetRetries (type: integer) (units: times)
375- :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -)
376- :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -)
377- :x: StopTransactionOnInvalidId (type: boolean) (units: -)
378- :x: StopTxnAlignedData (type: CSL) (units: -)
379- :x: StopTxnSampledData (type: CSL) (units: -)
36f6a92e 380- :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -)
7e1dc878
JB		 381- :x: TransactionMessageAttempts (type: integer) (units: times)
382- :x: TransactionMessageRetryInterval (type: integer) (units: seconds)
383- :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -)
36f6a92e 384- :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds)
7e1dc878 385
c56d42f1 386#### Firmware Management Profile
7e1dc878 387
e7aeea18 388- _none_
7e1dc878 389
c56d42f1 390#### Local Auth List Management Profile
7e1dc878 391
36f6a92e 392- :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
7e1dc878
JB		 393- :x: LocalAuthListMaxLength (type: integer) (units: -)
394- :x: SendLocalListMaxLength (type: integer) (units: -)
395
c56d42f1 396#### Reservation Profile
7e1dc878 397
e7aeea18 398- _none_
7e1dc878 399
c56d42f1 400#### Smart Charging Profile
7e1dc878
JB		 401
402- :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
403- :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
404- :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
405- :x: MaxChargingProfilesInstalled (type: integer) (units: -)
406
c56d42f1 407#### Remote Trigger Profile
7e1dc878 408
e7aeea18 409- _none_
7e1dc878 410
32de5a57
LM		 411## UI protocol
412
03ebf4c1 413Protocol to control the simulator via a Websocket or HTTP server.
32de5a57 414
4df14d3a
JB		 415### HTTP Protocol
416
97c19696 417To 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 418
02cde3b7 419### Websocket Protocol
32de5a57 420
02cde3b7 421SRPC protocol over Websocket. PDU stands for 'Protocol Data Unit'.
32de5a57 422
03ebf4c1
JB		 423- Request:
424 [`uuid`, `ProcedureName`, `PDU`]
425 `uuid`: String uniquely representing this request
426 `ProcedureName`: The procedure to run on the simulator
427 `PDU`: The parameters for said procedure
32de5a57 428
03ebf4c1
JB		 429- Response:
430 [`uuid`, `PDU`]
431 `uuid`: String uniquely linking the response to the request
02cde3b7 432 `PDU`: Response parameters to requested procedure
32de5a57 433
97c19696
JB		 434An [Insomnia](https://insomnia.rest/) WebSocket requests collection is available in [src/assets/ui-protocol](./src/assets/ui-protocol) directory.
435
d3140adc 436#### Version 0.0.1
4e3ff94d 437
02cde3b7 438Set the Websocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
4e3ff94d 439
d3140adc 440##### Procedures
32de5a57 441
d3140adc 442###### Start Simulator
5612b691 443
03ebf4c1
JB		 444- Request:
445 `ProcedureName`: 'startSimulator'
446 `PDU`: {}
5612b691 447
03ebf4c1
JB		 448- Response:
449 `PDU`: {
853ed24a 450 `status`: 'success' | 'failure'
03ebf4c1 451 }
5612b691 452
d3140adc 453###### Stop Simulator
5612b691 454
03ebf4c1
JB		 455- Request:
456 `ProcedureName`: 'stopSimulator'
457 `PDU`: {}
5612b691 458
03ebf4c1
JB		 459- Response:
460 `PDU`: {
853ed24a 461 `status`: 'success' | 'failure'
03ebf4c1 462 }
5612b691 463
d3140adc 464###### List Charging Stations
32de5a57 465
03ebf4c1
JB		 466- Request:
467 `ProcedureName`: 'listChargingStations'
468 `PDU`: {}
32de5a57 469
03ebf4c1
JB		 470- Response:
471 `PDU`: {
853ed24a 472 `status`: 'success' | 'failure',
02cde3b7 473 `chargingStations`: ChargingStationData[]
03ebf4c1 474 }
32de5a57 475
d3140adc 476###### Start Charging Station
80a3704c 477
03ebf4c1
JB		 478- Request:
479 `ProcedureName`: 'startChargingStation'
480 `PDU`: {
03eee93b 481 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
03ebf4c1 482 }
80a3704c 483
03ebf4c1
JB		 484- Response:
485 `PDU`: {
853ed24a
JB		 486 `status`: 'success' | 'failure',
487 `hashIdsSucceeded`: charging station unique identifier strings array,
488 `hashIdsFailed`: charging station unique identifier strings array (optional)
03eee93b 489 `responsesFailed`: failed responses payload array (optional)
03ebf4c1 490 }
80a3704c 491
d3140adc 492###### Stop Charging Station
80a3704c 493
03ebf4c1
JB		 494- Request:
495 `ProcedureName`: 'stopChargingStation'
496 `PDU`: {
853ed24a 497 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
03ebf4c1 498 }
80a3704c 499
03ebf4c1
JB		 500- Response:
501 `PDU`: {
853ed24a
JB		 502 `status`: 'success' | 'failure',
503 `hashIdsSucceeded`: charging station unique identifier strings array,
94abe068
JB		 504 `hashIdsFailed`: charging station unique identifier strings array (optional),
505 `responsesFailed`: failed responses payload array (optional)
03ebf4c1 506 }
80a3704c 507
d3140adc 508###### Open Connection
e4df816e 509
03ebf4c1
JB		 510- Request:
511 `ProcedureName`: 'openConnection'
512 `PDU`: {
853ed24a 513 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
03ebf4c1 514 }
e4df816e 515
03ebf4c1
JB		 516- Response:
517 `PDU`: {
853ed24a
JB		 518 `status`: 'success' | 'failure',
519 `hashIdsSucceeded`: charging station unique identifier strings array,
94abe068
JB		 520 `hashIdsFailed`: charging station unique identifier strings array (optional),
521 `responsesFailed`: failed responses payload array (optional)
03ebf4c1 522 }
e4df816e 523
d3140adc 524###### Close Connection
e4df816e 525
03ebf4c1
JB		 526- Request:
527 `ProcedureName`: 'closeConnection'
528 `PDU`: {
853ed24a 529 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
03ebf4c1
JB		 530 }
531
532- Response:
533 `PDU`: {
853ed24a
JB		 534 `status`: 'success' | 'failure',
535 `hashIdsSucceeded`: charging station unique identifier strings array,
94abe068
JB		 536 `hashIdsFailed`: charging station unique identifier strings array (optional),
537 `responsesFailed`: failed responses payload array (optional)
853ed24a
JB		 538 }
539
540###### Start Automatic Transaction Generator
541
542- Request:
543 `ProcedureName`: 'startAutomaticTransactionGenerator'
544 `PDU`: {
545 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
a38bc315 546 `connectorIds`: connector id integer array (optional, default: all connectors)
853ed24a
JB		 547 }
548
549- Response:
550 `PDU`: {
551 `status`: 'success' | 'failure',
552 `hashIdsSucceeded`: charging station unique identifier strings array,
5566ca3e
JB		 553 `hashIdsFailed`: charging station unique identifier strings array (optional),
554 `responsesFailed`: failed responses payload array (optional)
853ed24a
JB		 555 }
556
557###### Stop Automatic Transaction Generator
558
559- Request:
560 `ProcedureName`: 'stopAutomaticTransactionGenerator'
561 `PDU`: {
562 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
a38bc315 563 `connectorIds`: connector id integer array (optional, default: all connectors)
853ed24a
JB		 564 }
565
566- Response:
567 `PDU`: {
568 `status`: 'success' | 'failure',
569 `hashIdsSucceeded`: charging station unique identifier strings array,
5566ca3e
JB		 570 `hashIdsFailed`: charging station unique identifier strings array (optional),
571 `responsesFailed`: failed responses payload array (optional)
03ebf4c1
JB		 572 }
573
91a7d3ea 574###### OCPP commands trigger
a9ed42b2 575
82cbef8d
JB		 576- Request:
577 `ProcedureName`: 'commandName' (the OCPP command name in camel case)
578 `PDU`: {
579 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
580 ...`commandPayload`
581 } (the OCPP command payload with some optional fields added to target the simulated charging stations)
10db00b2 582
82cbef8d
JB		 583- Response:
584 `PDU`: {
585 `status`: 'success' | 'failure',
586 `hashIdsSucceeded`: charging station unique identifier strings array,
587 `hashIdsFailed`: charging station unique identifier strings array (optional),
588 `responsesFailed`: failed responses payload array (optional)
589 }
10db00b2 590
91a7d3ea 591Examples:
10db00b2 592
91a7d3ea 593- **Start Transaction**
a9ed42b2 594
91a7d3ea
JB		 595 - Request:
596 `ProcedureName`: 'startTransaction'
597 `PDU`: {
598 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
599 `connectorId`: connector id integer,
600 `idTag`: RFID tag string
601 }
602
603 - Response:
604 `PDU`: {
605 `status`: 'success' | 'failure',
606 `hashIdsSucceeded`: charging station unique identifier strings array,
607 `hashIdsFailed`: charging station unique identifier strings array (optional),
608 `responsesFailed`: failed responses payload array (optional)
609 }
610
611- **Stop Transaction**
612
613 - Request:
614 `ProcedureName`: 'stopTransaction'
615 `PDU`: {
616 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
617 `transactionId`: transaction id integer
618 }
619
620 - Response:
621 `PDU`: {
622 `status`: 'success' | 'failure',
623 `hashIdsSucceeded`: charging station unique identifier strings array,
624 `hashIdsFailed`: charging station unique identifier strings array (optional),
625 `responsesFailed`: failed responses payload array (optional)
626 }
627
628- **Status Notification**
629
630 - Request:
82cbef8d 631 `ProcedureName`: 'statusNotification'
91a7d3ea
JB		 632 `PDU`: {
633 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
634 `connectorId`: connector id integer,
635 `errorCode`: connector error code,
636 `status`: connector status
637 }
638
639 - Response:
640 `PDU`: {
641 `status`: 'success' | 'failure',
642 `hashIdsSucceeded`: charging station unique identifier strings array,
643 `hashIdsFailed`: charging station unique identifier strings array (optional),
644 `responsesFailed`: failed responses payload array (optional)
645 }
646
647- **Heartbeat**
648
649 - Request:
82cbef8d 650 `ProcedureName`: 'heartbeat'
91a7d3ea
JB		 651 `PDU`: {
652 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
653 }
654
655 - Response:
656 `PDU`: {
657 `status`: 'success' | 'failure',
658 `hashIdsSucceeded`: charging station unique identifier strings array,
659 `hashIdsFailed`: charging station unique identifier strings array (optional),
660 `responsesFailed`: failed responses payload array (optional)
661 }
a9ed42b2 662
251fff5c 663## Support, Feedback, Contributing
7dde0b73 664
7f774a55 665This 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 666
251fff5c
JB		 667## Code of Conduct
668
669We 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.
670
671## Licensing
672
7f774a55 673Copyright 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