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