README.md

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