Typedefs | Enumerations
Enumeration/Typedefs
Collaboration diagram for Enumeration/Typedefs:

Typedefs

typedef void(* tpfOtaNotifCb) (tstrOtaUpdateInfo *pstrOtaUpdateInfo)
 A callback to get notification about a potential OTA update. More...
 
typedef void(* tpfOtaUpdateCb) (uint8 u8OtaUpdateStatusType, uint8 u8OtaUpdateStatus)
 A callback to get OTA status update, the callback provides the download status, the switch to the downloaded firmware status and roll-back status. More...
 

Enumerations

enum  tenuM2mOtaCmd {
  M2M_OTA_REQ_NOTIF_SET_URL = M2M_OTA_CMD_BASE, M2M_OTA_REQ_NOTIF_CHECK_FOR_UPDATE, M2M_OTA_REQ_NOTIF_SCHED, M2M_OTA_REQ_START_UPDATE,
  M2M_OTA_REQ_SWITCH_FIRMWARE, M2M_OTA_REQ_ROLLBACK, M2M_OTA_REQ_ABORT, M2M_OTA_RESP_NOTIF_UPDATE_INFO,
  M2M_OTA_RESP_UPDATE_STATUS, M2M_OTA_REQ_TEST, M2M_OTA_MAX_ALL
}
 This enum contains all the WINC commands used for OTA operation. More...
 
enum  tenuOtaUpdateStatus {
  OTA_STATUS_SUCSESS = 0, OTA_STATUS_FAIL = 1, OTA_STATUS_INVAILD_ARG = 2, OTA_STATUS_INVAILD_RB_IMAGE = 3,
  OTA_STATUS_INVAILD_FLASH_SIZE = 4, OTA_STATUS_AlREADY_ENABLED = 5, OTA_STATUS_UPDATE_INPROGRESS = 6, OTA_STATUS_IMAGE_VERIF_FAILED = 7,
  OTA_STATUS_CONNECTION_ERROR = 8, OTA_STATUS_SERVER_ERROR = 9, OTA_STATUS_ABORTED = 10
}
 This struct contains the OTA return status. More...
 
enum  tenuOtaUpdateStatusType { DL_STATUS = 1, SW_STATUS = 2, RB_STATUS = 3, AB_STATUS = 4 }
 This struct contains the OTA update status type. More...
 

Detailed Description

Typedef Documentation

◆ tpfOtaNotifCb

void(* tpfOtaNotifCb)(tstrOtaUpdateInfo *)

A callback to get notification about a potential OTA update.

Parameters
[in]pstrOtaUpdateInfoA structure to provide notification payload.
See also
tstrOtaUpdateInfo
Warning
The notification is not supported (Not implemented yet)

Definition at line 68 of file m2m_ota.h.

◆ tpfOtaUpdateCb

void(* tpfOtaUpdateCb)(uint8 u8OtaUpdateStatusType,uint8 u8OtaUpdateStatus)

A callback to get OTA status update, the callback provides the download status, the switch to the downloaded firmware status and roll-back status.

Parameters
[in]u8OtaUpdateStatusTypePossible values are listed in tenuOtaUpdateStatusType. Possible types are:
[in]u8OtaUpdateStatusPossible values are listed in tenuOtaUpdateStatus.
See also
tenuOtaUpdateStatusType tenuOtaUpdateStatus

Definition at line 90 of file m2m_ota.h.

Enumeration Type Documentation

◆ tenuM2mOtaCmd

This enum contains all the WINC commands used for OTA operation.

Enumerator
M2M_OTA_REQ_NOTIF_SET_URL 

Reserved. Do not use.

M2M_OTA_REQ_NOTIF_CHECK_FOR_UPDATE 

Reserved. Do not use.

M2M_OTA_REQ_NOTIF_SCHED 

Reserved. Do not use.

M2M_OTA_REQ_START_UPDATE 

Request to start an OTA update.

M2M_OTA_REQ_SWITCH_FIRMWARE 

Request to switch firmware.

M2M_OTA_REQ_ROLLBACK 

Request to perform an OTA rollback.

M2M_OTA_REQ_ABORT 

Request to abort OTA.

M2M_OTA_RESP_NOTIF_UPDATE_INFO 

Reserved. Do not use.

M2M_OTA_RESP_UPDATE_STATUS 

Response to indicate the OTA update status.

M2M_OTA_REQ_TEST 

Reserved. Do not use.

M2M_OTA_MAX_ALL 

Definition at line 2003 of file m2m_types.h.

◆ tenuOtaUpdateStatus

This struct contains the OTA return status.

Enumerator
OTA_STATUS_SUCSESS 

OTA Success with no errors.

OTA_STATUS_FAIL 

OTA generic fail.

OTA_STATUS_INVAILD_ARG 

Invalid or malformed download URL.

OTA_STATUS_INVAILD_RB_IMAGE 

Invalid rollback image.

OTA_STATUS_INVAILD_FLASH_SIZE 

Flash size on device is not enough for OTA.

OTA_STATUS_AlREADY_ENABLED 

An OTA operation is already enabled.

OTA_STATUS_UPDATE_INPROGRESS 

An OTA operation update is in progress

OTA_STATUS_IMAGE_VERIF_FAILED 

OTA Verfication failed

OTA_STATUS_CONNECTION_ERROR 

OTA connection error

OTA_STATUS_SERVER_ERROR 

OTA server Error (file not found or else ...)

OTA_STATUS_ABORTED 

OTA download has been aborted by the application.

Definition at line 2034 of file m2m_types.h.

◆ tenuOtaUpdateStatusType

This struct contains the OTA update status type.

Enumerator
DL_STATUS 

Download OTA file status

SW_STATUS 

Switching to the upgrade firmware status

RB_STATUS 

Roll-back status

AB_STATUS 

Abort status

Definition at line 2065 of file m2m_types.h.



inertial_sense_ros
Author(s):
autogenerated on Sun Feb 28 2021 03:18:00