Set Display Message
Source: OCPP 2.0.1 Part 2 — Specification (Edition 2, 2022-12-15) — Section 1.52 (Messages); Use Cases O01 — Set DisplayMessage, O02 — Set DisplayMessage for Transaction, O06 — Replace DisplayMessage (Functional Block O. DisplayMessage)
Overview
The CSMS sends SetDisplayMessageRequest to configure a display message on the Charging Station — either a generic message (O01), a message tied to a specific transaction (O02), or a replacement of an existing message (O06).
The message carries MessageInfoType describing id, priority, state, optional time window, optional transactionId, the MessageContent (format/language/text), and optionally the display component where the message should be shown.
Sequence Diagram
CSMS ──── SetDisplayMessageRequest ────▶ Charging Station
(message)
CSMS ◀─── SetDisplayMessageResponse ──── Charging Station
(status, statusInfo?)
Initiator
CSMS → Charging Station
Fields
| Field Name | Field Type | Card. | Description |
|---|---|---|---|
| message | MessageInfoType | 1..1 | Required. The message to configure on the Charging Station. |
| Field Name | Field Type | Card. | Description |
|---|---|---|---|
| status | DisplayMessageStatusEnumType | 1..1 | Required. Whether the CS is able to display the message. |
| statusInfo | StatusInfoType | 0..1 | Optional. Detailed status information. |
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 | Start time of message visibility. |
| endDateTime | dateTime | 0..1 | End time of message visibility. |
| transactionId | identifierString [0..36] | 0..1 | If linked to a specific transaction. |
| message | MessageContentType | 1..1 | Content (format/language/text). |
| display | ComponentType | 0..1 | Display component on which to show the message. |
DisplayMessageStatusEnumType values
Accepted, NotSupportedMessageFormat, Rejected, NotSupportedPriority, NotSupportedState, UnknownTransaction.
Examples
{
"message": {
"id": 10,
"priority": "InFront",
"state": "Idle",
"message": {
"format": "ASCII",
"language": "en",
"content": "Welcome — please plug in your cable"
}
}
}{
"status": "Accepted"
}Schema
Source:
schemas/SetDisplayMessageRequest.json,schemas/SetDisplayMessageResponse.json(OCPP 2.0.1 FINAL)