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