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