Commit | Line | Data |
---|---|---|
ae8ee665 | 1 | # [charging-stations-simulator](https://github.com/jerome-benoit/charging-stations-simulator) |
7dde0b73 JB |
2 | |
3 | ## Summary | |
4 | ||
1eabf6a9 | 5 | Simple [node.js](https://nodejs.org/) program to simulate a set of charging stations based on the OCPP-J 1.6 protocol. |
7dde0b73 | 6 | |
696ce53a JB |
7 | ## Prerequisites |
8 | ||
9 | ### Windows | |
10 | ||
e7aeea18 | 11 | - [Chocolatey](https://chocolatey.org/): |
696ce53a JB |
12 | |
13 | ```powershell | |
14 | choco install -y nodejs-lts | |
15 | ``` | |
16 | ||
17 | ### MacOSX | |
18 | ||
e7aeea18 | 19 | - [Homebrew](https://brew.sh/): |
696ce53a JB |
20 | |
21 | ```shell | |
8f3d04b0 | 22 | brew install node@16 |
696ce53a JB |
23 | ``` |
24 | ||
e7aeea18 | 25 | ### GNU/Linux: |
511780c3 | 26 | |
11d8f3e9 | 27 | - [NodeSource](https://github.com/nodesource/distributions) Node.js Binary Distributions for version 16.X |
511780c3 | 28 | |
2c28fc83 JB |
29 | ## Configuration syntax |
30 | ||
e7aeea18 | 31 | All configuration files are in the JSON standard format. |
2c28fc83 | 32 | |
511780c3 | 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). |
2c28fc83 JB |
34 | |
35 | All charging station templates are in the directory [src/assets/station-templates](src/assets/station-templates). | |
36 | ||
511780c3 JB |
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 | ||
e7aeea18 | 39 | The charging stations simulator have an automatic configuration files reload feature at change for: |
511780c3 | 40 | |
e7aeea18 JB |
41 | - main configuration; |
42 | - charging station templates; | |
43 | - authorization RFID tags. | |
2c28fc83 | 44 | |
e7aeea18 JB |
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 | |
2c28fc83 | 48 | |
b1d6e944 | 49 | **src/assets/config.json**: |
2c28fc83 | 50 | |
e7aeea18 JB |
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: | |
a6b3c6c3 JB |
75 | |
76 | - **workerSet**: | |
77 | Worker set executing each a static number (chargingStationsPerWorker) of simulated charging stations from the total | |
78 | ||
79 | - **staticPool**: | |
e7aeea18 | 80 | Statically sized worker pool executing a static total number of simulated charging stations |
a6b3c6c3 JB |
81 | |
82 | - **dynamicPool**: | |
e7aeea18 | 83 | Dynamically sized worker pool executing a static total number of simulated charging stations |
a6b3c6c3 | 84 | |
2c28fc83 | 85 | ### Charging station template |
2e6e52f3 | 86 | |
e7aeea18 JB |
87 | | Key | Value(s) | Default Value | Value type | Description | |
88 | | --------------------------------- | ---------- | --------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | | |
d2971a4b | 89 | | supervisionUrls | | '' | string \| string[] | string or array of connection URIs to OCPP-J servers. It has priority over the global configuration parameter | |
e7aeea18 JB |
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 | true | boolean | Strict adherence to the OCPP version and protocol specifications | | |
97 | | wsOptions | | {} | ClientOptions & ClientRequestArgs | [ws](https://github.com/websockets/ws) and node.js [http](https://nodejs.org/api/http.html) clients options intersection | | |
98 | | authorizationFile | | '' | string | RFID tags list file relative to src/assets path | | |
99 | | baseName | | '' | string | base name to build charging stations name | | |
100 | | nameSuffix | | '' | string | name suffix to build charging stations name | | |
101 | | fixedName | true/false | false | boolean | use the baseName as the charging stations unique name | | |
102 | | chargePointModel | | '' | string | charging stations model | | |
103 | | chargePointVendor | | '' | string | charging stations vendor | | |
104 | | chargeBoxSerialNumberPrefix | | '' | string | charging stations serial number prefix | | |
105 | | firmwareVersion | | '' | string | charging stations firmware version | | |
d2971a4b | 106 | | power | | | float \| float[] | charging stations maximum power value(s) | |
e7aeea18 JB |
107 | | powerSharedByConnectors | true/false | false | boolean | charging stations power shared by its connectors | |
108 | | powerUnit | W/kW | W | string | charging stations power unit | | |
109 | | currentOutType | AC/DC | AC | string | charging stations current out type | | |
110 | | voltageOut | | AC:230/DC:400 | integer | charging stations voltage out | | |
111 | | numberOfPhases | 0/1/3 | AC:3/DC:0 | integer | charging stations number of phase(s) | | |
d2971a4b | 112 | | numberOfConnectors | | | integer \| integer[] | charging stations number of connector(s) | |
e7aeea18 JB |
113 | | useConnectorId0 | true/false | true | boolean | use connector id 0 definition from the template | |
114 | | randomConnectors | true/false | false | boolean | randomize runtime connector id affectation from the connector id definition in template | | |
115 | | resetTime | | 60 | integer | seconds to wait before the charging stations come back at reset | | |
116 | | autoRegister | true/false | false | boolean | set the charging station as registered at boot notification for testing purpose | | |
117 | | autoReconnectMaxRetries | | -1 (unlimited) | integer | connection retries to the OCPP-J server | | |
118 | | reconnectExponentialDelay | true/false | false | boolean | connection delay retry to the OCPP-J server | | |
119 | | registrationMaxRetries | | -1 (unlimited) | integer | charging stations boot notification retries | | |
120 | | enableStatistics | true/false | true | boolean | enable charging stations statistics | | |
121 | | mayAuthorizeAtRemoteStart | true/false | true | boolean | always send authorize at remote start transaction when AuthorizeRemoteTxRequests is enabled | | |
122 | | beginEndMeterValues | true/false | false | boolean | enable Transaction.{Begin,End} MeterValues | | |
123 | | outOfOrderEndMeterValues | true/false | false | boolean | send Transaction.End MeterValues out of order. Need to relax OCPP specifications strict compliance ('ocppStrictCompliance' parameter) | | |
124 | | meteringPerTransaction | true/false | true | boolean | enable metering history on a per transaction basis | | |
125 | | transactionDataMeterValues | true/false | false | boolean | enable transaction data MeterValues at stop transaction | | |
126 | | mainVoltageMeterValues | true/false | true | boolean | include charging station main voltage MeterValues on three phased charging stations | | |
127 | | phaseLineToLineVoltageMeterValues | true/false | true | boolean | include charging station line to line voltage MeterValues on three phased charging stations | | |
128 | | Configuration | | | ChargingStationConfiguration | charging stations OCPP parameters configuration section | | |
129 | | AutomaticTransactionGenerator | | | AutomaticTransactionGenerator | charging stations ATG configuration section | | |
130 | | Connectors | | | Connectors | charging stations connectors configuration section | | |
c94a349a JB |
131 | |
132 | #### Configuration section | |
133 | ||
134 | ```json | |
0302da79 | 135 | "Configuration": { |
c94a349a JB |
136 | "configurationKey": [ |
137 | ... | |
138 | { | |
139 | "key": "StandardKey", | |
140 | "readonly": false, | |
141 | "value": "StandardValue", | |
142 | "visible": true, | |
143 | "reboot": false | |
144 | }, | |
145 | ... | |
146 | { | |
147 | "key": "VendorKey", | |
148 | "readonly": false, | |
149 | "value": "VendorValue", | |
150 | "visible": false, | |
151 | "reboot": true | |
152 | }, | |
153 | ... | |
154 | ] | |
155 | } | |
156 | ``` | |
157 | ||
158 | #### AutomaticTransactionGenerator section | |
159 | ||
160 | ```json | |
0302da79 | 161 | "AutomaticTransactionGenerator": { |
c94a349a JB |
162 | "enable": false, |
163 | "minDuration": 60, | |
164 | "maxDuration": 80, | |
165 | "minDelayBetweenTwoTransactions": 15, | |
166 | "maxDelayBetweenTwoTransactions": 30, | |
167 | "probabilityOfStart": 1, | |
168 | "stopAfterHours": 0.3, | |
169 | "stopOnConnectionFailure": true, | |
e644918b | 170 | "requireAuthorize": true |
c94a349a JB |
171 | } |
172 | ``` | |
e7aeea18 | 173 | |
c94a349a JB |
174 | #### Connectors section |
175 | ||
176 | ```json | |
0302da79 | 177 | "Connectors": { |
c94a349a JB |
178 | "0": {}, |
179 | "1": { | |
180 | "bootStatus": "Available", | |
181 | "MeterValues": [ | |
9bd87386 JB |
182 | ... |
183 | { | |
184 | "unit": "W", | |
185 | "measurand": "Power.Active.Import", | |
186 | "phase": "L1-N", | |
187 | "value": "5000", | |
188 | "fluctuationPercent": "10" | |
189 | }, | |
c94a349a JB |
190 | ... |
191 | { | |
192 | "unit": "A", | |
193 | "measurand": "Current.Import" | |
194 | }, | |
195 | ... | |
196 | { | |
197 | "unit": "Wh" | |
198 | }, | |
199 | ... | |
200 | ] | |
201 | } | |
202 | }, | |
203 | ``` | |
204 | ||
6f0ec20e JB |
205 | ## Start |
206 | ||
207 | To start the program, run: `npm start`. | |
208 | ||
209 | ## Docker | |
210 | ||
211 | In the [docker](./docker) folder: | |
212 | ||
213 | ```bash | |
214 | make | |
215 | ``` | |
216 | ||
bfcad885 | 217 | Or with the optional git submodules: |
6f0ec20e JB |
218 | |
219 | ```bash | |
bfcad885 | 220 | make SUBMODULES_INIT=true |
6f0ec20e JB |
221 | ``` |
222 | ||
223 | ## OCPP-J commands supported | |
c94a349a JB |
224 | |
225 | ### Version 1.6 | |
226 | ||
c56d42f1 | 227 | #### Core Profile |
6f0ec20e | 228 | |
778f7924 JB |
229 | - :white_check_mark: Authorize |
230 | - :white_check_mark: BootNotification | |
231 | - :white_check_mark: ChangeAvailability | |
232 | - :white_check_mark: ChangeConfiguration | |
233 | - :white_check_mark: ClearCache | |
9e1b12e4 | 234 | - :x: DataTransfer |
778f7924 JB |
235 | - :white_check_mark: GetConfiguration |
236 | - :white_check_mark: Heartbeat | |
237 | - :white_check_mark: MeterValues | |
238 | - :white_check_mark: RemoteStartTransaction | |
239 | - :white_check_mark: RemoteStopTransaction | |
240 | - :white_check_mark: Reset | |
241 | - :white_check_mark: StartTransaction | |
242 | - :white_check_mark: StatusNotification | |
243 | - :white_check_mark: StopTransaction | |
244 | - :white_check_mark: UnlockConnector | |
6f0ec20e | 245 | |
c56d42f1 | 246 | #### Firmware Management Profile |
6f0ec20e | 247 | |
b652b0c3 | 248 | - :white_check_mark: GetDiagnostics |
d50343bd | 249 | - :white_check_mark: DiagnosticsStatusNotification |
9e1b12e4 JB |
250 | - :x: FirmwareStatusNotification |
251 | - :x: UpdateFirmware | |
6f0ec20e | 252 | |
c56d42f1 | 253 | #### Local Auth List Management Profile |
6f0ec20e | 254 | |
9e1b12e4 JB |
255 | - :x: GetLocalListVersion |
256 | - :x: SendLocalList | |
6f0ec20e | 257 | |
c56d42f1 | 258 | #### Reservation Profile |
6f0ec20e | 259 | |
9e1b12e4 JB |
260 | - :x: CancelReservation |
261 | - :x: ReserveNow | |
6f0ec20e | 262 | |
c56d42f1 | 263 | #### Smart Charging Profile |
6f0ec20e | 264 | |
778f7924 JB |
265 | - :white_check_mark: ClearChargingProfile |
266 | - :white_check_mark: GetCompositeSchedule | |
267 | - :white_check_mark: SetChargingProfile | |
6f0ec20e | 268 | |
c56d42f1 | 269 | #### Remote Trigger Profile |
6f0ec20e | 270 | |
802cfa13 | 271 | - :white_check_mark: TriggerMessage |
7dde0b73 | 272 | |
7e1dc878 JB |
273 | ## OCPP-J standard parameters supported |
274 | ||
e7aeea18 | 275 | 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. |
7e1dc878 JB |
276 | |
277 | ### Version 1.6 | |
278 | ||
c56d42f1 | 279 | #### Core Profile |
7e1dc878 JB |
280 | |
281 | - :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -) | |
282 | - :x: ClockAlignedDataInterval (type: integer) (units: seconds) | |
291cb255 | 283 | - :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds) |
7e1dc878 JB |
284 | - :x: GetConfigurationMaxKeys (type: integer) (units: -) |
285 | - :white_check_mark: HeartbeatInterval (type: integer) (units: seconds) | |
286 | - :x: LocalAuthorizeOffline (type: boolean) (units: -) | |
287 | - :x: LocalPreAuthorize (type: boolean) (units: -) | |
288 | - :x: MeterValuesAlignedData (type: CSL) (units: -) | |
289 | - :white_check_mark: MeterValuesSampledData (type: CSL) (units: -) | |
290 | - :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds) | |
291 | - :white_check_mark: NumberOfConnectors (type: integer) (units: -) | |
292 | - :x: ResetRetries (type: integer) (units: times) | |
293 | - :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -) | |
294 | - :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -) | |
295 | - :x: StopTransactionOnInvalidId (type: boolean) (units: -) | |
296 | - :x: StopTxnAlignedData (type: CSL) (units: -) | |
297 | - :x: StopTxnSampledData (type: CSL) (units: -) | |
36f6a92e | 298 | - :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -) |
7e1dc878 JB |
299 | - :x: TransactionMessageAttempts (type: integer) (units: times) |
300 | - :x: TransactionMessageRetryInterval (type: integer) (units: seconds) | |
301 | - :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -) | |
36f6a92e | 302 | - :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds) |
7e1dc878 | 303 | |
c56d42f1 | 304 | #### Firmware Management Profile |
7e1dc878 | 305 | |
e7aeea18 | 306 | - _none_ |
7e1dc878 | 307 | |
c56d42f1 | 308 | #### Local Auth List Management Profile |
7e1dc878 | 309 | |
36f6a92e | 310 | - :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -) |
7e1dc878 JB |
311 | - :x: LocalAuthListMaxLength (type: integer) (units: -) |
312 | - :x: SendLocalListMaxLength (type: integer) (units: -) | |
313 | ||
c56d42f1 | 314 | #### Reservation Profile |
7e1dc878 | 315 | |
e7aeea18 | 316 | - _none_ |
7e1dc878 | 317 | |
c56d42f1 | 318 | #### Smart Charging Profile |
7e1dc878 JB |
319 | |
320 | - :x: ChargeProfileMaxStackLevel (type: integer) (units: -) | |
321 | - :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -) | |
322 | - :x: ChargingScheduleMaxPeriods (type: integer) (units: -) | |
323 | - :x: MaxChargingProfilesInstalled (type: integer) (units: -) | |
324 | ||
c56d42f1 | 325 | #### Remote Trigger Profile |
7e1dc878 | 326 | |
e7aeea18 | 327 | - _none_ |
7e1dc878 | 328 | |
7dde0b73 JB |
329 | ## License |
330 | ||
25c7bbb9 | 331 | 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. |
7dde0b73 JB |
332 | |
333 | 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. |