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