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