1 <!-- markdownlint-disable-file MD033 MD024 -->
4 # [e-Mobility charging stations simulator](https://github.com/sap/e-mobility-charging-stations-simulator)
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)
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.
22 - [Installation](#installation)
23 - [Prerequisites](#prerequisites)
26 - [GNU/Linux](#gnulinux)
27 - [Development prerequisites (optional)](#development-prerequisites-optional)
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)
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)
57 Install the [node.js](https://nodejs.org/) current LTS or superior version runtime environment:
61 - [Chocolatey](https://chocolatey.org/):
64 choco install -y nodejs
69 - [Homebrew](https://brew.sh/):
77 - [NodeSource](https://github.com/nodesource/distributions) node.js binary distributions for all supported versions.
79 ### Development prerequisites (optional)
81 Install [volta](https://volta.sh/) for managing automatically the node.js runtime and package manager version:
86 curl https://get.volta.sh | bash
95 Setup [volta](https://volta.sh/) with [pnpm](https://github.com/pnpm/pnpm) package manager support: https://docs.volta.sh/advanced/pnpm
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`.
105 Enable corepack, if [volta](https://volta.sh/) is not installed and configured, and install latest pnpm version:
109 corepack prepare pnpm@latest --activate
112 In the repository root, run the following command:
118 ## Initial configuration
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).
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.
133 See Web UI [README.md](./ui/web/README.md) for more information.
135 ## Configuration files syntax
137 All configuration files are using the JSON standard syntax.
139 **Configuration files locations**:
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).
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).
148 All charging station configuration templates are in the directory [src/assets/station-templates](./src/assets/station-templates).
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).
152 **Configuration files hierarchy and priority**:
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).
158 The charging stations simulator has an automatic configuration files reload feature at change for:
160 - charging stations simulator configuration;
161 - charging station configuration templates;
162 - charging station authorization RFID tags lists.
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.
166 ### Charging stations simulator configuration
168 **src/assets/config.json**:
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 |
180 #### Worker process model
183 Worker set executing each a fixed number (elementsPerWorker) of simulated charging stations from the total
186 Fixedly sized worker pool executing a fixed total number of simulated charging stations
188 - **dynamicPool** (experimental):
189 Dynamically sized worker pool executing a fixed total number of simulated charging stations
191 ### Charging station template configuration
193 **src/assets/station-templates/\<name\>.json**:
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 |
254 #### Configuration section syntax example
258 "configurationKey": [
261 "key": "StandardKey",
263 "value": "StandardValue",
271 "value": "VendorValue",
280 #### AutomaticTransactionGenerator section syntax example
282 ##### Type definition:
285 type AutomaticTransactionGeneratorConfiguration = {
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'
302 "AutomaticTransactionGenerator": {
306 "minDelayBetweenTwoTransactions": 15,
307 "maxDelayBetweenTwoTransactions": 30,
308 "probabilityOfStart": 1,
309 "stopAfterHours": 0.3,
310 "requireAuthorize": true,
311 "idTagDistribution": "random"
315 #### Connectors section syntax example
321 "bootStatus": "Available",
326 "measurand": "Power.Active.Import",
329 "fluctuationPercent": "10"
334 "measurand": "Current.Import",
347 #### Evses section syntax example
359 "bootStatus": "Available",
364 "measurand": "Power.Active.Import",
367 "fluctuationPercent": "10"
372 "measurand": "Current.Import",
387 ### Charging station configuration
389 **dist/assets/configurations/\<hashId\>.json**:
391 The charging station configuration file is automatically generated at startup from the charging station configuration template file and is persistent.
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.
395 #### stationInfo section (optional)
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.
399 That section is overwritten on matching charging station configuration template file changes.
401 #### connectorsStatus section
403 The syntax is similar to charging station configuration template 'Connectors' section with some added fields.
405 That section is overwritten on matching charging station configuration template file changes.
407 #### evsesStatus section
409 The syntax is similar to charging station configuration template 'Evses' section with some added fields.
411 That section is overwritten on matching charging station configuration template file changes.
413 #### automaticTransactionGenerator section (optional)
415 The syntax is similar to the charging station configuration template 'AutomaticTransactionGenerator' section.
417 That section is overwritten on matching charging station configuration template file changes.
419 #### automaticTransactionGeneratorStatuses section
421 That section is not overwritten on matching charging station configuration template file changes.
423 #### configurationKey section (optional)
425 The syntax is similar to the charging station configuration template 'Configuration' section.
427 That section is not overwritten on matching charging station configuration template file changes.
431 In the [docker](./docker) folder:
437 <!-- Or with the optional git submodules:
440 make SUBMODULES_INIT=true
443 ## OCPP-J commands supported
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
466 #### Firmware Management Profile
468 - :white_check_mark: GetDiagnostics
469 - :white_check_mark: DiagnosticsStatusNotification
470 - :white_check_mark: FirmwareStatusNotification
471 - :white_check_mark: UpdateFirmware
473 #### Local Auth List Management Profile
475 - :x: GetLocalListVersion
478 #### Reservation Profile
480 - :white_check_mark: CancelReservation
481 - :white_check_mark: ReserveNow
483 #### Smart Charging Profile
485 - :white_check_mark: ClearChargingProfile
486 - :white_check_mark: GetCompositeSchedule
487 - :white_check_mark: SetChargingProfile
489 #### Remote Trigger Profile
491 - :white_check_mark: TriggerMessage
497 - :white_check_mark: BootNotification
501 - :white_check_mark: ClearCache
505 - :white_check_mark: StatusNotification
506 - :white_check_mark: Heartbeat
508 ## OCPP-J standard parameters supported
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.
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)
539 #### Firmware Management Profile
543 #### Local Auth List Management Profile
545 - :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
546 - :x: LocalAuthListMaxLength (type: integer) (units: -)
547 - :x: SendLocalListMaxLength (type: integer) (units: -)
549 #### Reservation Profile
551 - :white_check_mark: ReserveConnectorZeroSupported (type: boolean) (units: -)
553 #### Smart Charging Profile
555 - :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
556 - :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
557 - :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
558 - :x: MaxChargingProfilesInstalled (type: integer) (units: -)
560 #### Remote Trigger Profile
568 Protocol to control the simulator via a Websocket or HTTP server:
572 Client->>UI Server: request
573 UI Server->>Client: response
574 Note over UI Server,Client: HTTP or Websocket
577 ### Websocket Protocol
579 SRPC protocol over Websocket. PDU stands for 'Protocol Data Unit'.
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
589 `uuid`: String uniquely linking the response to the request
590 `PDU`: Response parameters to requested procedure
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.
596 Set the Websocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
600 ###### Simulator State
603 `ProcedureName`: 'simulatorState'
608 `status`: 'success' | 'failure',
611 `configuration`: ConfigurationData,
613 `templateStatistics`: Record<string, TemplateStatistics>
617 ###### Start Simulator
620 `ProcedureName`: 'startSimulator'
625 `status`: 'success' | 'failure'
628 ###### Stop Simulator
631 `ProcedureName`: 'stopSimulator'
636 `status`: 'success' | 'failure'
639 ###### List Charging Station Templates
642 `ProcedureName`: 'listTemplates'
647 `status`: 'success' | 'failure',
648 `templates`: string[]
651 ###### Add Charging Stations
654 `ProcedureName`: 'addChargingStations'
657 `numberOfStations`: number,
659 `supervisionUrls?`: string | string[],
660 `persistentConfiguration?`: boolean,
661 `autoStart?`: boolean,
662 `autoRegister?`: boolean,
663 `enableStatistics?`: boolean,
664 `ocppStrictCompliance?`: boolean,
665 `stopTransactionsOnStopped?`: boolean
671 `status`: 'success' | 'failure',
672 `hashIdsSucceeded`: charging station unique identifier strings array (optional),
673 `hashIdsFailed`: charging station unique identifier strings array (optional)
676 ###### Delete Charging Stations
679 `ProcedureName`: 'deleteChargingStations'
681 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
682 `deleteConfiguration?`: boolean
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)
693 ###### Set Charging Station Supervision Url
696 `ProcedureName`: 'setSupervisionUrl'
698 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
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)
710 ###### Performance Statistics
713 `ProcedureName`: 'performanceStatistics'
718 `status`: 'success' | 'failure',
719 `performanceStatistics`: Statistics[]
722 ###### List Charging Stations
725 `ProcedureName`: 'listChargingStations'
730 `status`: 'success' | 'failure',
731 `chargingStations`: ChargingStationData[]
734 ###### Start Charging Station
737 `ProcedureName`: 'startChargingStation'
739 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
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)
750 ###### Stop Charging Station
753 `ProcedureName`: 'stopChargingStation'
755 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
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)
766 ###### Open Connection
769 `ProcedureName`: 'openConnection'
771 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
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)
782 ###### Close Connection
785 `ProcedureName`: 'closeConnection'
787 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
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)
798 ###### Start Automatic Transaction Generator
801 `ProcedureName`: 'startAutomaticTransactionGenerator'
803 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
804 `connectorIds`: connector id integer array (optional, default: all connectors)
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)
815 ###### Stop Automatic Transaction Generator
818 `ProcedureName`: 'stopAutomaticTransactionGenerator'
820 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
821 `connectorIds`: connector id integer array (optional, default: all connectors)
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)
832 ###### OCPP commands trigger
835 `ProcedureName`: 'commandName' (the OCPP command name in camel case)
837 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
839 } (the OCPP command payload with some optional fields added to target the simulated charging stations)
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)
851 - **Start Transaction**
854 `ProcedureName`: 'startTransaction'
856 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
857 `connectorId`: connector id integer,
858 `idTag`: RFID tag string
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)
869 - **Stop Transaction**
872 `ProcedureName`: 'stopTransaction'
874 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
875 `transactionId`: transaction id integer
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)
886 - **Status Notification**
889 `ProcedureName`: 'statusNotification'
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
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)
908 `ProcedureName`: 'heartbeat'
910 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
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)
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.
925 ## Support, Feedback, Contributing
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).
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.
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).