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