1 <!-- markdownlint-disable-file MD033 MD024 -->
3 # [e-mobility charging stations simulator](https://github.com/sap/e-mobility-charging-stations-simulator)
5 [![GitHub Clones](https://img.shields.io/badge/dynamic/json?color=brightgreen&label=Clone&query=count&url=https://gist.githubusercontent.com/jerome-benoit/c7c669b881d5b27dc0b44a639504ff93/raw/clone.json&logo=github)](https://github.com/SAP/e-mobility-charging-stations-simulator/graphs/traffic)
6 [![GitHub commit activity (main)](https://img.shields.io/github/commit-activity/m/SAP/e-mobility-charging-stations-simulator/main?color=brightgreen&logo=github)](https://github.com/SAP/e-mobility-charging-stations-simulator/graphs/commit-activity)
7 [![CI workflow](https://github.com/SAP/e-mobility-charging-stations-simulator/actions/workflows/ci.yml/badge.svg)](https://github.com/SAP/e-mobility-charging-stations-simulator/actions/workflows/ci.yml)
8 [![REUSE status](https://api.reuse.software/badge/github.com/SAP/e-mobility-charging-stations-simulator)](https://api.reuse.software/info/github.com/SAP/e-mobility-charging-stations-simulator)
9 [![Javascript Standard Style Guide](<https://badgen.net/static/code style/standard/green>)](https://standardjs.com)
14 - [Installation](#installation)
15 - [Prerequisites](#prerequisites)
18 - [GNU/Linux](#gnulinux)
19 - [Dependencies](#dependencies)
20 - [Initial configuration](#initial-configuration)
22 - [Start Web UI](#start-web-ui)
23 - [Configuration files syntax](#configuration-files-syntax)
24 - [Charging stations simulator configuration](#charging-stations-simulator-configuration)
25 - [Charging station configuration template](#charging-station-configuration-template)
26 - [Charging station configuration](#charging-station-configuration)
28 - [OCPP-J commands supported](#ocpp-j-commands-supported)
29 - [Version 1.6](#version-16)
30 - [Version 2.x.x](#version-2xx)
31 - [OCPP-J standard parameters supported](#ocpp-j-standard-parameters-supported)
32 - [Version 1.6](#version-16-1)
33 - [Version 2.x.x](#version-2xx-1)
34 - [UI protocol](#ui-protocol)
35 - [Websocket Protocol](#websocket-protocol)
36 - [HTTP Protocol](#http-protocol)
37 - [Support, Feedback, Contributing](#support-feedback-contributing)
38 - [Code of Conduct](#code-of-conduct)
39 - [Licensing](#licensing)
43 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.
49 Install the [node.js](https://nodejs.org/) current LTS or superior version runtime environment:
53 - [Chocolatey](https://chocolatey.org/):
56 choco install -y nodejs
61 - [Homebrew](https://brew.sh/):
69 - [NodeSource](https://github.com/nodesource/distributions) Node.js Binary Distributions for all supported versions.
73 Enable corepack if not already done and install latest pnpm version:
77 corepack prepare pnpm@latest --activate
80 In the repository root, run the following command:
86 ## Initial configuration
88 Copy the configuration template file [src/assets/config-template.json](./src/assets/config-template.json) to [src/assets/config.json](./src/assets/config.json).
89 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).
91 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.
95 To start the program, run: `pnpm start`.
99 See Web UI [README.md](./ui/web/README.md) for more information.
101 ## Configuration files syntax
103 All configuration files are in the JSON standard format.
105 **Configuration files locations**:
107 - charging stations simulator configuration: [src/assets/config.json](./src/assets/config.json);
108 - charging station configuration templates: [src/assets/station-templates](./src/assets/station-templates);
109 - charging station configurations: [dist/assets/configurations](./dist/assets/configurations);
110 - charging station RFID tags lists: [src/assets](./src/assets).
112 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).
114 All charging station configuration templates are in the directory [src/assets/station-templates](./src/assets/station-templates).
116 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).
118 **Configuration files hierarchy and priority**:
120 1. charging station configuration: [dist/assets/configurations](./dist/assets/configurations);
121 2. charging station configuration template: [src/assets/station-templates](./src/assets/station-templates);
122 3. charging stations simulator configuration: [src/assets/config.json](./src/assets/config.json).
124 The charging stations simulator has an automatic configuration files reload feature at change for:
126 - charging stations simulator configuration;
127 - charging station configuration templates;
128 - charging station authorization RFID tags lists.
130 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.
132 ### Charging stations simulator configuration
134 **src/assets/config.json**:
136 | Key | Value(s) | Default Value | Value type | Description |
137 | -------------------------- | -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
138 | supervisionUrls | | [] | string \| string[] | string or strings array containing global connection URIs to OCPP-J servers |
139 | supervisionUrlDistribution | round-robin/random/charging-station-affinity | charging-station-affinity | string | supervision urls distribution policy to simulated charging stations |
140 | 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 |
141 | 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 |
142 | 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 |
143 | 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 |
144 | 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) |
146 #### Worker process model
149 Worker set executing each a fixed number (elementsPerWorker) of simulated charging stations from the total
152 Fixedly sized worker pool executing a fixed total number of simulated charging stations
154 - **dynamicPool** (experimental):
155 Dynamically sized worker pool executing a fixed total number of simulated charging stations
157 ### Charging station configuration template
159 **src/assets/station-templates/\<name\>.json**:
161 | Key | Value(s) | Default Value | Value type | Description |
162 | ---------------------------------------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
163 | supervisionUrls | | [] | string \| string[] | string or strings array containing connection URIs to OCPP-J servers |
164 | supervisionUser | | undefined | string | basic HTTP authentication user to OCPP-J server |
165 | supervisionPassword | | undefined | string | basic HTTP authentication password to OCPP-J server |
166 | supervisionUrlOcppConfiguration | true/false | false | boolean | enable supervision URL configuration via a vendor OCPP parameter key |
167 | supervisionUrlOcppKey | | 'ConnectionUrl' | string | the vendor string that will be used as a vendor OCPP parameter key to set the supervision URL |
168 | autoStart | true/false | true | boolean | enable automatic start of added charging station from template |
169 | ocppVersion | 1.6/2.0/2.0.1 | 1.6 | string | OCPP version |
170 | ocppProtocol | json | json | string | OCPP protocol |
171 | 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 |
172 | 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) |
173 | 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) |
174 | 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) |
175 | wsOptions | | {} | ClientOptions & ClientRequestArgs | [ws](https://github.com/websockets/ws) and node.js [http](https://nodejs.org/api/http.html) clients options intersection |
176 | idTagsFile | | undefined | string | RFID tags list file relative to [src/assets](./src/assets) path |
177 | baseName | | undefined | string | base name to build charging stations id |
178 | nameSuffix | | undefined | string | name suffix to build charging stations id |
179 | fixedName | true/false | false | boolean | use the 'baseName' as the charging stations unique name |
180 | chargePointModel | | undefined | string | charging stations model |
181 | chargePointVendor | | undefined | string | charging stations vendor |
182 | chargePointSerialNumberPrefix | | undefined | string | charge point serial number prefix |
183 | chargeBoxSerialNumberPrefix | | undefined | string | charge box serial number prefix (deprecated since OCPP 1.6) |
184 | 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 |
185 | firmwareVersion | | undefined | string | charging stations firmware version |
186 | power | | | float \| float[] | charging stations maximum power value(s) |
187 | powerSharedByConnectors | true/false | false | boolean | charging stations power shared by its connectors |
188 | powerUnit | W/kW | W | string | charging stations power unit |
189 | currentOutType | AC/DC | AC | string | charging stations current out type |
190 | voltageOut | | AC:230/DC:400 | integer | charging stations voltage out |
191 | numberOfPhases | 0/1/3 | AC:3/DC:0 | integer | charging stations number of phase(s) |
192 | numberOfConnectors | | | integer \| integer[] | charging stations number of connector(s) |
193 | useConnectorId0 | true/false | true | boolean | use connector id 0 definition from the charging station configuration template |
194 | randomConnectors | true/false | false | boolean | randomize runtime connector id affectation from the connector id definition in charging station configuration template |
195 | resetTime | | 60 | integer | seconds to wait before the charging stations come back at reset |
196 | autoRegister | true/false | false | boolean | set charging stations as registered at boot notification for testing purpose |
197 | autoReconnectMaxRetries | | -1 (unlimited) | integer | connection retries to the OCPP-J server |
198 | reconnectExponentialDelay | true/false | false | boolean | connection delay retry to the OCPP-J server |
199 | registrationMaxRetries | | -1 (unlimited) | integer | charging stations boot notification retries |
200 | 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 |
201 | amperageLimitationUnit | A/cA/dA/mA | A | string | charging stations amperage limit unit |
202 | enableStatistics | true/false | false | boolean | enable charging stations statistics |
203 | remoteAuthorization | true/false | true | boolean | enable RFID tags remote authorization |
204 | beginEndMeterValues | true/false | false | boolean | enable Transaction.{Begin,End} MeterValues |
205 | outOfOrderEndMeterValues | true/false | false | boolean | send Transaction.End MeterValues out of order. Need to relax OCPP specifications strict compliance ('ocppStrictCompliance' parameter) |
206 | meteringPerTransaction | true/false | true | boolean | enable metering history on a per transaction basis |
207 | transactionDataMeterValues | true/false | false | boolean | enable transaction data MeterValues at stop transaction |
208 | stopTransactionsOnStopped | true/false | true | boolean | enable stop transactions on charging station stop |
209 | mainVoltageMeterValues | true/false | true | boolean | include charging stations main voltage MeterValues on three phased charging stations |
210 | phaseLineToLineVoltageMeterValues | true/false | false | boolean | include charging stations line to line voltage MeterValues on three phased charging stations |
211 | customValueLimitationMeterValues | true/false | true | boolean | enable limitation on custom fluctuated value in MeterValues |
212 | 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. |
213 | 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 |
214 | messageTriggerSupport | | {} | Record<MessageTrigger, boolean> | Configuration section for OCPP commands trigger support. Empty section means all implemented OCPP trigger commands are supported |
215 | Configuration | | | ChargingStationOcppConfiguration | charging stations OCPP parameters configuration section |
216 | AutomaticTransactionGenerator | | | AutomaticTransactionGeneratorConfiguration | charging stations ATG configuration section |
217 | Connectors | | | Record<string, ConnectorStatus> | charging stations connectors configuration section |
218 | Evses | | | Record<string, EvseTemplate> | charging stations EVSEs configuration section |
220 #### Configuration section syntax example
224 "configurationKey": [
227 "key": "StandardKey",
229 "value": "StandardValue",
237 "value": "VendorValue",
246 #### AutomaticTransactionGenerator section syntax example
248 ##### Type definition:
251 type AutomaticTransactionGeneratorConfiguration = {
255 minDelayBetweenTwoTransactions: number
256 maxDelayBetweenTwoTransactions: number
257 probabilityOfStart: number
258 stopAfterHours: number
259 stopAbsoluteDuration: boolean
260 requireAuthorize?: boolean
261 idTagDistribution?: 'random' | 'round-robin' | 'connector-affinity'
268 "AutomaticTransactionGenerator": {
272 "minDelayBetweenTwoTransactions": 15,
273 "maxDelayBetweenTwoTransactions": 30,
274 "probabilityOfStart": 1,
275 "stopAfterHours": 0.3,
276 "requireAuthorize": true,
277 "idTagDistribution": "random"
281 #### Connectors section syntax example
287 "bootStatus": "Available",
292 "measurand": "Power.Active.Import",
295 "fluctuationPercent": "10"
300 "measurand": "Current.Import",
313 #### Evses section syntax example
325 "bootStatus": "Available",
330 "measurand": "Power.Active.Import",
333 "fluctuationPercent": "10"
338 "measurand": "Current.Import",
353 ### Charging station configuration
355 **dist/assets/configurations/\<hashId\>.json**:
357 The charging station configuration file is automatically generated at startup from the charging station configuration template file and is persistent.
359 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.
361 #### stationInfo section (optional)
363 The syntax is similar to charging station configuration template with some added fields like the charging station id (name) and the 'Configuration' section removed.
365 That section is overwritten on matching charging station configuration template file changes.
367 #### connectorsStatus section
369 The syntax is similar to charging station configuration template 'Connectors' section with some added fields.
371 That section is overwritten on matching charging station configuration template file changes.
373 #### evsesStatus section
375 The syntax is similar to charging station configuration template 'Evses' section with some added fields.
377 That section is overwritten on matching charging station configuration template file changes.
379 #### automaticTransactionGenerator section (optional)
381 The syntax is similar to the charging station configuration template 'AutomaticTransactionGenerator' section.
383 That section is overwritten on matching charging station configuration template file changes.
385 #### automaticTransactionGeneratorStatuses section
387 That section is not overwritten on matching charging station configuration template file changes.
389 #### configurationKey section (optional)
391 The syntax is similar to the charging station configuration template 'Configuration' section.
393 That section is not overwritten on matching charging station configuration template file changes.
397 In the [docker](./docker) folder:
403 <!-- Or with the optional git submodules:
406 make SUBMODULES_INIT=true
409 ## OCPP-J commands supported
415 - :white_check_mark: Authorize
416 - :white_check_mark: BootNotification
417 - :white_check_mark: ChangeAvailability
418 - :white_check_mark: ChangeConfiguration
419 - :white_check_mark: ClearCache
420 - :white_check_mark: DataTransfer
421 - :white_check_mark: GetConfiguration
422 - :white_check_mark: Heartbeat
423 - :white_check_mark: MeterValues
424 - :white_check_mark: RemoteStartTransaction
425 - :white_check_mark: RemoteStopTransaction
426 - :white_check_mark: Reset
427 - :white_check_mark: StartTransaction
428 - :white_check_mark: StatusNotification
429 - :white_check_mark: StopTransaction
430 - :white_check_mark: UnlockConnector
432 #### Firmware Management Profile
434 - :white_check_mark: GetDiagnostics
435 - :white_check_mark: DiagnosticsStatusNotification
436 - :white_check_mark: FirmwareStatusNotification
437 - :white_check_mark: UpdateFirmware
439 #### Local Auth List Management Profile
441 - :x: GetLocalListVersion
444 #### Reservation Profile
446 - :white_check_mark: CancelReservation
447 - :white_check_mark: ReserveNow
449 #### Smart Charging Profile
451 - :white_check_mark: ClearChargingProfile
452 - :white_check_mark: GetCompositeSchedule
453 - :white_check_mark: SetChargingProfile
455 #### Remote Trigger Profile
457 - :white_check_mark: TriggerMessage
463 - :white_check_mark: BootNotification
467 - :white_check_mark: ClearCache
471 - :white_check_mark: StatusNotification
472 - :white_check_mark: Heartbeat
474 ## OCPP-J standard parameters supported
476 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.
482 - :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -)
483 - :x: ClockAlignedDataInterval (type: integer) (units: seconds)
484 - :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds)
485 - :x: GetConfigurationMaxKeys (type: integer) (units: -)
486 - :white_check_mark: HeartbeatInterval (type: integer) (units: seconds)
487 - :x: LocalAuthorizeOffline (type: boolean) (units: -)
488 - :x: LocalPreAuthorize (type: boolean) (units: -)
489 - :x: MeterValuesAlignedData (type: CSL) (units: -)
490 - :white_check_mark: MeterValuesSampledData (type: CSL) (units: -)
491 - :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds)
492 - :white_check_mark: NumberOfConnectors (type: integer) (units: -)
493 - :x: ResetRetries (type: integer) (units: times)
494 - :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -)
495 - :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -)
496 - :x: StopTransactionOnInvalidId (type: boolean) (units: -)
497 - :x: StopTxnAlignedData (type: CSL) (units: -)
498 - :x: StopTxnSampledData (type: CSL) (units: -)
499 - :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -)
500 - :x: TransactionMessageAttempts (type: integer) (units: times)
501 - :x: TransactionMessageRetryInterval (type: integer) (units: seconds)
502 - :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -)
503 - :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds)
505 #### Firmware Management Profile
509 #### Local Auth List Management Profile
511 - :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
512 - :x: LocalAuthListMaxLength (type: integer) (units: -)
513 - :x: SendLocalListMaxLength (type: integer) (units: -)
515 #### Reservation Profile
517 - :white_check_mark: ReserveConnectorZeroSupported (type: boolean) (units: -)
519 #### Smart Charging Profile
521 - :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
522 - :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
523 - :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
524 - :x: MaxChargingProfilesInstalled (type: integer) (units: -)
526 #### Remote Trigger Profile
534 Protocol to control the simulator via a Websocket or HTTP server:
538 Client->>UI Server: request
539 UI Server->>Client: response
540 Note over UI Server,Client: Transport protocol: HTTP, Websocket
543 ### Websocket Protocol
545 SRPC protocol over Websocket. PDU stands for 'Protocol Data Unit'.
548 [`uuid`, `ProcedureName`, `PDU`]
549 `uuid`: String uniquely representing this request
550 `ProcedureName`: The procedure to run on the simulator
551 `PDU`: The parameters for said procedure
555 `uuid`: String uniquely linking the response to the request
556 `PDU`: Response parameters to requested procedure
558 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.
562 Set the Websocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
566 ###### Simulator State
569 `ProcedureName`: 'simulatorState'
574 `status`: 'success' | 'failure',
578 `templateStatistics`: Record<string, TemplateStatistics>
582 ###### Start Simulator
585 `ProcedureName`: 'startSimulator'
590 `status`: 'success' | 'failure'
593 ###### Stop Simulator
596 `ProcedureName`: 'stopSimulator'
601 `status`: 'success' | 'failure'
604 ###### List Charging Station Templates
607 `ProcedureName`: 'listTemplates'
612 `status`: 'success' | 'failure',
613 `templates`: string[]
616 ###### Add Charging Stations
619 `ProcedureName`: 'addChargingStations'
622 `numberOfStations`: number,
624 `supervisionUrls?`: string | string[],
625 `persistentConfiguration?`: boolean,
626 `autoStart?`: boolean,
627 `autoRegister?`: boolean,
628 `enableStatistics?`: boolean,
629 `ocppStrictCompliance?`: boolean,
630 `stopTransactionsOnStopped?`: boolean
636 `status`: 'success' | 'failure'
639 ###### Delete Charging Stations
642 `ProcedureName`: 'deleteChargingStations'
644 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
645 `deleteConfiguration?`: boolean
650 `status`: 'success' | 'failure',
651 `hashIdsSucceeded`: charging station unique identifier strings array,
652 `hashIdsFailed`: charging station unique identifier strings array (optional),
653 `responsesFailed`: failed responses payload array (optional)
656 ###### Set Charging Station Supervision Url
659 `ProcedureName`: 'setSupervisionUrl'
661 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
667 `status`: 'success' | 'failure',
668 `hashIdsSucceeded`: charging station unique identifier strings array,
669 `hashIdsFailed`: charging station unique identifier strings array (optional),
670 `responsesFailed`: failed responses payload array (optional)
673 ###### Performance Statistics
676 `ProcedureName`: 'performanceStatistics'
681 `status`: 'success' | 'failure',
682 `performanceStatistics`: Statistics[]
685 ###### List Charging Stations
688 `ProcedureName`: 'listChargingStations'
693 `status`: 'success' | 'failure',
694 `chargingStations`: ChargingStationData[]
697 ###### Start Charging Station
700 `ProcedureName`: 'startChargingStation'
702 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
707 `status`: 'success' | 'failure',
708 `hashIdsSucceeded`: charging station unique identifier strings array,
709 `hashIdsFailed`: charging station unique identifier strings array (optional),
710 `responsesFailed`: failed responses payload array (optional)
713 ###### Stop Charging Station
716 `ProcedureName`: 'stopChargingStation'
718 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
723 `status`: 'success' | 'failure',
724 `hashIdsSucceeded`: charging station unique identifier strings array,
725 `hashIdsFailed`: charging station unique identifier strings array (optional),
726 `responsesFailed`: failed responses payload array (optional)
729 ###### Open Connection
732 `ProcedureName`: 'openConnection'
734 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
739 `status`: 'success' | 'failure',
740 `hashIdsSucceeded`: charging station unique identifier strings array,
741 `hashIdsFailed`: charging station unique identifier strings array (optional),
742 `responsesFailed`: failed responses payload array (optional)
745 ###### Close Connection
748 `ProcedureName`: 'closeConnection'
750 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
755 `status`: 'success' | 'failure',
756 `hashIdsSucceeded`: charging station unique identifier strings array,
757 `hashIdsFailed`: charging station unique identifier strings array (optional),
758 `responsesFailed`: failed responses payload array (optional)
761 ###### Start Automatic Transaction Generator
764 `ProcedureName`: 'startAutomaticTransactionGenerator'
766 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
767 `connectorIds`: connector id integer array (optional, default: all connectors)
772 `status`: 'success' | 'failure',
773 `hashIdsSucceeded`: charging station unique identifier strings array,
774 `hashIdsFailed`: charging station unique identifier strings array (optional),
775 `responsesFailed`: failed responses payload array (optional)
778 ###### Stop Automatic Transaction Generator
781 `ProcedureName`: 'stopAutomaticTransactionGenerator'
783 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
784 `connectorIds`: connector id integer array (optional, default: all connectors)
789 `status`: 'success' | 'failure',
790 `hashIdsSucceeded`: charging station unique identifier strings array,
791 `hashIdsFailed`: charging station unique identifier strings array (optional),
792 `responsesFailed`: failed responses payload array (optional)
795 ###### OCPP commands trigger
798 `ProcedureName`: 'commandName' (the OCPP command name in camel case)
800 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
802 } (the OCPP command payload with some optional fields added to target the simulated charging stations)
806 `status`: 'success' | 'failure',
807 `hashIdsSucceeded`: charging station unique identifier strings array,
808 `hashIdsFailed`: charging station unique identifier strings array (optional),
809 `responsesFailed`: failed responses payload array (optional)
814 - **Start Transaction**
817 `ProcedureName`: 'startTransaction'
819 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
820 `connectorId`: connector id integer,
821 `idTag`: RFID tag string
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 - **Stop Transaction**
835 `ProcedureName`: 'stopTransaction'
837 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
838 `transactionId`: transaction id integer
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)
849 - **Status Notification**
852 `ProcedureName`: 'statusNotification'
854 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
855 `connectorId`: connector id integer,
856 `errorCode`: connector error code,
857 `status`: connector status
862 `status`: 'success' | 'failure',
863 `hashIdsSucceeded`: charging station unique identifier strings array,
864 `hashIdsFailed`: charging station unique identifier strings array (optional),
865 `responsesFailed`: failed responses payload array (optional)
871 `ProcedureName`: 'heartbeat'
873 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
878 `status`: 'success' | 'failure',
879 `hashIdsSucceeded`: charging station unique identifier strings array,
880 `hashIdsFailed`: charging station unique identifier strings array (optional),
881 `responsesFailed`: failed responses payload array (optional)
886 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.
888 ## Support, Feedback, Contributing
890 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).
894 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.
898 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).