The flexyPage Messenger is a tool for the message communication between a messaging center and the flexyPage device, e.g. elevator displays. The communication is facilitated via an MQTT broker. This document describes the relevant topics and payloads to communicate TO a device and understand its responses.
Available only on servers:
Accepts the following message:
An event describing that a client is connected to the broker uniquely identified by its client id.
This topic should be used in the last will and
testament (LWT). The payload should be then set
to "0" and a message-expiry-interval of 1
should be set.
[int] A value describing the connection status of an entity. Values could be a "0" for disconnected or a "1" for connected.
1
Available only on servers:
Accepts the following message:
An event describing that the device implementing this protocol accepts connections from the server.
[int] A value describing if connections are accepted. Values could be a 0 for ignoring connection requests or a 1 for accepting connection requests from server.
Available only on servers:
Accepts the following message:
An event describing that a client request the device to initiate the communication with the messaging center. The clientId in the payload helps the device to identify the communication partner and react on a disconnect.
Holds the client id of a client on the broker.
6a2f41a3-c54c-fce8-32d2-0324e1c32e22
Available only on servers:
Accepts the following message:
An event describing that a device just initialised the communication with the messaging center.
Holds the chat id used to group and bundle the messages and responses into a chat.
6a2f41a3-c54c-fce8-32d2-0324e1c32e22
Available only on servers:
Accepts the following message:
An event describing that a message center received the communication initiation for the given chatId.
Should send an array of available languages.
[
{
"locale": "en",
"name": "English",
"image": "dafsf"
}
]
Available only on servers:
Accepts the following message:
An event describing the language selected for the chat identified by the given chat id.
[ std::string ] Locale string.
en
Available only on servers:
Accepts the following message:
An event describing the sending of a message to the device identified by the serial number in a chat identified by the chat id.
The message object containing a yes or no question, a multiple choice question or a simple statement.
{
"operatorId": "operatorId",
"messageId": "71af0d51-06ba-4c97-ad00-c594b7df860e",
"message": "Are you hurt?",
"answers": [
"No",
"Yes"
],
"image": "<image-id|image-path>"
}
Available only on servers:
Accepts the following message:
An event describing the sending of an answer to the messaging center from the device identified by the serial number in a chat identified by the chat id to the message identified by message id.
[ std::string ] Index in answers array of message.
0
Available only on servers:
Accepts the following message:
An event describing that the device identified by serial number ended the communication on the chat identified by chat id.
[ std::string ] Should send an empty message.
Available only on servers:
Accepts the following message:
An event describing that the messaging center identified by clientId ended the communication to the device identified by serial number on the chat identified by chat id.
Holds the client id of a client on the broker.
6a2f41a3-c54c-fce8-32d2-0324e1c32e22
Available only on servers:
Accepts the following message:
An event describing MQTT client from device identified by serial number is connected to the mqtt broker.
[int] A value describing the connection status of an entity. Values could be a "0" for disconnected or a "1" for connected.
1
Available only on servers:
Accepts the following message:
An event describing that the device identified by serial number has a camera connected.
[int] A value describing the connection status of an entity. Values could be a "0" for disconnected or a "1" for connected.
1
Available only on servers:
Accepts the following message:
An event containing an base64 encoded image, that holds an image. That can be used for unrequested images.
[ std::string ] Base64 encoded jpeg image string.
string
Available only on servers:
Accepts the following message:
An event describing that the camera should take an image snapshot. The snapshot should be published with the given uuid in the payload and should have the dimensions specified by width and height.
The object information about how the snapshot should be taken and published. imageId specifies the uuid under which the image should be published. width and height specify the dimensions in which the image should be taken. A 0 value for both means max resolution of camera. Is only one value given the image should be scaled to this width or height in pixels while keeping the aspect ratio fixed.
{
"imageId": "71af0d51-06ba-4c97-ad00-c594b7df860e",
"width": 1024,
"height": 768
}
Available only on servers:
Accepts the following message:
An event containing an base64 encoded image, that holds the image that was requested with an camera/snapshot/take event.
[ std::string ] Base64 encoded jpeg image string.
string
Available only on servers:
Accepts the following message:
An event containing an error string, if the image creation was not successful.
[ std::string ] Human readable error string
string
Available only on servers:
Accepts the following message:
An event describing that help arrived on installation site of the device implementing this protocol.
Endpoint does not carry a payload.
Available only on servers:
Accepts the following message:
A signal notifying if a udp jpeg stream is supported.
[bool] True if in jpeg stream is supported.
Available only on servers:
Accepts the following message:
A signal triggering the start of an udp jpeg stream to port 5004 on the configured ECP device.
Available only on servers:
Accepts the following message:
A signal triggering the stop of an udp jpeg stream to port 5004 on the configured ECP device.
[int] A value describing the connection status of an entity. Values could be a "0" for disconnected or a "1" for connected.
[int] A value describing if connections are accepted. Values could be a 0 for ignoring connection requests or a 1 for accepting connection requests from server.
A language object containing a locale string and an image depicting the language.
The message object containing a yes or no question, a multiple choice question or a simple statement.
The object information about how the snapshot should be taken and published. imageId specifies the uuid under which the image should be published. width and height specify the dimensions in which the image should be taken. A 0 value for both means max resolution of camera. Is only one value given the image should be scaled to this width or height in pixels while keeping the aspect ratio fixed.
Holds the image id used uniquely identify an image in the whole system.
[ std::string ] The serial number of the device the communication happens with.
Holds the message id used uniquely identify a message in the whole system.
Holds the chat id used to group and bundle the messages and responses into a chat.
Holds the client id of a client on the broker.
[ std::string ] An answer option as string.
[ std::string ] Base64 encoded jpeg image string.
[ std::string ] A UUID