repositories / e-mobility-charging-stations-simulator.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
refactor: npx -> pnpm dlx where appropriates
[e-mobility-charging-stations-simulator.git] / README.md
1 <!-- markdownlint-disable-file MD033 MD024 -->
2 <div align="center">
3
4 # [e-Mobility charging stations simulator](https://github.com/sap/e-mobility-charging-stations-simulator)
5
6 </div>
7
8 <div align="center">
9
10 [![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)
11 [![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)
12 [![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)
13 [![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)
14 [![Javascript Standard Style Guide](<https://badgen.net/static/code style/standard/green>)](https://standardjs.com)
15
16 </div>
17
18 Simple [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.
19
20 ## Table of contents
21
22 - [Installation](#installation)
23 - [Prerequisites](#prerequisites)
24 - [Windows](#windows)
25 - [MacOSX](#macosx)
26 - [GNU/Linux](#gnulinux)
27 - [Development prerequisites (optional)](#development-prerequisites-optional)
28 - [Unix](#unix)
29 - [Windows](#windows-1)
30 - [Branching model](#branching-model)
31 - [Dependencies](#dependencies)
32 - [Initial configuration](#initial-configuration)
33 - [Start simulator](#start-simulator)
34 - [Start Web UI](#start-web-ui)
35 - [Configuration files syntax](#configuration-files-syntax)
36 - [Charging stations simulator configuration](#charging-stations-simulator-configuration)
37 - [Charging station template configuration](#charging-station-template-configuration)
38 - [Charging station configuration](#charging-station-configuration)
39 - [Docker](#docker)
40 - [OCPP-J commands supported](#ocpp-j-commands-supported)
41 - [Version 1.6](#version-16)
42 - [Version 2.x.x](#version-2xx)
43 - [OCPP-J standard parameters supported](#ocpp-j-standard-parameters-supported)
44 - [Version 1.6](#version-16-1)
45 - [Version 2.x.x](#version-2xx-1)
46 - [UI Protocol](#ui-protocol)
47 - [Websocket Protocol](#websocket-protocol)
48 - [HTTP Protocol](#http-protocol)
49 - [Support, Feedback, Contributing](#support-feedback-contributing)
50 - [Code of Conduct](#code-of-conduct)
51 - [Licensing](#licensing)
52
53 ## Installation
54
55 ### Prerequisites
56
57 Install the [node.js](https://nodejs.org/) current LTS or superior version runtime environment:
58
59 #### Windows
60
61 - [Chocolatey](https://chocolatey.org/):
62
63 ```powershell
64 choco install -y nodejs
65 ```
66
67 #### MacOSX
68
69 - [Homebrew](https://brew.sh/):
70
71 ```shell
72 brew install node
73 ```
74
75 #### GNU/Linux
76
77 - [NodeSource](https://github.com/nodesource/distributions) node.js binary distributions for all supported versions.
78
79 ### Development prerequisites (optional)
80
81 Install [volta](https://volta.sh/) for managing automatically the node.js runtime and package manager version:
82
83 #### Unix
84
85 ```shell
86 curl https://get.volta.sh | bash
87 ```
88
89 #### Windows
90
91 ```powershell
92 choco install volta
93 ```
94
95 Setup [volta](https://volta.sh/) with [pnpm](https://github.com/pnpm/pnpm) package manager support: https://docs.volta.sh/advanced/pnpm
96
97 ### Branching model
98
99 The `main` branch is the default development branch.
100 The `vX` branches are the maintenance branches for the corresponding major version `X`.
101 The `vX.Y` branches are the maintenance branches for the corresponding major and minor version `X.Y`.
102
103 ### Dependencies
104
105 Enable corepack, if [volta](https://volta.sh/) is not installed and configured, and install latest pnpm version:
106
107 ```shell
108 corepack enable
109 corepack prepare pnpm@latest --activate
110 ```
111
112 In the repository root, run the following command:
113
114 ```shell
115 pnpm install
116 ```
117
118 ## Initial configuration
119
120 Copy the configuration template file [src/assets/config-template.json](./src/assets/config-template.json) to [src/assets/config.json](./src/assets/config.json).
121 Copy the RFID tags template file [src/assets/idtags-template.json](./src/assets/idtags-template.json) to [src/assets/idtags.json](./src/assets/idtags.json).
122
123 Tweak them to your needs by following the section [configuration files syntax](#configuration-files-syntax): OCPP server supervision URL(s), charging station templates, etc.
124
125 ## Start simulator
126
127 ```shell
128 pnpm start
129 ```
130
131 ## Start Web UI
132
133 See Web UI [README.md](./ui/web/README.md) for more information.
134
135 ## Configuration files syntax
136
137 All configuration files are using the JSON standard syntax.
138
139 **Configuration files locations**:
140
141 - charging stations simulator configuration: [src/assets/config.json](./src/assets/config.json);
142 - charging station configuration templates: [src/assets/station-templates](./src/assets/station-templates);
143 - charging station configurations: [dist/assets/configurations](./dist/assets/configurations);
144 - charging station RFID tags lists: [src/assets](./src/assets).
145
146 The 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).
147
148 All charging station configuration templates are in the directory [src/assets/station-templates](./src/assets/station-templates).
149
150 A 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).
151
152 **Configuration files hierarchy and priority**:
153
154 1. charging station configuration: [dist/assets/configurations](./dist/assets/configurations);
155 2. charging station configuration template: [src/assets/station-templates](./src/assets/station-templates);
156 3. charging stations simulator configuration: [src/assets/config.json](./src/assets/config.json).
157
158 The charging stations simulator has an automatic configuration files reload feature at change for:
159
160 - charging stations simulator configuration;
161 - charging station configuration templates;
162 - charging station authorization RFID tags lists.
163
164 But 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.
165
166 ### Charging stations simulator configuration
167
168 **src/assets/config.json**:
169
170 | Key | Value(s) | Default Value | Value type | Description |
171 | -------------------------- | -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
172 | supervisionUrls | | [] | string \| string[] | string or strings array containing global connection URIs to OCPP-J servers |
173 | supervisionUrlDistribution | round-robin/random/charging-station-affinity | charging-station-affinity | string | supervision urls distribution policy to simulated charging stations |
174 | 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 |
175 | worker | | {<br />"processType": "workerSet",<br />"startDelay": 500,<br />"elementAddDelay": 0,<br />"elementsPerWorker": 'auto',<br />"poolMinSize": 4,<br />"poolMaxSize": 16<br />} | {<br />processType?: WorkerProcessType;<br />startDelay?: number;<br />elementAddDelay?: 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 />- _elementAddDelay_: milliseconds to wait between charging station add<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 |
176 | 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 |
177 | 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 |
178 | stationTemplateUrls | | {}[] | {<br />file: string;<br />numberOfStations: number;<br />provisionedNumberOfStations?: number;<br />}[] | array of charging station templates URIs configuration section:<br />- _file_: charging station configuration template file relative path<br />- _numberOfStations_: template number of stations at startup<br />- _provisionedNumberOfStations_: template provisioned number of stations after startup |
179
180 #### Worker process model
181
182 - **workerSet**:
183 Worker set executing each a fixed number (elementsPerWorker) of simulated charging stations from the total
184
185 - **fixedPool**:
186 Fixedly sized worker pool executing a fixed total number of simulated charging stations
187
188 - **dynamicPool** (experimental):
189 Dynamically sized worker pool executing a fixed total number of simulated charging stations
190
191 ### Charging station template configuration
192
193 **src/assets/station-templates/\<name\>.json**:
194
195 | Key | Value(s) | Default Value | Value type | Description |
196 | ---------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
197 | supervisionUrls | | [] | string \| string[] | string or strings array containing connection URIs to OCPP-J servers |
198 | supervisionUser | | undefined | string | basic HTTP authentication user to OCPP-J server |
199 | supervisionPassword | | undefined | string | basic HTTP authentication password to OCPP-J server |
200 | supervisionUrlOcppConfiguration | true/false | false | boolean | enable supervision URL configuration via a vendor OCPP parameter key |
201 | supervisionUrlOcppKey | | 'ConnectionUrl' | string | the vendor string that will be used as a vendor OCPP parameter key to set the supervision URL |
202 | autoStart | true/false | true | boolean | enable automatic start of added charging station from template |
203 | ocppVersion | 1.6/2.0/2.0.1 | 1.6 | string | OCPP version |
204 | ocppProtocol | json | json | string | OCPP protocol |
205 | 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 |
206 | 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) |
207 | 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) |
208 | 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) |
209 | wsOptions | | {} | ClientOptions & ClientRequestArgs | [ws](https://github.com/websockets/ws) and node.js [http](https://nodejs.org/api/http.html) clients options intersection |
210 | idTagsFile | | undefined | string | RFID tags list file relative to [src/assets](./src/assets) path |
211 | baseName | | undefined | string | base name to build charging stations id |
212 | nameSuffix | | undefined | string | name suffix to build charging stations id |
213 | fixedName | true/false | false | boolean | use the 'baseName' as the charging stations unique name |
214 | chargePointModel | | undefined | string | charging stations model |
215 | chargePointVendor | | undefined | string | charging stations vendor |
216 | chargePointSerialNumberPrefix | | undefined | string | charge point serial number prefix |
217 | chargeBoxSerialNumberPrefix | | undefined | string | charge box serial number prefix (deprecated since OCPP 1.6) |
218 | 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 |
219 | firmwareVersion | | undefined | string | charging stations firmware version |
220 | power | | | float \| float[] | charging stations maximum power value(s) |
221 | powerSharedByConnectors | true/false | false | boolean | charging stations power shared by its connectors |
222 | powerUnit | W/kW | W | string | charging stations power unit |
223 | currentOutType | AC/DC | AC | string | charging stations current out type |
224 | voltageOut | | AC:230/DC:400 | integer | charging stations voltage out |
225 | numberOfPhases | 0/1/3 | AC:3/DC:0 | integer | charging stations number of phase(s) |
226 | numberOfConnectors | | | integer \| integer[] | charging stations number of connector(s) |
227 | useConnectorId0 | true/false | true | boolean | use connector id 0 definition from the charging station configuration template |
228 | randomConnectors | true/false | false | boolean | randomize runtime connector id affectation from the connector id definition in charging station configuration template |
229 | resetTime | | 60 | integer | seconds to wait before the charging stations come back at reset |
230 | autoRegister | true/false | false | boolean | set charging stations as registered at boot notification for testing purpose |
231 | autoReconnectMaxRetries | | -1 (unlimited) | integer | connection retries to the OCPP-J server |
232 | reconnectExponentialDelay | true/false | false | boolean | connection delay retry to the OCPP-J server |
233 | registrationMaxRetries | | -1 (unlimited) | integer | charging stations boot notification retries |
234 | 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 |
235 | amperageLimitationUnit | A/cA/dA/mA | A | string | charging stations amperage limit unit |
236 | enableStatistics | true/false | false | boolean | enable charging stations statistics |
237 | remoteAuthorization | true/false | true | boolean | enable RFID tags remote authorization |
238 | beginEndMeterValues | true/false | false | boolean | enable Transaction.{Begin,End} MeterValues |
239 | outOfOrderEndMeterValues | true/false | false | boolean | send Transaction.End MeterValues out of order. Need to relax OCPP specifications strict compliance ('ocppStrictCompliance' parameter) |
240 | meteringPerTransaction | true/false | true | boolean | enable metering history on a per transaction basis |
241 | transactionDataMeterValues | true/false | false | boolean | enable transaction data MeterValues at stop transaction |
242 | stopTransactionsOnStopped | true/false | true | boolean | enable stop transactions on charging station stop |
243 | mainVoltageMeterValues | true/false | true | boolean | include charging stations main voltage MeterValues on three phased charging stations |
244 | phaseLineToLineVoltageMeterValues | true/false | false | boolean | include charging stations line to line voltage MeterValues on three phased charging stations |
245 | customValueLimitationMeterValues | true/false | true | boolean | enable limitation on custom fluctuated value in MeterValues |
246 | 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. |
247 | 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 |
248 | messageTriggerSupport | | {} | Record<MessageTrigger, boolean> | Configuration section for OCPP commands trigger support. Empty section means all implemented OCPP trigger commands are supported |
249 | Configuration | | | ChargingStationOcppConfiguration | charging stations OCPP parameters configuration section |
250 | AutomaticTransactionGenerator | | | AutomaticTransactionGeneratorConfiguration | charging stations ATG configuration section |
251 | Connectors | | | Record<string, ConnectorStatus> | charging stations connectors configuration section |
252 | Evses | | | Record<string, EvseTemplate> | charging stations EVSEs configuration section |
253
254 #### Configuration section syntax example
255
256 ```json
257 "Configuration": {
258 "configurationKey": [
259 ...
260 {
261 "key": "StandardKey",
262 "readonly": false,
263 "value": "StandardValue",
264 "visible": true,
265 "reboot": false
266 },
267 ...
268 {
269 "key": "VendorKey",
270 "readonly": false,
271 "value": "VendorValue",
272 "visible": false,
273 "reboot": true
274 },
275 ...
276 ]
277 }
278 ```
279
280 #### AutomaticTransactionGenerator section syntax example
281
282 ##### Type definition:
283
284 ```ts
285 type AutomaticTransactionGeneratorConfiguration = {
286 enable: boolean
287 minDuration: number
288 maxDuration: number
289 minDelayBetweenTwoTransactions: number
290 maxDelayBetweenTwoTransactions: number
291 probabilityOfStart: number
292 stopAfterHours: number
293 stopAbsoluteDuration: boolean
294 requireAuthorize?: boolean
295 idTagDistribution?: 'random' | 'round-robin' | 'connector-affinity'
296 }
297 ```
298
299 ##### Example:
300
301 ```json
302 "AutomaticTransactionGenerator": {
303 "enable": false,
304 "minDuration": 60,
305 "maxDuration": 80,
306 "minDelayBetweenTwoTransactions": 15,
307 "maxDelayBetweenTwoTransactions": 30,
308 "probabilityOfStart": 1,
309 "stopAfterHours": 0.3,
310 "requireAuthorize": true,
311 "idTagDistribution": "random"
312 }
313 ```
314
315 #### Connectors section syntax example
316
317 ```json
318 "Connectors": {
319 "0": {},
320 "1": {
321 "bootStatus": "Available",
322 "MeterValues": [
323 ...
324 {
325 "unit": "W",
326 "measurand": "Power.Active.Import",
327 "phase": "L1-N",
328 "value": "5000",
329 "fluctuationPercent": "10"
330 },
331 ...
332 {
333 "unit": "A",
334 "measurand": "Current.Import",
335 "minimum": "0.5"
336 },
337 ...
338 {
339 "unit": "Wh"
340 },
341 ...
342 ]
343 }
344 },
345 ```
346
347 #### Evses section syntax example
348
349 ```json
350 "Evses": {
351 "0": {
352 "Connectors": {
353 "0": {}
354 }
355 },
356 "1": {
357 "Connectors": {
358 "1": {
359 "bootStatus": "Available",
360 "MeterValues": [
361 ...
362 {
363 "unit": "W",
364 "measurand": "Power.Active.Import",
365 "phase": "L1-N",
366 "value": "5000",
367 "fluctuationPercent": "10"
368 },
369 ...
370 {
371 "unit": "A",
372 "measurand": "Current.Import",
373 "minimum": "0.5"
374 },
375 ...
376 {
377 "unit": "Wh"
378 },
379 ...
380 ]
381 }
382 }
383 }
384 },
385 ```
386
387 ### Charging station configuration
388
389 **dist/assets/configurations/\<hashId\>.json**:
390
391 The charging station configuration file is automatically generated at startup from the charging station configuration template file and is persistent.
392
393 The 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.
394
395 #### stationInfo section (optional)
396
397 The syntax is similar to charging station configuration template with some added fields like the charging station id (name) and the 'Configuration' section removed.
398
399 That section is overwritten on matching charging station configuration template file changes.
400
401 #### connectorsStatus section
402
403 The syntax is similar to charging station configuration template 'Connectors' section with some added fields.
404
405 That section is overwritten on matching charging station configuration template file changes.
406
407 #### evsesStatus section
408
409 The syntax is similar to charging station configuration template 'Evses' section with some added fields.
410
411 That section is overwritten on matching charging station configuration template file changes.
412
413 #### automaticTransactionGenerator section (optional)
414
415 The syntax is similar to the charging station configuration template 'AutomaticTransactionGenerator' section.
416
417 That section is overwritten on matching charging station configuration template file changes.
418
419 #### automaticTransactionGeneratorStatuses section
420
421 That section is not overwritten on matching charging station configuration template file changes.
422
423 #### configurationKey section (optional)
424
425 The syntax is similar to the charging station configuration template 'Configuration' section.
426
427 That section is not overwritten on matching charging station configuration template file changes.
428
429 ## Docker
430
431 In the [docker](./docker) folder:
432
433 ```shell
434 make
435 ```
436
437 <!-- Or with the optional git submodules:
438
439 ```shell
440 make SUBMODULES_INIT=true
441 ``` -->
442
443 ## OCPP-J commands supported
444
445 ### Version 1.6
446
447 #### Core Profile
448
449 - :white_check_mark: Authorize
450 - :white_check_mark: BootNotification
451 - :white_check_mark: ChangeAvailability
452 - :white_check_mark: ChangeConfiguration
453 - :white_check_mark: ClearCache
454 - :white_check_mark: DataTransfer
455 - :white_check_mark: GetConfiguration
456 - :white_check_mark: Heartbeat
457 - :white_check_mark: MeterValues
458 - :white_check_mark: RemoteStartTransaction
459 - :white_check_mark: RemoteStopTransaction
460 - :white_check_mark: Reset
461 - :white_check_mark: StartTransaction
462 - :white_check_mark: StatusNotification
463 - :white_check_mark: StopTransaction
464 - :white_check_mark: UnlockConnector
465
466 #### Firmware Management Profile
467
468 - :white_check_mark: GetDiagnostics
469 - :white_check_mark: DiagnosticsStatusNotification
470 - :white_check_mark: FirmwareStatusNotification
471 - :white_check_mark: UpdateFirmware
472
473 #### Local Auth List Management Profile
474
475 - :x: GetLocalListVersion
476 - :x: SendLocalList
477
478 #### Reservation Profile
479
480 - :white_check_mark: CancelReservation
481 - :white_check_mark: ReserveNow
482
483 #### Smart Charging Profile
484
485 - :white_check_mark: ClearChargingProfile
486 - :white_check_mark: GetCompositeSchedule
487 - :white_check_mark: SetChargingProfile
488
489 #### Remote Trigger Profile
490
491 - :white_check_mark: TriggerMessage
492
493 ### Version 2.x.x
494
495 #### Provisioning
496
497 - :white_check_mark: BootNotification
498
499 #### Authorization
500
501 - :white_check_mark: ClearCache
502
503 #### Availability
504
505 - :white_check_mark: StatusNotification
506 - :white_check_mark: Heartbeat
507
508 ## OCPP-J standard parameters supported
509
510 All 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.
511
512 ### Version 1.6
513
514 #### Core Profile
515
516 - :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -)
517 - :x: ClockAlignedDataInterval (type: integer) (units: seconds)
518 - :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds)
519 - :x: GetConfigurationMaxKeys (type: integer) (units: -)
520 - :white_check_mark: HeartbeatInterval (type: integer) (units: seconds)
521 - :x: LocalAuthorizeOffline (type: boolean) (units: -)
522 - :x: LocalPreAuthorize (type: boolean) (units: -)
523 - :x: MeterValuesAlignedData (type: CSL) (units: -)
524 - :white_check_mark: MeterValuesSampledData (type: CSL) (units: -)
525 - :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds)
526 - :white_check_mark: NumberOfConnectors (type: integer) (units: -)
527 - :x: ResetRetries (type: integer) (units: times)
528 - :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -)
529 - :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -)
530 - :x: StopTransactionOnInvalidId (type: boolean) (units: -)
531 - :x: StopTxnAlignedData (type: CSL) (units: -)
532 - :x: StopTxnSampledData (type: CSL) (units: -)
533 - :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -)
534 - :x: TransactionMessageAttempts (type: integer) (units: times)
535 - :x: TransactionMessageRetryInterval (type: integer) (units: seconds)
536 - :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -)
537 - :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds)
538
539 #### Firmware Management Profile
540
541 - _none_
542
543 #### Local Auth List Management Profile
544
545 - :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
546 - :x: LocalAuthListMaxLength (type: integer) (units: -)
547 - :x: SendLocalListMaxLength (type: integer) (units: -)
548
549 #### Reservation Profile
550
551 - :white_check_mark: ReserveConnectorZeroSupported (type: boolean) (units: -)
552
553 #### Smart Charging Profile
554
555 - :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
556 - :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
557 - :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
558 - :x: MaxChargingProfilesInstalled (type: integer) (units: -)
559
560 #### Remote Trigger Profile
561
562 - _none_
563
564 ### Version 2.x.x
565
566 ## UI Protocol
567
568 Protocol to control the simulator via a Websocket or HTTP server:
569
570 ```mermaid
571 sequenceDiagram
572 Client->>UI Server: request
573 UI Server->>Client: response
574 Note over UI Server,Client: HTTP or Websocket
575 ```
576
577 ### Websocket Protocol
578
579 SRPC protocol over Websocket. PDU stands for 'Protocol Data Unit'.
580
581 - Request:
582 [`uuid`, `ProcedureName`, `PDU`]
583 `uuid`: String uniquely representing this request
584 `ProcedureName`: The procedure to run on the simulator
585 `PDU`: The parameters for said procedure
586
587 - Response:
588 [`uuid`, `PDU`]
589 `uuid`: String uniquely linking the response to the request
590 `PDU`: Response parameters to requested procedure
591
592 To 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.
593
594 #### Version 0.0.1
595
596 Set the Websocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
597
598 ##### Procedures
599
600 ###### Simulator State
601
602 - Request:
603 `ProcedureName`: 'simulatorState'
604 `PDU`: {}
605
606 - Response:
607 `PDU`: {
608 `status`: 'success' | 'failure',
609 `state`: {
610 `version`: string,
611 `configuration`: ConfigurationData,
612 `started`: boolean,
613 `templateStatistics`: Record<string, TemplateStatistics>
614 }
615 }
616
617 ###### Start Simulator
618
619 - Request:
620 `ProcedureName`: 'startSimulator'
621 `PDU`: {}
622
623 - Response:
624 `PDU`: {
625 `status`: 'success' | 'failure'
626 }
627
628 ###### Stop Simulator
629
630 - Request:
631 `ProcedureName`: 'stopSimulator'
632 `PDU`: {}
633
634 - Response:
635 `PDU`: {
636 `status`: 'success' | 'failure'
637 }
638
639 ###### List Charging Station Templates
640
641 - Request:
642 `ProcedureName`: 'listTemplates'
643 `PDU`: {}
644
645 - Response:
646 `PDU`: {
647 `status`: 'success' | 'failure',
648 `templates`: string[]
649 }
650
651 ###### Add Charging Stations
652
653 - Request:
654 `ProcedureName`: 'addChargingStations'
655 `PDU`: {
656 `template`: string,
657 `numberOfStations`: number,
658 `options?`: {
659 `supervisionUrls?`: string | string[],
660 `persistentConfiguration?`: boolean,
661 `autoStart?`: boolean,
662 `autoRegister?`: boolean,
663 `enableStatistics?`: boolean,
664 `ocppStrictCompliance?`: boolean,
665 `stopTransactionsOnStopped?`: boolean
666 }
667 }
668
669 - Response:
670 `PDU`: {
671 `status`: 'success' | 'failure',
672 `hashIdsSucceeded`: charging station unique identifier strings array (optional),
673 `hashIdsFailed`: charging station unique identifier strings array (optional)
674 }
675
676 ###### Delete Charging Stations
677
678 - Request:
679 `ProcedureName`: 'deleteChargingStations'
680 `PDU`: {
681 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
682 `deleteConfiguration?`: boolean
683 }
684
685 - Response:
686 `PDU`: {
687 `status`: 'success' | 'failure',
688 `hashIdsSucceeded`: charging station unique identifier strings array,
689 `hashIdsFailed`: charging station unique identifier strings array (optional),
690 `responsesFailed`: failed responses payload array (optional)
691 }
692
693 ###### Set Charging Station Supervision Url
694
695 - Request:
696 `ProcedureName`: 'setSupervisionUrl'
697 `PDU`: {
698 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
699 `url`: string
700 }
701
702 - Response:
703 `PDU`: {
704 `status`: 'success' | 'failure',
705 `hashIdsSucceeded`: charging station unique identifier strings array,
706 `hashIdsFailed`: charging station unique identifier strings array (optional),
707 `responsesFailed`: failed responses payload array (optional)
708 }
709
710 ###### Performance Statistics
711
712 - Request:
713 `ProcedureName`: 'performanceStatistics'
714 `PDU`: {}
715
716 - Response:
717 `PDU`: {
718 `status`: 'success' | 'failure',
719 `performanceStatistics`: Statistics[]
720 }
721
722 ###### List Charging Stations
723
724 - Request:
725 `ProcedureName`: 'listChargingStations'
726 `PDU`: {}
727
728 - Response:
729 `PDU`: {
730 `status`: 'success' | 'failure',
731 `chargingStations`: ChargingStationData[]
732 }
733
734 ###### Start Charging Station
735
736 - Request:
737 `ProcedureName`: 'startChargingStation'
738 `PDU`: {
739 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
740 }
741
742 - Response:
743 `PDU`: {
744 `status`: 'success' | 'failure',
745 `hashIdsSucceeded`: charging station unique identifier strings array,
746 `hashIdsFailed`: charging station unique identifier strings array (optional),
747 `responsesFailed`: failed responses payload array (optional)
748 }
749
750 ###### Stop Charging Station
751
752 - Request:
753 `ProcedureName`: 'stopChargingStation'
754 `PDU`: {
755 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
756 }
757
758 - Response:
759 `PDU`: {
760 `status`: 'success' | 'failure',
761 `hashIdsSucceeded`: charging station unique identifier strings array,
762 `hashIdsFailed`: charging station unique identifier strings array (optional),
763 `responsesFailed`: failed responses payload array (optional)
764 }
765
766 ###### Open Connection
767
768 - Request:
769 `ProcedureName`: 'openConnection'
770 `PDU`: {
771 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
772 }
773
774 - Response:
775 `PDU`: {
776 `status`: 'success' | 'failure',
777 `hashIdsSucceeded`: charging station unique identifier strings array,
778 `hashIdsFailed`: charging station unique identifier strings array (optional),
779 `responsesFailed`: failed responses payload array (optional)
780 }
781
782 ###### Close Connection
783
784 - Request:
785 `ProcedureName`: 'closeConnection'
786 `PDU`: {
787 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
788 }
789
790 - Response:
791 `PDU`: {
792 `status`: 'success' | 'failure',
793 `hashIdsSucceeded`: charging station unique identifier strings array,
794 `hashIdsFailed`: charging station unique identifier strings array (optional),
795 `responsesFailed`: failed responses payload array (optional)
796 }
797
798 ###### Start Automatic Transaction Generator
799
800 - Request:
801 `ProcedureName`: 'startAutomaticTransactionGenerator'
802 `PDU`: {
803 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
804 `connectorIds`: connector id integer array (optional, default: all connectors)
805 }
806
807 - Response:
808 `PDU`: {
809 `status`: 'success' | 'failure',
810 `hashIdsSucceeded`: charging station unique identifier strings array,
811 `hashIdsFailed`: charging station unique identifier strings array (optional),
812 `responsesFailed`: failed responses payload array (optional)
813 }
814
815 ###### Stop Automatic Transaction Generator
816
817 - Request:
818 `ProcedureName`: 'stopAutomaticTransactionGenerator'
819 `PDU`: {
820 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
821 `connectorIds`: connector id integer array (optional, default: all connectors)
822 }
823
824 - Response:
825 `PDU`: {
826 `status`: 'success' | 'failure',
827 `hashIdsSucceeded`: charging station unique identifier strings array,
828 `hashIdsFailed`: charging station unique identifier strings array (optional),
829 `responsesFailed`: failed responses payload array (optional)
830 }
831
832 ###### OCPP commands trigger
833
834 - Request:
835 `ProcedureName`: 'commandName' (the OCPP command name in camel case)
836 `PDU`: {
837 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
838 ...`commandPayload`
839 } (the OCPP command payload with some optional fields added to target the simulated charging stations)
840
841 - Response:
842 `PDU`: {
843 `status`: 'success' | 'failure',
844 `hashIdsSucceeded`: charging station unique identifier strings array,
845 `hashIdsFailed`: charging station unique identifier strings array (optional),
846 `responsesFailed`: failed responses payload array (optional)
847 }
848
849 Examples:
850
851 - **Start Transaction**
852
853 - Request:
854 `ProcedureName`: 'startTransaction'
855 `PDU`: {
856 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
857 `connectorId`: connector id integer,
858 `idTag`: RFID tag string
859 }
860
861 - Response:
862 `PDU`: {
863 `status`: 'success' | 'failure',
864 `hashIdsSucceeded`: charging station unique identifier strings array,
865 `hashIdsFailed`: charging station unique identifier strings array (optional),
866 `responsesFailed`: failed responses payload array (optional)
867 }
868
869 - **Stop Transaction**
870
871 - Request:
872 `ProcedureName`: 'stopTransaction'
873 `PDU`: {
874 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
875 `transactionId`: transaction id integer
876 }
877
878 - Response:
879 `PDU`: {
880 `status`: 'success' | 'failure',
881 `hashIdsSucceeded`: charging station unique identifier strings array,
882 `hashIdsFailed`: charging station unique identifier strings array (optional),
883 `responsesFailed`: failed responses payload array (optional)
884 }
885
886 - **Status Notification**
887
888 - Request:
889 `ProcedureName`: 'statusNotification'
890 `PDU`: {
891 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
892 `connectorId`: connector id integer,
893 `errorCode`: connector error code,
894 `status`: connector status
895 }
896
897 - Response:
898 `PDU`: {
899 `status`: 'success' | 'failure',
900 `hashIdsSucceeded`: charging station unique identifier strings array,
901 `hashIdsFailed`: charging station unique identifier strings array (optional),
902 `responsesFailed`: failed responses payload array (optional)
903 }
904
905 - **Heartbeat**
906
907 - Request:
908 `ProcedureName`: 'heartbeat'
909 `PDU`: {
910 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
911 }
912
913 - Response:
914 `PDU`: {
915 `status`: 'success' | 'failure',
916 `hashIdsSucceeded`: charging station unique identifier strings array,
917 `hashIdsFailed`: charging station unique identifier strings array (optional),
918 `responsesFailed`: failed responses payload array (optional)
919 }
920
921 ### HTTP Protocol
922
923 To 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.
924
925 ## Support, Feedback, Contributing
926
927 This 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).
928
929 ## Code of Conduct
930
931 We 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.
932
933 ## Licensing
934
935 Copyright 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