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