repositories / e-mobility-charging-stations-simulator.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Change repo URI to SAP one
[e-mobility-charging-stations-simulator.git] / README.md
1 # [emobility-charging-stations-simulator](https://github.com/sap/emobility-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 files syntax
30
31 All 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: [src/assets](src/assets).
39
40 The 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
42 All charging station configuration templates are in the directory [src/assets/station-templates](src/assets/station-templates).
43
44 A 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
48 1. charging station configuration: [dist/assets/configurations](dist/assets/configurations);
49 2. charging station configuration template: [src/assets/station-templates](src/assets/station-templates);
50 3. charging stations simulator configuration: [src/assets/config.json](src/assets/config.json).
51
52 The 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
58 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.
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 | uiServer | | { "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 | customValueLimitationMeterValues | true/false | true | boolean | enable limitation on custom fluctuated value in MeterValues |
148 | Configuration | | | ChargingStationConfiguration | charging stations OCPP parameters configuration section |
149 | AutomaticTransactionGenerator | | | AutomaticTransactionGenerator | charging stations ATG configuration section |
150 | Connectors | | | Connectors | charging stations connectors configuration section |
151
152 #### Configuration section
153
154 ```json
155 "Configuration": {
156 "configurationKey": [
157 ...
158 {
159 "key": "StandardKey",
160 "readonly": false,
161 "value": "StandardValue",
162 "visible": true,
163 "reboot": false
164 },
165 ...
166 {
167 "key": "VendorKey",
168 "readonly": false,
169 "value": "VendorValue",
170 "visible": false,
171 "reboot": true
172 },
173 ...
174 ]
175 }
176 ```
177
178 #### AutomaticTransactionGenerator section
179
180 ```json
181 "AutomaticTransactionGenerator": {
182 "enable": false,
183 "minDuration": 60,
184 "maxDuration": 80,
185 "minDelayBetweenTwoTransactions": 15,
186 "maxDelayBetweenTwoTransactions": 30,
187 "probabilityOfStart": 1,
188 "stopAfterHours": 0.3,
189 "stopOnConnectionFailure": true,
190 "requireAuthorize": true
191 }
192 ```
193
194 #### Connectors section
195
196 ```json
197 "Connectors": {
198 "0": {},
199 "1": {
200 "bootStatus": "Available",
201 "MeterValues": [
202 ...
203 {
204 "unit": "W",
205 "measurand": "Power.Active.Import",
206 "phase": "L1-N",
207 "value": "5000",
208 "fluctuationPercent": "10"
209 },
210 ...
211 {
212 "unit": "A",
213 "measurand": "Current.Import"
214 },
215 ...
216 {
217 "unit": "Wh"
218 },
219 ...
220 ]
221 }
222 },
223 ```
224
225 ### Charging station configuration
226
227 **dist/assets/configurations/\<hashId\>.json**:
228
229 The charging station configuration file is automatically generated at startup from the charging station configuration template file and is persistent.
230
231 The 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.
232
233 #### stationInfo section
234
235 The syntax is similar to charging station configuration template with some added fields like the charging station id (name) and the 'Configuration' section removed.
236
237 #### configurationKey section
238
239 The syntax is similar to the charging station configuration template 'Configuration' section.
240
241 ## Start
242
243 To start the program, run: `npm start`.
244
245 To start the program with a UI controller, run: `npm start:server`.
246 Then, start/stop the simulator by going to `https://<hostname:port>` in a browser. Localhost port will default to 8080. For Cloud Foundry, the port is assigned based on the `process.env.PORT` environment variable.
247
248 ## Docker
249
250 In the [docker](./docker) folder:
251
252 ```bash
253 make
254 ```
255
256 Or with the optional git submodules:
257
258 ```bash
259 make SUBMODULES_INIT=true
260 ```
261
262 ## OCPP-J commands supported
263
264 ### Version 1.6
265
266 #### Core Profile
267
268 - :white_check_mark: Authorize
269 - :white_check_mark: BootNotification
270 - :white_check_mark: ChangeAvailability
271 - :white_check_mark: ChangeConfiguration
272 - :white_check_mark: ClearCache
273 - :x: DataTransfer
274 - :white_check_mark: GetConfiguration
275 - :white_check_mark: Heartbeat
276 - :white_check_mark: MeterValues
277 - :white_check_mark: RemoteStartTransaction
278 - :white_check_mark: RemoteStopTransaction
279 - :white_check_mark: Reset
280 - :white_check_mark: StartTransaction
281 - :white_check_mark: StatusNotification
282 - :white_check_mark: StopTransaction
283 - :white_check_mark: UnlockConnector
284
285 #### Firmware Management Profile
286
287 - :white_check_mark: GetDiagnostics
288 - :white_check_mark: DiagnosticsStatusNotification
289 - :x: FirmwareStatusNotification
290 - :x: UpdateFirmware
291
292 #### Local Auth List Management Profile
293
294 - :x: GetLocalListVersion
295 - :x: SendLocalList
296
297 #### Reservation Profile
298
299 - :x: CancelReservation
300 - :x: ReserveNow
301
302 #### Smart Charging Profile
303
304 - :white_check_mark: ClearChargingProfile
305 - :x: GetCompositeSchedule
306 - :white_check_mark: SetChargingProfile
307
308 #### Remote Trigger Profile
309
310 - :white_check_mark: TriggerMessage
311
312 ## OCPP-J standard parameters supported
313
314 All 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.
315
316 ### Version 1.6
317
318 #### Core Profile
319
320 - :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -)
321 - :x: ClockAlignedDataInterval (type: integer) (units: seconds)
322 - :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds)
323 - :x: GetConfigurationMaxKeys (type: integer) (units: -)
324 - :white_check_mark: HeartbeatInterval (type: integer) (units: seconds)
325 - :x: LocalAuthorizeOffline (type: boolean) (units: -)
326 - :x: LocalPreAuthorize (type: boolean) (units: -)
327 - :x: MeterValuesAlignedData (type: CSL) (units: -)
328 - :white_check_mark: MeterValuesSampledData (type: CSL) (units: -)
329 - :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds)
330 - :white_check_mark: NumberOfConnectors (type: integer) (units: -)
331 - :x: ResetRetries (type: integer) (units: times)
332 - :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -)
333 - :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -)
334 - :x: StopTransactionOnInvalidId (type: boolean) (units: -)
335 - :x: StopTxnAlignedData (type: CSL) (units: -)
336 - :x: StopTxnSampledData (type: CSL) (units: -)
337 - :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -)
338 - :x: TransactionMessageAttempts (type: integer) (units: times)
339 - :x: TransactionMessageRetryInterval (type: integer) (units: seconds)
340 - :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -)
341 - :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds)
342
343 #### Firmware Management Profile
344
345 - _none_
346
347 #### Local Auth List Management Profile
348
349 - :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
350 - :x: LocalAuthListMaxLength (type: integer) (units: -)
351 - :x: SendLocalListMaxLength (type: integer) (units: -)
352
353 #### Reservation Profile
354
355 - _none_
356
357 #### Smart Charging Profile
358
359 - :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
360 - :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
361 - :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
362 - :x: MaxChargingProfilesInstalled (type: integer) (units: -)
363
364 #### Remote Trigger Profile
365
366 - _none_
367
368 ## Support, Feedback, Contributing
369
370 This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/emobility-charging-stations-simulator/issues). Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our [Contribution Guidelines](CONTRIBUTING.md).
371
372 ## Code of Conduct
373
374 We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its [Code of Conduct](CODE_OF_CONDUCT.md) at all times.
375
376 ## Licensing
377
378 Copyright 2020-2022 SAP SE or an SAP affiliate company and emobility-charging-stations-simulator contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/emobility-charging-stations-simulator).
Charging stations simulator mirror - https://github.com/SAP/e-mobility-charging-stations-simulator