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