Contains function definitions and structures for data and control interfaces. More...

#include "ota.h"
#include "ota_private.h"

Include dependency graph for ota_interface_private.h:

This graph shows which files directly or indirectly include this file:

Data Structures
struct	OtaControlInterface_t
	Represents the OTA control interface functions. More...

struct	OtaDataInterface_t
	Represents the OTA data interface functions. More...

Macros
#define	OTA_CONTROL_OVER_MQTT 0x00000001

#define	OTA_DATA_OVER_MQTT 0x00000001

#define	OTA_DATA_OVER_HTTP 0x00000002

#define	OTA_DATA_NUM_PROTOCOLS ( 2U )

Functions
void	setControlInterface (OtaControlInterface_t *pControlInterface)
	Set control interface for OTA operations.

OtaErr_t	setDataInterface (OtaDataInterface_t pDataInterface, const uint8_t pProtocol)
	Set the data interface used for OTA operations.

Detailed Description

Contains function definitions and structures for data and control interfaces.

Macro Definition Documentation

◆ OTA_CONTROL_OVER_MQTT

#define OTA_CONTROL_OVER_MQTT 0x00000001

Specify control over mqtt.

◆ OTA_DATA_OVER_MQTT

#define OTA_DATA_OVER_MQTT 0x00000001

Specify data over mqtt.

◆ OTA_DATA_OVER_HTTP

#define OTA_DATA_OVER_HTTP 0x00000002

Specify data over http.

◆ OTA_DATA_NUM_PROTOCOLS

#define OTA_DATA_NUM_PROTOCOLS ( 2U )

Number of protocols supported.

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] pControlInterface OTA 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.