Get Monitoring Report

Source: OCPP 2.0.1 Part 2 — Specification (Edition 2, 2022-12-15) — Section 1.25 (Messages); Use Case N02 — Get Monitoring report (Functional Block N. Diagnostics)

Overview

The CSMS sends GetMonitoringReportRequest to ask the Charging Station to report which monitors are currently configured for given components / variables. Filtering is by monitoringCriteria (up to 3) and/or by an explicit list of componentVariable[].

The CS first responds with GetMonitoringReportResponse(status), then delivers the actual data via one or more NotifyMonitoringReport messages sharing the same requestId.

Sequence Diagram

CSMS  ──── GetMonitoringReportRequest ────▶  Charging Station
            (requestId, monitoringCriteria[]?, componentVariable[]?)
CSMS  ◀─── GetMonitoringReportResponse ────  Charging Station
            (status, statusInfo?)

(then NotifyMonitoringReportRequest messages with same requestId)

Initiator

CSMS → Charging Station

Fields

MonitoringCriterionEnumType values

ThresholdMonitoring, DeltaMonitoring, PeriodicMonitoring.

GenericDeviceModelStatusEnumType values

Accepted, Rejected, NotSupported, EmptyResultSet.

Examples

{
  "requestId": 42,
  "monitoringCriteria": ["ThresholdMonitoring"],
  "componentVariable": [
    { "component": { "name": "EVSE", "evse": { "id": 1 } }, "variable": { "name": "Temperature" } }
  ]
}

{
  "status": "Accepted"
}

Schema

Source: schemas/GetMonitoringReportRequest.json, schemas/GetMonitoringReportResponse.json (OCPP 2.0.1 FINAL)