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 autoReconnectMaxRetries | | -1 (unlimited) | integer | connection retries to the OCPP-J server
  67 reconnectExponentialDelay | true/false | false | boolean | connection delay retry to the OCPP-J server
  68 registrationMaxRetries | | -1 (unlimited) | integer | charging stations boot notification retries
  69 enableStatistics | true/false | true | boolean | enable charging stations statistics
  70 beginEndMeterValues | true/false | false | boolean | enable Transaction.{Begin,End} MeterValues
  71 outOfOrderEndMeterValues | true/false | false | boolean | send Transaction.End MeterValues out of order
  72 meteringPerTransaction | true/false | true | boolean | disable metering on a per transaction basis
  73 transactionDataMeterValues | true/false | false | boolean | enable transaction data MeterValues at stop transaction
  74 Configuration | | | ChargingStationConfiguration | charging stations OCPP configuration parameters
  75 AutomaticTransactionGenerator | | | AutomaticTransactionGenerator | charging stations ATG configuration
  76 Connectors | | | Connectors | charging stations connectors configuration
  77
  78 #### Configuration section
  79
  80 ```json
  81   "Configuration": {
  82     "configurationKey": [
  83        ...
  84        {
  85         "key": "StandardKey",
  86         "readonly": false,
  87         "value": "StandardValue",
  88         "visible": true,
  89         "reboot": false
  90       },
  91       ...
  92       {
  93         "key": "VendorKey",
  94         "readonly": false,
  95         "value": "VendorValue",
  96         "visible": false,
  97         "reboot": true
  98       },
  99       ...
 100     ]
 101   }
 102 ```
 103
 104 #### AutomaticTransactionGenerator section
 105
 106 ```json
 107   "AutomaticTransactionGenerator": {
 108     "enable": false,
 109     "minDuration": 60,
 110     "maxDuration": 80,
 111     "minDelayBetweenTwoTransactions": 15,
 112     "maxDelayBetweenTwoTransactions": 30,
 113     "probabilityOfStart": 1,
 114     "stopAfterHours": 0.3,
 115     "stopOnConnectionFailure": true,
 116     "requireAuthorize": true
 117   }
 118 ```
 119 #### Connectors section
 120
 121 ```json
 122   "Connectors": {
 123     "0": {},
 124     "1": {
 125       "bootStatus": "Available",
 126       "MeterValues": [
 127         ...
 128         {
 129           "unit": "A",
 130           "measurand": "Current.Import"
 131         },
 132         ...
 133         {
 134           "unit": "Wh"
 135         },
 136         ...
 137       ]
 138     }
 139   },
 140 ```
 141
 142 ## Start
 143
 144 To start the program, run: `npm start`.
 145
 146 ## Docker
 147
 148 In the [docker](./docker) folder:
 149
 150 ```bash
 151 make
 152 ```
 153
 154 Or without the optional git submodules:
 155
 156 ```bash
 157 make SUBMODULES_INIT=false
 158 ```
 159
 160 ## OCPP-J commands supported
 161
 162 ### Version 1.6
 163
 164 #### Core Profile
 165
 166 - :white_check_mark: Authorize
 167 - :white_check_mark: BootNotification
 168 - :white_check_mark: ChangeAvailability
 169 - :white_check_mark: ChangeConfiguration
 170 - :white_check_mark: ClearCache
 171 - :x: DataTransfer
 172 - :white_check_mark: GetConfiguration
 173 - :white_check_mark: Heartbeat
 174 - :white_check_mark: MeterValues
 175 - :white_check_mark: RemoteStartTransaction
 176 - :white_check_mark: RemoteStopTransaction
 177 - :white_check_mark: Reset
 178 - :white_check_mark: StartTransaction
 179 - :white_check_mark: StatusNotification
 180 - :white_check_mark: StopTransaction
 181 - :white_check_mark: UnlockConnector
 182
 183 #### Firmware Management Profile
 184
 185 - :x: GetDiagnostics
 186 - :x: DiagnosticsStatusNotification
 187 - :x: FirmwareStatusNotification
 188 - :x: UpdateFirmware
 189
 190 #### Local Auth List Management Profile
 191
 192 - :x: GetLocalListVersion
 193 - :x: SendLocalList
 194
 195 #### Reservation Profile
 196
 197 - :x: CancelReservation
 198 - :x: ReserveNow
 199
 200 #### Smart Charging Profile
 201
 202 - :white_check_mark: ClearChargingProfile
 203 - :white_check_mark: GetCompositeSchedule
 204 - :white_check_mark: SetChargingProfile
 205
 206 #### Remote Trigger Profile
 207
 208 - :x: TriggerMessage
 209
 210 ## OCPP-J standard parameters supported
 211
 212 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.
 213
 214 ### Version 1.6
 215
 216 #### Core Profile
 217
 218 - :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -)
 219 - :x: ClockAlignedDataInterval (type: integer) (units: seconds)
 220 - :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds)
 221 - :x: GetConfigurationMaxKeys (type: integer) (units: -)
 222 - :white_check_mark: HeartbeatInterval (type: integer) (units: seconds)
 223 - :x: LocalAuthorizeOffline (type: boolean) (units: -)
 224 - :x: LocalPreAuthorize (type: boolean) (units: -)
 225 - :x: MeterValuesAlignedData (type: CSL) (units: -)
 226 - :white_check_mark: MeterValuesSampledData (type: CSL) (units: -)
 227 - :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds)
 228 - :white_check_mark: NumberOfConnectors (type: integer) (units: -)
 229 - :x: ResetRetries (type: integer) (units: times)
 230 - :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -)
 231 - :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -)
 232 - :x: StopTransactionOnInvalidId (type: boolean) (units: -)
 233 - :x: StopTxnAlignedData (type: CSL) (units: -)
 234 - :x: StopTxnSampledData (type: CSL) (units: -)
 235 - :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -)
 236 - :x: TransactionMessageAttempts (type: integer) (units: times)
 237 - :x: TransactionMessageRetryInterval (type: integer) (units: seconds)
 238 - :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -)
 239 - :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds)
 240
 241 #### Firmware Management Profile
 242
 243 - *none*
 244
 245 #### Local Auth List Management Profile
 246
 247 - :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
 248 - :x: LocalAuthListMaxLength (type: integer) (units: -)
 249 - :x: SendLocalListMaxLength (type: integer) (units: -)
 250
 251 #### Reservation Profile
 252
 253 - *none*
 254
 255 #### Smart Charging Profile
 256
 257 - :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
 258 - :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
 259 - :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
 260 - :x: MaxChargingProfilesInstalled (type: integer) (units: -)
 261
 262 #### Remote Trigger Profile
 263
 264 - *none*
 265
 266 ## License
 267
 268 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.
 269
 270 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.