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