Skip to content
Ivan Tustanivsky edited this page Sep 16, 2019 · 41 revisions

MQTT Utilities plugin API description

MQTT Client Interface

MQTT Client Interface

MQTT Client Interface represents the object that handles all communication with MQTT broker. It provides a set of methods that allow performing basic operations defined in MQTT protocol.

Creating MQTT Client

To create MQTT client call CreateMqttClient function. It takes MqttClientConfig structure as a parameter which specifies client settings like host URL, port number, client ID.

Connect

To establish connection with MQTT broker call Connect function on MQTT Client. Client connects to broker which was specified by MqttClientConfig structure during its creation. The function takes MqttConnectionData structure as a parameter which specifies users login and password.

Disconnect

To disconnect from MQTT broker call Disconnect function on MQTT Client.

Subscribe

To subscribe to a topic that the client is interested in call Subscribe function on MQTT Client. It takes topic name (as string) and quality of service (int value) as parameters.

Unsubscribe

To usubscribe from a topic call Unsubscribe function on MQTT Client. It takes topic name (as string) as a parameter.

Publish

To publish message to MQTT broker call Publish function on MQTT Client. It takes MqttMessage structure as a parameter which specifies message content, topic, quality of service and whether message should be retained.

Event handlers

MQTT Client can listen to several events triggered by MQTT broker during their communication. To receive and process certain callback corresponding handler should be set for MQTT Client.

Clone this wiki locally