Clear Variable Monitoring
Source: OCPP 2.0.1 Part 2 — Specification (Edition 2, 2022-12-15) — Section 1.10 (Messages); Use Case N06 — Clear / Remove Monitoring (Functional Block N. Diagnostics)
Overview
The CSMS sends ClearVariableMonitoringRequest to remove one or more variable monitors, identified by their monitor id. The CS replies with one ClearMonitoringResultType per requested id.
Sequence Diagram
CSMS ──── ClearVariableMonitoringRequest ────▶ Charging Station
(id[])
CSMS ◀─── ClearVariableMonitoringResponse ──── Charging Station
(clearMonitoringResult[])
Initiator
CSMS → Charging Station
Fields
| Field Name | Field Type | Card. | Description |
|---|---|---|---|
| id | integer | 1..* | Required. List of monitor ids to be cleared. |
| Field Name | Field Type | Card. | Description |
|---|---|---|---|
| clearMonitoringResult | ClearMonitoringResultType | 1..* | Required. Result status per monitor. |
ClearMonitoringResultType (selected fields)
| Field | Type | Card. | Description |
|---|---|---|---|
| status | ClearMonitoringStatusEnumType | 1..1 | Accepted / Rejected / NotFound. |
| id | integer | 1..1 | The monitor id this result applies to. |
| statusInfo | StatusInfoType | 0..1 | Optional. Detailed status information. |
ClearMonitoringStatusEnumType values
Accepted, Rejected, NotFound.
Examples
{
"id": [7, 8, 9]
}{
"clearMonitoringResult": [
{ "id": 7, "status": "Accepted" },
{ "id": 8, "status": "NotFound" },
{ "id": 9, "status": "Accepted" }
]
}Schema
Source:
schemas/ClearVariableMonitoringRequest.json,schemas/ClearVariableMonitoringResponse.json(OCPP 2.0.1 FINAL)