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.

Table of contents

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

Installation

Prerequisites

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

Windows

• Chocolatey:

choco install -y nodejs

MacOSX

• Homebrew:

brew install node

GNU/Linux

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

Development prerequisites (optional)

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

Unix

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

Windows

choco install -y volta

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

Branching model

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.

Dependencies

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

Initial configuration

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.

Start simulator

pnpm start

Start Web UI

See Web UI README.md for more information.

Configuration files syntax

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.

Charging stations simulator configuration

src/assets/config.json:

Worker process model

• 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

Charging station template configuration

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

Configuration section syntax example

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

AutomaticTransactionGenerator section syntax example

Type definition:

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'
}

Example:

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

Connectors section syntax example

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

Evses section syntax example

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

Charging station configuration

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.

stationInfo section (optional)

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.

connectorsStatus section

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.

evsesStatus section

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.

automaticTransactionGenerator section (optional)

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

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

automaticTransactionGeneratorStatuses section

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

configurationKey section (optional)

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.

Docker

In the docker folder:

make

OCPP-J commands supported

Version 1.6

Core Profile

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

Firmware Management Profile

• :white_check_mark: GetDiagnostics
• :white_check_mark: DiagnosticsStatusNotification
• :white_check_mark: FirmwareStatusNotification
• :white_check_mark: UpdateFirmware

Local Auth List Management Profile

• :x: GetLocalListVersion
• :x: SendLocalList

Reservation Profile

• :white_check_mark: CancelReservation
• :white_check_mark: ReserveNow

Smart Charging Profile

• :white_check_mark: ClearChargingProfile
• :white_check_mark: GetCompositeSchedule
• :white_check_mark: SetChargingProfile

Remote Trigger Profile

• :white_check_mark: TriggerMessage

Version 2.x.x

Provisioning

• :white_check_mark: BootNotification

Authorization

• :white_check_mark: ClearCache

Availability

• :white_check_mark: StatusNotification
• :white_check_mark: Heartbeat

OCPP-J standard parameters supported

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.

Version 1.6

Core Profile

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

Firmware Management Profile

• none

Local Auth List Management Profile

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

Reservation Profile

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

Smart Charging Profile

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

Remote Trigger Profile

• none

Version 2.x.x

UI Protocol

Protocol to control the simulator via a Websocket or HTTP server:

sequenceDiagram
Client->>UI Server: request
UI Server->>Client: response
Note over UI Server,Client: HTTP or Websocket

Websocket Protocol

SRPC protocol over Websocket. PDU stands for 'Protocol Data Unit'.

• 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.

Version 0.0.1

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

Procedures

Simulator State

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

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

Start Simulator

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

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

Stop Simulator

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

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

List Charging Station Templates

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

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

Add Charging Stations

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

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

Delete Charging Stations

• 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)
  }

Set Charging Station Supervision Url

• Request:
  ProcedureName: 'setSupervisionUrl'
  PDU: {
  hashIds: charging station unique identifier strings array (optional, default: all charging stations),
  url: 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)
  }

Performance Statistics

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

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

List Charging Stations

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

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

Start Charging Station

• 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)
  }

Stop Charging Station

• 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)
  }

Open Connection

• 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)
  }

Close Connection

• 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)
  }

Start Automatic Transaction Generator

• 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)
  }

Stop Automatic Transaction Generator

• 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)
  }

OCPP commands trigger

• 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)
  }

Examples:

• 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)
    }

HTTP Protocol

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.

Support, Feedback, Contributing

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.

Code of Conduct

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.

Licensing

Copyright 2020-2024 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.