AWS IoT Over-the-air Update  v3.0.0
Client library for AWS IoT OTA
ota_interface.c File Reference

Internal interface for setting the data and control planes. More...

#include <string.h>
#include <assert.h>
#include "ota_interface_private.h"

Functions

void setControlInterface (OtaControlInterface_t *pControlInterface)
 Set control interface for OTA operations. More...
 
OtaErr_t setDataInterface (OtaDataInterface_t *pDataInterface, const uint8_t *pProtocol)
 Set the data interface used for OTA operations. More...
 

Detailed Description

Internal interface for setting the data and control planes.

Function Documentation

◆ setControlInterface()

void setControlInterface ( OtaControlInterface_t pControlInterface)

Set control interface for OTA operations.

This function updates the OTA control operation functions as per the config options selected.

Parameters
[out]pControlInterfaceOTA Control interface.

◆ setDataInterface()

OtaErr_t setDataInterface ( OtaDataInterface_t pDataInterface,
const uint8_t *  pProtocol 
)

Set the data interface used for OTA operations.

This function updates the OTA data operation based on the config options. The interface can be set to the MQTT interface or the HTTP interface.

These interfaces can be enabled with the configENABLED_DATA_PROTOCOLS macro. The protocol interface that should be prioritized when both protocols are valid options is configured with the configOTA_PRIMARY_DATA_PROTOCOL macro.

Parameters
[out]pDataInterfaceOTA data interface to overwrite.
[in]pProtocolString containing a list of protocols that may be set.