repositories / e-mobility-charging-stations-simulator.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
docs: document UI protocol simulator state RPC command
[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
f80e9e18
JB		 56Copy the configuration template file [src/assets/config-template.json](./src/assets/config-template.json) to [src/assets/config.json](./src/assets/config.json).
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
f80e9e18 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
f80e9e18 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
f80e9e18
JB		 75- charging stations simulator configuration: [src/assets/config.json](./src/assets/config.json);
76- charging station configuration templates: [src/assets/station-templates](./src/assets/station-templates);
77- charging station configurations: [dist/assets/configurations](./dist/assets/configurations);
78- charging station RFID tags lists: [src/assets](./src/assets).
2c28fc83 79
f80e9e18 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).
1816f743 81
f80e9e18 82All charging station configuration templates are in the directory [src/assets/station-templates](./src/assets/station-templates).
1816f743 83
f80e9e18 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
f80e9e18
JB		 881. charging station configuration: [dist/assets/configurations](./dist/assets/configurations);
892. charging station configuration template: [src/assets/station-templates](./src/assets/station-templates);
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
f80e9e18 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 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 |
a66bbcfe 111| performanceStorage | | {<br />"enabled": true,<br />"type": "none",<br />} | {<br />enabled?: boolean;<br />type?: string;<br />uri?: string;<br />} | Performance storage configuration section:<br />- _enabled_: enable performance storage<br />- _type_: 'jsonfile', 'mongodb' or 'none'<br />- _uri_: storage URI |
dda3305e 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
f80e9e18
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 | enable 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| autoStart | true/false | true | boolean | enable automatic start of added charging station from template |
137| ocppVersion | 1.6/2.0/2.0.1 | 1.6 | string | OCPP version |
138| ocppProtocol | json | json | string | OCPP protocol |
139| ocppStrictCompliance | true/false | true | boolean | enable strict adherence to the OCPP version and protocol specifications with OCPP commands PDU validation against [OCA](https://www.openchargealliance.org/) JSON schemas |
140| 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) |
141| 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) |
142| 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) |
143| wsOptions | | {} | ClientOptions & ClientRequestArgs | [ws](https://github.com/websockets/ws) and node.js [http](https://nodejs.org/api/http.html) clients options intersection |
144| idTagsFile | | undefined | string | RFID tags list file relative to [src/assets](./src/assets) path |
145| baseName | | undefined | string | base name to build charging stations id |
146| nameSuffix | | undefined | string | name suffix to build charging stations id |
147| fixedName | true/false | false | boolean | use the 'baseName' as the charging stations unique name |
148| chargePointModel | | undefined | string | charging stations model |
149| chargePointVendor | | undefined | string | charging stations vendor |
150| chargePointSerialNumberPrefix | | undefined | string | charge point serial number prefix |
151| chargeBoxSerialNumberPrefix | | undefined | string | charge box serial number prefix (deprecated since OCPP 1.6) |
152| 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 |
153| firmwareVersion | | undefined | string | charging stations firmware version |
154| power | | | float \| float[] | charging stations maximum power value(s) |
155| powerSharedByConnectors | true/false | false | boolean | charging stations power shared by its connectors |
156| powerUnit | W/kW | W | string | charging stations power unit |
157| currentOutType | AC/DC | AC | string | charging stations current out type |
158| voltageOut | | AC:230/DC:400 | integer | charging stations voltage out |
159| numberOfPhases | 0/1/3 | AC:3/DC:0 | integer | charging stations number of phase(s) |
160| numberOfConnectors | | | integer \| integer[] | charging stations number of connector(s) |
161| useConnectorId0 | true/false | true | boolean | use connector id 0 definition from the charging station configuration template |
162| randomConnectors | true/false | false | boolean | randomize runtime connector id affectation from the connector id definition in charging station configuration template |
163| resetTime | | 60 | integer | seconds to wait before the charging stations come back at reset |
164| autoRegister | true/false | false | boolean | set charging stations as registered at boot notification for testing purpose |
165| autoReconnectMaxRetries | | -1 (unlimited) | integer | connection retries to the OCPP-J server |
166| reconnectExponentialDelay | true/false | false | boolean | connection delay retry to the OCPP-J server |
167| registrationMaxRetries | | -1 (unlimited) | integer | charging stations boot notification retries |
168| 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 |
169| amperageLimitationUnit | A/cA/dA/mA | A | string | charging stations amperage limit unit |
170| enableStatistics | true/false | false | boolean | enable charging stations statistics |
171| remoteAuthorization | true/false | true | boolean | enable RFID tags remote authorization |
172| beginEndMeterValues | true/false | false | boolean | enable Transaction.{Begin,End} MeterValues |
173| outOfOrderEndMeterValues | true/false | false | boolean | send Transaction.End MeterValues out of order. Need to relax OCPP specifications strict compliance ('ocppStrictCompliance' parameter) |
174| meteringPerTransaction | true/false | true | boolean | enable metering history on a per transaction basis |
175| transactionDataMeterValues | true/false | false | boolean | enable transaction data MeterValues at stop transaction |
176| stopTransactionsOnStopped | true/false | true | boolean | enable stop transactions on charging station stop |
177| mainVoltageMeterValues | true/false | true | boolean | include charging stations main voltage MeterValues on three phased charging stations |
178| phaseLineToLineVoltageMeterValues | true/false | false | boolean | include charging stations line to line voltage MeterValues on three phased charging stations |
179| customValueLimitationMeterValues | true/false | true | boolean | enable limitation on custom fluctuated value in MeterValues |
180| 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. |
181| 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 |
182| messageTriggerSupport | | {} | Record<MessageTrigger, boolean> | Configuration section for OCPP commands trigger support. Empty section means all implemented OCPP trigger commands are supported |
183| Configuration | | | ChargingStationOcppConfiguration | charging stations OCPP parameters configuration section |
184| AutomaticTransactionGenerator | | | AutomaticTransactionGeneratorConfiguration | charging stations ATG configuration section |
185| Connectors | | | Record<string, ConnectorStatus> | charging stations connectors configuration section |
186| Evses | | | Record<string, EvseTemplate> | charging stations EVSEs configuration section |
c94a349a 187
3e1dfe42 188#### Configuration section syntax example
c94a349a
JB		 189
190```json
0302da79 191 "Configuration": {
c94a349a
JB		 192 "configurationKey": [
193 ...
194 {
195 "key": "StandardKey",
196 "readonly": false,
197 "value": "StandardValue",
198 "visible": true,
199 "reboot": false
200 },
201 ...
202 {
203 "key": "VendorKey",
204 "readonly": false,
205 "value": "VendorValue",
206 "visible": false,
207 "reboot": true
208 },
209 ...
210 ]
211 }
212```
213
3e1dfe42 214#### AutomaticTransactionGenerator section syntax example
c94a349a 215
20f09970 216##### Type definition:
c72f6634
JB		 217
218```ts
219type AutomaticTransactionGeneratorConfiguration = {
66a7748d
JB		 220 enable: boolean
221 minDuration: number
222 maxDuration: number
223 minDelayBetweenTwoTransactions: number
224 maxDelayBetweenTwoTransactions: number
225 probabilityOfStart: number
226 stopAfterHours: number
46a830d2 227 stopAbsoluteDuration: boolean
66a7748d
JB		 228 requireAuthorize?: boolean
229 idTagDistribution?: 'random' | 'round-robin' | 'connector-affinity'
230}
c72f6634
JB		 231```
232
20f09970 233##### Example:
c72f6634 234
c94a349a 235```json
0302da79 236 "AutomaticTransactionGenerator": {
c94a349a
JB		 237 "enable": false,
238 "minDuration": 60,
239 "maxDuration": 80,
240 "minDelayBetweenTwoTransactions": 15,
241 "maxDelayBetweenTwoTransactions": 30,
242 "probabilityOfStart": 1,
243 "stopAfterHours": 0.3,
c72f6634
JB		 244 "requireAuthorize": true,
245 "idTagDistribution": "random"
c94a349a
JB		 246 }
247```
e7aeea18 248
3e1dfe42 249#### Connectors section syntax example
c94a349a
JB		 250
251```json
0302da79 252 "Connectors": {
c94a349a
JB		 253 "0": {},
254 "1": {
255 "bootStatus": "Available",
256 "MeterValues": [
9bd87386
JB		 257 ...
258 {
259 "unit": "W",
260 "measurand": "Power.Active.Import",
261 "phase": "L1-N",
262 "value": "5000",
263 "fluctuationPercent": "10"
264 },
c94a349a
JB		 265 ...
266 {
267 "unit": "A",
860ef183
JB		 268 "measurand": "Current.Import",
269 "minimum": "0.5"
c94a349a
JB		 270 },
271 ...
272 {
273 "unit": "Wh"
274 },
275 ...
276 ]
277 }
278 },
279```
280
3e1dfe42
JB		 281#### Evses section syntax example
282
283```json
284 "Evses": {
285 "0": {
286 "Connectors": {
287 "0": {}
288 }
289 },
290 "1": {
291 "Connectors": {
292 "1": {
293 "bootStatus": "Available",
294 "MeterValues": [
295 ...
296 {
297 "unit": "W",
298 "measurand": "Power.Active.Import",
299 "phase": "L1-N",
300 "value": "5000",
301 "fluctuationPercent": "10"
302 },
303 ...
304 {
305 "unit": "A",
306 "measurand": "Current.Import",
307 "minimum": "0.5"
308 },
309 ...
310 {
311 "unit": "Wh"
312 },
313 ...
314 ]
315 }
316 }
317 }
318 },
319```
320
1816f743
JB		 321### Charging station configuration
322
1c51fd1d 323**dist/assets/configurations/\<hashId\>.json**:
1816f743 324
a9ec2018 325The charging station configuration file is automatically generated at startup from the charging station configuration template file and is persistent.
1816f743
JB		 326
327The 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.
328
09810639 329#### stationInfo section (optional)
1816f743
JB		 330
331The syntax is similar to charging station configuration template with some added fields like the charging station id (name) and the 'Configuration' section removed.
332
10211789 333That section is overwritten on matching charging station configuration template file changes.
1816f743 334
10211789
JB		 335#### connectorsStatus section
336
337The syntax is similar to charging station configuration template 'Connectors' section with some added fields.
338
339That section is overwritten on matching charging station configuration template file changes.
1816f743 340
0aa874ce
JB		 341#### evsesStatus section
342
343The syntax is similar to charging station configuration template 'Evses' section with some added fields.
344
345That section is overwritten on matching charging station configuration template file changes.
346
09810639 347#### automaticTransactionGenerator section (optional)
3a28512c
JB		 348
349The syntax is similar to the charging station configuration template 'AutomaticTransactionGenerator' section.
350
10211789
JB		 351That section is overwritten on matching charging station configuration template file changes.
352
353#### automaticTransactionGeneratorStatuses section
354
355That section is not overwritten on matching charging station configuration template file changes.
356
09810639 357#### configurationKey section (optional)
10211789
JB		 358
359The syntax is similar to the charging station configuration template 'Configuration' section.
360
361That section is not overwritten on matching charging station configuration template file changes.
362
6f0ec20e
JB		 363## Docker
364
365In the [docker](./docker) folder:
366
81ed2a48 367```shell
6f0ec20e
JB		 368make
369```
370
673dceeb 371<!-- Or with the optional git submodules:
6f0ec20e 372
81ed2a48 373```shell
bfcad885 374make SUBMODULES_INIT=true
673dceeb 375``` -->
6f0ec20e
JB		 376
377## OCPP-J commands supported
c94a349a
JB		 378
379### Version 1.6
380
c56d42f1 381#### Core Profile
6f0ec20e 382
778f7924
JB		 383- :white_check_mark: Authorize
384- :white_check_mark: BootNotification
385- :white_check_mark: ChangeAvailability
386- :white_check_mark: ChangeConfiguration
387- :white_check_mark: ClearCache
91a7d3ea 388- :white_check_mark: DataTransfer
778f7924
JB		 389- :white_check_mark: GetConfiguration
390- :white_check_mark: Heartbeat
391- :white_check_mark: MeterValues
392- :white_check_mark: RemoteStartTransaction
393- :white_check_mark: RemoteStopTransaction
394- :white_check_mark: Reset
395- :white_check_mark: StartTransaction
396- :white_check_mark: StatusNotification
397- :white_check_mark: StopTransaction
398- :white_check_mark: UnlockConnector
6f0ec20e 399
c56d42f1 400#### Firmware Management Profile
6f0ec20e 401
b652b0c3 402- :white_check_mark: GetDiagnostics
d50343bd 403- :white_check_mark: DiagnosticsStatusNotification
c9a4f9ea
JB		 404- :white_check_mark: FirmwareStatusNotification
405- :white_check_mark: UpdateFirmware
6f0ec20e 406
c56d42f1 407#### Local Auth List Management Profile
6f0ec20e 408
9e1b12e4
JB		 409- :x: GetLocalListVersion
410- :x: SendLocalList
6f0ec20e 411
c56d42f1 412#### Reservation Profile
6f0ec20e 413
24578c31
JB		 414- :white_check_mark: CancelReservation
415- :white_check_mark: ReserveNow
6f0ec20e 416
c56d42f1 417#### Smart Charging Profile
6f0ec20e 418
778f7924 419- :white_check_mark: ClearChargingProfile
e1d9a0f4 420- :white_check_mark: GetCompositeSchedule
778f7924 421- :white_check_mark: SetChargingProfile
6f0ec20e 422
c56d42f1 423#### Remote Trigger Profile
6f0ec20e 424
802cfa13 425- :white_check_mark: TriggerMessage
7dde0b73 426
d4371252
JB		 427### Version 2.x.x
428
429#### Provisioning
430
431- :white_check_mark: BootNotification
432
bc950df1 433#### Authorization
d4371252
JB		 434
435- :white_check_mark: ClearCache
436
437#### Availability
438
439- :white_check_mark: StatusNotification
440- :white_check_mark: Heartbeat
441
7e1dc878
JB		 442## OCPP-J standard parameters supported
443
3a28512c 444All 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		 445
446### Version 1.6
447
c56d42f1 448#### Core Profile
7e1dc878
JB		 449
450- :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -)
451- :x: ClockAlignedDataInterval (type: integer) (units: seconds)
291cb255 452- :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds)
7e1dc878
JB		 453- :x: GetConfigurationMaxKeys (type: integer) (units: -)
454- :white_check_mark: HeartbeatInterval (type: integer) (units: seconds)
455- :x: LocalAuthorizeOffline (type: boolean) (units: -)
456- :x: LocalPreAuthorize (type: boolean) (units: -)
457- :x: MeterValuesAlignedData (type: CSL) (units: -)
458- :white_check_mark: MeterValuesSampledData (type: CSL) (units: -)
459- :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds)
460- :white_check_mark: NumberOfConnectors (type: integer) (units: -)
461- :x: ResetRetries (type: integer) (units: times)
462- :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -)
463- :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -)
464- :x: StopTransactionOnInvalidId (type: boolean) (units: -)
465- :x: StopTxnAlignedData (type: CSL) (units: -)
466- :x: StopTxnSampledData (type: CSL) (units: -)
36f6a92e 467- :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -)
7e1dc878
JB		 468- :x: TransactionMessageAttempts (type: integer) (units: times)
469- :x: TransactionMessageRetryInterval (type: integer) (units: seconds)
470- :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -)
36f6a92e 471- :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds)
7e1dc878 472
c56d42f1 473#### Firmware Management Profile
7e1dc878 474
e7aeea18 475- _none_
7e1dc878 476
c56d42f1 477#### Local Auth List Management Profile
7e1dc878 478
36f6a92e 479- :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
7e1dc878
JB		 480- :x: LocalAuthListMaxLength (type: integer) (units: -)
481- :x: SendLocalListMaxLength (type: integer) (units: -)
482
c56d42f1 483#### Reservation Profile
7e1dc878 484
66dd3447 485- :white_check_mark: ReserveConnectorZeroSupported (type: boolean) (units: -)
7e1dc878 486
c56d42f1 487#### Smart Charging Profile
7e1dc878
JB		 488
489- :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
490- :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
491- :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
492- :x: MaxChargingProfilesInstalled (type: integer) (units: -)
493
c56d42f1 494#### Remote Trigger Profile
7e1dc878 495
e7aeea18 496- _none_
7e1dc878 497
d4371252
JB		 498### Version 2.x.x
499
32de5a57
LM		 500## UI protocol
501
6ca7a41d 502Protocol to control the simulator via a Websocket or HTTP server:
32de5a57 503
5d8bbc63
JB		 504```mermaid
505sequenceDiagram
506Client->>UI Server: request
507UI Server->>Client: response
4c4f320e 508Note over UI Server,Client: Transport protocol: HTTP, Websocket
5d8bbc63
JB		 509```
510
02cde3b7 511### Websocket Protocol
32de5a57 512
02cde3b7 513SRPC protocol over Websocket. PDU stands for 'Protocol Data Unit'.
32de5a57 514
03ebf4c1
JB		 515- Request:
516 [`uuid`, `ProcedureName`, `PDU`]
517 `uuid`: String uniquely representing this request
518 `ProcedureName`: The procedure to run on the simulator
519 `PDU`: The parameters for said procedure
32de5a57 520
03ebf4c1
JB		 521- Response:
522 [`uuid`, `PDU`]
523 `uuid`: String uniquely linking the response to the request
02cde3b7 524 `PDU`: Response parameters to requested procedure
32de5a57 525
c03dea88 526To learn how to use the Websocket protocol to pilot the simulator, an [Insomnia](https://insomnia.rest/) Websocket requests collection is available in [src/assets/ui-protocol](./src/assets/ui-protocol) directory.
97c19696 527
d3140adc 528#### Version 0.0.1
4e3ff94d 529
02cde3b7 530Set the Websocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
4e3ff94d 531
d3140adc 532##### Procedures
32de5a57 533
a997fb63
JB		 534###### Simulator State
535
536- Request:
537 `ProcedureName`: 'simulatorState'
538 `PDU`: {}
539
540- Response:
541 `PDU`: {
542 `status`: 'success' | 'failure'
543 `state`: {
544 `version`: string
545 `started`: boolean
546 `templateStatistics`: Record<string, TemplateStatistics>
547 }
548 }
549
d3140adc 550###### Start Simulator
5612b691 551
03ebf4c1
JB		 552- Request:
553 `ProcedureName`: 'startSimulator'
554 `PDU`: {}
5612b691 555
03ebf4c1
JB		 556- Response:
557 `PDU`: {
6ca7a41d 558 `status`: 'success' | 'failure'
03ebf4c1 559 }
5612b691 560
d3140adc 561###### Stop Simulator
5612b691 562
03ebf4c1
JB		 563- Request:
564 `ProcedureName`: 'stopSimulator'
565 `PDU`: {}
5612b691 566
03ebf4c1
JB		 567- Response:
568 `PDU`: {
6ca7a41d
JB		 569 `status`: 'success' | 'failure'
570 }
571
572###### List Charging Station Templates
573
574- Request:
575 `ProcedureName`: 'listTemplates'
576 `PDU`: {}
577
578- Response:
579 `PDU`: {
580 `status`: 'success' | 'failure',
581 `templates`: string[]
582 }
583
584###### Add Charging Stations
585
586- Request:
587 `ProcedureName`: 'addChargingStations'
588 `PDU`: {
589 `template`: string,
95c7658e
JB		 590 `numberOfStations`: number,
591 `options?`: {
6eb63615 592 `supervisionUrls?`: string | string[],
9a08f38e 593 `persistentConfiguration?`: boolean,
52c58949 594 `autoStart?`: boolean,
43e04bb7
JB		 595 `autoRegister?`: boolean,
596 `enableStatistics?`: boolean,
1feac591
JB		 597 `ocppStrictCompliance?`: boolean,
598 `stopTransactionsOnStopped?`: boolean
95c7658e 599 }
6ca7a41d
JB		 600 }
601
602- Response:
603 `PDU`: {
604 `status`: 'success' | 'failure'
03ebf4c1 605 }
5612b691 606
09e5a7a8
JB		 607###### Delete Charging Stations
608
609- Request:
610 `ProcedureName`: 'deleteChargingStations'
611 `PDU`: {
612 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
613 `deleteConfiguration?`: boolean
614 }
615
616- Response:
617 `PDU`: {
618 `status`: 'success' | 'failure',
619 `hashIdsSucceeded`: charging station unique identifier strings array,
620 `hashIdsFailed`: charging station unique identifier strings array (optional),
621 `responsesFailed`: failed responses payload array (optional)
622 }
623
1e534dab
JB		 624###### Set Charging Station Supervision Url
625
626- Request:
627 `ProcedureName`: 'setSupervisionUrl'
628 `PDU`: {
629 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
a66bbcfe 630 `url`: string
1e534dab
JB		 631 }
632
633- Response:
634 `PDU`: {
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)
639 }
640
a66bbcfe
JB		 641###### Performance Statistics
642
643- Request:
644 `ProcedureName`: 'performanceStatistics'
645 `PDU`: {}
646
647- Response:
648 `PDU`: {
649 `status`: 'success' | 'failure'
650 `performanceStatistics`: Statistics[]
651 }
652
d3140adc 653###### List Charging Stations
32de5a57 654
03ebf4c1
JB		 655- Request:
656 `ProcedureName`: 'listChargingStations'
657 `PDU`: {}
32de5a57 658
03ebf4c1
JB		 659- Response:
660 `PDU`: {
6ca7a41d
JB		 661 `status`: 'success' | 'failure',
662 `chargingStations`: ChargingStationData[]
03ebf4c1 663 }
32de5a57 664
d3140adc 665###### Start Charging Station
80a3704c 666
03ebf4c1
JB		 667- Request:
668 `ProcedureName`: 'startChargingStation'
669 `PDU`: {
6ca7a41d 670 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
03ebf4c1 671 }
80a3704c 672
03ebf4c1
JB		 673- Response:
674 `PDU`: {
6ca7a41d
JB		 675 `status`: 'success' | 'failure',
676 `hashIdsSucceeded`: charging station unique identifier strings array,
677 `hashIdsFailed`: charging station unique identifier strings array (optional),
678 `responsesFailed`: failed responses payload array (optional)
03ebf4c1 679 }
80a3704c 680
d3140adc 681###### Stop Charging Station
80a3704c 682
03ebf4c1
JB		 683- Request:
684 `ProcedureName`: 'stopChargingStation'
685 `PDU`: {
6ca7a41d 686 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
03ebf4c1 687 }
80a3704c 688
03ebf4c1
JB		 689- Response:
690 `PDU`: {
6ca7a41d
JB		 691 `status`: 'success' | 'failure',
692 `hashIdsSucceeded`: charging station unique identifier strings array,
693 `hashIdsFailed`: charging station unique identifier strings array (optional),
694 `responsesFailed`: failed responses payload array (optional)
03ebf4c1 695 }
80a3704c 696
d3140adc 697###### Open Connection
e4df816e 698
03ebf4c1
JB		 699- Request:
700 `ProcedureName`: 'openConnection'
701 `PDU`: {
6ca7a41d 702 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
03ebf4c1 703 }
e4df816e 704
03ebf4c1
JB		 705- Response:
706 `PDU`: {
6ca7a41d
JB		 707 `status`: 'success' | 'failure',
708 `hashIdsSucceeded`: charging station unique identifier strings array,
709 `hashIdsFailed`: charging station unique identifier strings array (optional),
710 `responsesFailed`: failed responses payload array (optional)
03ebf4c1 711 }
e4df816e 712
d3140adc 713###### Close Connection
e4df816e 714
03ebf4c1
JB		 715- Request:
716 `ProcedureName`: 'closeConnection'
717 `PDU`: {
6ca7a41d 718 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
03ebf4c1
JB		 719 }
720
721- Response:
722 `PDU`: {
6ca7a41d
JB		 723 `status`: 'success' | 'failure',
724 `hashIdsSucceeded`: charging station unique identifier strings array,
725 `hashIdsFailed`: charging station unique identifier strings array (optional),
726 `responsesFailed`: failed responses payload array (optional)
853ed24a
JB		 727 }
728
729###### Start Automatic Transaction Generator
730
731- Request:
732 `ProcedureName`: 'startAutomaticTransactionGenerator'
733 `PDU`: {
6ca7a41d
JB		 734 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
735 `connectorIds`: connector id integer array (optional, default: all connectors)
853ed24a
JB		 736 }
737
738- Response:
739 `PDU`: {
6ca7a41d
JB		 740 `status`: 'success' | 'failure',
741 `hashIdsSucceeded`: charging station unique identifier strings array,
742 `hashIdsFailed`: charging station unique identifier strings array (optional),
743 `responsesFailed`: failed responses payload array (optional)
853ed24a
JB		 744 }
745
746###### Stop Automatic Transaction Generator
747
748- Request:
749 `ProcedureName`: 'stopAutomaticTransactionGenerator'
750 `PDU`: {
6ca7a41d
JB		 751 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
752 `connectorIds`: connector id integer array (optional, default: all connectors)
853ed24a
JB		 753 }
754
755- Response:
756 `PDU`: {
6ca7a41d
JB		 757 `status`: 'success' | 'failure',
758 `hashIdsSucceeded`: charging station unique identifier strings array,
759 `hashIdsFailed`: charging station unique identifier strings array (optional),
760 `responsesFailed`: failed responses payload array (optional)
03ebf4c1
JB		 761 }
762
91a7d3ea 763###### OCPP commands trigger
a9ed42b2 764
82cbef8d
JB		 765- Request:
766 `ProcedureName`: 'commandName' (the OCPP command name in camel case)
767 `PDU`: {
768 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
769 ...`commandPayload`
1e534dab 770 } (the OCPP command payload with some optional fields added to target the simulated charging stations)
10db00b2 771
82cbef8d 772- Response:
7f9d5299 773 `PDU`: {
82cbef8d
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)
1e534dab 778 }
10db00b2 779
91a7d3ea 780Examples:
10db00b2 781
91a7d3ea 782- **Start Transaction**
a9ed42b2 783
91a7d3ea
JB		 784 - Request:
785 `ProcedureName`: 'startTransaction'
786 `PDU`: {
6ca7a41d
JB		 787 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
788 `connectorId`: connector id integer,
789 `idTag`: RFID tag string
91a7d3ea
JB		 790 }
791
792 - Response:
793 `PDU`: {
6ca7a41d
JB		 794 `status`: 'success' | 'failure',
795 `hashIdsSucceeded`: charging station unique identifier strings array,
796 `hashIdsFailed`: charging station unique identifier strings array (optional),
797 `responsesFailed`: failed responses payload array (optional)
91a7d3ea
JB		 798 }
799
800- **Stop Transaction**
801
802 - Request:
803 `ProcedureName`: 'stopTransaction'
804 `PDU`: {
6ca7a41d
JB		 805 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
806 `transactionId`: transaction id integer
91a7d3ea
JB		 807 }
808
809 - Response:
810 `PDU`: {
1e534dab 811 `status`: 'success' | 'failure',
6ca7a41d
JB		 812 `hashIdsSucceeded`: charging station unique identifier strings array,
813 `hashIdsFailed`: charging station unique identifier strings array (optional),
814 `responsesFailed`: failed responses payload array (optional)
91a7d3ea
JB		 815 }
816
817- **Status Notification**
818
819 - Request:
82cbef8d 820 `ProcedureName`: 'statusNotification'
91a7d3ea 821 `PDU`: {
6ca7a41d
JB		 822 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
823 `connectorId`: connector id integer,
824 `errorCode`: connector error code,
825 `status`: connector status
91a7d3ea
JB		 826 }
827
828 - Response:
829 `PDU`: {
6ca7a41d
JB		 830 `status`: 'success' | 'failure',
831 `hashIdsSucceeded`: charging station unique identifier strings array,
832 `hashIdsFailed`: charging station unique identifier strings array (optional),
833 `responsesFailed`: failed responses payload array (optional)
91a7d3ea
JB		 834 }
835
836- **Heartbeat**
837
838 - Request:
82cbef8d 839 `ProcedureName`: 'heartbeat'
91a7d3ea 840 `PDU`: {
6ca7a41d 841 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
91a7d3ea
JB		 842 }
843
844 - Response:
845 `PDU`: {
6ca7a41d
JB		 846 `status`: 'success' | 'failure',
847 `hashIdsSucceeded`: charging station unique identifier strings array,
848 `hashIdsFailed`: charging station unique identifier strings array (optional),
849 `responsesFailed`: failed responses payload array (optional)
91a7d3ea 850 }
a9ed42b2 851
6ca7a41d
JB		 852### HTTP Protocol
853
854To 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.
855
251fff5c 856## Support, Feedback, Contributing
7dde0b73 857
f80e9e18 858This 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 859
251fff5c
JB		 860## Code of Conduct
861
f80e9e18 862We 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.
251fff5c
JB		 863
864## Licensing
865
f80e9e18 866Copyright 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