MQTT response message structure
Structure of the MQTT response message that can be send from MQTT client to the firmware service and vice versa. Client sends the response message to the MQTT gateway (using topic), which will route the message to the service specified in field. When firmware service sends the response to the client, the message will be forwarded by MQTT gateway to the client using the MQTT topic specified by field.
- Message field must match the
- Message group must match the value of field from the original request.
| Field | Type | Required | Description |
|---|---|---|---|
| msg_group | string | + | Name of the message group aka message destination |
| msg_class | string | + | Message response class is |
| msg_subclass | string | + | Message response class is |
| result | object | + | Message information |
| result.sender | string | + | Service/client name that sended the message. Response will use this field as |
| result.uuid | string | + | Message uuid from the request |
| result.requestBody | object | + | Response parameters |
Examples
response:
{
“msg_group“:“response”,
“msg_class“: “mqtt.test_client”,
“msg_subclass“: “ResponseResult”,
“result“:{
“requestBody“: {
“controller_uuid“: ‘<“uuid”>’,
“controller_uuid“: ‘<“token”>’,
“uuid“: “63e134860000000174696003”
}
}
“msg_group“:“response”,
“msg_class“: “mqtt.test_client”,
“msg_subclass“: “ResponseResult”,
“result“:{
“requestBody“: {
“controller_uuid“: ‘<“uuid”>’,
“controller_uuid“: ‘<“token”>’,
“uuid“: “63e134860000000174696003”
}
}