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