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