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