Notify Display Messages
Source: OCPP 2.0.1 Part 2 — Specification (Edition 2, 2022-12-15) — Section 1.35 (Messages); Use Cases O03 — Get All DisplayMessages, O04 — Get Specific DisplayMessages (Functional Block O. DisplayMessage)
Overview
After the CSMS sends GetDisplayMessagesRequest, the Charging Station replies with one or more NotifyDisplayMessagesRequest messages containing the matching display messages. The report can be split across multiple messages using the tbc ("to be continued") flag.
Sequence Diagram
Charging Station ──── NotifyDisplayMessagesRequest ────▶ CSMS
(requestId, tbc?, messageInfo[]?)
Charging Station ◀─── NotifyDisplayMessagesResponse ──── CSMS
(repeated until tbc = false)
Initiator
Charging Station → CSMS
Fields
| Field Name | Field Type | Card. | Description |
|---|---|---|---|
| requestId | integer | 1..1 | Required. The id of the originating GetDisplayMessagesRequest. |
| tbc | boolean | 0..1 | Optional. "To be continued" indicator. Default false. |
| messageInfo | MessageInfoType | 0..* | Optional. The requested display message(s) as configured in the Charging Station. |
No fields are defined.
MessageInfoType (selected fields)
| Field | Type | Card. | Description |
|---|---|---|---|
| id | integer | 1..1 | Identifier of the message. |
| priority | MessagePriorityEnumType | 1..1 | AlwaysFront, InFront, NormalCycle. |
| state | MessageStateEnumType | 0..1 | Charging, Faulted, Idle, Unavailable. |
| startDateTime | dateTime | 0..1 | Optional start time of the message. |
| endDateTime | dateTime | 0..1 | Optional end time of the message. |
| transactionId | identifierString [0..36] | 0..1 | If linked to a specific transaction. |
| message | MessageContentType | 1..1 | The actual message content, format and language. |
| display | ComponentType | 0..1 | The display where the message should be shown. |
Examples
{
"requestId": 88,
"tbc": false,
"messageInfo": [
{
"id": 1,
"priority": "InFront",
"state": "Idle",
"message": {
"format": "ASCII",
"language": "en",
"content": "Welcome — please plug in your cable"
}
}
]
}{}Schema
Source:
schemas/NotifyDisplayMessagesRequest.json,schemas/NotifyDisplayMessagesResponse.json(OCPP 2.0.1 FINAL)