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 ### Global configuration
  47
  48 **src/assets/config.json**:
  49
  50 Key | Value(s) | Default Value | Value type | Description
  51 --- | -------| --------------| ---------- | ------------
  52 supervisionURLs | | [] | string[] |  array of connection URIs to OCPP-J servers
  53 distributeStationsToTenantsEqually | true/false | true | boolean | distribute charging stations uniformly to the OCPP-J servers
  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 performanceStorage | | { "enabled": false, "type": "jsonfile", "file:///performanceMeasurements.json" } | { enabled: string; type: string; URI: string; } where type can be 'jsonfile', 'mysql', 'mariadb', 'sqlite' or 'mongodb' | performance storage configuration section
  69 stationTemplateURLs | | {}[] | { file: string; numberOfStations: number; }[] | array of charging station templates URIs configuration section (template file name and number of stations)
  70
  71 #### Worker process model:
  72
  73 - **workerSet**:
  74   Worker set executing each a static number (chargingStationsPerWorker) of simulated charging stations from the total
  75
  76 - **staticPool**:
  77   Statically sized worker pool executing a static total number of simulated charging stations
  78
  79 - **dynamicPool**:
  80   Dynamically sized worker pool executing a static total number of simulated charging stations
  81
  82 ### Charging station template
  83
  84 Key | Value(s) | Default Value | Value type | Description
  85 --- | -------| --------------| ---------- | ------------
  86 supervisionURL | | '' | string | connection URI to OCPP-J server
  87 supervisionUser | | '' | string | basic HTTP authentication user to OCPP-J server
  88 supervisionPassword | | '' | string | basic HTTP authentication password to OCPP-J server
  89 ocppVersion | 1.6 | 1.6 | string | OCPP version
  90 ocppProtocol | json | json | string | OCPP protocol
  91 authorizationFile | | '' | string | RFID tags list file relative to src/assets path
  92 baseName | | '' | string | base name to build charging stations name
  93 nameSuffix | | '' | string | name suffix to build charging stations name
  94 fixedName | true/false | false | boolean | use the baseName as the charging stations unique name
  95 chargePointModel | | '' | string | charging stations model
  96 chargePointVendor | | '' | string | charging stations vendor
  97 chargeBoxSerialNumberPrefix | | '' | string | charging stations serial number prefix
  98 firmwareVersion | | '' | string | charging stations firmware version
  99 power | | | float\|float[] | charging stations maximum power value(s)
 100 powerSharedByConnectors | true/false | false | boolean | charging stations power shared by its connectors
 101 powerUnit | W/kW | W | string | charging stations power unit
 102 currentOutType | AC/DC | AC | string | charging stations current out type
 103 voltageOut | | AC:230/DC:400 | integer | charging stations voltage out
 104 numberOfPhases | 0/1/3 | AC:3/DC:0 | integer | charging stations number of phase(s)
 105 numberOfConnectors | | | integer\|integer[] | charging stations number of connector(s)
 106 useConnectorId0 | true/false | true | boolean | use connector id 0 definition from the template
 107 randomConnectors | true/false | false | boolean | randomize runtime connector id affectation from the connector id definition in template
 108 resetTime | | 60 | integer | seconds to wait before the charging stations come back at reset
 109 autoRegister | true/false | false | boolean | set the charging station as registered at boot notification for testing purpose
 110 autoReconnectMaxRetries | | -1 (unlimited) | integer | connection retries to the OCPP-J server
 111 reconnectExponentialDelay | true/false | false | boolean | connection delay retry to the OCPP-J server
 112 registrationMaxRetries | | -1 (unlimited) | integer | charging stations boot notification retries
 113 enableStatistics | true/false | true | boolean | enable charging stations statistics
 114 mayAuthorizeAtRemoteStart | true/false | true | boolean | always send authorize at remote start transaction when AuthorizeRemoteTxRequests is enabled
 115 beginEndMeterValues | true/false | false | boolean | enable Transaction.{Begin,End} MeterValues
 116 outOfOrderEndMeterValues | true/false | false | boolean | send Transaction.End MeterValues out of order
 117 meteringPerTransaction | true/false | true | boolean | enable metering history on a per transaction basis
 118 transactionDataMeterValues | true/false | false | boolean | enable transaction data MeterValues at stop transaction
 119 mainVoltageMeterValues | true/false | true | boolean | include charging station main voltage MeterValues on three phased charging stations
 120 phaseLineToLineVoltageMeterValues | true/false | true | boolean | include charging station line to line voltage MeterValues on three phased charging stations
 121 Configuration | | | ChargingStationConfiguration | charging stations OCPP parameters configuration section
 122 AutomaticTransactionGenerator | | | AutomaticTransactionGenerator | charging stations ATG configuration section
 123 Connectors | | | Connectors | charging stations connectors configuration section
 124
 125 #### Configuration section
 126
 127 ```json
 128   "Configuration": {
 129     "configurationKey": [
 130        ...
 131        {
 132         "key": "StandardKey",
 133         "readonly": false,
 134         "value": "StandardValue",
 135         "visible": true,
 136         "reboot": false
 137       },
 138       ...
 139       {
 140         "key": "VendorKey",
 141         "readonly": false,
 142         "value": "VendorValue",
 143         "visible": false,
 144         "reboot": true
 145       },
 146       ...
 147     ]
 148   }
 149 ```
 150
 151 #### AutomaticTransactionGenerator section
 152
 153 ```json
 154   "AutomaticTransactionGenerator": {
 155     "enable": false,
 156     "minDuration": 60,
 157     "maxDuration": 80,
 158     "minDelayBetweenTwoTransactions": 15,
 159     "maxDelayBetweenTwoTransactions": 30,
 160     "probabilityOfStart": 1,
 161     "stopAfterHours": 0.3,
 162     "stopOnConnectionFailure": true,
 163     "requireAuthorize": true
 164   }
 165 ```
 166 #### Connectors section
 167
 168 ```json
 169   "Connectors": {
 170     "0": {},
 171     "1": {
 172       "bootStatus": "Available",
 173       "MeterValues": [
 174         ...
 175         {
 176           "unit": "W",
 177           "measurand": "Power.Active.Import",
 178           "phase": "L1-N",
 179           "value": "5000",
 180           "fluctuationPercent": "10"
 181         },
 182         ...
 183         {
 184           "unit": "A",
 185           "measurand": "Current.Import"
 186         },
 187         ...
 188         {
 189           "unit": "Wh"
 190         },
 191         ...
 192       ]
 193     }
 194   },
 195 ```
 196
 197 ## Start
 198
 199 To start the program, run: `npm start`.
 200
 201 ## Docker
 202
 203 In the [docker](./docker) folder:
 204
 205 ```bash
 206 make
 207 ```
 208
 209 Or without the optional git submodules:
 210
 211 ```bash
 212 make SUBMODULES_INIT=false
 213 ```
 214
 215 ## OCPP-J commands supported
 216
 217 ### Version 1.6
 218
 219 #### Core Profile
 220
 221 - :white_check_mark: Authorize
 222 - :white_check_mark: BootNotification
 223 - :white_check_mark: ChangeAvailability
 224 - :white_check_mark: ChangeConfiguration
 225 - :white_check_mark: ClearCache
 226 - :x: DataTransfer
 227 - :white_check_mark: GetConfiguration
 228 - :white_check_mark: Heartbeat
 229 - :white_check_mark: MeterValues
 230 - :white_check_mark: RemoteStartTransaction
 231 - :white_check_mark: RemoteStopTransaction
 232 - :white_check_mark: Reset
 233 - :white_check_mark: StartTransaction
 234 - :white_check_mark: StatusNotification
 235 - :white_check_mark: StopTransaction
 236 - :white_check_mark: UnlockConnector
 237
 238 #### Firmware Management Profile
 239
 240 - :white_check_mark: GetDiagnostics
 241 - :x: DiagnosticsStatusNotification
 242 - :x: FirmwareStatusNotification
 243 - :x: UpdateFirmware
 244
 245 #### Local Auth List Management Profile
 246
 247 - :x: GetLocalListVersion
 248 - :x: SendLocalList
 249
 250 #### Reservation Profile
 251
 252 - :x: CancelReservation
 253 - :x: ReserveNow
 254
 255 #### Smart Charging Profile
 256
 257 - :white_check_mark: ClearChargingProfile
 258 - :white_check_mark: GetCompositeSchedule
 259 - :white_check_mark: SetChargingProfile
 260
 261 #### Remote Trigger Profile
 262
 263 - :white_check_mark: TriggerMessage
 264
 265 ## OCPP-J standard parameters supported
 266
 267 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.
 268
 269 ### Version 1.6
 270
 271 #### Core Profile
 272
 273 - :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -)
 274 - :x: ClockAlignedDataInterval (type: integer) (units: seconds)
 275 - :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds)
 276 - :x: GetConfigurationMaxKeys (type: integer) (units: -)
 277 - :white_check_mark: HeartbeatInterval (type: integer) (units: seconds)
 278 - :x: LocalAuthorizeOffline (type: boolean) (units: -)
 279 - :x: LocalPreAuthorize (type: boolean) (units: -)
 280 - :x: MeterValuesAlignedData (type: CSL) (units: -)
 281 - :white_check_mark: MeterValuesSampledData (type: CSL) (units: -)
 282 - :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds)
 283 - :white_check_mark: NumberOfConnectors (type: integer) (units: -)
 284 - :x: ResetRetries (type: integer) (units: times)
 285 - :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -)
 286 - :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -)
 287 - :x: StopTransactionOnInvalidId (type: boolean) (units: -)
 288 - :x: StopTxnAlignedData (type: CSL) (units: -)
 289 - :x: StopTxnSampledData (type: CSL) (units: -)
 290 - :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -)
 291 - :x: TransactionMessageAttempts (type: integer) (units: times)
 292 - :x: TransactionMessageRetryInterval (type: integer) (units: seconds)
 293 - :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -)
 294 - :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds)
 295
 296 #### Firmware Management Profile
 297
 298 - *none*
 299
 300 #### Local Auth List Management Profile
 301
 302 - :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
 303 - :x: LocalAuthListMaxLength (type: integer) (units: -)
 304 - :x: SendLocalListMaxLength (type: integer) (units: -)
 305
 306 #### Reservation Profile
 307
 308 - *none*
 309
 310 #### Smart Charging Profile
 311
 312 - :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
 313 - :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
 314 - :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
 315 - :x: MaxChargingProfilesInstalled (type: integer) (units: -)
 316
 317 #### Remote Trigger Profile
 318
 319 - *none*
 320
 321 ## License
 322
 323 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.
 324
 325 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.