Improve code readability
[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@14
23```
24
25### GNU/Linux:
26
27* [NodeSource](https://github.com/nodesource/distributions) Node.js Binary Distributions for version 14.X
28
29## Configuration syntax
30
31All configuration files are in the JSON standard format.
32
33The 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
35All charging station templates are in the directory [src/assets/station-templates](src/assets/station-templates).
36
37A 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
39The charging stations simulator have an automatic configuration files reload feature at change for:
40* main configuration;
41* charging station templates;
42* authorization RFID tags.
43
44But 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.
45
46### Main configuration
47
48**src/assets/config.json**:
49
50Key | Value(s) | Default Value | Value type | Description
51--- | -------| --------------| ---------- | ------------
52supervisionURLs | | [] | string[] | array of connection URIs to OCPP-J servers
53distributeStationsToTenantsEqually | true/false | true | boolean | distribute charging stations uniformly to the OCPP-J servers
54workerProcess | workerSet/staticPool/dynamicPool | workerSet | string | worker threads process type
55workerStartDelay | | 500 | integer | milliseconds to wait at charging station worker threads startup
56workerPoolMinSize | | 4 | integer | worker threads pool minimum number of threads
57workerPoolMaxSize | | 16 | integer | worker threads pool maximum number of threads
58workerPoolStrategy | 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
59chargingStationsPerWorker | | 1 | integer | number of charging stations per worker threads for the `workerSet` process type
60logStatisticsInterval | | 60 | integer | seconds between charging stations statistics output in the logs
61logConsole | true/false | false | boolean | output logs on the console
62logFormat | | simple | string | winston log format
63logRotate | true/false | true | boolean | enable daily log files rotation
64logMaxFiles | | 7 | integer | maximum number of log files to keep
65logLevel | emerg/alert/crit/error/warning/notice/info/debug | info | string | winston logging level
66logFile | | combined.log | string | log file relative path
67logErrorFile | | error.log | string | error log file relative path
68performanceStorage | | { "enabled": false, "type": "jsonfile", "file:///performanceRecords.json" } | { enabled: string; type: string; URI: string; } where type can be 'jsonfile' or 'mongodb' | performance storage configuration section
69stationTemplateURLs | | {}[] | { file: string; numberOfStations: number; }[] | array of charging station templates URIs configuration section (template file name and number of stations)
70
71#### Worker process model:
72
73- **workerSet**:
74 Worker set executing each a static number (chargingStationsPerWorker) of simulated charging stations from the total
75
76- **staticPool**:
77 Statically sized worker pool executing a static total number of simulated charging stations
78
79- **dynamicPool**:
80 Dynamically sized worker pool executing a static total number of simulated charging stations
81
82### Charging station template
83
84Key | Value(s) | Default Value | Value type | Description
85--- | -------| --------------| ---------- | ------------
86supervisionURL | | '' | string | connection URI to OCPP-J server
87supervisionUser | | '' | string | basic HTTP authentication user to OCPP-J server
88supervisionPassword | | '' | string | basic HTTP authentication password to OCPP-J server
89ocppVersion | 1.6 | 1.6 | string | OCPP version
90ocppProtocol | json | json | string | OCPP protocol
91wsOptions | | {} | ClientOptions & ClientRequestArgs | [ws](https://github.com/websockets/ws) and node.js [http](https://nodejs.org/api/http.html) clients options intersection
92authorizationFile | | '' | string | RFID tags list file relative to src/assets path
93baseName | | '' | string | base name to build charging stations name
94nameSuffix | | '' | string | name suffix to build charging stations name
95fixedName | true/false | false | boolean | use the baseName as the charging stations unique name
96chargePointModel | | '' | string | charging stations model
97chargePointVendor | | '' | string | charging stations vendor
98chargeBoxSerialNumberPrefix | | '' | string | charging stations serial number prefix
99firmwareVersion | | '' | string | charging stations firmware version
100power | | | float\|float[] | charging stations maximum power value(s)
101powerSharedByConnectors | true/false | false | boolean | charging stations power shared by its connectors
102powerUnit | W/kW | W | string | charging stations power unit
103currentOutType | AC/DC | AC | string | charging stations current out type
104voltageOut | | AC:230/DC:400 | integer | charging stations voltage out
105numberOfPhases | 0/1/3 | AC:3/DC:0 | integer | charging stations number of phase(s)
106numberOfConnectors | | | integer\|integer[] | charging stations number of connector(s)
107useConnectorId0 | true/false | true | boolean | use connector id 0 definition from the template
108randomConnectors | true/false | false | boolean | randomize runtime connector id affectation from the connector id definition in template
109resetTime | | 60 | integer | seconds to wait before the charging stations come back at reset
110autoRegister | true/false | false | boolean | set the charging station as registered at boot notification for testing purpose
111autoReconnectMaxRetries | | -1 (unlimited) | integer | connection retries to the OCPP-J server
112reconnectExponentialDelay | true/false | false | boolean | connection delay retry to the OCPP-J server
113registrationMaxRetries | | -1 (unlimited) | integer | charging stations boot notification retries
114enableStatistics | true/false | true | boolean | enable charging stations statistics
115mayAuthorizeAtRemoteStart | true/false | true | boolean | always send authorize at remote start transaction when AuthorizeRemoteTxRequests is enabled
116beginEndMeterValues | true/false | false | boolean | enable Transaction.{Begin,End} MeterValues
117outOfOrderEndMeterValues | true/false | false | boolean | send Transaction.End MeterValues out of order
118meteringPerTransaction | true/false | true | boolean | enable metering history on a per transaction basis
119transactionDataMeterValues | true/false | false | boolean | enable transaction data MeterValues at stop transaction
120mainVoltageMeterValues | true/false | true | boolean | include charging station main voltage MeterValues on three phased charging stations
121phaseLineToLineVoltageMeterValues | true/false | true | boolean | include charging station line to line voltage MeterValues on three phased charging stations
122Configuration | | | ChargingStationConfiguration | charging stations OCPP parameters configuration section
123AutomaticTransactionGenerator | | | AutomaticTransactionGenerator | charging stations ATG configuration section
124Connectors | | | Connectors | charging stations connectors configuration section
125
126#### Configuration section
127
128```json
129 "Configuration": {
130 "configurationKey": [
131 ...
132 {
133 "key": "StandardKey",
134 "readonly": false,
135 "value": "StandardValue",
136 "visible": true,
137 "reboot": false
138 },
139 ...
140 {
141 "key": "VendorKey",
142 "readonly": false,
143 "value": "VendorValue",
144 "visible": false,
145 "reboot": true
146 },
147 ...
148 ]
149 }
150```
151
152#### AutomaticTransactionGenerator section
153
154```json
155 "AutomaticTransactionGenerator": {
156 "enable": false,
157 "minDuration": 60,
158 "maxDuration": 80,
159 "minDelayBetweenTwoTransactions": 15,
160 "maxDelayBetweenTwoTransactions": 30,
161 "probabilityOfStart": 1,
162 "stopAfterHours": 0.3,
163 "stopOnConnectionFailure": true,
164 "requireAuthorize": true
165 }
166```
167#### Connectors section
168
169```json
170 "Connectors": {
171 "0": {},
172 "1": {
173 "bootStatus": "Available",
174 "MeterValues": [
175 ...
176 {
177 "unit": "W",
178 "measurand": "Power.Active.Import",
179 "phase": "L1-N",
180 "value": "5000",
181 "fluctuationPercent": "10"
182 },
183 ...
184 {
185 "unit": "A",
186 "measurand": "Current.Import"
187 },
188 ...
189 {
190 "unit": "Wh"
191 },
192 ...
193 ]
194 }
195 },
196```
197
198## Start
199
200To start the program, run: `npm start`.
201
202## Docker
203
204In the [docker](./docker) folder:
205
206```bash
207make
208```
209
210Or with the optional git submodules:
211
212```bash
213make SUBMODULES_INIT=true
214```
215
216## OCPP-J commands supported
217
218### Version 1.6
219
220#### Core Profile
221
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
227- :x: DataTransfer
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
238
239#### Firmware Management Profile
240
241- :white_check_mark: GetDiagnostics
242- :white_check_mark: DiagnosticsStatusNotification
243- :x: FirmwareStatusNotification
244- :x: UpdateFirmware
245
246#### Local Auth List Management Profile
247
248- :x: GetLocalListVersion
249- :x: SendLocalList
250
251#### Reservation Profile
252
253- :x: CancelReservation
254- :x: ReserveNow
255
256#### Smart Charging Profile
257
258- :white_check_mark: ClearChargingProfile
259- :white_check_mark: GetCompositeSchedule
260- :white_check_mark: SetChargingProfile
261
262#### Remote Trigger Profile
263
264- :white_check_mark: TriggerMessage
265
266## OCPP-J standard parameters supported
267
268All kind of OCPP parameters are supported in a charging station template. The list here mention the standard ones also handled automatically in the simulator.
269
270### Version 1.6
271
272#### Core Profile
273
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)
296
297#### Firmware Management Profile
298
299- *none*
300
301#### Local Auth List Management Profile
302
303- :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
304- :x: LocalAuthListMaxLength (type: integer) (units: -)
305- :x: SendLocalListMaxLength (type: integer) (units: -)
306
307#### Reservation Profile
308
309- *none*
310
311#### Smart Charging Profile
312
313- :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
314- :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
315- :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
316- :x: MaxChargingProfilesInstalled (type: integer) (units: -)
317
318#### Remote Trigger Profile
319
320- *none*
321
322## License
323
324This 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.
325
326Please 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.