README.md

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