OCPP 2.0.1 Schemas — Diagnostics

Functional Block: K

Types Reference: Shared types referenced below are defined in OCPP-2.0.1-DataTypes.md.
Types used only within this block are documented inline below.

#Messages

• GetLog (CSMS → CS)
• LogStatusNotification (CS → CSMS)
• NotifyEvent (CS → CSMS)
• SetMonitoringBase (CSMS → CS)
• SetVariableMonitoring (CSMS → CS)
• SetMonitoringLevel (CSMS → CS)
• GetMonitoringReport (CSMS → CS)
• ClearVariableMonitoring (CSMS → CS)
• NotifyMonitoringReport (CS → CSMS)
• CustomerInformation (CSMS → CS)
• NotifyCustomerInformation (CS → CSMS)

#GetLog

Direction: CSMS → CS

#GetLogRequest

{
  "log": {
    "remoteLocation": "string"
  },
  "logType": "DiagnosticsLog",
  "requestId": 0
}

#GetLogResponse

#LogStatusNotification

Direction: CS → CSMS

#LogStatusNotificationRequest

{
  "status": "BadMessage"
}

#LogStatusNotificationResponse

No required fields. An empty {} is a valid response.

#NotifyEvent

Direction: CS → CSMS

#NotifyEventRequest

{
  "eventData": [
    {
      "eventId": 0,
      "timestamp": "2024-01-15T10:30:00Z",
      "trigger": "Alerting",
      "actualValue": "string",
      "eventNotificationType": "HardWiredNotification",
      "component": "{...}",
      "variable": "{...}"
    }
  ],
  "generatedAt": "2024-01-15T10:30:00Z",
  "seqNo": 0
}

#NotifyEventResponse

No required fields. An empty {} is a valid response.

#SetMonitoringBase

Direction: CSMS → CS

#SetMonitoringBaseRequest

{
  "monitoringBase": "All"
}

#SetMonitoringBaseResponse

#SetVariableMonitoring

Direction: CSMS → CS

#SetVariableMonitoringRequest

{
  "setMonitoringData": [
    {
      "value": 0.0,
      "type": "UpperThreshold",
      "severity": 0,
      "component": "{...}",
      "variable": "{...}"
    }
  ]
}

#SetVariableMonitoringResponse

#SetMonitoringLevel

Direction: CSMS → CS

#SetMonitoringLevelRequest

{
  "severity": 0
}

#SetMonitoringLevelResponse

#GetMonitoringReport

Direction: CSMS → CS

#GetMonitoringReportRequest

{
  "requestId": 0
}

#GetMonitoringReportResponse

#ClearVariableMonitoring

Direction: CSMS → CS

#ClearVariableMonitoringRequest

{
  "id": [
    0
  ]
}

#ClearVariableMonitoringResponse

#NotifyMonitoringReport

Direction: CS → CSMS

#NotifyMonitoringReportRequest

{
  "generatedAt": "2024-01-15T10:30:00Z",
  "requestId": 0,
  "seqNo": 0
}

#NotifyMonitoringReportResponse

No required fields. An empty {} is a valid response.

#CustomerInformation

Direction: CSMS → CS

#CustomerInformationRequest

{
  "clear": false,
  "report": false,
  "requestId": 0
}

#CustomerInformationResponse

#NotifyCustomerInformation

Direction: CS → CSMS

#NotifyCustomerInformationRequest

{
  "data": "string",
  "generatedAt": "2024-01-15T10:30:00Z",
  "requestId": 0,
  "seqNo": 0
}

#NotifyCustomerInformationResponse

No required fields. An empty {} is a valid response.

#Local Types

Types used only within this block's messages.

#ClearMonitoringStatusEnumType

Result of the clear request for this monitor, identified by its Id.

Used in: ClearVariableMonitoring

#CustomerInformationStatusEnumType

Indicates whether the request was accepted.

Used in: CustomerInformation

#EventNotificationEnumType

Specifies the event notification type of the message.

Used in: NotifyEvent

#EventTriggerEnumType

Type of monitor that triggered this event, e.g. exceeding a threshold value.

Used in: NotifyEvent

#LogEnumType

This contains the type of log file that the Charging Station should send.

Used in: GetLog

#LogStatusEnumType

This field indicates whether the Charging Station was able to accept the request.

Used in: GetLog

#MonitoringBaseEnumType

Specify which monitoring base will be set

Used in: SetMonitoringBase

#MonitoringCriterionEnumType

Used in: GetMonitoringReport

#SetMonitoringStatusEnumType

Status is OK if a value could be returned. Otherwise this will indicate the reason why a value could not be returned.

Used in: SetVariableMonitoring

#UploadLogStatusEnumType

This contains the status of the log upload.

Used in: LogStatusNotification

#ClearMonitoringResultType

Used in: ClearVariableMonitoring

#ComponentVariableType

Class to report components, variables and variable attributes and characteristics.

Used in: GetMonitoringReport, GetReport

#EventDataType

Class to report an event notification for a component-variable.

Used in: NotifyEvent

#LogParametersType

Generic class for the configuration of logging entries.

Used in: GetLog

#MonitoringDataType

Class to hold parameters of SetVariableMonitoring request.

Used in: NotifyMonitoringReport

#SetMonitoringDataType

Class to hold parameters of SetVariableMonitoring request.

Used in: SetVariableMonitoring

#SetMonitoringResultType

Class to hold result of SetVariableMonitoring request.

Used in: SetVariableMonitoring

#VariableMonitoringType

A monitoring setting for a variable.

Used in: NotifyMonitoringReport