OTA MQTT Interface

The OTA PAL interface definition.

OTA MQTT Overview

The OTA MQTT interface is a set of APIs that must be implemented by a library to enable the OTA library to connect to AWS IoT and manage notification and request data. The OTA library uses MQTT PUBLISH messages to inform AWS IoT about the job status and receives notifications and datablock over job and stream topics.

The OTA MQTT interface is defined in ota_mqtt_interface.h.

The functions that must be implemented are:

• OTA MQTT Subscribe
• OTA MQTT Unsubscribe
• OTA MQTT Publish

These functions can be grouped into the structure OtaMqttInterface_t and passed to OtaInterfaces_t to represent the MQTT interface.

OtaMqttInterface_t mqttInterface;
mqttInterface.subscribe = mqttSubscribe;
mqttInterface.unsubscribe = mqttUnsubscribe;
mqttInterface.publish = mqttPublish;
 
 ....
 
OtaInterfaces_t otaInterfaces;
otaInterfaces.mqtt = mqttInterface
 
 ....
 
OTA_Init( &otaBuffer,
          &otaInterfaces,
          ( CLIENT_IDENTIFIER ),
          otaAppCallback )