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 | | | integer\|integer[] | 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 numberOfPhases | 0/1/3 | AC:3/DC:0 | integer | charging stations number of phase(s)
  61 numberOfConnectors | | | integer\|integer[] | charging stations number of connector(s)
  62 useConnectorId0 | true/false | true | boolean | use connector id 0 definition from the template
  63 randomConnectors | true/false | false | boolean | randomize runtime connector id affectation from the connector id definition in template
  64 resetTime | | 60 | integer | seconds to wait before the charging stations come back at reset
  65 connectionTimeout | | 30 | integer | connection timeout to the OCPP-J server
  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 voltageOut | | AC:230/DC:400 | integer | charging stations voltage out
  71 Configuration | | | ChargingStationConfiguration | charging stations OCPP configuration parameters
  72 AutomaticTransactionGenerator | | | AutomaticTransactionGenerator | charging stations ATG configuration
  73 Connectors | | | Connectors | charging stations connectors configuration
  74
  75 #### Configuration section
  76
  77 ```json
  78   "Configuration": {
  79     "configurationKey": [
  80        ...
  81        {
  82         "key": "StandardKey",
  83         "readonly": false,
  84         "value": "StandardValue",
  85         "visible": true,
  86         "reboot": false
  87       },
  88       ...
  89       {
  90         "key": "VendorKey",
  91         "readonly": false,
  92         "value": "VendorValue",
  93         "visible": false,
  94         "reboot": true
  95       },
  96       ...
  97     ]
  98   }
  99 ```
 100
 101 #### AutomaticTransactionGenerator section
 102
 103 ```json
 104   "AutomaticTransactionGenerator": {
 105     "enable": false,
 106     "minDuration": 60,
 107     "maxDuration": 80,
 108     "minDelayBetweenTwoTransactions": 15,
 109     "maxDelayBetweenTwoTransactions": 30,
 110     "probabilityOfStart": 1,
 111     "stopAfterHours": 0.3,
 112     "stopOnConnectionFailure": true,
 113     "requireAuthorize": false
 114   }
 115 ```
 116 #### Connectors section
 117
 118 ```json
 119   "Connectors": {
 120     "0": {},
 121     "1": {
 122       "bootStatus": "Available",
 123       "MeterValues": [
 124         ...
 125         {
 126           "unit": "A",
 127           "measurand": "Current.Import"
 128         },
 129         ...
 130         {
 131           "unit": "Wh"
 132         },
 133         ...
 134       ]
 135     }
 136   },
 137 ```
 138
 139 ## Start
 140
 141 To start the program, run: `npm start`.
 142
 143 ## Docker
 144
 145 In the [docker](./docker) folder:
 146
 147 ```bash
 148 make
 149 ```
 150
 151 Or without the optional git submodules:
 152
 153 ```bash
 154 make SUBMODULES_INIT=false
 155 ```
 156
 157 ## OCPP-J commands supported
 158
 159 ### Version 1.6
 160
 161 ### Core Profile
 162
 163 - :heavy_check_mark: Authorize
 164 - :heavy_check_mark: BootNotification
 165 - :heavy_check_mark: ChangeAvailability
 166 - :heavy_check_mark: ChangeConfiguration
 167 - :heavy_check_mark: ClearCache
 168 - :x: DataTransfer
 169 - :heavy_check_mark: GetConfiguration
 170 - :heavy_check_mark: Heartbeat
 171 - :heavy_check_mark: MeterValues
 172 - :heavy_check_mark: RemoteStartTransaction
 173 - :heavy_check_mark: RemoteStopTransaction
 174 - :heavy_check_mark: Reset
 175 - :heavy_check_mark: StartTransaction
 176 - :heavy_check_mark: StatusNotification
 177 - :heavy_check_mark: StopTransaction
 178 - :heavy_check_mark: UnlockConnector
 179
 180 ### Firmware Management Profile
 181
 182 - :x: GetDiagnostics
 183 - :x: DiagnosticsStatusNotification
 184 - :x: FirmwareStatusNotification
 185 - :x: UpdateFirmware
 186
 187 ### Local Auth List Management Profile
 188
 189 - :x: GetLocalListVersion
 190 - :x: SendLocalList
 191
 192 ### Reservation Profile
 193
 194 - :x: CancelReservation
 195 - :x: ReserveNow
 196
 197 ### Smart Charging Profile
 198
 199 - :heavy_check_mark: ClearChargingProfile
 200 - :heavy_check_mark: GetCompositeSchedule
 201 - :heavy_check_mark: SetChargingProfile
 202
 203 ### Remote Trigger Profile
 204
 205 - :x: TriggerMessage
 206
 207 ## License
 208
 209 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.
 210
 211 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.