OTA Macros

group group_ota_macros

Macros used to define the OTA Agent behavior.

Defines

CY_RSLT_MODULE_OTA_UPDATE_BASE

OTA Update module base.

CY_RSLT_OTA_ERROR_BASE

OTA Update error code base.

CY_RSLT_OTA_ERROR_UNSUPPORTED

Unsupported feature.

CY_RSLT_OTA_ERROR_GENERAL

Generic error.

CY_RSLT_OTA_ERROR_BADARG

Bad argument.

CY_RSLT_OTA_ERROR_OUT_OF_MEMORY

Out of Memory error.

CY_RSLT_OTA_ERROR_ALREADY_STARTED

OTA update already started.

CY_RSLT_OTA_ERROR_MQTT_INIT

MQTT init failed.

CY_RSLT_OTA_ERROR_OPEN_STORAGE

Could not open local storage.

CY_RSLT_OTA_ERROR_READ_STORAGE

Could not Read from local storage.

CY_RSLT_OTA_ERROR_WRITE_STORAGE

Could not Write to local storage.

CY_RSLT_OTA_ERROR_CLOSE_STORAGE

Close local storage error.

CY_RSLT_OTA_ERROR_CONNECT

Connection to the server failed.

CY_RSLT_OTA_ERROR_DISCONNECT

Server disconnect error.

CY_RSLT_OTA_ERROR_REDIRECT

Redirection failure.

CY_RSLT_OTA_ERROR_SERVER_DROPPED

Broker/server disconnected.

CY_RSLT_OTA_ERROR_MQTT_SUBSCRIBE

Broker/server Subscribe error.

CY_RSLT_OTA_ERROR_MQTT_PUBLISH

Broker/Server Publish error.

CY_RSLT_OTA_ERROR_GET_JOB

Failed to get the OTA Job document.

CY_RSLT_OTA_ERROR_GET_DATA

Failed to get the OTA image.

CY_RSLT_OTA_ERROR_NOT_A_HEADER

No header in the payload.

CY_RSLT_OTA_ERROR_NOT_A_JOB_DOC

Job document is invalid.

CY_RSLT_OTA_ERROR_MALFORMED_JOB_DOC

Malformed Job document.

CY_RSLT_OTA_ERROR_WRONG_BOARD

Board in Job document does not match.

CY_RSLT_OTA_ERROR_INVALID_VERSION

Invalid version in Job or Packet.

CY_RSLT_OTA_ERROR_VERIFY

Verify image failure.

CY_RSLT_OTA_ERROR_SENDING_RESULT

Sending result failed.

CY_RSLT_OTA_ERROR_APP_RETURNED_STOP

Callback returned Stop OTA download.

CY_RSLT_OTA_ERROR_APP_EXCEEDED_RETRIES

Number of retries exceeded.

CY_RSLT_OTA_INFO_BASE

Base for informational results.

CY_RSLT_OTA_EXITING

OTA Agent exiting.

CY_RSLT_OTA_ALREADY_CONNECTED

OTA already connected.

CY_RSLT_OTA_CHANGING_SERVER

Data broker/server different from job.

CY_RSLT_OTA_USE_JOB_FLOW

Use Job flow for update.

CY_RSLT_OTA_USE_DIRECT_FLOW

Use Direct flow for update.

CY_RSLT_OTA_NO_UPDATE_AVAILABLE

No OTA update on the server.