ota_interface_private.h File Reference

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

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

Go to the source code of 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. More...
OtaErr_t	setDataInterface (OtaDataInterface_t *pDataInterface, const uint8_t *pProtocol)
	Set data interface for OTA operations. More...

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 data interface for OTA operations.

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

Parameters

[out]	pDataInterface	OTA data interface.
[in]	pProtocol	Protocols used for the download.