repositories / e-mobility-charging-stations-simulator.git / blame_incremental
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (non-incremental) | history | HEAD
Add support for random meter serial number
[e-mobility-charging-stations-simulator.git] / README.md
... / ...
CommitLineData
1# [charging-stations-simulator](https://github.com/jerome-benoit/charging-stations-simulator)
2
3## Summary
4
5Simple [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
14choco install -y nodejs-lts
15```
16
17### MacOSX
18
19- [Homebrew](https://brew.sh/):
20
21```shell
22brew install node@16
23```
24
25### GNU/Linux:
26
27- [NodeSource](https://github.com/nodesource/distributions) Node.js Binary Distributions for version 16.X
28
29## Configuration files syntax
30
31All configuration files are in the JSON standard format.
32
33**Configuration files list**:
34
35- charging stations simulator configuration: [src/assets/config.json](src/assets/config.json);
36- charging station configuration templates: [src/assets/station-templates](src/assets/station-templates);
37- charging station configurations: [dist/assets/configurations](dist/assets/configurations);
38- charging station RFID tags lists in [src/assets](src/assets).
39
40The charging stations simulator's configuration parameters must be within the `src/assets/config.json` file. A charging station simulator configuration template file is available at [src/assets/config-template.json](src/assets/config-template.json).
41
42All charging station configuration templates are in the directory [src/assets/station-templates](src/assets/station-templates).
43
44A list of RFID tags must be defined for the automatic transaction generator with a 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).
45
46**Configuration files hierarchy and priority**:
47
481. charging station configuration: [dist/assets/configurations](dist/assets/configurations);
492. charging station configuration template: [src/assets/station-templates](src/assets/station-templates);
503. charging stations simulator configuration: [src/assets/config.json](src/assets/config.json).
51
52The charging stations simulator have an automatic configuration files reload feature at change for:
53
54- charging stations simulator configuration;
55- charging station configuration templates;
56- charging station authorization RFID tags lists.
57
58But 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.
59
60### Charging stations simulator configuration
61
62**src/assets/config.json**:
63
64| Key | Value(s) | Default Value | Value type | Description |
65| -------------------------- | ------------------------------------------------ | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
66| supervisionUrls | | [] | string \| string[] | string or array of global connection URIs to OCPP-J servers |
67| supervisionUrlDistribution | round-robin/random/sequential | round-robin | boolean | supervision urls distribution policy to simulated charging stations |
68| workerProcess | workerSet/staticPool/dynamicPool | workerSet | string | worker threads process type |
69| workerStartDelay | | 500 | integer | milliseconds to wait at worker threads startup (only for workerSet threads process type) |
70| elementStartDelay | | 0 | integer | milliseconds to wait at charging station startup |
71| workerPoolMinSize | | 4 | integer | worker threads pool minimum number of threads |
72| workerPoolMaxSize | | 16 | integer | worker threads pool maximum number of threads |
73| 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 |
74| chargingStationsPerWorker | | 1 | integer | number of charging stations per worker threads for the `workerSet` process type |
75| logStatisticsInterval | | 60 | integer | seconds between charging stations statistics output in the logs |
76| logConsole | true/false | false | boolean | output logs on the console |
77| logFormat | | simple | string | winston log format |
78| logRotate | true/false | true | boolean | enable daily log files rotation |
79| logMaxFiles | | 7 | integer | maximum number of log files to keep |
80| logLevel | emerg/alert/crit/error/warning/notice/info/debug | info | string | winston logging level |
81| logFile | | combined.log | string | log file relative path |
82| logErrorFile | | error.log | string | error log file relative path |
83| uiWebSocketServer | | { "enabled": true, "options": { "host: "localhost", "port": 8080 } } | { enabled: boolean; options: ServerOptions; } | UI WebSocket server configuration section |
84| performanceStorage | | { "enabled": false, "type": "jsonfile", "file:///performanceRecords.json" } | { enabled: boolean; type: string; URI: string; } where type can be 'jsonfile' or 'mongodb' | performance storage configuration section |
85| stationTemplateUrls | | {}[] | { file: string; numberOfStations: number; }[] | array of charging station configuration templates URIs configuration section (charging station configuration template file name and number of stations) |
86
87#### Worker process model:
88
89- **workerSet**:
90 Worker set executing each a static number (chargingStationsPerWorker) of simulated charging stations from the total
91
92- **staticPool**:
93 Statically sized worker pool executing a static total number of simulated charging stations
94
95- **dynamicPool**:
96 Dynamically sized worker pool executing a static total number of simulated charging stations
97
98### Charging station configuration template
99
100**src/assets/station-templates/\<name\>.json**:
101
102| Key | Value(s) | Default Value | Value type | Description |
103| --------------------------------- | ---------- | --------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
104| supervisionUrls | | '' | string \| string[] | string or array of connection URIs to OCPP-J servers |
105| supervisionUser | | '' | string | basic HTTP authentication user to OCPP-J server |
106| supervisionPassword | | '' | string | basic HTTP authentication password to OCPP-J server |
107| supervisionUrlOcppConfiguration | true/false | false | boolean | allow supervision URL configuration via a vendor OCPP parameter key |
108| supervisionUrlOcppKey | | 'ConnectionUrl' | string | the vendor string that will be used as a vendor OCPP parameter key to set the supervision URL |
109| ocppVersion | 1.6 | 1.6 | string | OCPP version |
110| ocppProtocol | json | json | string | OCPP protocol |
111| ocppStrictCompliance | true/false | false | boolean | strict adherence to the OCPP version and protocol specifications |
112| ocppPersistentConfiguration | true/false | true | boolean | enable persistent OCPP parameters storage by charging stations 'hashId'. The persistency is ensured by the charging stations configuration files in dist/assets/configurations |
113| wsOptions | | {} | ClientOptions & ClientRequestArgs | [ws](https://github.com/websockets/ws) and node.js [http](https://nodejs.org/api/http.html) clients options intersection |
114| authorizationFile | | '' | string | RFID tags list file relative to src/assets path |
115| baseName | | '' | string | base name to build charging stations id |
116| nameSuffix | | '' | string | name suffix to build charging stations id |
117| fixedName | true/false | false | boolean | use the baseName as the charging stations unique name |
118| chargePointModel | | '' | string | charging stations model |
119| chargePointVendor | | '' | string | charging stations vendor |
120| chargePointSerialNumberPrefix | | '' | string | charge point serial number prefix |
121| chargeBoxSerialNumberPrefix | | '' | string | charge box serial number prefix (deprecated in OCPP 1.6) |
122| firmwareVersion | | '' | string | charging stations firmware version |
123| power | | | float \| float[] | charging stations maximum power value(s) |
124| powerSharedByConnectors | true/false | false | boolean | charging stations power shared by its connectors |
125| powerUnit | W/kW | W | string | charging stations power unit |
126| currentOutType | AC/DC | AC | string | charging stations current out type |
127| voltageOut | | AC:230/DC:400 | integer | charging stations voltage out |
128| numberOfPhases | 0/1/3 | AC:3/DC:0 | integer | charging stations number of phase(s) |
129| numberOfConnectors | | | integer \| integer[] | charging stations number of connector(s) |
130| useConnectorId0 | true/false | true | boolean | use connector id 0 definition from the charging station configuration template |
131| randomConnectors | true/false | false | boolean | randomize runtime connector id affectation from the connector id definition in charging station configuration template |
132| resetTime | | 60 | integer | seconds to wait before the charging stations come back at reset |
133| autoRegister | true/false | false | boolean | set charging stations as registered at boot notification for testing purpose |
134| autoReconnectMaxRetries | | -1 (unlimited) | integer | connection retries to the OCPP-J server |
135| reconnectExponentialDelay | true/false | false | boolean | connection delay retry to the OCPP-J server |
136| registrationMaxRetries | | -1 (unlimited) | integer | charging stations boot notification retries |
137| amperageLimitationOcppKey | | undefined | string | charging stations OCPP parameter key used to set the amperage limit, per phase for each connector on AC and global for DC |
138| amperageLimitationUnit | A/cA/dA/mA | A | string | charging stations amperage limit unit |
139| enableStatistics | true/false | true | boolean | enable charging stations statistics |
140| mayAuthorizeAtRemoteStart | true/false | true | boolean | always send authorize at remote start transaction when AuthorizeRemoteTxRequests is enabled |
141| beginEndMeterValues | true/false | false | boolean | enable Transaction.{Begin,End} MeterValues |
142| outOfOrderEndMeterValues | true/false | false | boolean | send Transaction.End MeterValues out of order. Need to relax OCPP specifications strict compliance ('ocppStrictCompliance' parameter) |
143| meteringPerTransaction | true/false | true | boolean | enable metering history on a per transaction basis |
144| transactionDataMeterValues | true/false | false | boolean | enable transaction data MeterValues at stop transaction |
145| mainVoltageMeterValues | true/false | true | boolean | include charging stations main voltage MeterValues on three phased charging stations |
146| phaseLineToLineVoltageMeterValues | true/false | true | boolean | include charging stations line to line voltage MeterValues on three phased charging stations |
147| Configuration | | | ChargingStationConfiguration | charging stations OCPP parameters configuration section |
148| AutomaticTransactionGenerator | | | AutomaticTransactionGenerator | charging stations ATG configuration section |
149| Connectors | | | Connectors | charging stations connectors configuration section |
150
151#### Configuration section
152
153```json
154 "Configuration": {
155 "configurationKey": [
156 ...
157 {
158 "key": "StandardKey",
159 "readonly": false,
160 "value": "StandardValue",
161 "visible": true,
162 "reboot": false
163 },
164 ...
165 {
166 "key": "VendorKey",
167 "readonly": false,
168 "value": "VendorValue",
169 "visible": false,
170 "reboot": true
171 },
172 ...
173 ]
174 }
175```
176
177#### AutomaticTransactionGenerator section
178
179```json
180 "AutomaticTransactionGenerator": {
181 "enable": false,
182 "minDuration": 60,
183 "maxDuration": 80,
184 "minDelayBetweenTwoTransactions": 15,
185 "maxDelayBetweenTwoTransactions": 30,
186 "probabilityOfStart": 1,
187 "stopAfterHours": 0.3,
188 "stopOnConnectionFailure": true,
189 "requireAuthorize": true
190 }
191```
192
193#### Connectors section
194
195```json
196 "Connectors": {
197 "0": {},
198 "1": {
199 "bootStatus": "Available",
200 "MeterValues": [
201 ...
202 {
203 "unit": "W",
204 "measurand": "Power.Active.Import",
205 "phase": "L1-N",
206 "value": "5000",
207 "fluctuationPercent": "10"
208 },
209 ...
210 {
211 "unit": "A",
212 "measurand": "Current.Import"
213 },
214 ...
215 {
216 "unit": "Wh"
217 },
218 ...
219 ]
220 }
221 },
222```
223
224### Charging station configuration
225
226**dist/assets/configurations/\<hashId\>.json**:
227
228The charging station configuration file is automatically generated at startup from the charging station configuration template file and are persistent.
229
230The charging station configuration file content can be regenerated partially on matching charging station configuration template file changes. The charging station serial number is kept unchanged.
231
232#### stationInfo section
233
234The syntax is similar to charging station configuration template with some added fields like the charging station id (name) and the 'Configuration' section removed.
235
236#### configurationKey section
237
238The syntax is similar to the charging station configuration template 'Configuration' section.
239
240## Start
241
242To start the program, run: `npm start`.
243
244## Docker
245
246In the [docker](./docker) folder:
247
248```bash
249make
250```
251
252Or with the optional git submodules:
253
254```bash
255make SUBMODULES_INIT=true
256```
257
258## OCPP-J commands supported
259
260### Version 1.6
261
262#### Core Profile
263
264- :white_check_mark: Authorize
265- :white_check_mark: BootNotification
266- :white_check_mark: ChangeAvailability
267- :white_check_mark: ChangeConfiguration
268- :white_check_mark: ClearCache
269- :x: DataTransfer
270- :white_check_mark: GetConfiguration
271- :white_check_mark: Heartbeat
272- :white_check_mark: MeterValues
273- :white_check_mark: RemoteStartTransaction
274- :white_check_mark: RemoteStopTransaction
275- :white_check_mark: Reset
276- :white_check_mark: StartTransaction
277- :white_check_mark: StatusNotification
278- :white_check_mark: StopTransaction
279- :white_check_mark: UnlockConnector
280
281#### Firmware Management Profile
282
283- :white_check_mark: GetDiagnostics
284- :white_check_mark: DiagnosticsStatusNotification
285- :x: FirmwareStatusNotification
286- :x: UpdateFirmware
287
288#### Local Auth List Management Profile
289
290- :x: GetLocalListVersion
291- :x: SendLocalList
292
293#### Reservation Profile
294
295- :x: CancelReservation
296- :x: ReserveNow
297
298#### Smart Charging Profile
299
300- :white_check_mark: ClearChargingProfile
301- :x: GetCompositeSchedule
302- :white_check_mark: SetChargingProfile
303
304#### Remote Trigger Profile
305
306- :white_check_mark: TriggerMessage
307
308## OCPP-J standard parameters supported
309
310All kind of OCPP parameters are supported in a charging station configuration or a charging station configuration template file. The list here mention the standard ones also handled automatically in the simulator.
311
312### Version 1.6
313
314#### Core Profile
315
316- :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -)
317- :x: ClockAlignedDataInterval (type: integer) (units: seconds)
318- :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds)
319- :x: GetConfigurationMaxKeys (type: integer) (units: -)
320- :white_check_mark: HeartbeatInterval (type: integer) (units: seconds)
321- :x: LocalAuthorizeOffline (type: boolean) (units: -)
322- :x: LocalPreAuthorize (type: boolean) (units: -)
323- :x: MeterValuesAlignedData (type: CSL) (units: -)
324- :white_check_mark: MeterValuesSampledData (type: CSL) (units: -)
325- :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds)
326- :white_check_mark: NumberOfConnectors (type: integer) (units: -)
327- :x: ResetRetries (type: integer) (units: times)
328- :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -)
329- :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -)
330- :x: StopTransactionOnInvalidId (type: boolean) (units: -)
331- :x: StopTxnAlignedData (type: CSL) (units: -)
332- :x: StopTxnSampledData (type: CSL) (units: -)
333- :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -)
334- :x: TransactionMessageAttempts (type: integer) (units: times)
335- :x: TransactionMessageRetryInterval (type: integer) (units: seconds)
336- :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -)
337- :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds)
338
339#### Firmware Management Profile
340
341- _none_
342
343#### Local Auth List Management Profile
344
345- :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
346- :x: LocalAuthListMaxLength (type: integer) (units: -)
347- :x: SendLocalListMaxLength (type: integer) (units: -)
348
349#### Reservation Profile
350
351- _none_
352
353#### Smart Charging Profile
354
355- :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
356- :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
357- :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
358- :x: MaxChargingProfilesInstalled (type: integer) (units: -)
359
360#### Remote Trigger Profile
361
362- _none_
363
364## License
365
366This 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.
367
368Please 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.
Charging stations simulator mirror - https://github.com/SAP/e-mobility-charging-stations-simulator