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