1 # [e-mobility charging stations simulator](https://github.com/sap/e-mobility-charging-stations-simulator)
3 [![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)
7 Simple [node.js](https://nodejs.org/) software to simulate a set of charging stations based on the OCPP-J 1.6 protocol as part of SAP e-Mobility solution.
11 Install the [node.js](https://nodejs.org/) LTS runtime environment:
15 - [Chocolatey](https://chocolatey.org/):
18 choco install -y nodejs-lts
23 - [Homebrew](https://brew.sh/):
31 - [NodeSource](https://github.com/nodesource/distributions) Node.js Binary Distributions for version >= 16.X
35 In the repository root, run the following command:
41 ## Initial configuration
43 Copy the configuration template file [src/assets/config-template.json](src/assets/config-template.json) to [src/assets/config.json](src/assets/config.json).
44 Copy the authorization RFID tags template file [src/assets/authorization-tags-template.json](src/assets/authorization-tags-template.json) to [src/assets/authorization-tags.json](src/assets/authorization-tags.json).
46 Tweak them to your needs by following the section [configuration files syntax](README.md#configuration-files-syntax).
50 To start the program, run: `npm start`.
54 See Web UI [README.md](src/ui/web/README.md) for more information.
56 ## Configuration files syntax
58 All configuration files are in the JSON standard format.
60 **Configuration files locations**:
62 - charging stations simulator configuration: [src/assets/config.json](src/assets/config.json);
63 - charging station configuration templates: [src/assets/station-templates](src/assets/station-templates);
64 - charging station configurations: [dist/assets/configurations](dist/assets/configurations);
65 - charging station RFID tags lists: [src/assets](src/assets).
67 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).
69 All charging station configuration templates are in the directory [src/assets/station-templates](src/assets/station-templates).
71 A list of RFID tags must be defined for the automatic transaction generator with a default location and name: `src/assets/authorization-tags.json`. A template file is available at [src/assets/authorization-tags-template.json](src/assets/authorization-tags-template.json).
73 **Configuration files hierarchy and priority**:
75 1. charging station configuration: [dist/assets/configurations](dist/assets/configurations);
76 2. charging station configuration template: [src/assets/station-templates](src/assets/station-templates);
77 3. charging stations simulator configuration: [src/assets/config.json](src/assets/config.json).
79 The charging stations simulator have an automatic configuration files reload feature at change for:
81 - charging stations simulator configuration;
82 - charging station configuration templates;
83 - charging station authorization RFID tags lists.
85 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.
87 ### Charging stations simulator configuration
89 **src/assets/config.json**:
91 | Key | Value(s) | Default Value | Value type | Description |
92 | -------------------------- | ------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
93 | supervisionUrls | | [] | string \| string[] | string or array of global connection URIs to OCPP-J servers |
94 | supervisionUrlDistribution | round-robin/random/sequential | round-robin | boolean | supervision urls distribution policy to simulated charging stations |
95 | logStatisticsInterval | | 60 | integer | seconds between charging stations statistics output in the logs |
96 | logConsole | true/false | false | boolean | output logs on the console |
97 | logFormat | | simple | string | winston log format |
98 | logRotate | true/false | true | boolean | enable daily log files rotation |
99 | logMaxFiles | | 7 | integer | maximum number of log files to keep |
100 | logLevel | emerg/alert/crit/error/warning/notice/info/debug | info | string | winston logging level |
101 | logFile | | combined.log | string | log file relative path |
102 | logErrorFile | | error.log | string | error log file relative path |
103 | worker | | {<br />"processType": "workerSet",<br />"startDelay": 500,<br />"elementStartDelay": 0,<br />"elementsPerWorker": 1,<br />"poolMinSize": 4,<br />"poolMaxSize": 16,<br />"poolStrategy": "ROUND_ROBBIN"<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 |
104 | uiServer | | {<br />"enabled": true,<br />"type": "ws",<br />"options": {<br />"host: "localhost",<br />"port": 8080<br />}<br />} | {<br />enabled: boolean;<br />type: ApplicationProtocol;<br />options: ServerOptions;<br />} | UI server configuration section |
105 | 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 |
106 | 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) |
108 #### Worker process model:
111 Worker set executing each a static number (elementsPerWorker) of simulated charging stations from the total
114 Statically sized worker pool executing a static total number of simulated charging stations
117 Dynamically sized worker pool executing a static total number of simulated charging stations
119 ### Charging station configuration template
121 **src/assets/station-templates/\<name\>.json**:
123 | Key | Value(s) | Default Value | Value type | Description |
124 | ---------------------------------- | ---------- | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
125 | supervisionUrls | | '' | string \| string[] | string or array of connection URIs to OCPP-J servers |
126 | supervisionUser | | '' | string | basic HTTP authentication user to OCPP-J server |
127 | supervisionPassword | | '' | string | basic HTTP authentication password to OCPP-J server |
128 | supervisionUrlOcppConfiguration | true/false | false | boolean | allow supervision URL configuration via a vendor OCPP parameter key |
129 | supervisionUrlOcppKey | | 'ConnectionUrl' | string | the vendor string that will be used as a vendor OCPP parameter key to set the supervision URL |
130 | ocppVersion | 1.6 | 1.6 | string | OCPP version |
131 | ocppProtocol | json | json | string | OCPP protocol |
132 | ocppStrictCompliance | true/false | false | boolean | strict adherence to the OCPP version and protocol specifications |
133 | 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 |
134 | 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 |
135 | wsOptions | | {} | ClientOptions & ClientRequestArgs | [ws](https://github.com/websockets/ws) and node.js [http](https://nodejs.org/api/http.html) clients options intersection |
136 | authorizationFile | | '' | string | RFID tags list file relative to src/assets path |
137 | baseName | | '' | string | base name to build charging stations id |
138 | nameSuffix | | '' | string | name suffix to build charging stations id |
139 | fixedName | true/false | false | boolean | use the baseName as the charging stations unique name |
140 | chargePointModel | | '' | string | charging stations model |
141 | chargePointVendor | | '' | string | charging stations vendor |
142 | chargePointSerialNumberPrefix | | '' | string | charge point serial number prefix |
143 | chargeBoxSerialNumberPrefix | | '' | string | charge box serial number prefix (deprecated in OCPP 1.6) |
144 | firmwareVersion | | '' | string | charging stations firmware version |
145 | power | | | float \| float[] | charging stations maximum power value(s) |
146 | powerSharedByConnectors | true/false | false | boolean | charging stations power shared by its connectors |
147 | powerUnit | W/kW | W | string | charging stations power unit |
148 | currentOutType | AC/DC | AC | string | charging stations current out type |
149 | voltageOut | | AC:230/DC:400 | integer | charging stations voltage out |
150 | numberOfPhases | 0/1/3 | AC:3/DC:0 | integer | charging stations number of phase(s) |
151 | numberOfConnectors | | | integer \| integer[] | charging stations number of connector(s) |
152 | useConnectorId0 | true/false | true | boolean | use connector id 0 definition from the charging station configuration template |
153 | randomConnectors | true/false | false | boolean | randomize runtime connector id affectation from the connector id definition in charging station configuration template |
154 | resetTime | | 60 | integer | seconds to wait before the charging stations come back at reset |
155 | autoRegister | true/false | false | boolean | set charging stations as registered at boot notification for testing purpose |
156 | autoReconnectMaxRetries | | -1 (unlimited) | integer | connection retries to the OCPP-J server |
157 | reconnectExponentialDelay | true/false | false | boolean | connection delay retry to the OCPP-J server |
158 | registrationMaxRetries | | -1 (unlimited) | integer | charging stations boot notification retries |
159 | 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 |
160 | amperageLimitationUnit | A/cA/dA/mA | A | string | charging stations amperage limit unit |
161 | enableStatistics | true/false | true | boolean | enable charging stations statistics |
162 | mustAuthorizeAtRemoteStart | true/false | true | boolean | always send authorize at remote start transaction when AuthorizeRemoteTxRequests is enabled |
163 | payloadSchemaValidation | true/false | true | boolean | validate OCPP commands PDU against [OCA](https://www.openchargealliance.org/) JSON schemas |
164 | beginEndMeterValues | true/false | false | boolean | enable Transaction.{Begin,End} MeterValues |
165 | outOfOrderEndMeterValues | true/false | false | boolean | send Transaction.End MeterValues out of order. Need to relax OCPP specifications strict compliance ('ocppStrictCompliance' parameter) |
166 | meteringPerTransaction | true/false | true | boolean | enable metering history on a per transaction basis |
167 | transactionDataMeterValues | true/false | false | boolean | enable transaction data MeterValues at stop transaction |
168 | mainVoltageMeterValues | true/false | true | boolean | include charging stations main voltage MeterValues on three phased charging stations |
169 | phaseLineToLineVoltageMeterValues | true/false | true | boolean | include charging stations line to line voltage MeterValues on three phased charging stations |
170 | customValueLimitationMeterValues | true/false | true | boolean | enable limitation on custom fluctuated value in MeterValues |
171 | 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 commands are supported |
172 | Configuration | | | ChargingStationConfiguration | charging stations OCPP parameters configuration section |
173 | AutomaticTransactionGenerator | | | AutomaticTransactionGenerator | charging stations ATG configuration section |
174 | Connectors | | | Connectors | charging stations connectors configuration section |
176 #### Configuration section
180 "configurationKey": [
183 "key": "StandardKey",
185 "value": "StandardValue",
193 "value": "VendorValue",
202 #### AutomaticTransactionGenerator section
205 "AutomaticTransactionGenerator": {
209 "minDelayBetweenTwoTransactions": 15,
210 "maxDelayBetweenTwoTransactions": 30,
211 "probabilityOfStart": 1,
212 "stopAfterHours": 0.3,
213 "stopOnConnectionFailure": true,
214 "requireAuthorize": true
218 #### Connectors section
224 "bootStatus": "Available",
229 "measurand": "Power.Active.Import",
232 "fluctuationPercent": "10"
237 "measurand": "Current.Import"
249 ### Charging station configuration
251 **dist/assets/configurations/\<hashId\>.json**:
253 The charging station configuration file is automatically generated at startup from the charging station configuration template file and is persistent.
255 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.
257 #### stationInfo section
259 The syntax is similar to charging station configuration template with some added fields like the charging station id (name) and the 'Configuration' section removed.
261 #### configurationKey section
263 The syntax is similar to the charging station configuration template 'Configuration' section.
267 In the [docker](./docker) folder:
273 Or with the optional git submodules:
276 make SUBMODULES_INIT=true
279 ## OCPP-J commands supported
285 - :white_check_mark: Authorize
286 - :white_check_mark: BootNotification
287 - :white_check_mark: ChangeAvailability
288 - :white_check_mark: ChangeConfiguration
289 - :white_check_mark: ClearCache
291 - :white_check_mark: GetConfiguration
292 - :white_check_mark: Heartbeat
293 - :white_check_mark: MeterValues
294 - :white_check_mark: RemoteStartTransaction
295 - :white_check_mark: RemoteStopTransaction
296 - :white_check_mark: Reset
297 - :white_check_mark: StartTransaction
298 - :white_check_mark: StatusNotification
299 - :white_check_mark: StopTransaction
300 - :white_check_mark: UnlockConnector
302 #### Firmware Management Profile
304 - :white_check_mark: GetDiagnostics
305 - :white_check_mark: DiagnosticsStatusNotification
306 - :x: FirmwareStatusNotification
309 #### Local Auth List Management Profile
311 - :x: GetLocalListVersion
314 #### Reservation Profile
316 - :x: CancelReservation
319 #### Smart Charging Profile
321 - :white_check_mark: ClearChargingProfile
322 - :x: GetCompositeSchedule
323 - :white_check_mark: SetChargingProfile
325 #### Remote Trigger Profile
327 - :white_check_mark: TriggerMessage
329 ## OCPP-J standard parameters supported
331 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.
337 - :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -)
338 - :x: ClockAlignedDataInterval (type: integer) (units: seconds)
339 - :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds)
340 - :x: GetConfigurationMaxKeys (type: integer) (units: -)
341 - :white_check_mark: HeartbeatInterval (type: integer) (units: seconds)
342 - :x: LocalAuthorizeOffline (type: boolean) (units: -)
343 - :x: LocalPreAuthorize (type: boolean) (units: -)
344 - :x: MeterValuesAlignedData (type: CSL) (units: -)
345 - :white_check_mark: MeterValuesSampledData (type: CSL) (units: -)
346 - :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds)
347 - :white_check_mark: NumberOfConnectors (type: integer) (units: -)
348 - :x: ResetRetries (type: integer) (units: times)
349 - :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -)
350 - :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -)
351 - :x: StopTransactionOnInvalidId (type: boolean) (units: -)
352 - :x: StopTxnAlignedData (type: CSL) (units: -)
353 - :x: StopTxnSampledData (type: CSL) (units: -)
354 - :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -)
355 - :x: TransactionMessageAttempts (type: integer) (units: times)
356 - :x: TransactionMessageRetryInterval (type: integer) (units: seconds)
357 - :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -)
358 - :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds)
360 #### Firmware Management Profile
364 #### Local Auth List Management Profile
366 - :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
367 - :x: LocalAuthListMaxLength (type: integer) (units: -)
368 - :x: SendLocalListMaxLength (type: integer) (units: -)
370 #### Reservation Profile
374 #### Smart Charging Profile
376 - :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
377 - :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
378 - :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
379 - :x: MaxChargingProfilesInstalled (type: integer) (units: -)
381 #### Remote Trigger Profile
387 Protocol to control the simulator via a Websocket or HTTP server.
389 ### WebSocket Protocol
391 PDU stands for Protocol Data Unit.
394 [`uuid`, `ProcedureName`, `PDU`]
395 `uuid`: String uniquely representing this request
396 `ProcedureName`: The procedure to run on the simulator
397 `PDU`: The parameters for said procedure
401 `uuid`: String uniquely linking the response to the request
402 `PDU`: Response data to requested procedure
406 Set the WebSocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
410 ##### Start Simulator
413 `ProcedureName`: 'startSimulator'
424 `ProcedureName`: 'stopSimulator'
432 ##### List Charging Stations
435 `ProcedureName`: 'listChargingStations'
441 `index`: ChargingStationData,
443 `index`: ChargingStationData
446 ##### Start Transaction
449 `ProcedureName`: 'startTransaction'
451 `hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array,
452 `connectorId`: connector id integer,
453 `idTag`: RFID tag string
461 ##### Stop Transaction
464 `ProcedureName`: 'stopTransaction'
466 `hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array,
467 `transactionId`: transaction id integer
475 ##### Start Charging Station
478 `ProcedureName`: 'startChargingStation'
480 `hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array
488 ##### Stop Charging Station
491 `ProcedureName`: 'stopChargingStation'
493 `hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array
501 ##### Open Connection
504 `ProcedureName`: 'openConnection'
506 `hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array
514 ##### Close Connection
517 `ProcedureName`: 'closeConnection'
519 `hashId`: charging station unique identifier string (deprecated) | `hashIds`: charging station unique identifier strings array
529 A Postman or Advanced REST client collection to learn how to use the HTTP protocol to pilot the simulator is available.
531 ## Support, Feedback, Contributing
533 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).
537 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.
541 Copyright 2020-2022 SAP SE or an SAP affiliate company and e-mobility-charging-stations-simulator contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/e-mobility-charging-stations-simulator).