Get Configuration

Source: OCPP 1.6 Specification — Section 5.8 (Operation), Sections 6.23 / 6.24 (Messages)

Overview

To retrieve the value of configuration settings, the Central System SHALL send a GetConfiguration.req PDU to the Charge Point.

If the list of keys in the request PDU is empty or missing (it is optional), the Charge Point SHALL return a list of all configuration settings in GetConfiguration.conf. Otherwise the Charge Point SHALL return a list of recognized keys and their corresponding values and read-only state. Unrecognized keys SHALL be placed in the response PDU as part of the optional unknownKey list element of GetConfiguration.conf.

The number of configuration keys requested in a single PDU MAY be limited by the Charge Point. This maximum can be retrieved by reading the configuration key GetConfigurationMaxKeys.

Sequence Diagram

Figure 29. Sequence Diagram: Get Configuration

Central System  ──── GetConfiguration.req ────▶  Charge Point
                     (key[]?)
Central System  ◀─── GetConfiguration.conf ────  Charge Point
                     (configurationKey[]?, unknownKey[]?)

Initiator

Central System → Charge Point

Fields

Field Name	Field Type	Card.	Description
key	CiString50Type	0..*	Optional. List of keys for which the configuration value is requested.

KeyValue type

Field	Type	Card.	Description
key	CiString50Type	1..1	The name of the configuration key.
readonly	boolean	1..1	If `true`, the configuration key cannot be changed.
value	CiString500Type	0..1	The value of the configuration key (if any).

Examples

{
  "configurationKey": [
    { "key": "HeartbeatInterval", "readonly": false, "value": "300" },
    { "key": "MeterValueSampleInterval", "readonly": false, "value": "60" }
  ],
  "unknownKey": ["DoesNotExist"]
}

GetConfigurationMaxKeys — Maximum number of keys per GetConfiguration.req.

Schema

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

Request schema (JSON Schema)

Response schema (JSON Schema)

Field Name	Field Type	Card.	Description
configurationKey	KeyValue	0..*	Optional. List of requested or known keys.
unknownKey	CiString50Type	0..*	Optional. Requested keys that are unknown.