Commit | Line | Data |
---|---|---|
d6b76da3 | 1 | <!-- markdownlint-disable-file MD033 MD024 --> |
9e0845f7 | 2 | |
1ea2264a | 3 | # [e-mobility charging stations simulator](https://github.com/sap/e-mobility-charging-stations-simulator) |
7dde0b73 | 4 | |
4d188eb9 | 5 | [![REUSE status](https://api.reuse.software/badge/github.com/SAP/e-mobility-charging-stations-simulator)](https://api.reuse.software/info/github.com/SAP/e-mobility-charging-stations-simulator) |
0a3d08ef | 6 | |
7dde0b73 JB |
7 | ## Summary |
8 | ||
fd405348 | 9 | Simple [node.js](https://nodejs.org/) software to simulate and scale a set of charging stations based on the OCPP-J 1.6 protocol as part of SAP e-Mobility solution. |
7dde0b73 | 10 | |
696ce53a JB |
11 | ## Prerequisites |
12 | ||
007ee642 JB |
13 | Install the [node.js](https://nodejs.org/) LTS runtime environment: |
14 | ||
696ce53a JB |
15 | ### Windows |
16 | ||
e7aeea18 | 17 | - [Chocolatey](https://chocolatey.org/): |
696ce53a JB |
18 | |
19 | ```powershell | |
20 | choco install -y nodejs-lts | |
21 | ``` | |
22 | ||
23 | ### MacOSX | |
24 | ||
e7aeea18 | 25 | - [Homebrew](https://brew.sh/): |
696ce53a JB |
26 | |
27 | ```shell | |
8f3d04b0 | 28 | brew install node@16 |
696ce53a JB |
29 | ``` |
30 | ||
d6b76da3 | 31 | ### GNU/Linux |
511780c3 | 32 | |
7e901376 | 33 | - [NodeSource](https://github.com/nodesource/distributions) Node.js Binary Distributions for version >= 16.X |
511780c3 | 34 | |
007ee642 JB |
35 | ## Installation |
36 | ||
37 | In the repository root, run the following command: | |
38 | ||
39 | ```shell | |
40 | npm install | |
41 | ``` | |
42 | ||
43 | ## Initial configuration | |
44 | ||
db70b600 JB |
45 | Copy the configuration template file [src/assets/config-template.json](src/assets/config-template.json) to [src/assets/config.json](src/assets/config.json). |
46 | Copy the authorization RFID tags template file [src/assets/authorization-tags-template.json](src/assets/authorization-tags-template.json) to [src/assets/authorization-tags.json](src/assets/authorization-tags.json). | |
47 | ||
48 | Tweak them to your needs by following the section [configuration files syntax](README.md#configuration-files-syntax). | |
007ee642 JB |
49 | |
50 | ## Start | |
51 | ||
52 | To start the program, run: `npm start`. | |
53 | ||
4e3ff94d | 54 | ## Start Web UI |
007ee642 | 55 | |
ebbfbf1c | 56 | See Web UI [README.md](ui/web/README.md) for more information. |
b8cc885d | 57 | |
4d3821a2 | 58 | ## Configuration files syntax |
2c28fc83 | 59 | |
e7aeea18 | 60 | All configuration files are in the JSON standard format. |
2c28fc83 | 61 | |
ff82dc5f | 62 | **Configuration files locations**: |
2c28fc83 | 63 | |
170bec53 | 64 | - charging stations simulator configuration: [src/assets/config.json](src/assets/config.json); |
1816f743 | 65 | - charging station configuration templates: [src/assets/station-templates](src/assets/station-templates); |
1c51fd1d | 66 | - charging station configurations: [dist/assets/configurations](dist/assets/configurations); |
7f818162 | 67 | - charging station RFID tags lists: [src/assets](src/assets). |
2c28fc83 | 68 | |
1816f743 JB |
69 | 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). |
70 | ||
71 | All charging station configuration templates are in the directory [src/assets/station-templates](src/assets/station-templates). | |
72 | ||
73 | 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). | |
74 | ||
75 | **Configuration files hierarchy and priority**: | |
76 | ||
1c51fd1d | 77 | 1. charging station configuration: [dist/assets/configurations](dist/assets/configurations); |
1816f743 | 78 | 2. charging station configuration template: [src/assets/station-templates](src/assets/station-templates); |
170bec53 | 79 | 3. charging stations simulator configuration: [src/assets/config.json](src/assets/config.json). |
511780c3 | 80 | |
e7aeea18 | 81 | The charging stations simulator have an automatic configuration files reload feature at change for: |
511780c3 | 82 | |
170bec53 | 83 | - charging stations simulator configuration; |
1816f743 | 84 | - charging station configuration templates; |
170bec53 | 85 | - charging station authorization RFID tags lists. |
2c28fc83 | 86 | |
c645fe94 | 87 | But the modifications to test have to be done to the files in the build target 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. |
e7aeea18 | 88 | |
170bec53 | 89 | ### Charging stations simulator configuration |
2c28fc83 | 90 | |
b1d6e944 | 91 | **src/assets/config.json**: |
2c28fc83 | 92 | |
19dbb570 JB |
93 | | Key | Value(s) | Default Value | Value type | Description | |
94 | | -------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | |
95 | | supervisionUrls | | [] | string \| string[] | string or array of global connection URIs to OCPP-J servers | | |
96 | | supervisionUrlDistribution | round-robin/random/charging-station-affinity | charging-station-affinity | boolean | supervision urls distribution policy to simulated charging stations | | |
97 | | logStatisticsInterval | | 60 | integer | seconds between charging stations statistics output in the logs | | |
98 | | logConsole | true/false | false | boolean | output logs on the console | | |
99 | | logFormat | | simple | string | winston log format | | |
100 | | logRotate | true/false | true | boolean | enable daily log files rotation | | |
101 | | logMaxFiles | | 7 | integer | maximum number of log files to keep | | |
102 | | logLevel | emerg/alert/crit/error/warning/notice/info/debug | info | string | winston logging level | | |
103 | | logFile | | combined.log | string | log file relative path | | |
104 | | logErrorFile | | error.log | string | error log file relative path | | |
105 | | worker | | {<br />"processType": "workerSet",<br />"startDelay": 500,<br />"elementStartDelay": 0,<br />"elementsPerWorker": 1,<br />"poolMinSize": 4,<br />"poolMaxSize": 16,<br />"poolStrategy": "ROUND_ROBIN"<br />} | {<br />processType: WorkerProcessType;<br />startDelay: number;<br />elementStartDelay: number;<br />elementsPerWorker: number;<br />poolMinSize: number;<br />poolMaxSize: number;<br />poolStrategy: WorkerChoiceStrategy;<br />} | Worker configuration section:<br />- processType: worker threads process type (workerSet/staticPool/dynamicPool)<br />- startDelay: milliseconds to wait at worker threads startup (only for workerSet threads process type)<br />- elementStartDelay: milliseconds to wait at charging station startup<br />- elementsPerWorker: number of charging stations per worker threads for the `workerSet` process type<br />- poolMinSize: worker threads pool minimum number of threads</br >- poolMaxSize: worker threads pool maximum number of threads<br />- poolStrategy: worker threads pool [poolifier](https://github.com/poolifier/poolifier) worker choice strategy | | |
106 | | uiServer | | {<br />"enabled": true,<br />"type": "ws",<br />"options": {<br />"host": "localhost",<br />"port": 8080<br />}<br />} | {<br />enabled: boolean;<br />type: ApplicationProtocol;<br />options: ServerOptions;<br />authentication: {<br />enabled: boolean;<br />type: AuthenticationType;<br />username: string;<br />password: string;<br />}<br />} | UI server configuration section | | |
107 | | performanceStorage | | {<br />"enabled": false,<br />"type": "jsonfile",<br />"file:///performanceRecords.json"<br />} | {<br />enabled: boolean;<br />type: string;<br />URI: string;<br />}<br />where type can be 'jsonfile' or 'mongodb' | performance storage configuration section | | |
108 | | stationTemplateUrls | | {}[] | {<br />file: string;<br />numberOfStations: number;<br />}[] | array of charging station configuration templates URIs configuration section (charging station configuration template file name and number of stations) | | |
e7aeea18 | 109 | |
d6b76da3 | 110 | #### Worker process model |
a6b3c6c3 JB |
111 | |
112 | - **workerSet**: | |
4c6ed1d7 | 113 | Worker set executing each a static number (elementsPerWorker) of simulated charging stations from the total |
a6b3c6c3 JB |
114 | |
115 | - **staticPool**: | |
e7aeea18 | 116 | Statically sized worker pool executing a static total number of simulated charging stations |
a6b3c6c3 JB |
117 | |
118 | - **dynamicPool**: | |
e7aeea18 | 119 | Dynamically sized worker pool executing a static total number of simulated charging stations |
a6b3c6c3 | 120 | |
1816f743 JB |
121 | ### Charging station configuration template |
122 | ||
afccb423 | 123 | **src/assets/station-templates/\<name\>.json**: |
1816f743 | 124 | |
65554cc3 JB |
125 | | Key | Value(s) | Default Value | Value type | Description | |
126 | | ---------------------------------- | ---------- | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | |
127 | | supervisionUrls | | '' | string \| string[] | string or array of connection URIs to OCPP-J servers | | |
128 | | supervisionUser | | '' | string | basic HTTP authentication user to OCPP-J server | | |
129 | | supervisionPassword | | '' | string | basic HTTP authentication password to OCPP-J server | | |
130 | | supervisionUrlOcppConfiguration | true/false | false | boolean | allow supervision URL configuration via a vendor OCPP parameter key | | |
131 | | supervisionUrlOcppKey | | 'ConnectionUrl' | string | the vendor string that will be used as a vendor OCPP parameter key to set the supervision URL | | |
132 | | ocppVersion | 1.6 | 1.6 | string | OCPP version | | |
133 | | ocppProtocol | json | json | string | OCPP protocol | | |
134 | | ocppStrictCompliance | true/false | false | boolean | strict adherence to the OCPP version and protocol specifications | | |
135 | | 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 | | |
136 | | stationInfoPersistentConfiguration | true/false | true | boolean | enable persistent station information and specifications storage by charging stations 'hashId'. The persistency is ensured by the charging stations configuration files in dist/assets/configurations | | |
137 | | wsOptions | | {} | ClientOptions & ClientRequestArgs | [ws](https://github.com/websockets/ws) and node.js [http](https://nodejs.org/api/http.html) clients options intersection | | |
138 | | authorizationFile | | '' | string | RFID tags list file relative to src/assets path | | |
139 | | baseName | | '' | string | base name to build charging stations id | | |
140 | | nameSuffix | | '' | string | name suffix to build charging stations id | | |
141 | | fixedName | true/false | false | boolean | use the baseName as the charging stations unique name | | |
142 | | chargePointModel | | '' | string | charging stations model | | |
143 | | chargePointVendor | | '' | string | charging stations vendor | | |
144 | | chargePointSerialNumberPrefix | | '' | string | charge point serial number prefix | | |
145 | | chargeBoxSerialNumberPrefix | | '' | string | charge box serial number prefix (deprecated in OCPP 1.6) | | |
146 | | firmwareVersion | | '' | string | charging stations firmware version | | |
147 | | power | | | float \| float[] | charging stations maximum power value(s) | | |
148 | | powerSharedByConnectors | true/false | false | boolean | charging stations power shared by its connectors | | |
149 | | powerUnit | W/kW | W | string | charging stations power unit | | |
150 | | currentOutType | AC/DC | AC | string | charging stations current out type | | |
151 | | voltageOut | | AC:230/DC:400 | integer | charging stations voltage out | | |
152 | | numberOfPhases | 0/1/3 | AC:3/DC:0 | integer | charging stations number of phase(s) | | |
153 | | numberOfConnectors | | | integer \| integer[] | charging stations number of connector(s) | | |
154 | | useConnectorId0 | true/false | true | boolean | use connector id 0 definition from the charging station configuration template | | |
155 | | randomConnectors | true/false | false | boolean | randomize runtime connector id affectation from the connector id definition in charging station configuration template | | |
156 | | resetTime | | 60 | integer | seconds to wait before the charging stations come back at reset | | |
157 | | autoRegister | true/false | false | boolean | set charging stations as registered at boot notification for testing purpose | | |
158 | | autoReconnectMaxRetries | | -1 (unlimited) | integer | connection retries to the OCPP-J server | | |
159 | | reconnectExponentialDelay | true/false | false | boolean | connection delay retry to the OCPP-J server | | |
160 | | registrationMaxRetries | | -1 (unlimited) | integer | charging stations boot notification retries | | |
161 | | 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 | | |
162 | | amperageLimitationUnit | A/cA/dA/mA | A | string | charging stations amperage limit unit | | |
163 | | enableStatistics | true/false | true | boolean | enable charging stations statistics | | |
03ebf4c1 JB |
164 | | mustAuthorizeAtRemoteStart | true/false | true | boolean | always send authorize at remote start transaction when AuthorizeRemoteTxRequests is enabled | |
165 | | payloadSchemaValidation | true/false | true | boolean | validate OCPP commands PDU against [OCA](https://www.openchargealliance.org/) JSON schemas | | |
65554cc3 JB |
166 | | beginEndMeterValues | true/false | false | boolean | enable Transaction.{Begin,End} MeterValues | |
167 | | outOfOrderEndMeterValues | true/false | false | boolean | send Transaction.End MeterValues out of order. Need to relax OCPP specifications strict compliance ('ocppStrictCompliance' parameter) | | |
168 | | meteringPerTransaction | true/false | true | boolean | enable metering history on a per transaction basis | | |
169 | | transactionDataMeterValues | true/false | false | boolean | enable transaction data MeterValues at stop transaction | | |
170 | | mainVoltageMeterValues | true/false | true | boolean | include charging stations main voltage MeterValues on three phased charging stations | | |
171 | | phaseLineToLineVoltageMeterValues | true/false | true | boolean | include charging stations line to line voltage MeterValues on three phased charging stations | | |
172 | | customValueLimitationMeterValues | true/false | true | boolean | enable limitation on custom fluctuated value in MeterValues | | |
c60ed4b8 JB |
173 | | commandsSupport | | {<br />"incomingCommands": {},<br />"outgoingCommands": {}<br />} | {<br /> incomingCommands: Record<IncomingRequestCommand, boolean>;<br />outgoingCommands?: Record<RequestCommand, boolean>;<br />} | Configuration section for OCPP commands support. Empty section or subsections means all implemented OCPP commands are supported | |
174 | | messageTriggerSupport | | {} | Record<MessageTrigger, boolean> | Configuration section for OCPP commands trigger support. Empty section means all implemented OCPP trigger commands are supported | | |
65554cc3 JB |
175 | | Configuration | | | ChargingStationConfiguration | charging stations OCPP parameters configuration section | |
176 | | AutomaticTransactionGenerator | | | AutomaticTransactionGenerator | charging stations ATG configuration section | | |
177 | | Connectors | | | Connectors | charging stations connectors configuration section | | |
c94a349a JB |
178 | |
179 | #### Configuration section | |
180 | ||
181 | ```json | |
0302da79 | 182 | "Configuration": { |
c94a349a JB |
183 | "configurationKey": [ |
184 | ... | |
185 | { | |
186 | "key": "StandardKey", | |
187 | "readonly": false, | |
188 | "value": "StandardValue", | |
189 | "visible": true, | |
190 | "reboot": false | |
191 | }, | |
192 | ... | |
193 | { | |
194 | "key": "VendorKey", | |
195 | "readonly": false, | |
196 | "value": "VendorValue", | |
197 | "visible": false, | |
198 | "reboot": true | |
199 | }, | |
200 | ... | |
201 | ] | |
202 | } | |
203 | ``` | |
204 | ||
205 | #### AutomaticTransactionGenerator section | |
206 | ||
c72f6634 JB |
207 | Section type definition: |
208 | ||
209 | ```ts | |
210 | type AutomaticTransactionGeneratorConfiguration = { | |
211 | enable: boolean; | |
212 | minDuration: number; | |
213 | maxDuration: number; | |
214 | minDelayBetweenTwoTransactions: number; | |
215 | maxDelayBetweenTwoTransactions: number; | |
216 | probabilityOfStart: number; | |
217 | stopAfterHours: number; | |
218 | stopOnConnectionFailure: boolean; | |
219 | requireAuthorize?: boolean; | |
220 | idTagDistribution?: 'random' | 'round-robin' | 'connector-affinity'; | |
221 | }; | |
222 | ``` | |
223 | ||
224 | Section example: | |
225 | ||
c94a349a | 226 | ```json |
0302da79 | 227 | "AutomaticTransactionGenerator": { |
c94a349a JB |
228 | "enable": false, |
229 | "minDuration": 60, | |
230 | "maxDuration": 80, | |
231 | "minDelayBetweenTwoTransactions": 15, | |
232 | "maxDelayBetweenTwoTransactions": 30, | |
233 | "probabilityOfStart": 1, | |
234 | "stopAfterHours": 0.3, | |
235 | "stopOnConnectionFailure": true, | |
c72f6634 JB |
236 | "requireAuthorize": true, |
237 | "idTagDistribution": "random" | |
c94a349a JB |
238 | } |
239 | ``` | |
e7aeea18 | 240 | |
c94a349a JB |
241 | #### Connectors section |
242 | ||
243 | ```json | |
0302da79 | 244 | "Connectors": { |
c94a349a JB |
245 | "0": {}, |
246 | "1": { | |
247 | "bootStatus": "Available", | |
248 | "MeterValues": [ | |
9bd87386 JB |
249 | ... |
250 | { | |
251 | "unit": "W", | |
252 | "measurand": "Power.Active.Import", | |
253 | "phase": "L1-N", | |
254 | "value": "5000", | |
255 | "fluctuationPercent": "10" | |
256 | }, | |
c94a349a JB |
257 | ... |
258 | { | |
259 | "unit": "A", | |
260 | "measurand": "Current.Import" | |
261 | }, | |
262 | ... | |
263 | { | |
264 | "unit": "Wh" | |
265 | }, | |
266 | ... | |
267 | ] | |
268 | } | |
269 | }, | |
270 | ``` | |
271 | ||
1816f743 JB |
272 | ### Charging station configuration |
273 | ||
1c51fd1d | 274 | **dist/assets/configurations/\<hashId\>.json**: |
1816f743 | 275 | |
a9ec2018 | 276 | The charging station configuration file is automatically generated at startup from the charging station configuration template file and is persistent. |
1816f743 JB |
277 | |
278 | 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. | |
279 | ||
280 | #### stationInfo section | |
281 | ||
282 | The syntax is similar to charging station configuration template with some added fields like the charging station id (name) and the 'Configuration' section removed. | |
283 | ||
284 | #### configurationKey section | |
285 | ||
286 | The syntax is similar to the charging station configuration template 'Configuration' section. | |
287 | ||
6f0ec20e JB |
288 | ## Docker |
289 | ||
290 | In the [docker](./docker) folder: | |
291 | ||
292 | ```bash | |
293 | make | |
294 | ``` | |
295 | ||
bfcad885 | 296 | Or with the optional git submodules: |
6f0ec20e JB |
297 | |
298 | ```bash | |
bfcad885 | 299 | make SUBMODULES_INIT=true |
6f0ec20e JB |
300 | ``` |
301 | ||
302 | ## OCPP-J commands supported | |
c94a349a JB |
303 | |
304 | ### Version 1.6 | |
305 | ||
c56d42f1 | 306 | #### Core Profile |
6f0ec20e | 307 | |
778f7924 JB |
308 | - :white_check_mark: Authorize |
309 | - :white_check_mark: BootNotification | |
310 | - :white_check_mark: ChangeAvailability | |
311 | - :white_check_mark: ChangeConfiguration | |
312 | - :white_check_mark: ClearCache | |
91a7d3ea | 313 | - :white_check_mark: DataTransfer |
778f7924 JB |
314 | - :white_check_mark: GetConfiguration |
315 | - :white_check_mark: Heartbeat | |
316 | - :white_check_mark: MeterValues | |
317 | - :white_check_mark: RemoteStartTransaction | |
318 | - :white_check_mark: RemoteStopTransaction | |
319 | - :white_check_mark: Reset | |
320 | - :white_check_mark: StartTransaction | |
321 | - :white_check_mark: StatusNotification | |
322 | - :white_check_mark: StopTransaction | |
323 | - :white_check_mark: UnlockConnector | |
6f0ec20e | 324 | |
c56d42f1 | 325 | #### Firmware Management Profile |
6f0ec20e | 326 | |
b652b0c3 | 327 | - :white_check_mark: GetDiagnostics |
d50343bd | 328 | - :white_check_mark: DiagnosticsStatusNotification |
9e1b12e4 JB |
329 | - :x: FirmwareStatusNotification |
330 | - :x: UpdateFirmware | |
6f0ec20e | 331 | |
c56d42f1 | 332 | #### Local Auth List Management Profile |
6f0ec20e | 333 | |
9e1b12e4 JB |
334 | - :x: GetLocalListVersion |
335 | - :x: SendLocalList | |
6f0ec20e | 336 | |
c56d42f1 | 337 | #### Reservation Profile |
6f0ec20e | 338 | |
9e1b12e4 JB |
339 | - :x: CancelReservation |
340 | - :x: ReserveNow | |
6f0ec20e | 341 | |
c56d42f1 | 342 | #### Smart Charging Profile |
6f0ec20e | 343 | |
778f7924 | 344 | - :white_check_mark: ClearChargingProfile |
68cb8b91 | 345 | - :x: GetCompositeSchedule |
778f7924 | 346 | - :white_check_mark: SetChargingProfile |
6f0ec20e | 347 | |
c56d42f1 | 348 | #### Remote Trigger Profile |
6f0ec20e | 349 | |
802cfa13 | 350 | - :white_check_mark: TriggerMessage |
7dde0b73 | 351 | |
7e1dc878 JB |
352 | ## OCPP-J standard parameters supported |
353 | ||
1816f743 | 354 | 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. |
7e1dc878 JB |
355 | |
356 | ### Version 1.6 | |
357 | ||
c56d42f1 | 358 | #### Core Profile |
7e1dc878 JB |
359 | |
360 | - :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -) | |
361 | - :x: ClockAlignedDataInterval (type: integer) (units: seconds) | |
291cb255 | 362 | - :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds) |
7e1dc878 JB |
363 | - :x: GetConfigurationMaxKeys (type: integer) (units: -) |
364 | - :white_check_mark: HeartbeatInterval (type: integer) (units: seconds) | |
365 | - :x: LocalAuthorizeOffline (type: boolean) (units: -) | |
366 | - :x: LocalPreAuthorize (type: boolean) (units: -) | |
367 | - :x: MeterValuesAlignedData (type: CSL) (units: -) | |
368 | - :white_check_mark: MeterValuesSampledData (type: CSL) (units: -) | |
369 | - :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds) | |
370 | - :white_check_mark: NumberOfConnectors (type: integer) (units: -) | |
371 | - :x: ResetRetries (type: integer) (units: times) | |
372 | - :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -) | |
373 | - :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -) | |
374 | - :x: StopTransactionOnInvalidId (type: boolean) (units: -) | |
375 | - :x: StopTxnAlignedData (type: CSL) (units: -) | |
376 | - :x: StopTxnSampledData (type: CSL) (units: -) | |
36f6a92e | 377 | - :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -) |
7e1dc878 JB |
378 | - :x: TransactionMessageAttempts (type: integer) (units: times) |
379 | - :x: TransactionMessageRetryInterval (type: integer) (units: seconds) | |
380 | - :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -) | |
36f6a92e | 381 | - :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds) |
7e1dc878 | 382 | |
c56d42f1 | 383 | #### Firmware Management Profile |
7e1dc878 | 384 | |
e7aeea18 | 385 | - _none_ |
7e1dc878 | 386 | |
c56d42f1 | 387 | #### Local Auth List Management Profile |
7e1dc878 | 388 | |
36f6a92e | 389 | - :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -) |
7e1dc878 JB |
390 | - :x: LocalAuthListMaxLength (type: integer) (units: -) |
391 | - :x: SendLocalListMaxLength (type: integer) (units: -) | |
392 | ||
c56d42f1 | 393 | #### Reservation Profile |
7e1dc878 | 394 | |
e7aeea18 | 395 | - _none_ |
7e1dc878 | 396 | |
c56d42f1 | 397 | #### Smart Charging Profile |
7e1dc878 JB |
398 | |
399 | - :x: ChargeProfileMaxStackLevel (type: integer) (units: -) | |
400 | - :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -) | |
401 | - :x: ChargingScheduleMaxPeriods (type: integer) (units: -) | |
402 | - :x: MaxChargingProfilesInstalled (type: integer) (units: -) | |
403 | ||
c56d42f1 | 404 | #### Remote Trigger Profile |
7e1dc878 | 405 | |
e7aeea18 | 406 | - _none_ |
7e1dc878 | 407 | |
32de5a57 LM |
408 | ## UI protocol |
409 | ||
03ebf4c1 | 410 | Protocol to control the simulator via a Websocket or HTTP server. |
32de5a57 | 411 | |
4df14d3a JB |
412 | ### HTTP Protocol |
413 | ||
97c19696 | 414 | To learn how to use the HTTP protocol to pilot the simulator, an [Insomnia](https://insomnia.rest/) HTTP requests collection is available in [src/assets/ui-protocol](./src/assets/ui-protocol) directory. |
4df14d3a | 415 | |
02cde3b7 | 416 | ### Websocket Protocol |
32de5a57 | 417 | |
02cde3b7 | 418 | SRPC protocol over Websocket. PDU stands for 'Protocol Data Unit'. |
32de5a57 | 419 | |
03ebf4c1 JB |
420 | - Request: |
421 | [`uuid`, `ProcedureName`, `PDU`] | |
422 | `uuid`: String uniquely representing this request | |
423 | `ProcedureName`: The procedure to run on the simulator | |
424 | `PDU`: The parameters for said procedure | |
32de5a57 | 425 | |
03ebf4c1 JB |
426 | - Response: |
427 | [`uuid`, `PDU`] | |
428 | `uuid`: String uniquely linking the response to the request | |
02cde3b7 | 429 | `PDU`: Response parameters to requested procedure |
32de5a57 | 430 | |
97c19696 JB |
431 | An [Insomnia](https://insomnia.rest/) WebSocket requests collection is available in [src/assets/ui-protocol](./src/assets/ui-protocol) directory. |
432 | ||
d3140adc | 433 | #### Version 0.0.1 |
4e3ff94d | 434 | |
02cde3b7 | 435 | Set the Websocket header _Sec-Websocket-Protocol_ to `ui0.0.1`. |
4e3ff94d | 436 | |
d3140adc | 437 | ##### Procedures |
32de5a57 | 438 | |
d3140adc | 439 | ###### Start Simulator |
5612b691 | 440 | |
03ebf4c1 JB |
441 | - Request: |
442 | `ProcedureName`: 'startSimulator' | |
443 | `PDU`: {} | |
5612b691 | 444 | |
03ebf4c1 JB |
445 | - Response: |
446 | `PDU`: { | |
853ed24a | 447 | `status`: 'success' | 'failure' |
03ebf4c1 | 448 | } |
5612b691 | 449 | |
d3140adc | 450 | ###### Stop Simulator |
5612b691 | 451 | |
03ebf4c1 JB |
452 | - Request: |
453 | `ProcedureName`: 'stopSimulator' | |
454 | `PDU`: {} | |
5612b691 | 455 | |
03ebf4c1 JB |
456 | - Response: |
457 | `PDU`: { | |
853ed24a | 458 | `status`: 'success' | 'failure' |
03ebf4c1 | 459 | } |
5612b691 | 460 | |
d3140adc | 461 | ###### List Charging Stations |
32de5a57 | 462 | |
03ebf4c1 JB |
463 | - Request: |
464 | `ProcedureName`: 'listChargingStations' | |
465 | `PDU`: {} | |
32de5a57 | 466 | |
03ebf4c1 JB |
467 | - Response: |
468 | `PDU`: { | |
853ed24a | 469 | `status`: 'success' | 'failure', |
02cde3b7 | 470 | `chargingStations`: ChargingStationData[] |
03ebf4c1 | 471 | } |
32de5a57 | 472 | |
d3140adc | 473 | ###### Start Charging Station |
80a3704c | 474 | |
03ebf4c1 JB |
475 | - Request: |
476 | `ProcedureName`: 'startChargingStation' | |
477 | `PDU`: { | |
03eee93b | 478 | `hashIds`: charging station unique identifier strings array (optional, default: all charging stations) |
03ebf4c1 | 479 | } |
80a3704c | 480 | |
03ebf4c1 JB |
481 | - Response: |
482 | `PDU`: { | |
853ed24a JB |
483 | `status`: 'success' | 'failure', |
484 | `hashIdsSucceeded`: charging station unique identifier strings array, | |
485 | `hashIdsFailed`: charging station unique identifier strings array (optional) | |
03eee93b | 486 | `responsesFailed`: failed responses payload array (optional) |
03ebf4c1 | 487 | } |
80a3704c | 488 | |
d3140adc | 489 | ###### Stop Charging Station |
80a3704c | 490 | |
03ebf4c1 JB |
491 | - Request: |
492 | `ProcedureName`: 'stopChargingStation' | |
493 | `PDU`: { | |
853ed24a | 494 | `hashIds`: charging station unique identifier strings array (optional, default: all charging stations) |
03ebf4c1 | 495 | } |
80a3704c | 496 | |
03ebf4c1 JB |
497 | - Response: |
498 | `PDU`: { | |
853ed24a JB |
499 | `status`: 'success' | 'failure', |
500 | `hashIdsSucceeded`: charging station unique identifier strings array, | |
94abe068 JB |
501 | `hashIdsFailed`: charging station unique identifier strings array (optional), |
502 | `responsesFailed`: failed responses payload array (optional) | |
03ebf4c1 | 503 | } |
80a3704c | 504 | |
d3140adc | 505 | ###### Open Connection |
e4df816e | 506 | |
03ebf4c1 JB |
507 | - Request: |
508 | `ProcedureName`: 'openConnection' | |
509 | `PDU`: { | |
853ed24a | 510 | `hashIds`: charging station unique identifier strings array (optional, default: all charging stations) |
03ebf4c1 | 511 | } |
e4df816e | 512 | |
03ebf4c1 JB |
513 | - Response: |
514 | `PDU`: { | |
853ed24a JB |
515 | `status`: 'success' | 'failure', |
516 | `hashIdsSucceeded`: charging station unique identifier strings array, | |
94abe068 JB |
517 | `hashIdsFailed`: charging station unique identifier strings array (optional), |
518 | `responsesFailed`: failed responses payload array (optional) | |
03ebf4c1 | 519 | } |
e4df816e | 520 | |
d3140adc | 521 | ###### Close Connection |
e4df816e | 522 | |
03ebf4c1 JB |
523 | - Request: |
524 | `ProcedureName`: 'closeConnection' | |
525 | `PDU`: { | |
853ed24a | 526 | `hashIds`: charging station unique identifier strings array (optional, default: all charging stations) |
03ebf4c1 JB |
527 | } |
528 | ||
529 | - Response: | |
530 | `PDU`: { | |
853ed24a JB |
531 | `status`: 'success' | 'failure', |
532 | `hashIdsSucceeded`: charging station unique identifier strings array, | |
94abe068 JB |
533 | `hashIdsFailed`: charging station unique identifier strings array (optional), |
534 | `responsesFailed`: failed responses payload array (optional) | |
853ed24a JB |
535 | } |
536 | ||
537 | ###### Start Automatic Transaction Generator | |
538 | ||
539 | - Request: | |
540 | `ProcedureName`: 'startAutomaticTransactionGenerator' | |
541 | `PDU`: { | |
542 | `hashIds`: charging station unique identifier strings array (optional, default: all charging stations), | |
a38bc315 | 543 | `connectorIds`: connector id integer array (optional, default: all connectors) |
853ed24a JB |
544 | } |
545 | ||
546 | - Response: | |
547 | `PDU`: { | |
548 | `status`: 'success' | 'failure', | |
549 | `hashIdsSucceeded`: charging station unique identifier strings array, | |
5566ca3e JB |
550 | `hashIdsFailed`: charging station unique identifier strings array (optional), |
551 | `responsesFailed`: failed responses payload array (optional) | |
853ed24a JB |
552 | } |
553 | ||
554 | ###### Stop Automatic Transaction Generator | |
555 | ||
556 | - Request: | |
557 | `ProcedureName`: 'stopAutomaticTransactionGenerator' | |
558 | `PDU`: { | |
559 | `hashIds`: charging station unique identifier strings array (optional, default: all charging stations), | |
a38bc315 | 560 | `connectorIds`: connector id integer array (optional, default: all connectors) |
853ed24a JB |
561 | } |
562 | ||
563 | - Response: | |
564 | `PDU`: { | |
565 | `status`: 'success' | 'failure', | |
566 | `hashIdsSucceeded`: charging station unique identifier strings array, | |
5566ca3e JB |
567 | `hashIdsFailed`: charging station unique identifier strings array (optional), |
568 | `responsesFailed`: failed responses payload array (optional) | |
03ebf4c1 JB |
569 | } |
570 | ||
91a7d3ea | 571 | ###### OCPP commands trigger |
a9ed42b2 | 572 | |
82cbef8d JB |
573 | - Request: |
574 | `ProcedureName`: 'commandName' (the OCPP command name in camel case) | |
575 | `PDU`: { | |
576 | `hashIds`: charging station unique identifier strings array (optional, default: all charging stations), | |
577 | ...`commandPayload` | |
578 | } (the OCPP command payload with some optional fields added to target the simulated charging stations) | |
10db00b2 | 579 | |
82cbef8d JB |
580 | - Response: |
581 | `PDU`: { | |
582 | `status`: 'success' | 'failure', | |
583 | `hashIdsSucceeded`: charging station unique identifier strings array, | |
584 | `hashIdsFailed`: charging station unique identifier strings array (optional), | |
585 | `responsesFailed`: failed responses payload array (optional) | |
586 | } | |
10db00b2 | 587 | |
91a7d3ea | 588 | Examples: |
10db00b2 | 589 | |
91a7d3ea | 590 | - **Start Transaction** |
a9ed42b2 | 591 | |
91a7d3ea JB |
592 | - Request: |
593 | `ProcedureName`: 'startTransaction' | |
594 | `PDU`: { | |
595 | `hashIds`: charging station unique identifier strings array (optional, default: all charging stations), | |
596 | `connectorId`: connector id integer, | |
597 | `idTag`: RFID tag string | |
598 | } | |
599 | ||
600 | - Response: | |
601 | `PDU`: { | |
602 | `status`: 'success' | 'failure', | |
603 | `hashIdsSucceeded`: charging station unique identifier strings array, | |
604 | `hashIdsFailed`: charging station unique identifier strings array (optional), | |
605 | `responsesFailed`: failed responses payload array (optional) | |
606 | } | |
607 | ||
608 | - **Stop Transaction** | |
609 | ||
610 | - Request: | |
611 | `ProcedureName`: 'stopTransaction' | |
612 | `PDU`: { | |
613 | `hashIds`: charging station unique identifier strings array (optional, default: all charging stations), | |
614 | `transactionId`: transaction id integer | |
615 | } | |
616 | ||
617 | - Response: | |
618 | `PDU`: { | |
619 | `status`: 'success' | 'failure', | |
620 | `hashIdsSucceeded`: charging station unique identifier strings array, | |
621 | `hashIdsFailed`: charging station unique identifier strings array (optional), | |
622 | `responsesFailed`: failed responses payload array (optional) | |
623 | } | |
624 | ||
625 | - **Status Notification** | |
626 | ||
627 | - Request: | |
82cbef8d | 628 | `ProcedureName`: 'statusNotification' |
91a7d3ea JB |
629 | `PDU`: { |
630 | `hashIds`: charging station unique identifier strings array (optional, default: all charging stations), | |
631 | `connectorId`: connector id integer, | |
632 | `errorCode`: connector error code, | |
633 | `status`: connector status | |
634 | } | |
635 | ||
636 | - Response: | |
637 | `PDU`: { | |
638 | `status`: 'success' | 'failure', | |
639 | `hashIdsSucceeded`: charging station unique identifier strings array, | |
640 | `hashIdsFailed`: charging station unique identifier strings array (optional), | |
641 | `responsesFailed`: failed responses payload array (optional) | |
642 | } | |
643 | ||
644 | - **Heartbeat** | |
645 | ||
646 | - Request: | |
82cbef8d | 647 | `ProcedureName`: 'heartbeat' |
91a7d3ea JB |
648 | `PDU`: { |
649 | `hashIds`: charging station unique identifier strings array (optional, default: all charging stations), | |
650 | } | |
651 | ||
652 | - Response: | |
653 | `PDU`: { | |
654 | `status`: 'success' | 'failure', | |
655 | `hashIdsSucceeded`: charging station unique identifier strings array, | |
656 | `hashIdsFailed`: charging station unique identifier strings array (optional), | |
657 | `responsesFailed`: failed responses payload array (optional) | |
658 | } | |
a9ed42b2 | 659 | |
251fff5c | 660 | ## Support, Feedback, Contributing |
7dde0b73 | 661 | |
7f774a55 | 662 | This project is open to feature requests/suggestions, bug reports etc. via [GitHub issues](https://github.com/SAP/e-mobility-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). |
7dde0b73 | 663 | |
251fff5c JB |
664 | ## Code of Conduct |
665 | ||
666 | 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. | |
667 | ||
668 | ## Licensing | |
669 | ||
7f774a55 | 670 | Copyright 2020-2022 SAP SE or an SAP affiliate company and e-mobility-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/e-mobility-charging-stations-simulator). |