13.3.4. display_message

Message to show on a display

MessagePriorityEnum:string
Priority of the message. AlwaysFront is the highest priority: The Charging Station SHALL show this message at the configured moment, regardless of other installed messages. Hence, it shall not cycle it with other messages and the Charging Station’s own message shall not override this message. When a newer message with this MessagePriority is received, this message is replaced. InFront: The Charging Station SHALL show this message at the configured moment, regardless of the normal cycle of messages. If there are multiple InFront message that must be shown at the same time, they must be cycled. NormalCycle: Show this message in the cycle of messages.
enum:
- AlwaysFront
- InFront
- NormalCycle
MessageStateEnum:string
During what state the message should be shown
enum:
- Charging
- Faulted
- Idle
- Unavailable
DisplayMessageStatusEnum:string
Response on a display message request
enum:
- Accepted
- NotSupportedMessageFormat
- Rejected
- NotSupportedPriority
- NotSupportedState
- UnknownTransaction
ClearMessageResponseEnum:string
Response on a clear display message request
enum:
- Accepted
- Unknown
MessageContent:object
Contains message details
properties:
format:string <optional> (display_message-MessageFormat)

There is an extended definition for this object here.
language:string <optional>

content:string <required>

MessageFormat:string
Format of the message to be displayed
enum:
- ASCII
- HTML
- URI
- UTF8
DisplayMessage:object
Message to show on a display
properties:
id:integer <optional>
The message id
priority:string <optional> (display_message-MessagePriorityEnum)
Priority of the message. For OCPP 2.0.1, this is a required property. But as we also use this interface outside of ocpp, for other messages it is not required and if priority is not given, we assume it is the lowest priority, ‘NormalCycle’. When priority is ‘AlwaysFront’ and there already is a message with priority ‘AlwaysFront’, the last received message shall replace the already existing message.
There is an extended definition for this object here.
state:string <optional> (display_message-MessageStateEnum)
During what state should this message be shown. When omitted, this message should be shown in any state of the Charging Station
There is an extended definition for this object here.
timestamp_from:string <optional>
From what date-time should this message be shown. If omitted: directly.
format:date-time
timestamp_to:string <optional>
Until what date-time should this message be shown, after this date/time this message SHALL be removed. If omitted, message can be shown ‘forever’ (until it is specifically removed).
format:date-time
identifier_id:string <optional>
To which user / during which session shall this message be shown. User can be identified by id token (when the session did not start yet), session id or transaction id. identifier_type will hold the type of identifier_id (default session id). Message SHALL be removed by the Charging Station after session has ended. If omitted, message is not tight to a session.
identifier_type:string <optional>
The type of ‘identifier_id’. If omitted, type will be session id.
enum:
- IdToken
- SessionId
- TransactionId
message:object <required> (display_message-MessageContent)
The message to show
There is an extended definition for this object here.
qr_code:string <optional>
QR Code to scan for more information.
SetDisplayMessageResponse:object
Response to the set display message request.
properties:
status:object <required> (display_message-DisplayMessageStatusEnum)
Whether the charging station is able to display the message
There is an extended definition for this object here.
status_info:string <optional>
Detailed status information
GetDisplayMessageRequest:object
Request display messages. The properties are filtered. If the properties are omitted, there will be no filter applied (if all properties are omitted, all stored display messages will be returned).
properties:
id:array <required>
If provided the Charging Station shall return Display Messages of the given ids.
array_item:integer


priority:string <required> (display_message-MessagePriorityEnum)
If provided the Charging Station shall return Display Messages with the given priority only.
There is an extended definition for this object here.
state:string <required> (display_message-MessageStateEnum)
If provided the Charging Station shall return Display Messages with the given state only.
There is an extended definition for this object here.
GetDisplayMessageResponse:object
Reponse on the ‘get display message’ request. Will return the requested display messages.
properties:
status_info:string <required>
Detailed status information
messages:array <required>
Requested messages, if any
array_item:object (display_message-DisplayMessage)

There is an extended definition for this object here.

ClearDisplayMessageRequest:object
Request to remove a specific display message.
properties:
id:integer <required>
Id of display message that should be removed from the charging station
ClearDisplayMessageResponse:object
Response on the clear display message request.
properties:
status:object <required> (display_message-ClearMessageResponseEnum)

There is an extended definition for this object here.
status_info:string <optional>