Simple node.js software to simulate and scale a set of charging stations based on the OCPP-J protocol as part of SAP e-Mobility solution.

• Installation
  • Prerequisites
    • Windows
    • macOS
    • GNU/Linux
  • Development prerequisites (optional)
    • Unix
    • Windows
  • Branching model
  • Dependencies
• Initial configuration
• Start simulator
• Start Web UI
• Start CLI
• Configuration files syntax
  • Charging stations simulator configuration
  • Charging station template configuration
  • Charging station configuration
• Docker
• OCPP-J commands supported
  • Version 1.6
  • Version 2.0.x
• OCPP-J standard parameters supported
  • Version 1.6
  • Version 2.0.x
• UI Protocol
  • MCP Protocol
  • WebSocket Protocol
  • HTTP Protocol (deprecated)
• Support, Feedback, Contributing
• Code of Conduct
• Licensing

Install the node.js current LTS or superior version runtime environment:

• Chocolatey:

choco install -y nodejs

• Homebrew:

brew install node

• NodeSource node.js binary distributions for all supported versions.

Install volta for managing automatically the node.js runtime and package manager version:

curl https://get.volta.sh | bash

choco install -y volta

Setup volta with pnpm package manager support: https://docs.volta.sh/advanced/pnpm

The main branch is the default development branch.
The vX branches are the maintenance branches for the corresponding major version X.
The vX.Y branches are the maintenance branches for the corresponding major and minor version X.Y.

Enable corepack, if volta is not installed and configured, and install latest pnpm version:

corepack enable
corepack prepare pnpm@latest --activate

In the repository root, run the following command:

pnpm install

Copy the configuration template file src/assets/config-template.json to src/assets/config.json.
Copy the RFID tags template file src/assets/idtags-template.json to src/assets/idtags.json.

Tweak them to your needs by following the section configuration files syntax: OCPP server supervision URL(s), charging station templates, etc.

pnpm start

See Web UI README.md for more information.

See CLI README.md for more information.

All configuration files are using the JSON standard syntax.

Configuration files locations:

• charging stations simulator configuration: src/assets/config.json;
• charging station configuration templates: src/assets/station-templates;
• charging station configurations: dist/assets/configurations;
• charging station RFID tags lists: src/assets.

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.

All charging station configuration templates are in the directory src/assets/station-templates.

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.

Configuration files hierarchy and priority:

1. charging station configuration: dist/assets/configurations;
2. charging station configuration template: src/assets/station-templates;
3. charging stations simulator configuration: src/assets/config.json.

The charging stations simulator has an automatic configuration files reload feature at change for:

• charging stations simulator configuration;
• charging station configuration templates;
• charging station authorization RFID tags lists.

But the modifications to test have to be done to the files in the build target directory dist/assets. Once the modifications are done, they have to be reported to the matching files in the build source directory src/assets to ensure they will be taken into account at next build.

src/assets/config.json:

• workerSet: Worker set executing each a fixed number (elementsPerWorker) of simulated charging stations from the total

• fixedPool: Fixedly sized worker pool executing a fixed total number of simulated charging stations

• dynamicPool (experimental): Dynamically sized worker pool executing a fixed total number of simulated charging stations

src/assets/station-templates/<name>.json:

  "Configuration": {
    "configurationKey": [
       ...
       {
        "key": "StandardKey",
        "readonly": false,
        "value": "StandardValue",
        "visible": true,
        "reboot": false
      },
      ...
      {
        "key": "VendorKey",
        "readonly": false,
        "value": "VendorValue",
        "visible": false,
        "reboot": true
      },
      ...
    ]
  }

type AutomaticTransactionGeneratorConfiguration = {
  enable: boolean
  minDuration: number
  maxDuration: number
  minDelayBetweenTwoTransactions: number
  maxDelayBetweenTwoTransactions: number
  probabilityOfStart: number
  stopAfterHours: number
  stopAbsoluteDuration: boolean
  requireAuthorize?: boolean
  idTagDistribution?: 'random' | 'round-robin' | 'connector-affinity'
}

  "AutomaticTransactionGenerator": {
    "enable": false,
    "minDuration": 60,
    "maxDuration": 80,
    "minDelayBetweenTwoTransactions": 15,
    "maxDelayBetweenTwoTransactions": 30,
    "probabilityOfStart": 1,
    "stopAfterHours": 0.3,
    "requireAuthorize": true,
    "idTagDistribution": "random"
  }

  "Connectors": {
    "0": {},
    "1": {
      "bootStatus": "Available",
      "maximumPower": 50000,
      "MeterValues": [
        ...
        {
          "unit": "W",
          "measurand": "Power.Active.Import",
          "phase": "L1-N",
          "value": "5000",
          "fluctuationPercent": "10"
        },
        ...
        {
          "unit": "A",
          "measurand": "Current.Import",
          "minimum": "0.5"
        },
        ...
        {
          "unit": "Wh"
        },
        ...
      ]
    }
  },

MeterValues can be defined at EVSE-level or at connector-level. EVSE-level definitions apply to all connectors of the EVSE and override connector-level definitions.

  "Evses": {
    "0": {
      "Connectors": {
        "0": {}
      }
    },
    "1": {
      "MeterValues": [
        ...
        {
          "unit": "W",
          "measurand": "Power.Active.Import",
          "phase": "L1-N",
          "value": "5000",
          "fluctuationPercent": "10"
        },
        ...
        {
          "unit": "A",
          "measurand": "Current.Import",
          "minimum": "0.5"
        },
        ...
        {
          "unit": "Wh"
        },
        ...
      ],
      "Connectors": {
        "1": {
          "bootStatus": "Available"
        }
      }
    }
  },

  "Evses": {
    "0": {
      "Connectors": {
        "0": {}
      }
    },
    "1": {
      "Connectors": {
        "1": {
          "bootStatus": "Available",
          "maximumPower": 22080,
          "MeterValues": [
            ...
            {
              "unit": "W",
              "measurand": "Power.Active.Import",
              "phase": "L1-N",
              "value": "5000",
              "fluctuationPercent": "10"
            },
            ...
            {
              "unit": "A",
              "measurand": "Current.Import",
              "minimum": "0.5"
            },
            ...
            {
              "unit": "Wh"
            },
            ...
          ]
        }
      }
    }
  },

The EV profile file is a JSON file referenced by the evProfilesFile template field. It defines a pool of EV charging profiles from which one is selected per transaction (weighted random, seeded deterministically). Consumed only when coherentMeterValues is true.

Schema (src/assets/<name>.json):

{
  "profiles": [
    {
      "id": "city-ev-40kWh",
      "weight": 3,
      "batteryCapacityWh": 40000,
      "maxPowerW": 11000,
      "initialSocPercentMin": 15,
      "initialSocPercentMax": 55,
      "chargingCurve": [
        { "socPercent": 0, "powerFraction": 1.0 },
        { "socPercent": 75, "powerFraction": 1.0 },
        { "socPercent": 90, "powerFraction": 0.4 },
        { "socPercent": 100, "powerFraction": 0.08 }
      ]
    }
  ]
}

A template file is available at src/assets/ev-profiles-template.json.

Template resolution scope. When coherentMeterValues is true, EVSE-level MeterValues (when defined and non-empty) override connector-level definitions for every connector under that EVSE; connector-level MeterValues are used when the connector is not grouped under an EVSE (flat Connectors map station layout) or when the EVSE-level array is undefined or empty. Note: the coherent generator emits templates from exactly one source (EVSE-level or the queried connector) - unlike the random/fixed path's getSampledValueTemplate, it does not aggregate MeterValues across sibling connectors under the same EVSE.

Phase-qualified measurands. When a connector template carries a phase field, the coherent generator emits one SampledValue per matching template with phase-aware values:

• Voltage: L1-N/L2-N/L3-N emit the sampled phase voltage; L1-L2/L2-L3/L3-L1 emit sqrt(phases) × sampled phase voltage (unsupported when phases < 2); N emits 0.
• Power.Active.Import: no phase emits total power; L1-N/L2-N/L3-N emit P / phases; line-to-line and N phases are unsupported and the template is skipped with a warning.
• Current.Import: any line phase (L1/L2/L3 or L1-N/L2-N/L3-N) emits sample.currentA (balanced 3-phase Y assumption); N emits 0; line-to-line phase is unsupported.
• Energy.Active.Import.Register: no phase emits the aggregate register; L1-N/L2-N/L3-N emit register / phases (balanced 3-phase Y contribution per phase); line-to-line and N phases are unsupported. On OCPP 2.0.1 stations, when SampledDataCtrlr.RegisterValuesWithoutPhases is true, templates are grouped into identity families keyed by (context, format, location, unit); within each family, per-phase L-N register templates are filtered out and, when a family has no aggregate template configured, an aggregate is synthesized from the first suppressed L-N of that family (phase cleared, other identity fields preserved) so the spec requirement "will only report the total energy over all phases" holds per family. On OCPP 1.6 stations the component-scoped configuration key is not present by default (getConfigurationKey returns undefined, convertToBoolean(undefined) === false), so current behavior is preserved.
• SoC: aggregate scalar; phase-qualified templates are skipped with a warning.

dist/assets/configurations/<hashId>.json:

The charging station configuration file is automatically generated at startup from the charging station configuration template file and is persistent.

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.

The syntax is similar to charging station configuration template with some added fields like the charging station id (name) and the 'Configuration' section removed.

That section is overwritten on matching charging station configuration template file changes.

The syntax is similar to charging station configuration template 'Connectors' section with some added fields.

That section is overwritten on matching charging station configuration template file changes.

The syntax is similar to charging station configuration template 'Evses' section with some added fields.

That section is overwritten on matching charging station configuration template file changes.

The syntax is similar to the charging station configuration template 'AutomaticTransactionGenerator' section.

That section is overwritten on matching charging station configuration template file changes.

That section is not overwritten on matching charging station configuration template file changes.

The syntax is similar to the charging station configuration template 'Configuration' section.

That section is not overwritten on matching charging station configuration template file changes.

In the docker folder:

make

The bundled Docker Compose configuration publishes the UI server on host loopback only (127.0.0.1:8080:8080) and disables requireTlsForNonLoopback for this local-only plaintext path. To expose the UI through a public host or reverse proxy, keep requireTlsForNonLoopback enabled and set uiServer.accessPolicy.allowedHosts, allowedOrigins, and trustedProxies in docker/config.json accordingly.

• ✅ Authorize
• ✅ BootNotification
• ✅ ChangeAvailability
• ✅ ChangeConfiguration
• ✅ ClearCache
• ✅ DataTransfer
• ✅ GetConfiguration
• ✅ Heartbeat
• ✅ MeterValues
• ✅ RemoteStartTransaction
• ✅ RemoteStopTransaction
• ✅ Reset
• ✅ StartTransaction
• ✅ StatusNotification
• ✅ StopTransaction
• ✅ UnlockConnector

• ✅ GetDiagnostics
• ✅ DiagnosticsStatusNotification
• ✅ FirmwareStatusNotification
• ✅ UpdateFirmware

• ✅ GetLocalListVersion
• ✅ SendLocalList

• ✅ CancelReservation
• ✅ ReserveNow

• ✅ ClearChargingProfile
• ✅ GetCompositeSchedule
• ✅ SetChargingProfile

• ✅ TriggerMessage

• ✅ SecurityEventNotification

• ✅ BootNotification
• ✅ GetBaseReport
• ✅ GetVariables
• ✅ NotifyReport
• ✅ SetNetworkProfile
• ✅ SetVariables

Note: SetNetworkProfile validates and accepts valid requests but does not persist the connection profile data (B09.FR.01).

• ✅ Authorize
• ✅ ClearCache

• ✅ GetLocalListVersion
• ✅ SendLocalList

• ✅ GetTransactionStatus
• ✅ RequestStartTransaction
• ✅ RequestStopTransaction
• ✅ TransactionEvent

• ✅ Reset
• ✅ TriggerMessage
• ✅ UnlockConnector

• ✅ ChangeAvailability
• ✅ Heartbeat
• ✅ MeterValues
• ✅ StatusNotification

• ✅ GetLog
• ✅ LogStatusNotification

• ✅ FirmwareStatusNotification
• ✅ UpdateFirmware

• ✅ CertificateSigned
• ✅ DeleteCertificate
• ✅ Get15118EVCertificate
• ✅ GetCertificateStatus
• ✅ GetInstalledCertificateIds
• ✅ InstallCertificate
• ✅ SignCertificate

Note: Certificate hierarchy verification required by A02.FR.06 is not implemented; only validity period is checked.

• ✅ CustomerInformation
• ✅ NotifyCustomerInformation

• ✅ DataTransfer

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.

• ✅ AuthorizeRemoteTxRequests (type: boolean) (units: -)
• ❌ ClockAlignedDataInterval (type: integer) (units: seconds)
• ✅ ConnectionTimeOut (type: integer) (units: seconds)
• ❌ GetConfigurationMaxKeys (type: integer) (units: -)
• ✅ HeartbeatInterval (type: integer) (units: seconds)
• ❌ LocalAuthorizeOffline (type: boolean) (units: -)
• ❌ LocalPreAuthorize (type: boolean) (units: -)
• ❌ MeterValuesAlignedData (type: CSL) (units: -)
• ✅ MeterValuesSampledData (type: CSL) (units: -)
• ✅ MeterValueSampleInterval (type: integer) (units: seconds)
• ✅ NumberOfConnectors (type: integer) (units: -)
• ❌ ResetRetries (type: integer) (units: times)
• ✅ ConnectorPhaseRotation (type: CSL) (units: -)
• ❌ StopTransactionOnEVSideDisconnect (type: boolean) (units: -)
• ❌ StopTransactionOnInvalidId (type: boolean) (units: -)
• ❌ StopTxnAlignedData (type: CSL) (units: -)
• ❌ StopTxnSampledData (type: CSL) (units: -)
• ✅ SupportedFeatureProfiles (type: CSL) (units: -)
• ❌ TransactionMessageAttempts (type: integer) (units: times)
• ❌ TransactionMessageRetryInterval (type: integer) (units: seconds)
• ❌ UnlockConnectorOnEVSideDisconnect (type: boolean) (units: -)
• ✅ WebSocketPingInterval (type: integer) (units: seconds)

• none

• ✅ LocalAuthListEnabled (type: boolean) (units: -)
• ✅ LocalAuthListMaxLength (type: integer) (units: -)
• ✅ SendLocalListMaxLength (type: integer) (units: -)

• ✅ ReserveConnectorZeroSupported (type: boolean) (units: -)

• ❌ ChargeProfileMaxStackLevel (type: integer) (units: -)
• ❌ ChargingScheduleAllowedChargingRateUnit (type: CSL) (units: -)
• ❌ ChargingScheduleMaxPeriods (type: integer) (units: -)
• ❌ MaxChargingProfilesInstalled (type: integer) (units: -)

• none

• ✅ AlignedDataSignReadings (type: boolean) (units: -) (vendor-specific)
• ✅ AlignedDataSignUpdatedReadings (type: boolean) (units: -) (vendor-specific)
• ✅ MeterPublicKey[ConnectorID] (type: string) (units: -) (vendor-specific)
• ✅ PublicKeyWithSignedMeterValue (type: optionlist) (units: -) (vendor-specific)
• ✅ SampledDataSignReadings (type: boolean) (units: -) (vendor-specific)
• ✅ SampledDataSignStartedReadings (type: boolean) (units: -) (vendor-specific)
• ✅ SampledDataSignUpdatedReadings (type: boolean) (units: -) (vendor-specific)
• ✅ SigningMethod (type: string) (units: -) (vendor-specific)
• ✅ StartTxnSampledData (type: memberlist) (units: -) (vendor-specific)

• ✅ Available (type: boolean) (units: -)
• ✅ Enabled (type: boolean) (units: -)
• ✅ Interval (type: integer) (units: seconds)
• ✅ Measurands (type: memberlist) (units: -)
• ✅ SendDuringIdle (type: boolean) (units: -)
• ✅ SignReadings (type: boolean) (units: -)
• ✅ SignUpdatedReadings (type: boolean) (units: -) (vendor-specific)
• ✅ TxEndedInterval (type: integer) (units: seconds)
• ✅ TxEndedMeasurands (type: memberlist) (units: -)

• ✅ Available (type: boolean) (units: -)
• ✅ DisablePostAuthorize (type: boolean) (units: -)
• ✅ Enabled (type: boolean) (units: -)
• ✅ LifeTime (type: integer) (units: -)
• ✅ Policy (type: optionlist) (units: -)
• ✅ Storage (type: integer) (units: -)

• ✅ AdditionalInfoItemsPerMessage (type: integer) (units: -)
• ✅ AuthorizeRemoteStart (type: boolean) (units: -)
• ✅ DisableRemoteAuthorization (type: boolean) (units: -)
• ✅ Enabled (type: boolean) (units: -)
• ✅ LocalAuthorizationOffline (type: boolean) (units: -)
• ✅ LocalPreAuthorization (type: boolean) (units: -)
• ✅ MasterPassGroupId (type: string) (units: -)
• ✅ OfflineTxForUnknownIdEnabled (type: boolean) (units: -)

• ✅ AutoManufacturerCode (type: integer) (units: -)
• ✅ CHAdeMOProtocolNumber (type: integer) (units: -)
• ✅ DynamicControl (type: boolean) (units: -)
• ✅ HighCurrentControl (type: boolean) (units: -)
• ✅ HighVoltageControl (type: boolean) (units: -)
• ✅ SelftestActive (type: boolean) (units: -)
• ✅ VehicleStatus (type: boolean) (units: -)

• ✅ AllowNewSessionsPendingFirmwareUpdate (type: boolean) (units: -)
• ✅ AvailabilityState (type: optionlist) (units: -)
• ✅ Available (type: boolean) (units: -)
• ✅ ConnectionUrl (type: string) (units: -) (vendor-specific)
• ✅ Model (type: string) (units: -)
• ✅ SupplyPhases (type: integer) (units: -)
• ✅ VendorName (type: string) (units: -)
• ✅ WebSocketPingInterval (type: integer) (units: seconds)

• ✅ DateTime (type: datetime) (units: -)
• ✅ NextTimeOffsetTransitionDateTime (type: datetime) (units: -)
• ✅ NtpServerUri (type: string) (units: -)
• ✅ NtpSource (type: optionlist) (units: -)
• ✅ TimeAdjustmentReportingThreshold (type: integer) (units: -)
• ✅ TimeOffset (type: string) (units: -)
• ✅ TimeSource (type: sequencelist) (units: -)
• ✅ TimeZone (type: string) (units: -)

• ✅ BytesPerMessage (type: integer) (units: -)
• ✅ ConfigurationValueSize (type: integer) (units: characters)
• ✅ ItemsPerMessage (type: integer) (units: -)
• ✅ ReportingValueSize (type: integer) (units: characters)
• ✅ ValueSize (type: integer) (units: characters)

• ✅ DisplayMessages (type: integer) (units: -)
• ✅ SupportedFormats (type: memberlist) (units: -)
• ✅ SupportedPriorities (type: memberlist) (units: -)

• ✅ AllowReset (type: boolean) (units: -)
• ✅ AvailabilityState (type: optionlist) (units: -)
• ✅ Available (type: boolean) (units: -)
• ✅ EvseId (type: string) (units: -)
• ✅ ISO15118EvseId (type: string) (units: -)
• ✅ Power (type: decimal) (units: W)
• ✅ SupplyPhases (type: integer) (units: -)

• ✅ SimulateSignatureVerificationFailure (type: boolean) (units: -) (vendor-specific)

• ✅ PublicKey (type: string) (units: -) (vendor-specific)
• ✅ SigningMethod (type: string) (units: -) (vendor-specific)

• ✅ CentralContractValidationAllowed (type: boolean) (units: -)
• ✅ ContractCertificateInstallationEnabled (type: boolean) (units: -)
• ✅ ContractValidationOffline (type: boolean) (units: -)
• ✅ CountryName (type: string) (units: -)
• ✅ MaxScheduleEntries (type: integer) (units: -)
• ✅ PnCEnabled (type: boolean) (units: -)
• ✅ RequestMeteringReceipt (type: boolean) (units: -)
• ✅ RequestedEnergyTransferMode (type: optionlist) (units: -)
• ✅ SeccId (type: string) (units: -)
• ✅ V2GCertificateInstallationEnabled (type: boolean) (units: -)

• ✅ Available (type: boolean) (units: -)
• ✅ BytesPerMessage (type: integer) (units: -)
• ✅ DisablePostAuthorize (type: boolean) (units: -)
• ✅ Enabled (type: boolean) (units: -)
• ✅ Entries (type: integer) (units: -)
• ✅ ItemsPerMessage (type: integer) (units: -)
• ✅ Storage (type: integer) (units: -)

• ✅ ActiveMonitoringBase (type: optionlist) (units: -)
• ✅ ActiveMonitoringLevel (type: integer) (units: -)
• ✅ Available (type: boolean) (units: -)
• ✅ BytesPerMessage (type: integer) (units: -)
• ✅ Enabled (type: boolean) (units: -)
• ✅ ItemsPerMessage (type: integer) (units: -)
• ✅ MonitoringBase (type: optionlist) (units: -)
• ✅ MonitoringLevel (type: integer) (units: -)
• ✅ OfflineQueuingSeverity (type: integer) (units: -)

• ✅ ActiveNetworkProfile (type: string) (units: -)
• ✅ FieldLength (type: integer) (units: -)
• ✅ FileTransferProtocols (type: memberlist) (units: -)
• ✅ HeartbeatInterval (type: integer) (units: seconds)
• ✅ MessageAttemptInterval (type: integer) (units: seconds)
• ✅ MessageAttempts (type: integer) (units: -)
• ✅ MessageTimeout (type: integer) (units: seconds)
• ✅ NetworkConfigurationPriority (type: string) (units: -)
• ✅ NetworkProfileConnectionAttempts (type: integer) (units: -)
• ✅ OfflineThreshold (type: integer) (units: seconds)
• ✅ PublicKeyWithSignedMeterValue (type: optionlist) (units: -)
• ✅ QueueAllMessages (type: boolean) (units: -)
• ✅ ResetRetries (type: integer) (units: -)
• ✅ RetryBackOffRandomRange (type: integer) (units: -)
• ✅ RetryBackOffRepeatTimes (type: integer) (units: -)
• ✅ RetryBackOffWaitMinimum (type: integer) (units: -)
• ✅ UnlockOnEVSideDisconnect (type: boolean) (units: -)
• ✅ WebSocketPingInterval (type: integer) (units: seconds)

• ✅ Available (type: boolean) (units: -)
• ✅ Enabled (type: boolean) (units: -)
• ✅ NonEvseSpecific (type: boolean) (units: -)

• ✅ Available (type: boolean) (units: -)
• ✅ Enabled (type: boolean) (units: -)
• ✅ RegisterValuesWithoutPhases (type: boolean) (units: -)
• ✅ SignReadings (type: boolean) (units: -)
• ✅ SignStartedReadings (type: boolean) (units: -) (vendor-specific)
• ✅ SignUpdatedReadings (type: boolean) (units: -) (vendor-specific)
• ✅ TxEndedInterval (type: integer) (units: seconds)
• ✅ TxEndedMeasurands (type: memberlist) (units: -)
• ✅ TxStartedMeasurands (type: memberlist) (units: -)
• ✅ TxUpdatedInterval (type: integer) (units: seconds)
• ✅ TxUpdatedMeasurands (type: memberlist) (units: -)

• ✅ AdditionalRootCertificateCheck (type: boolean) (units: -)
• ✅ BasicAuthPassword (type: string) (units: -)
• ✅ CertSigningRepeatTimes (type: integer) (units: -)
• ✅ CertSigningWaitMinimum (type: integer) (units: seconds)
• ✅ CertificateEntries (type: integer) (units: -)
• ✅ CertificatePrivateKey (type: string) (units: -) (vendor-specific)
• ✅ Identity (type: string) (units: -)
• ✅ MaxCertificateChainSize (type: integer) (units: -)
• ✅ OrganizationName (type: string) (units: -)
• ✅ SecurityProfile (type: integer) (units: -)

• ✅ ACPhaseSwitchingSupported (type: boolean) (units: -)
• ✅ Available (type: boolean) (units: -)
• ✅ Enabled (type: boolean) (units: -)
• ✅ Entries (type: integer) (units: -)
• ✅ ExternalControlSignalsEnabled (type: boolean) (units: -)
• ✅ LimitChangeSignificance (type: decimal) (units: percent)
• ✅ NotifyChargingLimitWithSchedules (type: boolean) (units: -)
• ✅ PeriodsPerSchedule (type: integer) (units: -)
• ✅ Phases3to1 (type: boolean) (units: -)
• ✅ ProfileStackLevel (type: integer) (units: -)
• ✅ RateUnit (type: memberlist) (units: -)

• ✅ Available (type: boolean) (units: -)
• ✅ Currency (type: string) (units: -)
• ✅ Enabled (type: boolean) (units: -)
• ✅ TariffFallbackMessage (type: string) (units: -)
• ✅ TotalCostFallbackMessage (type: string) (units: -)

• ✅ ChargingTime (type: decimal) (units: seconds)
• ✅ EVConnectionTimeOut (type: integer) (units: seconds)
• ✅ MaxEnergyOnInvalidId (type: integer) (units: Wh)
• ✅ StopTxOnEVSideDisconnect (type: boolean) (units: -)
• ✅ StopTxOnInvalidId (type: boolean) (units: -)
• ✅ TxBeforeAcceptedEnabled (type: boolean) (units: -)
• ✅ TxStartPoint (type: memberlist) (units: -)
• ✅ TxStopPoint (type: memberlist) (units: -)

Protocol to control the simulator via the UI server. Three transport types are available:

The recommended transport for programmatic access. MCP enables LLM agents and AI tools to discover and use the simulator's capabilities automatically.

SRPC protocol over WebSocket for real-time dashboard communication. PDU stands for 'Protocol Data Unit'.

sequenceDiagram
Client->>UI Server: request
UI Server->>Client: response
Note over UI Server,Client: WebSocket

• Request:
  [uuid, ProcedureName, PDU]
  uuid: String uniquely representing this request
  ProcedureName: The procedure to run on the simulator
  PDU: The parameters for said procedure

• Response:
  [uuid, PDU]
  uuid: String uniquely linking the response to the request
  PDU: Response parameters to requested procedure

To learn how to use the WebSocket protocol to pilot the simulator, an Insomnia WebSocket requests collection is available in src/assets/ui-protocol directory.

Set the WebSocket header Sec-WebSocket-Protocol to ui0.0.1.

• Request:
  ProcedureName: 'simulatorState'
  PDU: {}

• Response:
  PDU: {
  status: 'success' | 'failure',
  state: {
  version: string,
  configuration: ConfigurationData,
  started: boolean,
  templateStatistics: Record<string, TemplateStatistics>
  }
  }

• Request:
  ProcedureName: 'startSimulator'
  PDU: {}

• Response:
  PDU: {
  status: 'success' | 'failure'
  }

• Request:
  ProcedureName: 'stopSimulator'
  PDU: {}

• Response:
  PDU: {
  status: 'success' | 'failure'
  }

• Request:
  ProcedureName: 'listTemplates'
  PDU: {}

• Response:
  PDU: {
  status: 'success' | 'failure',
  templates: string[]
  }

• Request:
  ProcedureName: 'addChargingStations'
  PDU: {
  template: string,
  numberOfStations: number,
  options?: {
  autoRegister?: boolean,
  autoStart?: boolean,
  baseName?: string,
  enableStatistics?: boolean,
  fixedName?: boolean,
  nameSuffix?: string,
  ocppStrictCompliance?: boolean,
  persistentConfiguration?: boolean,
  stopTransactionsOnStopped?: boolean,
  supervisionPassword?: string,
  supervisionUrls?: string | string[],
  supervisionUser?: string
  }
  }

• Response:
  PDU: {
  status: 'success' | 'failure',
  hashIdsSucceeded: charging station unique identifier strings array (optional),
  hashIdsFailed: charging station unique identifier strings array (optional)
  }

• Request:
  ProcedureName: 'deleteChargingStations'
  PDU: {
  hashIds: charging station unique identifier strings array (optional, default: all charging stations),
  deleteConfiguration?: boolean
  }

• Response:
  PDU: {
  status: 'success' | 'failure',
  hashIdsSucceeded: charging station unique identifier strings array,
  hashIdsFailed: charging station unique identifier strings array (optional),
  responsesFailed: failed responses payload array (optional)
  }

• Request:
  ProcedureName: 'setSupervisionUrl'
  PDU: {
  hashIds: charging station unique identifier strings array (optional, default: all charging stations),
  url: string,
  supervisionUser?: string,
  supervisionPassword?: string
  }
  url is required. supervisionUser and supervisionPassword are each optional and independent: a string (including "", which clears the field) updates the value; omitting the field preserves the existing value. Changes take effect on the next WebSocket (re)connect.

• Response:
  PDU: {
  status: 'success' | 'failure',
  hashIdsSucceeded: charging station unique identifier strings array,
  hashIdsFailed: charging station unique identifier strings array (optional),
  responsesFailed: failed responses payload array (optional)
  }

• Request:
  ProcedureName: 'performanceStatistics'
  PDU: {}

• Response:
  PDU: {
  status: 'success' | 'failure',
  performanceStatistics: Statistics[]
  }

• Request:
  ProcedureName: 'listChargingStations'
  PDU: {}

• Response:
  PDU: {
  status: 'success' | 'failure',
  chargingStations: ChargingStationData[]
  }

• Request:
  ProcedureName: 'startChargingStation'
  PDU: {
  hashIds: charging station unique identifier strings array (optional, default: all charging stations)
  }

• Response:
  PDU: {
  status: 'success' | 'failure',
  hashIdsSucceeded: charging station unique identifier strings array,
  hashIdsFailed: charging station unique identifier strings array (optional),
  responsesFailed: failed responses payload array (optional)
  }

• Request:
  ProcedureName: 'stopChargingStation'
  PDU: {
  hashIds: charging station unique identifier strings array (optional, default: all charging stations)
  }

• Response:
  PDU: {
  status: 'success' | 'failure',
  hashIdsSucceeded: charging station unique identifier strings array,
  hashIdsFailed: charging station unique identifier strings array (optional),
  responsesFailed: failed responses payload array (optional)
  }

• Request:
  ProcedureName: 'openConnection'
  PDU: {
  hashIds: charging station unique identifier strings array (optional, default: all charging stations)
  }

• Response:
  PDU: {
  status: 'success' | 'failure',
  hashIdsSucceeded: charging station unique identifier strings array,
  hashIdsFailed: charging station unique identifier strings array (optional),
  responsesFailed: failed responses payload array (optional)
  }

• Request:
  ProcedureName: 'closeConnection'
  PDU: {
  hashIds: charging station unique identifier strings array (optional, default: all charging stations)
  }

• Response:
  PDU: {
  status: 'success' | 'failure',
  hashIdsSucceeded: charging station unique identifier strings array,
  hashIdsFailed: charging station unique identifier strings array (optional),
  responsesFailed: failed responses payload array (optional)
  }

• Request:
  ProcedureName: 'startAutomaticTransactionGenerator'
  PDU: {
  hashIds: charging station unique identifier strings array (optional, default: all charging stations),
  connectorIds: connector id integer array (optional, default: all connectors)
  }

• Response:
  PDU: {
  status: 'success' | 'failure',
  hashIdsSucceeded: charging station unique identifier strings array,
  hashIdsFailed: charging station unique identifier strings array (optional),
  responsesFailed: failed responses payload array (optional)
  }

• Request:
  ProcedureName: 'stopAutomaticTransactionGenerator'
  PDU: {
  hashIds: charging station unique identifier strings array (optional, default: all charging stations),
  connectorIds: connector id integer array (optional, default: all connectors)
  }

• Response:
  PDU: {
  status: 'success' | 'failure',
  hashIdsSucceeded: charging station unique identifier strings array,
  hashIdsFailed: charging station unique identifier strings array (optional),
  responsesFailed: failed responses payload array (optional)
  }

• Request:
  ProcedureName: 'lockConnector'
  PDU: {
  hashIds: charging station unique identifier strings array (optional, default: all charging stations),
  connectorId: connector id integer
  }

• Response:
  PDU: {
  status: 'success' | 'failure',
  hashIdsSucceeded: charging station unique identifier strings array,
  hashIdsFailed: charging station unique identifier strings array (optional),
  responsesFailed: failed responses payload array (optional)
  }

• Request:
  ProcedureName: 'unlockConnector'
  PDU: {
  hashIds: charging station unique identifier strings array (optional, default: all charging stations),
  connectorId: connector id integer
  }

• Response:
  PDU: {
  status: 'success' | 'failure',
  hashIdsSucceeded: charging station unique identifier strings array,
  hashIdsFailed: charging station unique identifier strings array (optional),
  responsesFailed: failed responses payload array (optional)
  }

• Request:
  ProcedureName: 'commandName' (the OCPP command name in camel case)
  PDU: {
  hashIds: charging station unique identifier strings array (optional, default: all charging stations),
  ...commandPayload
  } (the OCPP command payload with some optional fields added to target the simulated charging stations)

• Response:
  PDU: {
  status: 'success' | 'failure',
  hashIdsSucceeded: charging station unique identifier strings array,
  hashIdsFailed: charging station unique identifier strings array (optional),
  responsesFailed: failed responses payload array (optional)
  }

Available OCPP command procedure names:

OCPP 1.6: authorize, bootNotification, dataTransfer, diagnosticsStatusNotification, firmwareStatusNotification, heartbeat, meterValues, startTransaction, statusNotification, stopTransaction

OCPP 2.0.x: bootNotification, firmwareStatusNotification, get15118EVCertificate, getCertificateStatus, heartbeat, logStatusNotification, meterValues, notifyCustomerInformation, notifyReport, securityEventNotification, signCertificate, statusNotification, transactionEvent

Examples:

• Authorize

• Request:
  ProcedureName: 'authorize'
  PDU: {
  hashIds: charging station unique identifier strings array (optional, default: all charging stations),
  idTag: RFID tag string
  }

• Response:
  PDU: {
  status: 'success' | 'failure',
  hashIdsSucceeded: charging station unique identifier strings array,
  hashIdsFailed: charging station unique identifier strings array (optional),
  responsesFailed: failed responses payload array (optional)
  }

• Start Transaction

  • Request:
    ProcedureName: 'startTransaction'
    PDU: {
    hashIds: charging station unique identifier strings array (optional, default: all charging stations),
    connectorId: connector id integer,
    idTag: RFID tag string
    }

  • Response:
    PDU: {
    status: 'success' | 'failure',
    hashIdsSucceeded: charging station unique identifier strings array,
    hashIdsFailed: charging station unique identifier strings array (optional),
    responsesFailed: failed responses payload array (optional)
    }

• Stop Transaction

  • Request:
    ProcedureName: 'stopTransaction'
    PDU: {
    hashIds: charging station unique identifier strings array (optional, default: all charging stations),
    transactionId: transaction id integer
    }

  • Response:
    PDU: {
    status: 'success' | 'failure',
    hashIdsSucceeded: charging station unique identifier strings array,
    hashIdsFailed: charging station unique identifier strings array (optional),
    responsesFailed: failed responses payload array (optional)
    }

• Status Notification

  • Request:
    ProcedureName: 'statusNotification'
    PDU: {
    hashIds: charging station unique identifier strings array (optional, default: all charging stations),
    connectorId: connector id integer,
    errorCode: connector error code,
    status: connector status
    }

  • Response:
    PDU: {
    status: 'success' | 'failure',
    hashIdsSucceeded: charging station unique identifier strings array,
    hashIdsFailed: charging station unique identifier strings array (optional),
    responsesFailed: failed responses payload array (optional)
    }

• Heartbeat

  • Request:
    ProcedureName: 'heartbeat'
    PDU: {
    hashIds: charging station unique identifier strings array (optional, default: all charging stations)
    }

  • Response:
    PDU: {
    status: 'success' | 'failure',
    hashIdsSucceeded: charging station unique identifier strings array,
    hashIdsFailed: charging station unique identifier strings array (optional),
    responsesFailed: failed responses payload array (optional)
    }

Deprecated: Use "type": "mcp" for HTTP-based access to the simulator.

To learn how to use the HTTP protocol to pilot the simulator, an Insomnia HTTP requests collection is available in src/assets/ui-protocol directory.

This project is open to feature requests/suggestions, bug reports etc. via GitHub 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.

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 at all times.

Copyright 2020-2026 SAP SE or an SAP affiliate company and e-mobility-charging-stations-simulator contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.