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