API for EVerest api clients implementing display message.
default local MQTT
The ID of the module as defined in the EVerest config file.
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Request to set a display message
{
"headers": {
"replyTo": "string"
},
"payload": [
{
"id": 0,
"priority": "AlwaysFront",
"state": "Charging",
"timestamp_from": "2019-08-24T14:15:22Z",
"timestamp_to": "2019-08-24T14:15:22Z",
"identifier_id": "string",
"identifier_type": "IdToken",
"message": {
"format": "ASCII",
"language": "string",
"content": "string"
},
"qr_code": "string"
}
]
}
Accepts the following message:
Reply to a request to set adisplay message
Response to the set display message request.
{
"status": "Accepted",
"status_info": "string"
}
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Request to get a display message
{
"headers": {
"replyTo": "string"
},
"payload": {
"id": [
0
],
"priority": "AlwaysFront",
"state": "Charging"
}
}
Accepts the following message:
Reply to a request to get adisplay message
Reponse on the 'get display message' request. Will return the requested display messages.
{
"status_info": "string",
"messages": [
{
"id": 0,
"priority": "AlwaysFront",
"state": "Charging",
"timestamp_from": "2019-08-24T14:15:22Z",
"timestamp_to": "2019-08-24T14:15:22Z",
"session_id": "string",
"message": {
"format": "ASCII",
"language": "string",
"content": "string"
},
"qr_code": "string"
}
]
}
Direction: EVerest to Module
Available only on servers:
Accepts the following message:
Request to clear a display message
{
"headers": {
"replyTo": "string"
},
"payload": {
"id": 0
}
}
Accepts the following message:
Reply to a request to clear adisplay message
Response on the clear display message request.
{
"status": "Accepted",
"status_info": "string"
}
Accepts the following message:
Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached
Heartbeat
Accepts the following message:
Signal to EVerest that communication is good or check shall be stopped
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check'
CommunicationCheck
Request to set a display message
Reply to a request to set adisplay message
Response to the set display message request.
Request to get a display message
Reply to a request to get adisplay message
Reponse on the 'get display message' request. Will return the requested display messages.
Request to clear a display message
Reply to a request to clear adisplay message
Response on the clear display message request.
Heartbeat produced by EVerest as configured via cfg_heartbeat_interval_ms in the EVerest configuration
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached
Signal to EVerest that communication is good or check shall be stopped
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check'
Request to remove a specific display message.
Response on the clear display message request.
Response on a clear display message request
Message to show on a display
Response on a display message request
The identifier type
Contains message details
Format of the message to be displayed
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.
During what state the message should be shown
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).
Reponse on the 'get display message' request. Will return the requested display messages.
Request to set a list of display messages.
Response to the set display message request.
Send 'true' at least every 'cfg_communication_check_to_s' seconds to signal module is alive. Send 'false' to stop communication check'
64bit unsigned integer. The id of every heartbeat increases by 1 and overflows when the maximum representable value is reached