1 # [charging-stations-simulator](https://github.com/jerome-benoit/charging-stations-simulator)
5 Simple [node.js](https://nodejs.org/) program to simulate a set of charging stations based on the OCPP-J 1.6 protocol.
11 * [Chocolatey](https://chocolatey.org/):
14 choco install -y nodejs-lts
19 * [Homebrew](https://brew.sh/):
27 * [NodeSource](https://github.com/nodesource/distributions) Node.js Binary Distributions for version 14.X
29 ## Configuration syntax
31 All configuration files are in the JSON standard format.
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).
35 All charging station templates are in the directory [src/assets/station-templates](src/assets/station-templates).
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).
39 The charging stations simulator have an automatic configuration files reload feature at change for:
41 * charging station templates;
42 * authorization RFID tags.
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.
46 ### Main configuration
48 **src/assets/config.json**:
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:///performanceRecords.json" } | { enabled: string; type: string; URI: string; } where type can be 'jsonfile' 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)
71 #### Worker process model:
74 Worker set executing each a static number (chargingStationsPerWorker) of simulated charging stations from the total
77 Statically sized worker pool executing a static total number of simulated charging stations
80 Dynamically sized worker pool executing a static total number of simulated charging stations
82 ### Charging station template
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 wsOptions | | {} | ClientOptions & ClientRequestArgs | [ws](https://github.com/websockets/ws) and node.js [http](https://nodejs.org/api/http.html) clients options intersection
92 authorizationFile | | '' | string | RFID tags list file relative to src/assets path
93 baseName | | '' | string | base name to build charging stations name
94 nameSuffix | | '' | string | name suffix to build charging stations name
95 fixedName | true/false | false | boolean | use the baseName as the charging stations unique name
96 chargePointModel | | '' | string | charging stations model
97 chargePointVendor | | '' | string | charging stations vendor
98 chargeBoxSerialNumberPrefix | | '' | string | charging stations serial number prefix
99 firmwareVersion | | '' | string | charging stations firmware version
100 power | | | float\|float[] | charging stations maximum power value(s)
101 powerSharedByConnectors | true/false | false | boolean | charging stations power shared by its connectors
102 powerUnit | W/kW | W | string | charging stations power unit
103 currentOutType | AC/DC | AC | string | charging stations current out type
104 voltageOut | | AC:230/DC:400 | integer | charging stations voltage out
105 numberOfPhases | 0/1/3 | AC:3/DC:0 | integer | charging stations number of phase(s)
106 numberOfConnectors | | | integer\|integer[] | charging stations number of connector(s)
107 useConnectorId0 | true/false | true | boolean | use connector id 0 definition from the template
108 randomConnectors | true/false | false | boolean | randomize runtime connector id affectation from the connector id definition in template
109 resetTime | | 60 | integer | seconds to wait before the charging stations come back at reset
110 autoRegister | true/false | false | boolean | set the charging station as registered at boot notification for testing purpose
111 autoReconnectMaxRetries | | -1 (unlimited) | integer | connection retries to the OCPP-J server
112 reconnectExponentialDelay | true/false | false | boolean | connection delay retry to the OCPP-J server
113 registrationMaxRetries | | -1 (unlimited) | integer | charging stations boot notification retries
114 enableStatistics | true/false | true | boolean | enable charging stations statistics
115 mayAuthorizeAtRemoteStart | true/false | true | boolean | always send authorize at remote start transaction when AuthorizeRemoteTxRequests is enabled
116 beginEndMeterValues | true/false | false | boolean | enable Transaction.{Begin,End} MeterValues
117 outOfOrderEndMeterValues | true/false | false | boolean | send Transaction.End MeterValues out of order
118 meteringPerTransaction | true/false | true | boolean | enable metering history on a per transaction basis
119 transactionDataMeterValues | true/false | false | boolean | enable transaction data MeterValues at stop transaction
120 mainVoltageMeterValues | true/false | true | boolean | include charging station main voltage MeterValues on three phased charging stations
121 phaseLineToLineVoltageMeterValues | true/false | true | boolean | include charging station line to line voltage MeterValues on three phased charging stations
122 Configuration | | | ChargingStationConfiguration | charging stations OCPP parameters configuration section
123 AutomaticTransactionGenerator | | | AutomaticTransactionGenerator | charging stations ATG configuration section
124 Connectors | | | Connectors | charging stations connectors configuration section
126 #### Configuration section
130 "configurationKey": [
133 "key": "StandardKey",
135 "value": "StandardValue",
143 "value": "VendorValue",
152 #### AutomaticTransactionGenerator section
155 "AutomaticTransactionGenerator": {
159 "minDelayBetweenTwoTransactions": 15,
160 "maxDelayBetweenTwoTransactions": 30,
161 "probabilityOfStart": 1,
162 "stopAfterHours": 0.3,
163 "stopOnConnectionFailure": true,
164 "requireAuthorize": true
167 #### Connectors section
173 "bootStatus": "Available",
178 "measurand": "Power.Active.Import",
181 "fluctuationPercent": "10"
186 "measurand": "Current.Import"
200 To start the program, run: `npm start`.
204 In the [docker](./docker) folder:
210 Or with the optional git submodules:
213 make SUBMODULES_INIT=true
216 ## OCPP-J commands supported
222 - :white_check_mark: Authorize
223 - :white_check_mark: BootNotification
224 - :white_check_mark: ChangeAvailability
225 - :white_check_mark: ChangeConfiguration
226 - :white_check_mark: ClearCache
228 - :white_check_mark: GetConfiguration
229 - :white_check_mark: Heartbeat
230 - :white_check_mark: MeterValues
231 - :white_check_mark: RemoteStartTransaction
232 - :white_check_mark: RemoteStopTransaction
233 - :white_check_mark: Reset
234 - :white_check_mark: StartTransaction
235 - :white_check_mark: StatusNotification
236 - :white_check_mark: StopTransaction
237 - :white_check_mark: UnlockConnector
239 #### Firmware Management Profile
241 - :white_check_mark: GetDiagnostics
242 - :white_check_mark: DiagnosticsStatusNotification
243 - :x: FirmwareStatusNotification
246 #### Local Auth List Management Profile
248 - :x: GetLocalListVersion
251 #### Reservation Profile
253 - :x: CancelReservation
256 #### Smart Charging Profile
258 - :white_check_mark: ClearChargingProfile
259 - :white_check_mark: GetCompositeSchedule
260 - :white_check_mark: SetChargingProfile
262 #### Remote Trigger Profile
264 - :white_check_mark: TriggerMessage
266 ## OCPP-J standard parameters supported
268 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.
274 - :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -)
275 - :x: ClockAlignedDataInterval (type: integer) (units: seconds)
276 - :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds)
277 - :x: GetConfigurationMaxKeys (type: integer) (units: -)
278 - :white_check_mark: HeartbeatInterval (type: integer) (units: seconds)
279 - :x: LocalAuthorizeOffline (type: boolean) (units: -)
280 - :x: LocalPreAuthorize (type: boolean) (units: -)
281 - :x: MeterValuesAlignedData (type: CSL) (units: -)
282 - :white_check_mark: MeterValuesSampledData (type: CSL) (units: -)
283 - :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds)
284 - :white_check_mark: NumberOfConnectors (type: integer) (units: -)
285 - :x: ResetRetries (type: integer) (units: times)
286 - :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -)
287 - :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -)
288 - :x: StopTransactionOnInvalidId (type: boolean) (units: -)
289 - :x: StopTxnAlignedData (type: CSL) (units: -)
290 - :x: StopTxnSampledData (type: CSL) (units: -)
291 - :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -)
292 - :x: TransactionMessageAttempts (type: integer) (units: times)
293 - :x: TransactionMessageRetryInterval (type: integer) (units: seconds)
294 - :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -)
295 - :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds)
297 #### Firmware Management Profile
301 #### Local Auth List Management Profile
303 - :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
304 - :x: LocalAuthListMaxLength (type: integer) (units: -)
305 - :x: SendLocalListMaxLength (type: integer) (units: -)
307 #### Reservation Profile
311 #### Smart Charging Profile
313 - :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
314 - :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
315 - :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
316 - :x: MaxChargingProfilesInstalled (type: integer) (units: -)
318 #### Remote Trigger Profile
324 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.
326 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.