1 <!-- markdownlint-disable-file MD033 MD024 -->
3 # [e-mobility charging stations simulator](https://github.com/sap/e-mobility-charging-stations-simulator)
5 [![CI worklow](https://github.com/SAP/e-mobility-charging-stations-simulator/actions/workflows/ci.yml/badge.svg)](https://github.com/SAP/e-mobility-charging-stations-simulator/actions/workflows/ci.yml)
6 [![REUSE status](https://api.reuse.software/badge/github.com/SAP/e-mobility-charging-stations-simulator)](https://api.reuse.software/info/github.com/SAP/e-mobility-charging-stations-simulator)
10 Simple [node.js](https://nodejs.org/) software to simulate and scale a set of charging stations based on the OCPP-J protocol as part of [SAP e-Mobility](https://www.sap.com/products/scm/e-mobility.html) solution.
14 Install the [node.js](https://nodejs.org/) current LTS or superior version runtime environment:
18 - [Chocolatey](https://chocolatey.org/):
21 choco install -y nodejs
26 - [Homebrew](https://brew.sh/):
34 - [NodeSource](https://github.com/nodesource/distributions) Node.js Binary Distributions for version >= 16.X
38 Enable corepack if not already done and install latest pnpm version:
42 corepack prepare pnpm@latest --activate
45 In the repository root, run the following command:
51 ## Initial configuration
53 Copy the configuration template file [src/assets/config-template.json](src/assets/config-template.json) to [src/assets/config.json](src/assets/config.json).
54 Copy the RFID tags template file [src/assets/idtags-template.json](src/assets/idtags-template.json) to [src/assets/idtags.json](src/assets/idtags.json).
56 Tweak them to your needs by following the section [configuration files syntax](README.md#configuration-files-syntax).
60 To start the program, run: `pnpm start`.
64 See Web UI [README.md](ui/web/README.md) for more information.
66 ## Configuration files syntax
68 All configuration files are in the JSON standard format.
70 **Configuration files locations**:
72 - charging stations simulator configuration: [src/assets/config.json](src/assets/config.json);
73 - charging station configuration templates: [src/assets/station-templates](src/assets/station-templates);
74 - charging station configurations: [dist/assets/configurations](dist/assets/configurations);
75 - charging station RFID tags lists: [src/assets](src/assets).
77 The charging stations simulator's configuration parameters must be within the `src/assets/config.json` file. A charging station simulator configuration template file is available at [src/assets/config-template.json](src/assets/config-template.json).
79 All charging station configuration templates are in the directory [src/assets/station-templates](src/assets/station-templates).
81 A list of RFID tags must be defined for the automatic transaction generator in a file with the default location and name: `src/assets/idtags.json`. A template file is available at [src/assets/idtags-template.json](src/assets/idtags-template.json).
83 **Configuration files hierarchy and priority**:
85 1. charging station configuration: [dist/assets/configurations](dist/assets/configurations);
86 2. charging station configuration template: [src/assets/station-templates](src/assets/station-templates);
87 3. charging stations simulator configuration: [src/assets/config.json](src/assets/config.json).
89 The charging stations simulator has an automatic configuration files reload feature at change for:
91 - charging stations simulator configuration;
92 - charging station configuration templates;
93 - charging station authorization RFID tags lists.
95 But the modifications to test have to be done to the files in the build target directory [dist/assets](dist/assets). Once the modifications are done, they have to be reported to the matching files in the build source directory [src/assets](src/assets) to ensure they will be taken into account at next build.
97 ### Charging stations simulator configuration
99 **src/assets/config.json**:
101 | Key | Value(s) | Default Value | Value type | Description |
102 | -------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
103 | supervisionUrls | | [] | string \| string[] | string or array of global connection URIs to OCPP-J servers |
104 | supervisionUrlDistribution | round-robin/random/charging-station-affinity | charging-station-affinity | boolean | supervision urls distribution policy to simulated charging stations |
105 | logStatisticsInterval | | 60 | integer | seconds between charging stations statistics output in the logs |
106 | logConsole | true/false | false | boolean | output logs on the console |
107 | logFormat | | simple | string | [winston](https://github.com/winstonjs/winston) log format |
108 | logRotate | true/false | true | boolean | enable daily log files rotation |
109 | logMaxFiles | x/"xd" where x is an integer | undefined | integer \| string | maximum number of log files: https://github.com/winstonjs/winston-daily-rotate-file#options |
110 | logMaxSize | x/"xk"/"xm"/"xg" where x is a number | undefined | number \| string | maximum size of log files in bytes, or units of kb, mb, and gb: https://github.com/winstonjs/winston-daily-rotate-file#options |
111 | logLevel | emerg/alert/crit/error/warning/notice/info/debug | info | string | [winston](https://github.com/winstonjs/winston) logging level |
112 | logFile | | combined.log | string | log file relative path |
113 | logErrorFile | | error.log | string | error log file relative path |
114 | 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 |
115 | uiServer | | {<br />"enabled": false,<br />"type": "ws",<br />"options": {<br />"host": "localhost",<br />"port": 8080<br />}<br />} | {<br />enabled: boolean;<br />type: ApplicationProtocol;<br />options: ServerOptions;<br />authentication: {<br />enabled: boolean;<br />type: AuthenticationType;<br />username: string;<br />password: string;<br />}<br />} | UI server configuration section |
116 | 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 |
117 | 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) |
119 #### Worker process model
122 Worker set executing each a static number (elementsPerWorker) of simulated charging stations from the total
125 Statically sized worker pool executing a static total number of simulated charging stations
128 Dynamically sized worker pool executing a static total number of simulated charging stations
130 ### Charging station configuration template
132 **src/assets/station-templates/\<name\>.json**:
134 | Key | Value(s) | Default Value | Value type | Description |
135 | ---------------------------------------------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
136 | supervisionUrls | | [] | string \| string[] | string or array of connection URIs to OCPP-J servers |
137 | supervisionUser | | undefined | string | basic HTTP authentication user to OCPP-J server |
138 | supervisionPassword | | undefined | string | basic HTTP authentication password to OCPP-J server |
139 | supervisionUrlOcppConfiguration | true/false | false | boolean | allow supervision URL configuration via a vendor OCPP parameter key |
140 | supervisionUrlOcppKey | | 'ConnectionUrl' | string | the vendor string that will be used as a vendor OCPP parameter key to set the supervision URL |
141 | ocppVersion | 1.6/2.0/2.0.1 | 1.6 | string | OCPP version |
142 | ocppProtocol | json | json | string | OCPP protocol |
143 | ocppStrictCompliance | true/false | false | boolean | strict adherence to the OCPP version and protocol specifications |
144 | 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) |
145 | 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) |
146 | 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) |
147 | wsOptions | | {} | ClientOptions & ClientRequestArgs | [ws](https://github.com/websockets/ws) and node.js [http](https://nodejs.org/api/http.html) clients options intersection |
148 | idTagsFile | | undefined | string | RFID tags list file relative to [src/assets](src/assets) path |
149 | baseName | | undefined | string | base name to build charging stations id |
150 | nameSuffix | | undefined | string | name suffix to build charging stations id |
151 | fixedName | true/false | false | boolean | use the baseName as the charging stations unique name |
152 | chargePointModel | | undefined | string | charging stations model |
153 | chargePointVendor | | undefined | string | charging stations vendor |
154 | chargePointSerialNumberPrefix | | undefined | string | charge point serial number prefix |
155 | chargeBoxSerialNumberPrefix | | undefined | string | charge box serial number prefix (deprecated in OCPP 1.6) |
156 | firmwareVersionPattern | | Semantic versionning regular expression: https://semver.org/#is-there-a-suggested-regular-expression-regex-to-check-a-semver-string | string | charging stations firmware version pattern |
157 | firmwareVersion | | undefined | string | charging stations firmware version |
158 | power | | | float \| float[] | charging stations maximum power value(s) |
159 | powerSharedByConnectors | true/false | false | boolean | charging stations power shared by its connectors |
160 | powerUnit | W/kW | W | string | charging stations power unit |
161 | currentOutType | AC/DC | AC | string | charging stations current out type |
162 | voltageOut | | AC:230/DC:400 | integer | charging stations voltage out |
163 | numberOfPhases | 0/1/3 | AC:3/DC:0 | integer | charging stations number of phase(s) |
164 | numberOfConnectors | | | integer \| integer[] | charging stations number of connector(s) |
165 | useConnectorId0 | true/false | true | boolean | use connector id 0 definition from the charging station configuration template |
166 | randomConnectors | true/false | false | boolean | randomize runtime connector id affectation from the connector id definition in charging station configuration template |
167 | resetTime | | 60 | integer | seconds to wait before the charging stations come back at reset |
168 | autoRegister | true/false | false | boolean | set charging stations as registered at boot notification for testing purpose |
169 | autoReconnectMaxRetries | | -1 (unlimited) | integer | connection retries to the OCPP-J server |
170 | reconnectExponentialDelay | true/false | false | boolean | connection delay retry to the OCPP-J server |
171 | registrationMaxRetries | | -1 (unlimited) | integer | charging stations boot notification retries |
172 | 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 |
173 | amperageLimitationUnit | A/cA/dA/mA | A | string | charging stations amperage limit unit |
174 | enableStatistics | true/false | false | boolean | enable charging stations statistics |
175 | mustAuthorizeAtRemoteStart | true/false | true | boolean | always send authorize at remote start transaction when AuthorizeRemoteTxRequests is enabled |
176 | payloadSchemaValidation | true/false | true | boolean | validate OCPP commands PDU against [OCA](https://www.openchargealliance.org/) JSON schemas |
177 | beginEndMeterValues | true/false | false | boolean | enable Transaction.{Begin,End} MeterValues |
178 | outOfOrderEndMeterValues | true/false | false | boolean | send Transaction.End MeterValues out of order. Need to relax OCPP specifications strict compliance ('ocppStrictCompliance' parameter) |
179 | meteringPerTransaction | true/false | true | boolean | enable metering history on a per transaction basis |
180 | transactionDataMeterValues | true/false | false | boolean | enable transaction data MeterValues at stop transaction |
181 | mainVoltageMeterValues | true/false | true | boolean | include charging stations main voltage MeterValues on three phased charging stations |
182 | phaseLineToLineVoltageMeterValues | true/false | false | boolean | include charging stations line to line voltage MeterValues on three phased charging stations |
183 | customValueLimitationMeterValues | true/false | true | boolean | enable limitation on custom fluctuated value in MeterValues |
184 | 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. |
185 | 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 |
186 | messageTriggerSupport | | {} | Record<MessageTrigger, boolean> | Configuration section for OCPP commands trigger support. Empty section means all implemented OCPP trigger commands are supported |
187 | Configuration | | | ChargingStationOcppConfiguration | charging stations OCPP parameters configuration section |
188 | AutomaticTransactionGenerator | | | AutomaticTransactionGeneratorConfiguration | charging stations ATG configuration section |
189 | Connectors | | | Record<string, ConnectorStatus> | charging stations connectors configuration section |
190 | Evses | | | Record<string, EvseTemplate> | charging stations EVSEs configuration section |
192 #### Configuration section syntax example
196 "configurationKey": [
199 "key": "StandardKey",
201 "value": "StandardValue",
209 "value": "VendorValue",
218 #### AutomaticTransactionGenerator section syntax example
220 ##### Type definition:
223 type AutomaticTransactionGeneratorConfiguration = {
227 minDelayBetweenTwoTransactions: number;
228 maxDelayBetweenTwoTransactions: number;
229 probabilityOfStart: number;
230 stopAfterHours: number;
231 stopOnConnectionFailure: boolean;
232 requireAuthorize?: boolean;
233 idTagDistribution?: 'random' | 'round-robin' | 'connector-affinity';
240 "AutomaticTransactionGenerator": {
244 "minDelayBetweenTwoTransactions": 15,
245 "maxDelayBetweenTwoTransactions": 30,
246 "probabilityOfStart": 1,
247 "stopAfterHours": 0.3,
248 "stopOnConnectionFailure": true,
249 "requireAuthorize": true,
250 "idTagDistribution": "random"
254 #### Connectors section syntax example
260 "bootStatus": "Available",
265 "measurand": "Power.Active.Import",
268 "fluctuationPercent": "10"
273 "measurand": "Current.Import",
286 #### Evses section syntax example
298 "bootStatus": "Available",
303 "measurand": "Power.Active.Import",
306 "fluctuationPercent": "10"
311 "measurand": "Current.Import",
326 ### Charging station configuration
328 **dist/assets/configurations/\<hashId\>.json**:
330 The charging station configuration file is automatically generated at startup from the charging station configuration template file and is persistent.
332 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.
334 #### stationInfo section
336 The syntax is similar to charging station configuration template with some added fields like the charging station id (name) and the 'Configuration' section removed.
338 #### configurationKey section
340 The syntax is similar to the charging station configuration template 'Configuration' section.
342 #### automaticTransactionGenerator section
344 The syntax is similar to the charging station configuration template 'AutomaticTransactionGenerator' section.
348 In the [docker](./docker) folder:
354 Or with the optional git submodules:
357 make SUBMODULES_INIT=true
360 ## OCPP-J commands supported
366 - :white_check_mark: Authorize
367 - :white_check_mark: BootNotification
368 - :white_check_mark: ChangeAvailability
369 - :white_check_mark: ChangeConfiguration
370 - :white_check_mark: ClearCache
371 - :white_check_mark: DataTransfer
372 - :white_check_mark: GetConfiguration
373 - :white_check_mark: Heartbeat
374 - :white_check_mark: MeterValues
375 - :white_check_mark: RemoteStartTransaction
376 - :white_check_mark: RemoteStopTransaction
377 - :white_check_mark: Reset
378 - :white_check_mark: StartTransaction
379 - :white_check_mark: StatusNotification
380 - :white_check_mark: StopTransaction
381 - :white_check_mark: UnlockConnector
383 #### Firmware Management Profile
385 - :white_check_mark: GetDiagnostics
386 - :white_check_mark: DiagnosticsStatusNotification
387 - :white_check_mark: FirmwareStatusNotification
388 - :white_check_mark: UpdateFirmware
390 #### Local Auth List Management Profile
392 - :x: GetLocalListVersion
395 #### Reservation Profile
397 - :x: CancelReservation
400 #### Smart Charging Profile
402 - :white_check_mark: ClearChargingProfile
403 - :x: GetCompositeSchedule
404 - :white_check_mark: SetChargingProfile
406 #### Remote Trigger Profile
408 - :white_check_mark: TriggerMessage
414 - :white_check_mark: BootNotification
418 - :white_check_mark: ClearCache
422 - :white_check_mark: StatusNotification
423 - :white_check_mark: Heartbeat
425 ## OCPP-J standard parameters supported
427 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.
433 - :white_check_mark: AuthorizeRemoteTxRequests (type: boolean) (units: -)
434 - :x: ClockAlignedDataInterval (type: integer) (units: seconds)
435 - :white_check_mark: ConnectionTimeOut (type: integer) (units: seconds)
436 - :x: GetConfigurationMaxKeys (type: integer) (units: -)
437 - :white_check_mark: HeartbeatInterval (type: integer) (units: seconds)
438 - :x: LocalAuthorizeOffline (type: boolean) (units: -)
439 - :x: LocalPreAuthorize (type: boolean) (units: -)
440 - :x: MeterValuesAlignedData (type: CSL) (units: -)
441 - :white_check_mark: MeterValuesSampledData (type: CSL) (units: -)
442 - :white_check_mark: MeterValueSampleInterval (type: integer) (units: seconds)
443 - :white_check_mark: NumberOfConnectors (type: integer) (units: -)
444 - :x: ResetRetries (type: integer) (units: times)
445 - :white_check_mark: ConnectorPhaseRotation (type: CSL) (units: -)
446 - :x: StopTransactionOnEVSideDisconnect (type: boolean) (units: -)
447 - :x: StopTransactionOnInvalidId (type: boolean) (units: -)
448 - :x: StopTxnAlignedData (type: CSL) (units: -)
449 - :x: StopTxnSampledData (type: CSL) (units: -)
450 - :white_check_mark: SupportedFeatureProfiles (type: CSL) (units: -)
451 - :x: TransactionMessageAttempts (type: integer) (units: times)
452 - :x: TransactionMessageRetryInterval (type: integer) (units: seconds)
453 - :x: UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -)
454 - :white_check_mark: WebSocketPingInterval (type: integer) (units: seconds)
456 #### Firmware Management Profile
460 #### Local Auth List Management Profile
462 - :white_check_mark: LocalAuthListEnabled (type: boolean) (units: -)
463 - :x: LocalAuthListMaxLength (type: integer) (units: -)
464 - :x: SendLocalListMaxLength (type: integer) (units: -)
466 #### Reservation Profile
470 #### Smart Charging Profile
472 - :x: ChargeProfileMaxStackLevel (type: integer) (units: -)
473 - :x: ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
474 - :x: ChargingScheduleMaxPeriods (type: integer) (units: -)
475 - :x: MaxChargingProfilesInstalled (type: integer) (units: -)
477 #### Remote Trigger Profile
485 Protocol to control the simulator via a Websocket or HTTP server.
489 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.
491 ### Websocket Protocol
493 SRPC protocol over Websocket. PDU stands for 'Protocol Data Unit'.
496 [`uuid`, `ProcedureName`, `PDU`]
497 `uuid`: String uniquely representing this request
498 `ProcedureName`: The procedure to run on the simulator
499 `PDU`: The parameters for said procedure
503 `uuid`: String uniquely linking the response to the request
504 `PDU`: Response parameters to requested procedure
506 An [Insomnia](https://insomnia.rest/) WebSocket requests collection is available in [src/assets/ui-protocol](./src/assets/ui-protocol) directory.
510 Set the Websocket header _Sec-Websocket-Protocol_ to `ui0.0.1`.
514 ###### Start Simulator
517 `ProcedureName`: 'startSimulator'
522 `status`: 'success' | 'failure'
525 ###### Stop Simulator
528 `ProcedureName`: 'stopSimulator'
533 `status`: 'success' | 'failure'
536 ###### List Charging Stations
539 `ProcedureName`: 'listChargingStations'
544 `status`: 'success' | 'failure',
545 `chargingStations`: ChargingStationData[]
548 ###### Start Charging Station
551 `ProcedureName`: 'startChargingStation'
553 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
558 `status`: 'success' | 'failure',
559 `hashIdsSucceeded`: charging station unique identifier strings array,
560 `hashIdsFailed`: charging station unique identifier strings array (optional)
561 `responsesFailed`: failed responses payload array (optional)
564 ###### Stop Charging Station
567 `ProcedureName`: 'stopChargingStation'
569 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
574 `status`: 'success' | 'failure',
575 `hashIdsSucceeded`: charging station unique identifier strings array,
576 `hashIdsFailed`: charging station unique identifier strings array (optional),
577 `responsesFailed`: failed responses payload array (optional)
580 ###### Open Connection
583 `ProcedureName`: 'openConnection'
585 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
590 `status`: 'success' | 'failure',
591 `hashIdsSucceeded`: charging station unique identifier strings array,
592 `hashIdsFailed`: charging station unique identifier strings array (optional),
593 `responsesFailed`: failed responses payload array (optional)
596 ###### Close Connection
599 `ProcedureName`: 'closeConnection'
601 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations)
606 `status`: 'success' | 'failure',
607 `hashIdsSucceeded`: charging station unique identifier strings array,
608 `hashIdsFailed`: charging station unique identifier strings array (optional),
609 `responsesFailed`: failed responses payload array (optional)
612 ###### Start Automatic Transaction Generator
615 `ProcedureName`: 'startAutomaticTransactionGenerator'
617 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
618 `connectorIds`: connector id integer array (optional, default: all connectors)
623 `status`: 'success' | 'failure',
624 `hashIdsSucceeded`: charging station unique identifier strings array,
625 `hashIdsFailed`: charging station unique identifier strings array (optional),
626 `responsesFailed`: failed responses payload array (optional)
629 ###### Stop Automatic Transaction Generator
632 `ProcedureName`: 'stopAutomaticTransactionGenerator'
634 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
635 `connectorIds`: connector id integer array (optional, default: all connectors)
640 `status`: 'success' | 'failure',
641 `hashIdsSucceeded`: charging station unique identifier strings array,
642 `hashIdsFailed`: charging station unique identifier strings array (optional),
643 `responsesFailed`: failed responses payload array (optional)
646 ###### OCPP commands trigger
649 `ProcedureName`: 'commandName' (the OCPP command name in camel case)
651 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
653 } (the OCPP command payload with some optional fields added to target the simulated charging stations)
657 `status`: 'success' | 'failure',
658 `hashIdsSucceeded`: charging station unique identifier strings array,
659 `hashIdsFailed`: charging station unique identifier strings array (optional),
660 `responsesFailed`: failed responses payload array (optional)
665 - **Start Transaction**
668 `ProcedureName`: 'startTransaction'
670 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
671 `connectorId`: connector id integer,
672 `idTag`: RFID tag string
677 `status`: 'success' | 'failure',
678 `hashIdsSucceeded`: charging station unique identifier strings array,
679 `hashIdsFailed`: charging station unique identifier strings array (optional),
680 `responsesFailed`: failed responses payload array (optional)
683 - **Stop Transaction**
686 `ProcedureName`: 'stopTransaction'
688 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
689 `transactionId`: transaction id integer
694 `status`: 'success' | 'failure',
695 `hashIdsSucceeded`: charging station unique identifier strings array,
696 `hashIdsFailed`: charging station unique identifier strings array (optional),
697 `responsesFailed`: failed responses payload array (optional)
700 - **Status Notification**
703 `ProcedureName`: 'statusNotification'
705 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
706 `connectorId`: connector id integer,
707 `errorCode`: connector error code,
708 `status`: connector status
713 `status`: 'success' | 'failure',
714 `hashIdsSucceeded`: charging station unique identifier strings array,
715 `hashIdsFailed`: charging station unique identifier strings array (optional),
716 `responsesFailed`: failed responses payload array (optional)
722 `ProcedureName`: 'heartbeat'
724 `hashIds`: charging station unique identifier strings array (optional, default: all charging stations),
729 `status`: 'success' | 'failure',
730 `hashIdsSucceeded`: charging station unique identifier strings array,
731 `hashIdsFailed`: charging station unique identifier strings array (optional),
732 `responsesFailed`: failed responses payload array (optional)
735 ## Support, Feedback, Contributing
737 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).
741 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.
745 Copyright 2020-2023 SAP SE or an SAP affiliate company and e-mobility-charging-stations-simulator contributors. Please see our [LICENSE](LICENSE) for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available [via the REUSE tool](https://api.reuse.software/info/github.com/SAP/e-mobility-charging-stations-simulator).