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