This represents the default values for the configuration macros for the OTA library. More...
Go to the source code of this file.
Macros | |
#define | OTA_DO_NOT_USE_CUSTOM_CONFIG |
Define this macro to build the OTA library without the custom config file ota_config.h. More... | |
#define | otaconfigSTACK_SIZE "Please set otaconfigSTACK_SIZE" |
The number of words allocated to the stack for the OTA agent. More... | |
#define | otaconfigAGENT_PRIORITY "Please set otaconfigAGENT_PRIORITY" |
The OTA agent task priority. Normally it runs at a low priority. More... | |
#define | otaconfigLOG2_FILE_BLOCK_SIZE 12UL |
Log base 2 of the size of the file data block message (excluding the header). More... | |
#define | otaconfigSELF_TEST_RESPONSE_WAIT_MS 16000U |
Milliseconds to wait for the self test phase to succeed before we force reset. More... | |
#define | otaconfigFILE_REQUEST_WAIT_MS 10000U |
Milliseconds to wait before requesting data blocks from the OTA service if nothing is happening. More... | |
#define | otaconfigMAX_THINGNAME_LEN 64U |
The maximum allowed length of the thing name used by the OTA agent. More... | |
#define | otaconfigMAX_NUM_BLOCKS_REQUEST 1U |
The maximum number of data blocks requested from OTA streaming service. More... | |
#define | otaconfigMAX_NUM_REQUEST_MOMENTUM 32U |
The maximum number of requests allowed to send without a response before we abort. More... | |
#define | otaconfigOTA_UPDATE_STATUS_FREQUENCY 64U |
How frequently the device will report its OTA progress to the cloud. More... | |
#define | otaconfigMAX_NUM_OTA_DATA_BUFFERS 1U |
The number of data buffers reserved by the OTA agent. More... | |
#define | otaconfigOTA_FILE_TYPE uint8_t |
Data type to represent a file. More... | |
#define | otaconfigAllowDowngrade 0U |
Flag to enable booting into updates that have an identical or lower version than the current version. More... | |
#define | configOTA_FIRMWARE_UPDATE_FILE_TYPE_ID 0U |
The file type id received in the job document. More... | |
#define | configENABLED_CONTROL_PROTOCOL ( OTA_CONTROL_OVER_MQTT ) |
The protocol selected for OTA control operations. More... | |
#define | configENABLED_DATA_PROTOCOLS ( OTA_DATA_OVER_MQTT ) |
The protocol selected for OTA data operations. More... | |
#define | configOTA_PRIMARY_DATA_PROTOCOL ( OTA_DATA_OVER_MQTT ) |
The preferred protocol selected for OTA data operations. More... | |
#define | configOTA_POLLING_EVENTS_TIMEOUT_MS ( 1000U ) |
The polling timeout (milliseconds) to receive messages from event queue. More... | |
#define | LogError(message) |
Macro that is called in the OTA library for logging "Error" level messages. More... | |
#define | LogWarn(message) |
Macro that is called in the OTA library for logging "Warning" level messages. More... | |
#define | LogInfo(message) |
Macro that is called in the OTA library for logging "Info" level messages. More... | |
#define | LogDebug(message) |
Macro that is called in the OTA library for logging "Debug" level messages. More... | |
This represents the default values for the configuration macros for the OTA library.
#define OTA_DO_NOT_USE_CUSTOM_CONFIG |
Define this macro to build the OTA library without the custom config file ota_config.h.
Without the custom config, the OTA library builds with default values of config macros defined in ota_config_defaults.h file.
If a custom config is provided, then OTA_DO_NOT_USE_CUSTOM_CONFIG should not be defined.
#define otaconfigSTACK_SIZE "Please set otaconfigSTACK_SIZE" |
The number of words allocated to the stack for the OTA agent.
The configuration parameter specifies the size of the stack that will be allocated to the task being created (the size is specified in words, not bytes!). The amount of stack required is dependent on the application specific parameters, for more information Link
Possible values: Any positive 32 bit integer.
Default value: Varies by platform
#define otaconfigAGENT_PRIORITY "Please set otaconfigAGENT_PRIORITY" |
The OTA agent task priority. Normally it runs at a low priority.
For more information Link.
Possible values: 0 to ( configMAX_PRIORITIES - 1 )
Default value: Varies by platform.
#define otaconfigLOG2_FILE_BLOCK_SIZE 12UL |
Log base 2 of the size of the file data block message (excluding the header).
Possible values: Any unsigned 32 integer.
Default value: '12'
#define otaconfigSELF_TEST_RESPONSE_WAIT_MS 16000U |
Milliseconds to wait for the self test phase to succeed before we force reset.
Possible values: Any unsigned 32 integer.
Default value: '16000'
#define otaconfigFILE_REQUEST_WAIT_MS 10000U |
Milliseconds to wait before requesting data blocks from the OTA service if nothing is happening.
Possible values: Any unsigned 32 integer.
Default value: '10000'
#define otaconfigMAX_THINGNAME_LEN 64U |
The maximum allowed length of the thing name used by the OTA agent.
Possible values: Any unsigned 32 integer.
Default value: '64'
#define otaconfigMAX_NUM_BLOCKS_REQUEST 1U |
The maximum number of data blocks requested from OTA streaming service.
Possible values: Any unsigned 32 integer value greater than 0.
Default value: '1'
#define otaconfigMAX_NUM_REQUEST_MOMENTUM 32U |
The maximum number of requests allowed to send without a response before we abort.
Possible values: Any unsigned 32 integer.
Default value: '32'
#define otaconfigOTA_UPDATE_STATUS_FREQUENCY 64U |
How frequently the device will report its OTA progress to the cloud.
Possible values: Any unsigned 32 integer.
Default value: '64'
#define otaconfigMAX_NUM_OTA_DATA_BUFFERS 1U |
The number of data buffers reserved by the OTA agent.
Possible values: Any unsigned 32 integer.
Default value: '1'
#define otaconfigOTA_FILE_TYPE uint8_t |
Data type to represent a file.
It is used to represent a file received via OTA. The file is declared as the pointer of this type: otaconfigOTA_FILE_TYPE * pFile.
Possible values: Any data type.
Default value: FILE on Windows or Linux, uint8_t on other platforms.
#define otaconfigAllowDowngrade 0U |
Flag to enable booting into updates that have an identical or lower version than the current version.
Possible values: Any unsigned 32 integer.
Default value: '0'
#define configOTA_FIRMWARE_UPDATE_FILE_TYPE_ID 0U |
The file type id received in the job document.
#define configENABLED_CONTROL_PROTOCOL ( OTA_CONTROL_OVER_MQTT ) |
The protocol selected for OTA control operations.
Possible values: OTA_CONTROL_OVER_MQTT
Default value: 'OTA_CONTROL_OVER_MQTT'
#define configENABLED_DATA_PROTOCOLS ( OTA_DATA_OVER_MQTT ) |
The protocol selected for OTA data operations.
Possible values:
Enable data over MQTT - ( OTA_DATA_OVER_MQTT )
Enable data over HTTP - ( OTA_DATA_OVER_HTTP )
Enable data over both MQTT & HTTP - ( OTA_DATA_OVER_MQTT | OTA_DATA_OVER_HTTP )
Default value: 'OTA_DATA_OVER_MQTT'
#define configOTA_PRIMARY_DATA_PROTOCOL ( OTA_DATA_OVER_MQTT ) |
The preferred protocol selected for OTA data operations.
Possible values:
Data over MQTT - ( OTA_DATA_OVER_MQTT )
Data over HTTP - ( OTA_DATA_OVER_HTTP )
Default value: 'OTA_DATA_OVER_MQTT'
#define configOTA_POLLING_EVENTS_TIMEOUT_MS ( 1000U ) |
The polling timeout (milliseconds) to receive messages from event queue.
Possible values: Any unsigned 32 integer.
Default value: '1000'
#define LogError | ( | message | ) |
Macro that is called in the OTA library for logging "Error" level messages.
To enable error level logging in the OTA library, this macro should be mapped to the application-specific logging implementation that supports error logging.
Default value: Error logging is turned off, and no code is generated for calls to the macro in the OTA library on compilation.
#define LogWarn | ( | message | ) |
Macro that is called in the OTA library for logging "Warning" level messages.
To enable warning level logging in the OTA library, this macro should be mapped to the application-specific logging implementation that supports warning logging.
Default value: Warning logging is turned off, and no code is generated for calls to the macro in the OTA library on compilation.
#define LogInfo | ( | message | ) |
Macro that is called in the OTA library for logging "Info" level messages.
To enable info level logging in the OTA library, this macro should be mapped to the application-specific logging implementation that supports info logging.
Default value: Info logging is turned off, and no code is generated for calls to the macro in the OTA library on compilation.
#define LogDebug | ( | message | ) |
Macro that is called in the OTA library for logging "Debug" level messages.
To enable Debug level logging in the OTA library, this macro should be mapped to the application-specific logging implementation that supports debug logging.
Default value: Debug logging is turned off, and no code is generated for calls to the macro in the OTA library on compilation.