Skip to content
Documentation Menu

Change Configuration

Source: OCPP 1.6 Specification — Section 5.3 (Operation), Sections 6.9 / 6.10 (Messages)

Overview

Central System can request a Charge Point to change configuration parameters. To achieve this, Central System SHALL send a ChangeConfiguration.req. This request contains a key-value pair, where key is the name of the configuration setting to change and value contains the new setting for the configuration setting.

Upon receipt of a ChangeConfiguration.req Charge Point SHALL reply with a ChangeConfiguration.conf indicating whether it was able to execute the change. Content of key and value is not prescribed.

  • If key does not correspond to a configuration setting supported by Charge Point, it SHALL reply with status NotSupported.
  • If the change was executed successfully, the Charge Point SHALL respond with a status Accepted.
  • If the change was executed successfully, but a reboot is needed to apply it, the Charge Point SHALL respond with status RebootRequired.
  • In case of failure to set the configuration, the Charge Point SHALL respond with status Rejected.

If a key value is defined as a CSL (comma-separated list), it MAY be accompanied with a [KeyName]MaxLength key, indicating the max length of the CSL in items. If this key is not set, a safe value of 1 (one) item SHOULD be assumed.

Sequence Diagram

Figure 24. Sequence Diagram: Change Configuration

Central System  ──── ChangeConfiguration.req ────▶  Charge Point
                     (key, value)
Central System  ◀─── ChangeConfiguration.conf ────  Charge Point
                     (status)

Initiator

Central System → Charge Point

Fields

Field NameField TypeCard.Description
keyCiString50Type1..1Required. The name of the configuration setting to change.
valueCiString500Type1..1Required. The new value as string for the setting.

ConfigurationStatus values

  • Accepted — Configuration key is supported and setting has been changed.
  • Rejected — Configuration key is supported, but setting could not be changed.
  • RebootRequired — Configuration key is supported and setting has been changed, but change will be available after reboot (Charge Point will not reboot itself).
  • NotSupported — Configuration key is not supported.

Examples

{
  "key": "HeartbeatInterval",
  "value": "300"
}

Schema

Source: schemas/ChangeConfiguration.json, schemas/ChangeConfigurationResponse.json (OCPP 1.6, JSON Schema draft-04)

Request schema (JSON Schema)
Response schema (JSON Schema)