1.2.3 MQTT System Service Interface
Data Types and Constants Summary
| Name | Description |
|---|---|
| SYS_MQTT_INTF_WIFI | Mqtt Socket Intf - Wifi |
| SYS_MQTT_INTF_ETHERNET | Mqtt Socket Intf - Ethernet |
| SYS_MQTT_STATUS | Identifies the current status of the Sys Mqtt Instance. |
| SYS_MQTT_RESULT | Identifies the return values for the Sys Mqtt APIs. |
| SYS_MQTT_BrokerConfig | Used for passing on the configuration related to the MQTT Broker |
| SYS_MQTT_SubscribeConfig | Used for passing on the configuration related to the MQTT Subtopics the user |
| SYS_MQTT_PublishConfig | Used for Reading the message that has been received on a topic subscribed to. |
| SYS_MQTT_PublishTopicCfg | Used for publishing a message on a topic. It contains the config related to the Topic |
| SYS_MQTT_EVENT_TYPE | Event Message Type which comes with the Callback SYS_MQTT_CALLBACK() |
| SYS_MQTT_Config | Used for passing on the configuration related to the either MQTT Broker, |
Initialization functions Summary
| Name | Description |
|---|---|
| SYS_MQTT_Initialize | Returns success/ failure for initialization of data structures of the MQTT service |
| SYS_MQTT_Deinitialize | Deinitialization of data structures of the MQTT service |
Status functions Summary
| Name | Description |
|---|---|
| SYS_MQTT_GetStatus | Returns System MQTT instance status. |
Setup functions Summary
| Name | Description |
|---|---|
| SYS_MQTT_Connect | Connects to the configured MQTT Broker. |
| SYS_MQTT_Disconnect | Disconnects from the MQTT Server |
| SYS_MQTT_Task | Executes the MQTT Service State Machine |
| SYS_MQTT_Subscribe | Returns success/ failure for the subscribing to a Topic by the user. |
| SYS_MQTT_Unsubscribe | Returns success/ failure for the unsubscribing to a Topic by the user. |
Data Exchange functions Summary
| Name | Description |
|---|---|
| SYS_MQTT_Publish | Returns success/ failure for the publishing of message asked by the user. |
| SYS_MQTT_CALLBACK | Pointer to a MQTT system service callback function. |