Over The Air (OTA) Update Library
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages

General Description

Macros used to define the OTA Agent behavior.

Macros

#define CY_RSLT_MODULE_MIDDLEWARE_OTA_UPDATE   (CY_RSLT_MODULE_MIDDLEWARE_BASE + 13)
 OTA Update module base. More...
 
#define CY_RSLT_OTA_ERROR_BASE   CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_MIDDLEWARE_OTA_UPDATE, 0)
 OTA Update error code base. More...
 
#define CY_RSLT_OTA_ERROR_UNSUPPORTED   (CY_RSLT_OTA_ERROR_BASE + 1)
 Unsupported feature. More...
 
#define CY_RSLT_OTA_ERROR_GENERAL   (CY_RSLT_OTA_ERROR_BASE + 2)
 Generic error. More...
 
#define CY_RSLT_OTA_ERROR_BADARG   (CY_RSLT_OTA_ERROR_BASE + 3)
 Bad argument. More...
 
#define CY_RSLT_OTA_ERROR_OUT_OF_MEMORY   (CY_RSLT_OTA_ERROR_BASE + 4)
 Out of Memory error. More...
 
#define CY_RSLT_OTA_ERROR_ALREADY_STARTED   (CY_RSLT_OTA_ERROR_BASE + 5)
 OTA update already started. More...
 
#define CY_RSLT_OTA_ERROR_MQTT_INIT   (CY_RSLT_OTA_ERROR_BASE + 6)
 MQTT init failed. More...
 
#define CY_RSLT_OTA_ERROR_OPEN_STORAGE   (CY_RSLT_OTA_ERROR_BASE + 7)
 Could not open local storage. More...
 
#define CY_RSLT_OTA_ERROR_READ_STORAGE   (CY_RSLT_OTA_ERROR_BASE + 8)
 Could not Read from local storage. More...
 
#define CY_RSLT_OTA_ERROR_WRITE_STORAGE   (CY_RSLT_OTA_ERROR_BASE + 9)
 Could not Write to local storage. More...
 
#define CY_RSLT_OTA_ERROR_CLOSE_STORAGE   (CY_RSLT_OTA_ERROR_BASE + 10)
 Close local storage error. More...
 
#define CY_RSLT_OTA_ERROR_CONNECT   (CY_RSLT_OTA_ERROR_BASE + 11)
 Connection to the server failed. More...
 
#define CY_RSLT_OTA_ERROR_DISCONNECT   (CY_RSLT_OTA_ERROR_BASE + 12)
 Server disconnect error. More...
 
#define CY_RSLT_OTA_ERROR_REDIRECT   (CY_RSLT_OTA_ERROR_BASE + 13)
 Redirection failure. More...
 
#define CY_RSLT_OTA_ERROR_SERVER_DROPPED   (CY_RSLT_OTA_ERROR_BASE + 14)
 Broker/server disconnected. More...
 
#define CY_RSLT_OTA_ERROR_MQTT_SUBSCRIBE   (CY_RSLT_OTA_ERROR_BASE + 15)
 Broker/server Subscribe error. More...
 
#define CY_RSLT_OTA_ERROR_MQTT_PUBLISH   (CY_RSLT_OTA_ERROR_BASE + 16)
 Broker/Server Publish error. More...
 
#define CY_RSLT_OTA_ERROR_GET_JOB   (CY_RSLT_OTA_ERROR_BASE + 17)
 Failed to get the OTA Job document. More...
 
#define CY_RSLT_OTA_ERROR_GET_DATA   (CY_RSLT_OTA_ERROR_BASE + 18)
 Failed to get the OTA image. More...
 
#define CY_RSLT_OTA_ERROR_NOT_A_HEADER   (CY_RSLT_OTA_ERROR_BASE + 19)
 No header in the payload. More...
 
#define CY_RSLT_OTA_ERROR_NOT_A_JOB_DOC   (CY_RSLT_OTA_ERROR_BASE + 20)
 Job document is invalid. More...
 
#define CY_RSLT_OTA_ERROR_MALFORMED_JOB_DOC   (CY_RSLT_OTA_ERROR_BASE + 21)
 Malformed Job document. More...
 
#define CY_RSLT_OTA_ERROR_WRONG_BOARD   (CY_RSLT_OTA_ERROR_BASE + 22)
 Board in Job document does not match. More...
 
#define CY_RSLT_OTA_ERROR_INVALID_VERSION   (CY_RSLT_OTA_ERROR_BASE + 23)
 Invalid version in Job or Packet. More...
 
#define CY_RSLT_OTA_ERROR_VERIFY   (CY_RSLT_OTA_ERROR_BASE + 24)
 Verify image failure. More...
 
#define CY_RSLT_OTA_ERROR_SENDING_RESULT   (CY_RSLT_OTA_ERROR_BASE + 25)
 Sending result failed. More...
 
#define CY_RSLT_OTA_ERROR_APP_RETURNED_STOP   (CY_RSLT_OTA_ERROR_BASE + 26)
 Callback returned Stop OTA download. More...
 
#define CY_RSLT_OTA_ERROR_APP_EXCEEDED_RETRIES   (CY_RSLT_OTA_ERROR_BASE + 27)
 Number of retries exceeded. More...
 
#define CY_RSLT_OTA_ERROR_TRANSPORT_UNSUPPORTED   (CY_RSLT_OTA_ERROR_BASE + 28)
 HTTP, MQTT or Bluetooth® not supported in this build. More...
 
#define CY_RSLT_OTA_ERROR_BLE_GENERAL   (CY_RSLT_OTA_ERROR_BASE + 32)
 General Bluetooth® error. More...
 
#define CY_RSLT_OTA_ERROR_BLE_VERIFY   (CY_RSLT_OTA_ERROR_BASE + 33)
 Bluetooth® Verification of download error. More...
 
#define CY_RSLT_OTA_ERROR_BLE_GATT   (CY_RSLT_OTA_ERROR_BASE + 34)
 Bluetooth® GATT event error. More...
 
#define CY_RSLT_OTA_ERROR_SMIF_TIMEOUT   (CY_RSLT_OTA_ERROR_BASE + 64)
 SMIF timeout. More...
 
#define CY_RSLT_OTA_INFO_BASE   CY_RSLT_CREATE(CY_RSLT_TYPE_INFO, CY_RSLT_MODULE_MIDDLEWARE_OTA_UPDATE, 0)
 Base for informational results. More...
 
#define CY_RSLT_OTA_EXITING   (CY_RSLT_OTA_INFO_BASE + 1)
 OTA Agent exiting. More...
 
#define CY_RSLT_OTA_ALREADY_CONNECTED   (CY_RSLT_OTA_INFO_BASE + 2)
 OTA already connected. More...
 
#define CY_RSLT_OTA_CHANGING_SERVER   (CY_RSLT_OTA_INFO_BASE + 3)
 Data broker/server different from job. More...
 
#define CY_RSLT_OTA_USE_JOB_FLOW   (CY_RSLT_SUCCESS )
 Use Job flow for update. More...
 
#define CY_RSLT_OTA_USE_DIRECT_FLOW   (CY_RSLT_OTA_INFO_BASE + 4)
 Use Direct flow for update. More...
 
#define CY_RSLT_OTA_NO_UPDATE_AVAILABLE   (CY_RSLT_OTA_INFO_BASE + 5)
 No OTA update on the server. More...
 

Macro Definition Documentation

#define CY_RSLT_MODULE_MIDDLEWARE_OTA_UPDATE   (CY_RSLT_MODULE_MIDDLEWARE_BASE + 13)

OTA Update module base.

#define CY_RSLT_OTA_ERROR_BASE   CY_RSLT_CREATE(CY_RSLT_TYPE_ERROR, CY_RSLT_MODULE_MIDDLEWARE_OTA_UPDATE, 0)

OTA Update error code base.

#define CY_RSLT_OTA_ERROR_UNSUPPORTED   (CY_RSLT_OTA_ERROR_BASE + 1)

Unsupported feature.

#define CY_RSLT_OTA_ERROR_GENERAL   (CY_RSLT_OTA_ERROR_BASE + 2)

Generic error.

#define CY_RSLT_OTA_ERROR_BADARG   (CY_RSLT_OTA_ERROR_BASE + 3)

Bad argument.

#define CY_RSLT_OTA_ERROR_OUT_OF_MEMORY   (CY_RSLT_OTA_ERROR_BASE + 4)

Out of Memory error.

#define CY_RSLT_OTA_ERROR_ALREADY_STARTED   (CY_RSLT_OTA_ERROR_BASE + 5)

OTA update already started.

#define CY_RSLT_OTA_ERROR_MQTT_INIT   (CY_RSLT_OTA_ERROR_BASE + 6)

MQTT init failed.

#define CY_RSLT_OTA_ERROR_OPEN_STORAGE   (CY_RSLT_OTA_ERROR_BASE + 7)

Could not open local storage.

#define CY_RSLT_OTA_ERROR_READ_STORAGE   (CY_RSLT_OTA_ERROR_BASE + 8)

Could not Read from local storage.

#define CY_RSLT_OTA_ERROR_WRITE_STORAGE   (CY_RSLT_OTA_ERROR_BASE + 9)

Could not Write to local storage.

#define CY_RSLT_OTA_ERROR_CLOSE_STORAGE   (CY_RSLT_OTA_ERROR_BASE + 10)

Close local storage error.

#define CY_RSLT_OTA_ERROR_CONNECT   (CY_RSLT_OTA_ERROR_BASE + 11)

Connection to the server failed.

#define CY_RSLT_OTA_ERROR_DISCONNECT   (CY_RSLT_OTA_ERROR_BASE + 12)

Server disconnect error.

#define CY_RSLT_OTA_ERROR_REDIRECT   (CY_RSLT_OTA_ERROR_BASE + 13)

Redirection failure.

#define CY_RSLT_OTA_ERROR_SERVER_DROPPED   (CY_RSLT_OTA_ERROR_BASE + 14)

Broker/server disconnected.

#define CY_RSLT_OTA_ERROR_MQTT_SUBSCRIBE   (CY_RSLT_OTA_ERROR_BASE + 15)

Broker/server Subscribe error.

#define CY_RSLT_OTA_ERROR_MQTT_PUBLISH   (CY_RSLT_OTA_ERROR_BASE + 16)

Broker/Server Publish error.

#define CY_RSLT_OTA_ERROR_GET_JOB   (CY_RSLT_OTA_ERROR_BASE + 17)

Failed to get the OTA Job document.

#define CY_RSLT_OTA_ERROR_GET_DATA   (CY_RSLT_OTA_ERROR_BASE + 18)

Failed to get the OTA image.

#define CY_RSLT_OTA_ERROR_NOT_A_HEADER   (CY_RSLT_OTA_ERROR_BASE + 19)

No header in the payload.

#define CY_RSLT_OTA_ERROR_NOT_A_JOB_DOC   (CY_RSLT_OTA_ERROR_BASE + 20)

Job document is invalid.

#define CY_RSLT_OTA_ERROR_MALFORMED_JOB_DOC   (CY_RSLT_OTA_ERROR_BASE + 21)

Malformed Job document.

#define CY_RSLT_OTA_ERROR_WRONG_BOARD   (CY_RSLT_OTA_ERROR_BASE + 22)

Board in Job document does not match.

#define CY_RSLT_OTA_ERROR_INVALID_VERSION   (CY_RSLT_OTA_ERROR_BASE + 23)

Invalid version in Job or Packet.

#define CY_RSLT_OTA_ERROR_VERIFY   (CY_RSLT_OTA_ERROR_BASE + 24)

Verify image failure.

#define CY_RSLT_OTA_ERROR_SENDING_RESULT   (CY_RSLT_OTA_ERROR_BASE + 25)

Sending result failed.

#define CY_RSLT_OTA_ERROR_APP_RETURNED_STOP   (CY_RSLT_OTA_ERROR_BASE + 26)

Callback returned Stop OTA download.

#define CY_RSLT_OTA_ERROR_APP_EXCEEDED_RETRIES   (CY_RSLT_OTA_ERROR_BASE + 27)

Number of retries exceeded.

#define CY_RSLT_OTA_ERROR_TRANSPORT_UNSUPPORTED   (CY_RSLT_OTA_ERROR_BASE + 28)

HTTP, MQTT or Bluetooth® not supported in this build.

#define CY_RSLT_OTA_ERROR_BLE_GENERAL   (CY_RSLT_OTA_ERROR_BASE + 32)

General Bluetooth® error.

#define CY_RSLT_OTA_ERROR_BLE_VERIFY   (CY_RSLT_OTA_ERROR_BASE + 33)

Bluetooth® Verification of download error.

#define CY_RSLT_OTA_ERROR_BLE_GATT   (CY_RSLT_OTA_ERROR_BASE + 34)

Bluetooth® GATT event error.

#define CY_RSLT_OTA_ERROR_SMIF_TIMEOUT   (CY_RSLT_OTA_ERROR_BASE + 64)

SMIF timeout.

#define CY_RSLT_OTA_INFO_BASE   CY_RSLT_CREATE(CY_RSLT_TYPE_INFO, CY_RSLT_MODULE_MIDDLEWARE_OTA_UPDATE, 0)

Base for informational results.

#define CY_RSLT_OTA_EXITING   (CY_RSLT_OTA_INFO_BASE + 1)

OTA Agent exiting.

#define CY_RSLT_OTA_ALREADY_CONNECTED   (CY_RSLT_OTA_INFO_BASE + 2)

OTA already connected.

#define CY_RSLT_OTA_CHANGING_SERVER   (CY_RSLT_OTA_INFO_BASE + 3)

Data broker/server different from job.

#define CY_RSLT_OTA_USE_JOB_FLOW   (CY_RSLT_SUCCESS )

Use Job flow for update.

#define CY_RSLT_OTA_USE_DIRECT_FLOW   (CY_RSLT_OTA_INFO_BASE + 4)

Use Direct flow for update.

#define CY_RSLT_OTA_NO_UPDATE_AVAILABLE   (CY_RSLT_OTA_INFO_BASE + 5)

No OTA update on the server.