README.md

   1 # [charging-stations-simulator](https://github.com/jerome-benoit/charging-stations-simulator)
   2
   3 ## Summary
   4
   5 Simple [node.js](https://nodejs.org/) program to simulate a set of charging stations based on the OCPP-J 1.6 protocol.
   6
   7 ## Prerequisites
   8
   9 ### Windows
  10
  11 * [Chocolatey](https://chocolatey.org/):
  12
  13 ```powershell
  14 choco install -y nodejs-lts
  15 ```
  16
  17 ### MacOSX
  18
  19 * [Homebrew](https://brew.sh/):
  20
  21 ```shell
  22 brew install node@14
  23 ```
  24
  25 ### GNU/Linux:
  26
  27 * [NodeSource](https://github.com/nodesource/distributions) Node.js Binary Distributions for version 14.X
  28
  29 ## Configuration syntax
  30
  31 All configuration files are in the JSON standard format.
  32
  33 The charging stations simulator's main configuration parameters must be within the `src/assets/config.json` file. A configuration template file is available at [src/assets/config-template.json](src/assets/config-template.json).
  34
  35 All charging station templates are in the directory [src/assets/station-templates](src/assets/station-templates).
  36
  37 A list of RFID tags must be defined for the automatic transaction generator with the 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).
  38
  39 The charging stations simulator have an automatic configuration files reload feature at change for:
  40 * main configuration;
  41 * charging station templates;
  42 * authorization RFID tags.
  43
  44 But the modifications to test have to be done to the files in the build result 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.
  45
  46 ### Main configuration
  47
  48 **src/assets/config.json**:
  49
  50 Key | Value(s) | Default Value | Value type | Description
  51 --- | -------| --------------| ---------- | ------------
  52 supervisionUrls | | [] | string \| string[] | string or array of global connection URIs to OCPP-J servers
  53 supervisionUrlDistribution | round-robin/random/sequential | round-robin | boolean | supervision urls distribution policy to simulated charging stations
  54 workerProcess | workerSet/staticPool/dynamicPool | workerSet | string | worker threads process type
  55 workerStartDelay | | 500 | integer | milliseconds to wait at charging station worker threads startup
  56 workerPoolMinSize | | 4 | integer | worker threads pool minimum number of threads
  57 workerPoolMaxSize | | 16 | integer | worker threads pool maximum number of threads
  58 workerPoolStrategy | ROUND_ROBIN/LESS_RECENTLY_USED/... | [poolifier](https://github.com/poolifier/poolifier) default: ROUND_ROBBIN | string | worker threads pool [poolifier](https://github.com/poolifier/poolifier) worker choice strategy
  59 chargingStationsPerWorker | | 1 | integer | number of charging stations per worker threads for the `workerSet` process type
  60 logStatisticsInterval | | 60 | integer | seconds between charging stations statistics output in the logs
  61 logConsole | true/false | false | boolean | output logs on the console
  62 logFormat | | simple | string | winston log format
  63 logRotate | true/false | true | boolean | enable daily log files rotation
  64 logMaxFiles | | 7 | integer | maximum number of log files to keep
  65 logLevel | emerg/alert/crit/error/warning/notice/info/debug | info | string | winston logging level
  66 logFile | | combined.log | string | log file relative path
  67 logErrorFile | | error.log | string | error log file relative path
  68 uiWebSocketServer | | { "enabled": true, "options": { "host: "localhost", "port": 8080 } } | { enabled: boolean; options: ServerOptions; } | UI WebSocket server configuration section
  69 performanceStorage | | { "enabled": false, "type": "jsonfile", "file:///performanceRecords.json" } | { enabled: boolean; type: string; URI: string; } where type can be 'jsonfile' or 'mongodb' | performance storage configuration section
  70 stationTemplateUrls | | {}[] | { file: string; numberOfStations: number; }[] | array of charging station templates URIs configuration section (template file name and number of stations)
  71
  72 #### Worker process model:
  73
  74 - **workerSet**:
  75   Worker set executing each a static number (chargingStationsPerWorker) of simulated charging stations from the total
  76
  77 - **staticPool**:
  78   Statically sized worker pool executing a static total number of simulated charging stations
  79
  80 - **dynamicPool**:
  81   Dynamically sized worker pool executing a static total number of simulated charging stations
  82
  83 ### Charging station template
  84
  85 Key | Value(s) | Default Value | Value type | Description
  86 --- | -------| --------------| ---------- | ------------
  87 supervisionUrls | | '' | string\|string[] | string or array of connection URIs to OCPP-J servers. It has priority over the global configuration parameter
  88 supervisionUser | | '' | string | basic HTTP authentication user to OCPP-J server
  89 supervisionPassword | | '' | string | basic HTTP authentication password to OCPP-J server
  90 supervisionUrlOcppConfiguration | true/false | false | boolean | Allow supervision URL configuration via a vendor OCPP parameter key
  91 supervisionUrlOcppKey | | 'ConnectionUrl' | string | The vendor string that will be used as a vendor OCPP parameter key to set the supervision URL
  92 ocppVersion | 1.6 | 1.6 | string | OCPP version
  93 ocppProtocol | json | json | string | OCPP protocol
  94 ocppStrictCompliance | true/false | true | boolean | Strict adherence to the OCPP version and protocol specifications
  95 wsOptions | | {} | ClientOptions & ClientRequestArgs | [ws](https://github.com/websockets/ws) and node.js [http](https://nodejs.org/api/http.html) clients options intersection
  96 authorizationFile | | '' | string | RFID tags list file relative to src/assets path
  97 baseName | | '' | string | base name to build charging stations name
  98 nameSuffix | | '' | string | name suffix to build charging stations name
  99 fixedName | true/false | false | boolean | use the baseName as the charging stations unique name
 100 chargePointModel | | '' | string | charging stations model
 101 chargePointVendor | | '' | string | charging stations vendor
 102 chargeBoxSerialNumberPrefix | | '' | string | charging stations serial number prefix
 103 firmwareVersion | | '' | string | charging stations firmware version
 104 power | | | float\|float[] | charging stations maximum power value(s)
 105 powerSharedByConnectors | true/false | false | boolean | charging stations power shared by its connectors
 106 powerUnit | W/kW | W | string | charging stations power unit
 107 currentOutType | AC/DC | AC | string | charging stations current out type
 108 voltageOut | | AC:230/DC:400 | integer | charging stations voltage out
 109 numberOfPhases | 0/1/3 | AC:3/DC:0 | integer | charging stations number of phase(s)
 110 numberOfConnectors | | | integer\|integer[] | charging stations number of connector(s)
 111 useConnectorId0 | true/false | true | boolean | use connector id 0 definition from the template
 112 randomConnectors | true/false | false | boolean | randomize runtime connector id affectation from the connector id definition in template
 113 resetTime | | 60 | integer | seconds to wait before the charging stations come back at reset
 114 autoRegister | true/false | false | boolean | set the charging station as registered at boot notification for testing purpose
 115 autoReconnectMaxRetries | | -1 (unlimited) | integer | connection retries to the OCPP-J server
 116 reconnectExponentialDelay | true/false | false | boolean | connection delay retry to the OCPP-J server
 117 registrationMaxRetries | | -1 (unlimited) | integer | charging stations boot notification retries
 118 enableStatistics | true/false | true | boolean | enable charging stations statistics
 119 mayAuthorizeAtRemoteStart | true/false | true | boolean | always send authorize at remote start transaction when AuthorizeRemoteTxRequests is enabled
 120 beginEndMeterValues | true/false | false | boolean | enable Transaction.{Begin,End} MeterValues
 121 outOfOrderEndMeterValues | true/false | false | boolean | send Transaction.End MeterValues out of order. Need to relax OCPP specifications strict compliance ('ocppStrictCompliance' parameter)
 122 meteringPerTransaction | true/false | true | boolean | enable metering history on a per transaction basis
 123 transactionDataMeterValues | true/false | false | boolean | enable transaction data MeterValues at stop transaction
 124 mainVoltageMeterValues | true/false | true | boolean | include charging station main voltage MeterValues on three phased charging stations
 125 phaseLineToLineVoltageMeterValues | true/false | true | boolean | include charging station line to line voltage MeterValues on three phased charging stations
 126 Configuration | | | ChargingStationConfiguration | charging stations OCPP parameters configuration section
 127 AutomaticTransactionGenerator | | | AutomaticTransactionGenerator | charging stations ATG configuration section
 128 Connectors | | | Connectors | charging stations connectors configuration section
 129
 130 #### Configuration section
 131
 132 ```json
 133   "Configuration": {
 134     "configurationKey": [
 135        ...
 136        {
 137         "key": "StandardKey",
 138         "readonly": false,
 139         "value": "StandardValue",
 140         "visible": true,
 141         "reboot": false
 142       },
 143       ...
 144       {
 145         "key": "VendorKey",
 146         "readonly": false,
 147         "value": "VendorValue",
 148         "visible": false,
 149         "reboot": true
 150       },
 151       ...
 152     ]
 153   }
 154 ```
 155
 156 #### AutomaticTransactionGenerator section
 157
 158 ```json
 159   "AutomaticTransactionGenerator": {
 160     "enable": false,
 161     "minDuration": 60,
 162     "maxDuration": 80,
 163     "minDelayBetweenTwoTransactions": 15,
 164     "maxDelayBetweenTwoTransactions": 30,
 165     "probabilityOfStart": 1,
 166     "stopAfterHours": 0.3,
 167     "stopOnConnectionFailure": true,
 168     "requireAuthorize": true
 169   }
 170 ```
 171 #### Connectors section
 172
 173 ```json
 174   "Connectors": {
 175     "0": {},
 176     "1": {
 177       "bootStatus": "Available",
 178       "MeterValues": [
 179         ...
 180         {
 181           "unit": "W",
 182           "measurand": "Power.Active.Import",
 183           "phase": "L1-N",
 184           "value": "5000",
 185           "fluctuationPercent": "10"
 186         },
 187         ...
 188         {
 189           "unit": "A",
 190           "measurand": "Current.Import"
 191         },
 192         ...
 193         {
 194           "unit": "Wh"
 195         },
 196         ...
 197       ]
 198     }
 199   },
 200 ```
 201
 202 ## Start
 203
 204 To start the program, run: `npm start`.
 205
 206 ## Docker
 207
 208 In the [docker](./docker) folder:
 209
 210 ```bash
 211 make
 212 ```
 213
 214 Or with the optional git submodules:
 215
 216 ```bash
 217 make SUBMODULES_INIT=true
 218 ```
 219
 220 ## OCPP-J commands supported
 221
 222 ### Version 1.6
 223
 224 #### Core Profile
 225
 226 - :white_check_mark: Authorize
 227 - :white_check_mark: BootNotification
 228 - :white_check_mark: ChangeAvailability
 229 - :white_check_mark: ChangeConfiguration
 230 - :white_check_mark: ClearCache
 231 - :x: DataTransfer
 232 - :white_check_mark: GetConfiguration
 233 - :white_check_mark: Heartbeat
 234 - :white_check_mark: MeterValues
 235 - :white_check_mark: RemoteStartTransaction
 236 - :white_check_mark: RemoteStopTransaction
 237 - :white_check_mark: Reset
 238 - :white_check_mark: StartTransaction
 239 - :white_check_mark: StatusNotification
 240 - :white_check_mark: StopTransaction
 241 - :white_check_mark: UnlockConnector
 242
 243 #### Firmware Management Profile
 244
 245 - :white_check_mark: GetDiagnostics
 246 - :white_check_mark: DiagnosticsStatusNotification
 247 - :x: FirmwareStatusNotification
 248 - :x: UpdateFirmware
 249
 250 #### Local Auth List Management Profile
 251
 252 - :x: GetLocalListVersion
 253 - :x: SendLocalList
 254
 255 #### Reservation Profile
 256
 257 - :x: CancelReservation
 258 - :x: ReserveNow
 259
 260 #### Smart Charging Profile
 261
 262 - :white_check_mark: ClearChargingProfile
 263 - :white_check_mark: GetCompositeSchedule
 264 - :white_check_mark: SetChargingProfile
 265
 266 #### Remote Trigger Profile
 267
 268 - :white_check_mark: TriggerMessage
 269
 270 ## OCPP-J standard parameters supported
 271
 272 All kind of OCPP parameters are supported in a charging station template. The list here mention the standard ones also handled automatically in the simulator.
 273
 274 ### Version 1.6
 275
 276 #### Core Profile
 277
 278 - :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -)
 279 - :x: ClockAlignedDataInterval (type: integer) (units: seconds)
 280 - :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds)
 281 - :x: GetConfigurationMaxKeys (type: integer) (units: -)
 282 - :white_check_mark: HeartbeatInterval (type: integer) (units: seconds)
 283 - :x: LocalAuthorizeOffline (type: boolean) (units: -)
 284 - :x: LocalPreAuthorize (type: boolean) (units: -)
 285 - :x: MeterValuesAlignedData (type: CSL) (units: -)
 286 - :white_check_mark: MeterValuesSampledData (type: CSL) (units: -)
 287 - :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds)
 288 - :white_check_mark: NumberOfConnectors (type: integer) (units: -)
 289 - :x: ResetRetries (type: integer) (units: times)
 290 - :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -)
 291 - :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -)
 292 - :x: StopTransactionOnInvalidId (type: boolean) (units: -)
 293 - :x: StopTxnAlignedData (type: CSL) (units: -)
 294 - :x: StopTxnSampledData (type: CSL) (units: -)
 295 - :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -)
 296 - :x: TransactionMessageAttempts (type: integer) (units: times)
 297 - :x: TransactionMessageRetryInterval (type: integer) (units: seconds)
 298 - :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -)
 299 - :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds)
 300
 301 #### Firmware Management Profile
 302
 303 - *none*
 304
 305 #### Local Auth List Management Profile
 306
 307 - :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
 308 - :x: LocalAuthListMaxLength (type: integer) (units: -)
 309 - :x: SendLocalListMaxLength (type: integer) (units: -)
 310
 311 #### Reservation Profile
 312
 313 - *none*
 314
 315 #### Smart Charging Profile
 316
 317 - :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
 318 - :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
 319 - :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
 320 - :x: MaxChargingProfilesInstalled (type: integer) (units: -)
 321
 322 #### Remote Trigger Profile
 323
 324 - *none*
 325
 326 ## License
 327
 328 This file and all other files in this repository are licensed under the Apache Software License, v.2 and copyrighted under the copyright in [NOTICE](NOTICE) file, except as noted otherwise in the [LICENSE](LICENSE) file or the code source file header.
 329
 330 Please note that Docker images can contain other software which may be licensed under different licenses. This LICENSE and NOTICE files are also included in the Docker image. For any usage of built Docker images please make sure to check the licenses of the artifacts contained in the images.