1 <!-- markdownlint-disable-file MD033 MD024 -->
2 # [e-mobility charging stations simulator](https://github.com/sap/e-mobility-charging-stations-simulator)
4 [![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)
8 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.
12 Install the [node.js](https://nodejs.org/) LTS runtime environment:
16 - [Chocolatey](https://chocolatey.org/):
19 choco install -y nodejs-lts
24 - [Homebrew](https://brew.sh/):
32 - [NodeSource](https://github.com/nodesource/distributions) Node.js Binary Distributions for version >= 16.X
36 In the repository root, run the following command:
42 ## Initial configuration
44 Copy the configuration template file [src/assets/config-template.json](src/assets/config-template.json) to [src/assets/config.json](src/assets/config.json).
45 Copy the authorization RFID tags template file [src/assets/authorization-tags-template.json](src/assets/authorization-tags-template.json) to [src/assets/authorization-tags.json](src/assets/authorization-tags.json).
47 Tweak them to your needs by following the section [configuration files syntax](README.md#configuration-files-syntax).
51 To start the program, run: `npm start`.
55 See Web UI [README.md](src/ui/web/README.md) for more information.
57 ## Configuration files syntax
59 All configuration files are in the JSON standard format.
61 **Configuration files locations**:
63 - charging stations simulator configuration: [src/assets/config.json](src/assets/config.json);
64 - charging station configuration templates: [src/assets/station-templates](src/assets/station-templates);
65 - charging station configurations: [dist/assets/configurations](dist/assets/configurations);
66 - charging station RFID tags lists: [src/assets](src/assets).
68 The charging stations simulator's configuration parameters must be within the `src/assets/config.json` file. A charging station simulator configuration template file is available at [src/assets/config-template.json](src/assets/config-template.json).
70 All charging station configuration templates are in the directory [src/assets/station-templates](src/assets/station-templates).
72 A list of RFID tags must be defined for the automatic transaction generator with a default location and name: `src/assets/authorization-tags.json`. A template file is available at [src/assets/authorization-tags-template.json](src/assets/authorization-tags-template.json).
74 **Configuration files hierarchy and priority**:
76 1. charging station configuration: [dist/assets/configurations](dist/assets/configurations);
77 2. charging station configuration template: [src/assets/station-templates](src/assets/station-templates);
78 3. charging stations simulator configuration: [src/assets/config.json](src/assets/config.json).
80 The charging stations simulator have an automatic configuration files reload feature at change for:
82 - charging stations simulator configuration;
83 - charging station configuration templates;
84 - charging station authorization RFID tags lists.
86 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.
88 ### Charging stations simulator configuration
90 **src/assets/config.json**:
92 | Key | Value(s) | Default Value | Value type | Description |
93 | -------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
94 | supervisionUrls | | [] | string \| string[] | string or array of global connection URIs to OCPP-J servers |
95 | supervisionUrlDistribution | round-robin/random/charging-station-affinity | charging-station-affinity | boolean | supervision urls distribution policy to simulated charging stations |
96 | logStatisticsInterval | | 60 | integer | seconds between charging stations statistics output in the logs |
97 | logConsole | true/false | false | boolean | output logs on the console |
98 | logFormat | | simple | string | winston log format |
99 | logRotate | true/false | true | boolean | enable daily log files rotation |
100 | logMaxFiles | | 7 | integer | maximum number of log files to keep |
101 | logLevel | emerg/alert/crit/error/warning/notice/info/debug | info | string | winston logging level |
102 | logFile | | combined.log | string | log file relative path |
103 | logErrorFile | | error.log | string | error log file relative path |
104 | worker | | {<br />"processType": "workerSet",<br />"startDelay": 500,<br />"elementStartDelay": 0,<br />"elementsPerWorker": 1,<br />"poolMinSize": 4,<br />"poolMaxSize": 16,<br />"poolStrategy": "ROUND_ROBIN"<br />} | {<br />processType: WorkerProcessType;<br />startDelay: number;<br />elementStartDelay: number;<br />elementsPerWorker: number;<br />poolMinSize: number;<br />poolMaxSize: number;<br />poolStrategy: WorkerChoiceStrategy;<br />} | Worker configuration section:<br />- processType: worker threads process type (workerSet/staticPool/dynamicPool)<br />- startDelay: milliseconds to wait at worker threads startup (only for workerSet threads process type)<br />- elementStartDelay: milliseconds to wait at charging station startup<br />- elementsPerWorker: number of charging stations per worker threads for the `workerSet` process type<br />- poolMinSize: worker threads pool minimum number of threads</br >- poolMaxSize: worker threads pool maximum number of threads<br />- poolStrategy: worker threads pool [poolifier](https://github.com/poolifier/poolifier) worker choice strategy |
105 | uiServer | | {<br />"enabled": true,<br />"type": "ws",<br />"options": {<br />"host": "localhost",<br />"port": 8080<br />}<br />} | {<br />enabled: boolean;<br />type: ApplicationProtocol;<br />options: ServerOptions;<br />authentication: {<br />enabled: boolean;<br />type: AuthenticationType;<br />username: string;<br />password: string;<br />}<br />} | UI server configuration section |
106 | 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 |
107 | 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) |
109 #### Worker process model
112 Worker set executing each a static number (elementsPerWorker) of simulated charging stations from the total
115 Statically sized worker pool executing a static total number of simulated charging stations
118 Dynamically sized worker pool executing a static total number of simulated charging stations
120 ### Charging station configuration template
122 **src/assets/station-templates/\<name\>.json**:
124 | Key | Value(s) | Default Value | Value type | Description |
125 | ---------------------------------- | ---------- | ----------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
126 | supervisionUrls | | '' | string \| string[] | string or array of connection URIs to OCPP-J servers |
127 | supervisionUser | | '' | string | basic HTTP authentication user to OCPP-J server |
128 | supervisionPassword | | '' | string | basic HTTP authentication password to OCPP-J server |
129 | supervisionUrlOcppConfiguration | true/false | false | boolean | allow supervision URL configuration via a vendor OCPP parameter key |
130 | supervisionUrlOcppKey | | 'ConnectionUrl' | string | the vendor string that will be used as a vendor OCPP parameter key to set the supervision URL |
131 | ocppVersion | 1.6 | 1.6 | string | OCPP version |
132 | ocppProtocol | json | json | string | OCPP protocol |
133 | ocppStrictCompliance | true/false | false | boolean | strict adherence to the OCPP version and protocol specifications |
134 | 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 |
135 | 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 |
136 | wsOptions | | {} | ClientOptions & ClientRequestArgs | [ws](https://github.com/websockets/ws) and node.js [http](https://nodejs.org/api/http.html) clients options intersection |
137 | authorizationFile | | '' | string | RFID tags list file relative to src/assets path |
138 | baseName | | '' | string | base name to build charging stations id |
139 | nameSuffix | | '' | string | name suffix to build charging stations id |
140 | fixedName | true/false | false | boolean | use the baseName as the charging stations unique name |
141 | chargePointModel | | '' | string | charging stations model |
142 | chargePointVendor | | '' | string | charging stations vendor |
143 | chargePointSerialNumberPrefix | | '' | string | charge point serial number prefix |
144 | chargeBoxSerialNumberPrefix | | '' | string | charge box serial number prefix (deprecated in OCPP 1.6) |
145 | firmwareVersion | | '' | string | charging stations firmware version |
146 | power | | | float \| float[] | charging stations maximum power value(s) |
147 | powerSharedByConnectors | true/false | false | boolean | charging stations power shared by its connectors |
148 | powerUnit | W/kW | W | string | charging stations power unit |
149 | currentOutType | AC/DC | AC | string | charging stations current out type |
150 | voltageOut | | AC:230/DC:400 | integer | charging stations voltage out |
151 | numberOfPhases | 0/1/3 | AC:3/DC:0 | integer | charging stations number of phase(s) |
152 | numberOfConnectors | | | integer \| integer[] | charging stations number of connector(s) |
153 | useConnectorId0 | true/false | true | boolean | use connector id 0 definition from the charging station configuration template |
154 | randomConnectors | true/false | false | boolean | randomize runtime connector id affectation from the connector id definition in charging station configuration template |
155 | resetTime | | 60 | integer | seconds to wait before the charging stations come back at reset |
156 | autoRegister | true/false | false | boolean | set charging stations as registered at boot notification for testing purpose |
157 | autoReconnectMaxRetries | | -1 (unlimited) | integer | connection retries to the OCPP-J server |
158 | reconnectExponentialDelay | true/false | false | boolean | connection delay retry to the OCPP-J server |
159 | registrationMaxRetries | | -1 (unlimited) | integer | charging stations boot notification retries |
160 | 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 |
161 | amperageLimitationUnit | A/cA/dA/mA | A | string | charging stations amperage limit unit |
162 | enableStatistics | true/false | true | boolean | enable charging stations statistics |
163 | mustAuthorizeAtRemoteStart | true/false | true | boolean | always send authorize at remote start transaction when AuthorizeRemoteTxRequests is enabled |
164 | payloadSchemaValidation | true/false | true | boolean | validate OCPP commands PDU against [OCA](https://www.openchargealliance.org/) JSON schemas |
165 | beginEndMeterValues | true/false | false | boolean | enable Transaction.{Begin,End} MeterValues |
166 | outOfOrderEndMeterValues | true/false | false | boolean | send Transaction.End MeterValues out of order. Need to relax OCPP specifications strict compliance ('ocppStrictCompliance' parameter) |
167 | meteringPerTransaction | true/false | true | boolean | enable metering history on a per transaction basis |
168 | transactionDataMeterValues | true/false | false | boolean | enable transaction data MeterValues at stop transaction |
169 | mainVoltageMeterValues | true/false | true | boolean | include charging stations main voltage MeterValues on three phased charging stations |
170 | phaseLineToLineVoltageMeterValues | true/false | true | boolean | include charging stations line to line voltage MeterValues on three phased charging stations |
171 | customValueLimitationMeterValues | true/false | true | boolean | enable limitation on custom fluctuated value in MeterValues |
172 | 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 |
173 | Configuration | | | ChargingStationConfiguration | charging stations OCPP parameters configuration section |
174 | AutomaticTransactionGenerator | | | AutomaticTransactionGenerator | charging stations ATG configuration section |
175 | Connectors | | | Connectors | charging stations connectors configuration section |
177 #### Configuration section
181 "configurationKey": [
184 "key": "StandardKey",
186 "value": "StandardValue",
194 "value": "VendorValue",
203 #### AutomaticTransactionGenerator section
205 Section type definition:
208 type AutomaticTransactionGeneratorConfiguration = {
212 minDelayBetweenTwoTransactions: number;
213 maxDelayBetweenTwoTransactions: number;
214 probabilityOfStart: number;
215 stopAfterHours: number;
216 stopOnConnectionFailure: boolean;
217 requireAuthorize?: boolean;
218 idTagDistribution?: 'random' | 'round-robin' | 'connector-affinity';
225 "AutomaticTransactionGenerator": {
229 "minDelayBetweenTwoTransactions": 15,
230 "maxDelayBetweenTwoTransactions": 30,
231 "probabilityOfStart": 1,
232 "stopAfterHours": 0.3,
233 "stopOnConnectionFailure": true,
234 "requireAuthorize": true,
235 "idTagDistribution": "random"
239 #### Connectors section
245 "bootStatus": "Available",
250 "measurand": "Power.Active.Import",
253 "fluctuationPercent": "10"
258 "measurand": "Current.Import"
270 ### Charging station configuration
272 **dist/assets/configurations/\<hashId\>.json**:
274 The charging station configuration file is automatically generated at startup from the charging station configuration template file and is persistent.
276 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.
278 #### stationInfo section
280 The syntax is similar to charging station configuration template with some added fields like the charging station id (name) and the 'Configuration' section removed.
282 #### configurationKey section
284 The syntax is similar to the charging station configuration template 'Configuration' section.
288 In the [docker](./docker) folder:
294 Or with the optional git submodules:
297 make SUBMODULES_INIT=true
300 ## OCPP-J commands supported
306 - :white_check_mark: Authorize
307 - :white_check_mark: BootNotification
308 - :white_check_mark: ChangeAvailability
309 - :white_check_mark: ChangeConfiguration
310 - :white_check_mark: ClearCache
312 - :white_check_mark: GetConfiguration
313 - :white_check_mark: Heartbeat
314 - :white_check_mark: MeterValues
315 - :white_check_mark: RemoteStartTransaction
316 - :white_check_mark: RemoteStopTransaction
317 - :white_check_mark: Reset
318 - :white_check_mark: StartTransaction
319 - :white_check_mark: StatusNotification
320 - :white_check_mark: StopTransaction
321 - :white_check_mark: UnlockConnector
323 #### Firmware Management Profile
325 - :white_check_mark: GetDiagnostics
326 - :white_check_mark: DiagnosticsStatusNotification
327 - :x: FirmwareStatusNotification
330 #### Local Auth List Management Profile
332 - :x: GetLocalListVersion
335 #### Reservation Profile
337 - :x: CancelReservation
340 #### Smart Charging Profile
342 - :white_check_mark: ClearChargingProfile
343 - :x: GetCompositeSchedule
344 - :white_check_mark: SetChargingProfile
346 #### Remote Trigger Profile
348 - :white_check_mark: TriggerMessage
350 ## OCPP-J standard parameters supported
352 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.
358 - :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -)
359 - :x: ClockAlignedDataInterval (type: integer) (units: seconds)
360 - :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds)
361 - :x: GetConfigurationMaxKeys (type: integer) (units: -)
362 - :white_check_mark: HeartbeatInterval (type: integer) (units: seconds)
363 - :x: LocalAuthorizeOffline (type: boolean) (units: -)
364 - :x: LocalPreAuthorize (type: boolean) (units: -)
365 - :x: MeterValuesAlignedData (type: CSL) (units: -)
366 - :white_check_mark: MeterValuesSampledData (type: CSL) (units: -)
367 - :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds)
368 - :white_check_mark: NumberOfConnectors (type: integer) (units: -)
369 - :x: ResetRetries (type: integer) (units: times)
370 - :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -)
371 - :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -)
372 - :x: StopTransactionOnInvalidId (type: boolean) (units: -)
373 - :x: StopTxnAlignedData (type: CSL) (units: -)
374 - :x: StopTxnSampledData (type: CSL) (units: -)
375 - :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -)
376 - :x: TransactionMessageAttempts (type: integer) (units: times)
377 - :x: TransactionMessageRetryInterval (type: integer) (units: seconds)
378 - :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -)
379 - :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds)
381 #### Firmware Management Profile
385 #### Local Auth List Management Profile
387 - :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
388 - :x: LocalAuthListMaxLength (type: integer) (units: -)
389 - :x: SendLocalListMaxLength (type: integer) (units: -)
391 #### Reservation Profile
395 #### Smart Charging Profile
397 - :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
398 - :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
399 - :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
400 - :x: MaxChargingProfilesInstalled (type: integer) (units: -)
402 #### Remote Trigger Profile
408 Protocol to control the simulator via a Websocket or HTTP server.
412 To learn how to use the HTTP protocol to pilot the simulator, an [Insomnia](https://insomnia.rest/) requests collection is available in [src/assets/ui-protocol](./src/assets/ui-protocol) directory.
414 ### Websocket Protocol
416 SRPC protocol over Websocket. PDU stands for 'Protocol Data Unit'.
419 [`uuid`, `ProcedureName`, `PDU`]
420 `uuid`: String uniquely representing this request
421 `ProcedureName`: The procedure to run on the simulator
422 `PDU`: The parameters for said procedure
426 `uuid`: String uniquely linking the response to the request
427 `PDU`: Response parameters to requested procedure
431 Set the Websocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
435 ###### Start Simulator
438 `ProcedureName`: 'startSimulator'
443 `status`: 'success' | 'failure'
446 ###### Stop Simulator
449 `ProcedureName`: 'stopSimulator'
454 `status`: 'success' | 'failure'
457 ###### List Charging Stations
460 `ProcedureName`: 'listChargingStations'
465 `status`: 'success' | 'failure',
466 `chargingStations`: ChargingStationData[]
469 ###### Start Transaction
472 `ProcedureName`: 'startTransaction'
474 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
475 `connectorId`: connector id integer,
476 `idTag`: RFID tag string
481 `status`: 'success' | 'failure',
482 `hashIdsSucceeded`: charging station unique identifier strings array,
483 `hashIdsFailed`: charging station unique identifier strings array (optional),
484 `responsesFailed`: failed responses payload array (optional)
487 ###### Stop Transaction
490 `ProcedureName`: 'stopTransaction'
492 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
493 `transactionId`: transaction id integer
498 `status`: 'success' | 'failure',
499 `hashIdsSucceeded`: charging station unique identifier strings array,
500 `hashIdsFailed`: charging station unique identifier strings array (optional),
501 `responsesFailed`: failed responses payload array (optional)
504 ###### Start Charging Station
507 `ProcedureName`: 'startChargingStation'
509 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
510 `responsesFailed`: failed responses payload array (optional)
515 `status`: 'success' | 'failure',
516 `hashIdsSucceeded`: charging station unique identifier strings array,
517 `hashIdsFailed`: charging station unique identifier strings array (optional)
520 ###### Stop Charging Station
523 `ProcedureName`: 'stopChargingStation'
525 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
530 `status`: 'success' | 'failure',
531 `hashIdsSucceeded`: charging station unique identifier strings array,
532 `hashIdsFailed`: charging station unique identifier strings array (optional),
533 `responsesFailed`: failed responses payload array (optional)
536 ###### Open Connection
539 `ProcedureName`: 'openConnection'
541 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
546 `status`: 'success' | 'failure',
547 `hashIdsSucceeded`: charging station unique identifier strings array,
548 `hashIdsFailed`: charging station unique identifier strings array (optional),
549 `responsesFailed`: failed responses payload array (optional)
552 ###### Close Connection
555 `ProcedureName`: 'closeConnection'
557 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
562 `status`: 'success' | 'failure',
563 `hashIdsSucceeded`: charging station unique identifier strings array,
564 `hashIdsFailed`: charging station unique identifier strings array (optional),
565 `responsesFailed`: failed responses payload array (optional)
568 ###### Start Automatic Transaction Generator
571 `ProcedureName`: 'startAutomaticTransactionGenerator'
573 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
574 `connectorIds`: connector id integer array (optional, default: all connectors)
579 `status`: 'success' | 'failure',
580 `hashIdsSucceeded`: charging station unique identifier strings array,
581 `hashIdsFailed`: charging station unique identifier strings array (optional),
582 `responsesFailed`: failed responses payload array (optional)
585 ###### Stop Automatic Transaction Generator
588 `ProcedureName`: 'stopAutomaticTransactionGenerator'
590 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
591 `connectorIds`: connector id integer array (optional, default: all connectors)
596 `status`: 'success' | 'failure',
597 `hashIdsSucceeded`: charging station unique identifier strings array,
598 `hashIdsFailed`: charging station unique identifier strings array (optional),
599 `responsesFailed`: failed responses payload array (optional)
602 ###### Status Notification
605 `ProcedureName`: 'StatusNotification'
607 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
608 `connectorId`: connector id integer,
609 `errorCode`: connector error code,
610 `status`: connector status
615 `status`: 'success' | 'failure',
616 `hashIdsSucceeded`: charging station unique identifier strings array,
617 `hashIdsFailed`: charging station unique identifier strings array (optional),
618 `responsesFailed`: failed responses payload array (optional)
624 `ProcedureName`: 'Heartbeat'
626 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
631 `status`: 'success' | 'failure',
632 `hashIdsSucceeded`: charging station unique identifier strings array,
633 `hashIdsFailed`: charging station unique identifier strings array (optional),
634 `responsesFailed`: failed responses payload array (optional)
637 ## Support, Feedback, Contributing
639 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).
643 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.
647 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).