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