Contains function definitions and structures for data and control interfaces. More...
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 the data interface used for OTA operations. More... | |
Contains function definitions and structures for data and control interfaces.
#define OTA_CONTROL_OVER_MQTT 0x00000001 |
Specify control over mqtt.
#define OTA_DATA_OVER_MQTT 0x00000001 |
Specify data over mqtt.
#define OTA_DATA_OVER_HTTP 0x00000002 |
Specify data over http.
#define OTA_DATA_NUM_PROTOCOLS ( 2U ) |
Number of protocols supported.
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.
[out] | pControlInterface | OTA Control interface. |
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.
[out] | pDataInterface | OTA data interface to overwrite. |
[in] | pProtocol | String containing a list of protocols that may be set. |