GetConfiguration
Reads configuration keys from the charge point, or enumerates all of them.
- Version
- OCPP 1.6
- Direction
- CSMS → Charge Point
- Feature profile
- Core
GetConfiguration reads back what ChangeConfiguration writes. Omitting key entirely asks for every key the charge point has, which is the fastest way to discover what a given model actually supports.
Keys the charger does not recognise come back in a separate unknownKey list rather than causing an error.
Request
| Field | Type | Required | Description |
|---|---|---|---|
key | CiString50[] | Optional | Keys to read. Omit to return every key. |
[2, "19223201", "GetConfiguration", {
"key": ["HeartbeatInterval", "MeterValueSampleInterval", "NotARealKey"]
}]Response
| Field | Type | Required | Description |
|---|---|---|---|
configurationKey | KeyValue[] | Optional | The keys that were found: key, readonly, and value. |
unknownKey | CiString50[] | Optional | Requested keys the charge point does not have. |
[3, "19223201", {
"configurationKey": [
{ "key": "HeartbeatInterval", "readonly": false, "value": "300" },
{ "key": "MeterValueSampleInterval", "readonly": false, "value": "60" }
],
"unknownKey": ["NotARealKey"]
}]Implementation notes
`value` is optional even for a key that exists. A key present in configurationKey with no value field is set to nothing — not an error, and not the same as an unknown key.
Asking for everything can produce a response larger than the charger's configured GetConfigurationMaxKeys, in which case it may truncate. Reading in batches is safer for stations with large key sets.
This is the correct first step when onboarding an unfamiliar charger model: enumerate the keys before assuming any standard one is present.