repositories / e-mobility-charging-stations-simulator.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
build(deps-dev): apply updates
[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
c20d5d72
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 |
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 />} | 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 |
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) |
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
8603c1ca
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 |
d0e58571 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 |
8603c1ca
JB		 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 |
7cd86d34 150| chargeBoxSerialNumberPrefix | | undefined | string | charge box serial number prefix (deprecated since OCPP 1.6) |
8603c1ca
JB		 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 |
cfdf901d 170| remoteAuthorization | true/false | true | boolean | enable RFID tags remote authorization |
8603c1ca
JB		 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 |
ab11404a 175| stopTransactionsOnStopped | true/false | true | boolean | enable stop transactions on charging station stop |
8603c1ca
JB		 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 stopOnConnectionFailure: boolean
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,
244 "stopOnConnectionFailure": true,
c72f6634
JB		 245 "requireAuthorize": true,
246 "idTagDistribution": "random"
c94a349a
JB		 247 }
248```
e7aeea18 249
3e1dfe42 250#### Connectors section syntax example
c94a349a
JB		 251
252```json
0302da79 253 "Connectors": {
c94a349a
JB		 254 "0": {},
255 "1": {
256 "bootStatus": "Available",
257 "MeterValues": [
9bd87386
JB		 258 ...
259 {
260 "unit": "W",
261 "measurand": "Power.Active.Import",
262 "phase": "L1-N",
263 "value": "5000",
264 "fluctuationPercent": "10"
265 },
c94a349a
JB		 266 ...
267 {
268 "unit": "A",
860ef183
JB		 269 "measurand": "Current.Import",
270 "minimum": "0.5"
c94a349a
JB		 271 },
272 ...
273 {
274 "unit": "Wh"
275 },
276 ...
277 ]
278 }
279 },
280```
281
3e1dfe42
JB		 282#### Evses section syntax example
283
284```json
285 "Evses": {
286 "0": {
287 "Connectors": {
288 "0": {}
289 }
290 },
291 "1": {
292 "Connectors": {
293 "1": {
294 "bootStatus": "Available",
295 "MeterValues": [
296 ...
297 {
298 "unit": "W",
299 "measurand": "Power.Active.Import",
300 "phase": "L1-N",
301 "value": "5000",
302 "fluctuationPercent": "10"
303 },
304 ...
305 {
306 "unit": "A",
307 "measurand": "Current.Import",
308 "minimum": "0.5"
309 },
310 ...
311 {
312 "unit": "Wh"
313 },
314 ...
315 ]
316 }
317 }
318 }
319 },
320```
321
1816f743
JB		 322### Charging station configuration
323
1c51fd1d 324**dist/assets/configurations/\<hashId\>.json**:
1816f743 325
a9ec2018 326The charging station configuration file is automatically generated at startup from the charging station configuration template file and is persistent.
1816f743
JB		 327
328The 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.
329
330#### stationInfo section
331
332The syntax is similar to charging station configuration template with some added fields like the charging station id (name) and the 'Configuration' section removed.
333
334#### configurationKey section
335
336The syntax is similar to the charging station configuration template 'Configuration' section.
337
3a28512c
JB		 338#### automaticTransactionGenerator section
339
340The syntax is similar to the charging station configuration template 'AutomaticTransactionGenerator' section.
341
6f0ec20e
JB		 342## Docker
343
344In the [docker](./docker) folder:
345
81ed2a48 346```shell
6f0ec20e
JB		 347make
348```
349
673dceeb 350<!-- Or with the optional git submodules:
6f0ec20e 351
81ed2a48 352```shell
bfcad885 353make SUBMODULES_INIT=true
673dceeb 354``` -->
6f0ec20e
JB		 355
356## OCPP-J commands supported
c94a349a
JB		 357
358### Version 1.6
359
c56d42f1 360#### Core Profile
6f0ec20e 361
778f7924
JB		 362- :white_check_mark: Authorize
363- :white_check_mark: BootNotification
364- :white_check_mark: ChangeAvailability
365- :white_check_mark: ChangeConfiguration
366- :white_check_mark: ClearCache
91a7d3ea 367- :white_check_mark: DataTransfer
778f7924
JB		 368- :white_check_mark: GetConfiguration
369- :white_check_mark: Heartbeat
370- :white_check_mark: MeterValues
371- :white_check_mark: RemoteStartTransaction
372- :white_check_mark: RemoteStopTransaction
373- :white_check_mark: Reset
374- :white_check_mark: StartTransaction
375- :white_check_mark: StatusNotification
376- :white_check_mark: StopTransaction
377- :white_check_mark: UnlockConnector
6f0ec20e 378
c56d42f1 379#### Firmware Management Profile
6f0ec20e 380
b652b0c3 381- :white_check_mark: GetDiagnostics
d50343bd 382- :white_check_mark: DiagnosticsStatusNotification
c9a4f9ea
JB		 383- :white_check_mark: FirmwareStatusNotification
384- :white_check_mark: UpdateFirmware
6f0ec20e 385
c56d42f1 386#### Local Auth List Management Profile
6f0ec20e 387
9e1b12e4
JB		 388- :x: GetLocalListVersion
389- :x: SendLocalList
6f0ec20e 390
c56d42f1 391#### Reservation Profile
6f0ec20e 392
24578c31
JB		 393- :white_check_mark: CancelReservation
394- :white_check_mark: ReserveNow
6f0ec20e 395
c56d42f1 396#### Smart Charging Profile
6f0ec20e 397
778f7924 398- :white_check_mark: ClearChargingProfile
e1d9a0f4 399- :white_check_mark: GetCompositeSchedule
778f7924 400- :white_check_mark: SetChargingProfile
6f0ec20e 401
c56d42f1 402#### Remote Trigger Profile
6f0ec20e 403
802cfa13 404- :white_check_mark: TriggerMessage
7dde0b73 405
d4371252
JB		 406### Version 2.x.x
407
408#### Provisioning
409
410- :white_check_mark: BootNotification
411
bc950df1 412#### Authorization
d4371252
JB		 413
414- :white_check_mark: ClearCache
415
416#### Availability
417
418- :white_check_mark: StatusNotification
419- :white_check_mark: Heartbeat
420
7e1dc878
JB		 421## OCPP-J standard parameters supported
422
3a28512c 423All 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		 424
425### Version 1.6
426
c56d42f1 427#### Core Profile
7e1dc878
JB		 428
429- :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -)
430- :x: ClockAlignedDataInterval (type: integer) (units: seconds)
291cb255 431- :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds)
7e1dc878
JB		 432- :x: GetConfigurationMaxKeys (type: integer) (units: -)
433- :white_check_mark: HeartbeatInterval (type: integer) (units: seconds)
434- :x: LocalAuthorizeOffline (type: boolean) (units: -)
435- :x: LocalPreAuthorize (type: boolean) (units: -)
436- :x: MeterValuesAlignedData (type: CSL) (units: -)
437- :white_check_mark: MeterValuesSampledData (type: CSL) (units: -)
438- :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds)
439- :white_check_mark: NumberOfConnectors (type: integer) (units: -)
440- :x: ResetRetries (type: integer) (units: times)
441- :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -)
442- :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -)
443- :x: StopTransactionOnInvalidId (type: boolean) (units: -)
444- :x: StopTxnAlignedData (type: CSL) (units: -)
445- :x: StopTxnSampledData (type: CSL) (units: -)
36f6a92e 446- :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -)
7e1dc878
JB		 447- :x: TransactionMessageAttempts (type: integer) (units: times)
448- :x: TransactionMessageRetryInterval (type: integer) (units: seconds)
449- :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -)
36f6a92e 450- :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds)
7e1dc878 451
c56d42f1 452#### Firmware Management Profile
7e1dc878 453
e7aeea18 454- _none_
7e1dc878 455
c56d42f1 456#### Local Auth List Management Profile
7e1dc878 457
36f6a92e 458- :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
7e1dc878
JB		 459- :x: LocalAuthListMaxLength (type: integer) (units: -)
460- :x: SendLocalListMaxLength (type: integer) (units: -)
461
c56d42f1 462#### Reservation Profile
7e1dc878 463
66dd3447 464- :white_check_mark: ReserveConnectorZeroSupported (type: boolean) (units: -)
7e1dc878 465
c56d42f1 466#### Smart Charging Profile
7e1dc878
JB		 467
468- :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
469- :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
470- :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
471- :x: MaxChargingProfilesInstalled (type: integer) (units: -)
472
c56d42f1 473#### Remote Trigger Profile
7e1dc878 474
e7aeea18 475- _none_
7e1dc878 476
d4371252
JB		 477### Version 2.x.x
478
32de5a57
LM		 479## UI protocol
480
03ebf4c1 481Protocol to control the simulator via a Websocket or HTTP server.
32de5a57 482
4df14d3a
JB		 483### HTTP Protocol
484
97c19696 485To 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 486
02cde3b7 487### Websocket Protocol
32de5a57 488
02cde3b7 489SRPC protocol over Websocket. PDU stands for 'Protocol Data Unit'.
32de5a57 490
03ebf4c1
JB		 491- Request:
492 [`uuid`, `ProcedureName`, `PDU`]
493 `uuid`: String uniquely representing this request
494 `ProcedureName`: The procedure to run on the simulator
495 `PDU`: The parameters for said procedure
32de5a57 496
03ebf4c1
JB		 497- Response:
498 [`uuid`, `PDU`]
499 `uuid`: String uniquely linking the response to the request
02cde3b7 500 `PDU`: Response parameters to requested procedure
32de5a57 501
97c19696
JB		 502An [Insomnia](https://insomnia.rest/) WebSocket requests collection is available in [src/assets/ui-protocol](./src/assets/ui-protocol) directory.
503
d3140adc 504#### Version 0.0.1
4e3ff94d 505
02cde3b7 506Set the Websocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
4e3ff94d 507
d3140adc 508##### Procedures
32de5a57 509
d3140adc 510###### Start Simulator
5612b691 511
03ebf4c1
JB		 512- Request:
513 `ProcedureName`: 'startSimulator'
514 `PDU`: {}
5612b691 515
03ebf4c1
JB		 516- Response:
517 `PDU`: {
853ed24a 518 `status`: 'success' | 'failure'
03ebf4c1 519 }
5612b691 520
d3140adc 521###### Stop Simulator
5612b691 522
03ebf4c1
JB		 523- Request:
524 `ProcedureName`: 'stopSimulator'
525 `PDU`: {}
5612b691 526
03ebf4c1
JB		 527- Response:
528 `PDU`: {
853ed24a 529 `status`: 'success' | 'failure'
03ebf4c1 530 }
5612b691 531
d3140adc 532###### List Charging Stations
32de5a57 533
03ebf4c1
JB		 534- Request:
535 `ProcedureName`: 'listChargingStations'
536 `PDU`: {}
32de5a57 537
03ebf4c1
JB		 538- Response:
539 `PDU`: {
853ed24a 540 `status`: 'success' | 'failure',
02cde3b7 541 `chargingStations`: ChargingStationData[]
03ebf4c1 542 }
32de5a57 543
d3140adc 544###### Start Charging Station
80a3704c 545
03ebf4c1
JB		 546- Request:
547 `ProcedureName`: 'startChargingStation'
548 `PDU`: {
03eee93b 549 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
03ebf4c1 550 }
80a3704c 551
03ebf4c1
JB		 552- Response:
553 `PDU`: {
853ed24a
JB		 554 `status`: 'success' | 'failure',
555 `hashIdsSucceeded`: charging station unique identifier strings array,
556 `hashIdsFailed`: charging station unique identifier strings array (optional)
03eee93b 557 `responsesFailed`: failed responses payload array (optional)
03ebf4c1 558 }
80a3704c 559
d3140adc 560###### Stop Charging Station
80a3704c 561
03ebf4c1
JB		 562- Request:
563 `ProcedureName`: 'stopChargingStation'
564 `PDU`: {
853ed24a 565 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
03ebf4c1 566 }
80a3704c 567
03ebf4c1
JB		 568- Response:
569 `PDU`: {
853ed24a
JB		 570 `status`: 'success' | 'failure',
571 `hashIdsSucceeded`: charging station unique identifier strings array,
94abe068
JB		 572 `hashIdsFailed`: charging station unique identifier strings array (optional),
573 `responsesFailed`: failed responses payload array (optional)
03ebf4c1 574 }
80a3704c 575
d3140adc 576###### Open Connection
e4df816e 577
03ebf4c1
JB		 578- Request:
579 `ProcedureName`: 'openConnection'
580 `PDU`: {
853ed24a 581 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
03ebf4c1 582 }
e4df816e 583
03ebf4c1
JB		 584- Response:
585 `PDU`: {
853ed24a
JB		 586 `status`: 'success' | 'failure',
587 `hashIdsSucceeded`: charging station unique identifier strings array,
94abe068
JB		 588 `hashIdsFailed`: charging station unique identifier strings array (optional),
589 `responsesFailed`: failed responses payload array (optional)
03ebf4c1 590 }
e4df816e 591
d3140adc 592###### Close Connection
e4df816e 593
03ebf4c1
JB		 594- Request:
595 `ProcedureName`: 'closeConnection'
596 `PDU`: {
853ed24a 597 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
03ebf4c1
JB		 598 }
599
600- Response:
601 `PDU`: {
853ed24a
JB		 602 `status`: 'success' | 'failure',
603 `hashIdsSucceeded`: charging station unique identifier strings array,
94abe068
JB		 604 `hashIdsFailed`: charging station unique identifier strings array (optional),
605 `responsesFailed`: failed responses payload array (optional)
853ed24a
JB		 606 }
607
608###### Start Automatic Transaction Generator
609
610- Request:
611 `ProcedureName`: 'startAutomaticTransactionGenerator'
612 `PDU`: {
613 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
a38bc315 614 `connectorIds`: connector id integer array (optional, default: all connectors)
853ed24a
JB		 615 }
616
617- Response:
618 `PDU`: {
619 `status`: 'success' | 'failure',
620 `hashIdsSucceeded`: charging station unique identifier strings array,
5566ca3e
JB		 621 `hashIdsFailed`: charging station unique identifier strings array (optional),
622 `responsesFailed`: failed responses payload array (optional)
853ed24a
JB		 623 }
624
625###### Stop Automatic Transaction Generator
626
627- Request:
628 `ProcedureName`: 'stopAutomaticTransactionGenerator'
629 `PDU`: {
630 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
a38bc315 631 `connectorIds`: connector id integer array (optional, default: all connectors)
853ed24a
JB		 632 }
633
634- Response:
635 `PDU`: {
636 `status`: 'success' | 'failure',
637 `hashIdsSucceeded`: charging station unique identifier strings array,
5566ca3e
JB		 638 `hashIdsFailed`: charging station unique identifier strings array (optional),
639 `responsesFailed`: failed responses payload array (optional)
03ebf4c1
JB		 640 }
641
91a7d3ea 642###### OCPP commands trigger
a9ed42b2 643
82cbef8d
JB		 644- Request:
645 `ProcedureName`: 'commandName' (the OCPP command name in camel case)
646 `PDU`: {
647 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
648 ...`commandPayload`
649 } (the OCPP command payload with some optional fields added to target the simulated charging stations)
10db00b2 650
82cbef8d
JB		 651- Response:
652 `PDU`: {
653 `status`: 'success' | 'failure',
654 `hashIdsSucceeded`: charging station unique identifier strings array,
655 `hashIdsFailed`: charging station unique identifier strings array (optional),
656 `responsesFailed`: failed responses payload array (optional)
657 }
10db00b2 658
91a7d3ea 659Examples:
10db00b2 660
91a7d3ea 661- **Start Transaction**
a9ed42b2 662
91a7d3ea
JB		 663 - Request:
664 `ProcedureName`: 'startTransaction'
665 `PDU`: {
666 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
667 `connectorId`: connector id integer,
668 `idTag`: RFID tag string
669 }
670
671 - Response:
672 `PDU`: {
673 `status`: 'success' | 'failure',
674 `hashIdsSucceeded`: charging station unique identifier strings array,
675 `hashIdsFailed`: charging station unique identifier strings array (optional),
676 `responsesFailed`: failed responses payload array (optional)
677 }
678
679- **Stop Transaction**
680
681 - Request:
682 `ProcedureName`: 'stopTransaction'
683 `PDU`: {
684 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
685 `transactionId`: transaction id integer
686 }
687
688 - Response:
689 `PDU`: {
690 `status`: 'success' | 'failure',
691 `hashIdsSucceeded`: charging station unique identifier strings array,
692 `hashIdsFailed`: charging station unique identifier strings array (optional),
693 `responsesFailed`: failed responses payload array (optional)
694 }
695
696- **Status Notification**
697
698 - Request:
82cbef8d 699 `ProcedureName`: 'statusNotification'
91a7d3ea
JB		 700 `PDU`: {
701 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
702 `connectorId`: connector id integer,
703 `errorCode`: connector error code,
704 `status`: connector status
705 }
706
707 - Response:
708 `PDU`: {
709 `status`: 'success' | 'failure',
710 `hashIdsSucceeded`: charging station unique identifier strings array,
711 `hashIdsFailed`: charging station unique identifier strings array (optional),
712 `responsesFailed`: failed responses payload array (optional)
713 }
714
715- **Heartbeat**
716
717 - Request:
82cbef8d 718 `ProcedureName`: 'heartbeat'
91a7d3ea
JB		 719 `PDU`: {
720 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
721 }
722
723 - Response:
724 `PDU`: {
725 `status`: 'success' | 'failure',
726 `hashIdsSucceeded`: charging station unique identifier strings array,
727 `hashIdsFailed`: charging station unique identifier strings array (optional),
728 `responsesFailed`: failed responses payload array (optional)
729 }
a9ed42b2 730
251fff5c 731## Support, Feedback, Contributing
7dde0b73 732
7f774a55 733This 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 734
251fff5c
JB		 735## Code of Conduct
736
737We 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.
738
739## Licensing
740
a6609c86 741Copyright 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