Get Variables

Source: OCPP 2.0.1 Part 2 — Specification (Edition 2, 2022-12-15) — Section 1.28 (Messages); Use Case B06 — Get Variables (Functional Block B. Provisioning)

Overview

The CSMS sends GetVariablesRequest to read one or more Device Model Variables synchronously. The response contains the result for each requested variable: actual/target/min/max value, attribute type, and a per-variable status.

Unlike GetBaseReport / GetReport, this is a direct read with the values returned in the response — no NotifyReport follow-up.

Sequence Diagram

CSMS  ──── GetVariablesRequest ────▶  Charging Station
            (getVariableData[])
CSMS  ◀─── GetVariablesResponse ────  Charging Station
            (getVariableResult[])

Initiator

CSMS → Charging Station

Fields

GetVariableDataType

GetVariableResultType (selected fields)

Examples

{
  "getVariableData": [
    { "component": { "name": "OCPPCommCtrlr" }, "variable": { "name": "HeartbeatInterval" } },
    { "component": { "name": "EVSE", "evse": { "id": 1 } }, "variable": { "name": "AvailabilityState" } }
  ]
}

{
  "getVariableResult": [
    {
      "attributeStatus": "Accepted",
      "attributeValue": "300",
      "component": { "name": "OCPPCommCtrlr" },
      "variable": { "name": "HeartbeatInterval" }
    },
    {
      "attributeStatus": "Accepted",
      "attributeValue": "Available",
      "component": { "name": "EVSE", "evse": { "id": 1 } },
      "variable": { "name": "AvailabilityState" }
    }
  ]
}

Schema

Source: schemas/GetVariablesRequest.json, schemas/GetVariablesResponse.json (OCPP 2.0.1 FINAL)