XDK API  3.6.0
Documentation
Data Structures | Typedefs | Enumerations | Functions | Variables
LWM2MObjectFirmwareUpdate.h File Reference

Interface header for LWM2MObjectFirmwareUpdate file. More...

#include "Serval_Lwm2m.h"
#include "BCDS_CmdProcessor.h"
+ Include dependency graph for LWM2MObjectFirmwareUpdate.h:
+ This graph shows which files directly or indirectly include this file:

Data Structures

struct  LWM2MObjectFirmwareUpdate_Resource_S
 Structure to represent the LWM2M standard firmware update object resources. More...
 

Typedefs

typedef struct
LWM2MObjectFirmwareUpdate_Resource_S 
LWM2MObjectFirmwareUpdate_Resource_T
 Typedef to represent the LWM2M standard firmware update object resource. More...
 
typedef enum
LWM2MObjectFirmwareUpdate_State_E 
LWM2MObjectFirmwareUpdate_State_T
 Typedef to represent the FOTA state. More...
 
typedef enum
LWM2MObjectFirmwareUpdate_State_E
LWM2MObjectFirmwareUpdate_StatePtr_T
 

Enumerations

enum  LWM2MObjectFirmwareUpdate_State_E
 Enum to represent the FOTA states. More...
 
enum  LWM2MObjectFirmwareUpdate_UpdateResult_E
 Enum to represent the LWM2M standard firmware update result values. More...
 

Functions

Retcode_T LWM2MObjectFirmwareUpdate_Enable (void)
 This function triggers the FOTA state machine by checking the various FOTA NVM variables necessary, validating their integrity and running FOTA. More...
 
Retcode_T LWM2MObjectFirmwareUpdate_Init (CmdProcessor_T *cmdProcessorHandle)
 This function initializes the FOTA state machine module. It is event driven internally. More...
 

Variables

LWM2MObjectFirmwareUpdate_Resource_T LWM2MObjectFirmwareUpdateResources
 Instance of the LWM2M standard firmware update object. More...
 

Typedef Documentation

Enumeration Type Documentation

Enumerator
LWM2M_OBJ_FW_UPDATE_STATE_IDLE 
LWM2M_OBJ_FW_UPDATE_STATE_DOWNLOADING 
LWM2M_OBJ_FW_UPDATE_STATE_DOWNLOADED 
LWM2M_OBJ_FW_UPDATE_STATE_UPDATING 
Enumerator
LWM2M_OBJ_FW_UPDATE_DEFAULT 
LWM2M_OBJ_FW_UPDATE_SUCCESS 
LWM2M_OBJ_FW_UPDATE_OUT_OF_STORAGE 
LWM2M_OBJ_FW_UPDATE_OUT_OF_MEMORY 
LWM2M_OBJ_FW_UPDATE_CONNECTION_LOST 
LWM2M_OBJ_FW_UPDATE_CRC_FAILED 
LWM2M_OBJ_FW_UPDATE_UNSUPPORTED_TYPE 
LWM2M_OBJ_FW_UPDATE_INVALID_URI 
LWM2M_OBJ_FW_UPDATE_FAILED 

Function Documentation

Retcode_T LWM2MObjectFirmwareUpdate_Enable ( void  )
Note
  • The node must have been registered successfully, prior.
  • This must be called only once upon successful LWM2MObjectFirmwareUpdate_Init.
Returns
RETCODE_OK on success, or an error code otherwise.
Retcode_T LWM2MObjectFirmwareUpdate_Init ( CmdProcessor_T cmdProcessorHandle)
Note
  • It is a pre-requisite that this is the first API to be called in case of making use of the FOTA state machine.
  • All the necessary FOTA related modules are initialized internally (necessary verification and storage agents).
  • Application has to provide valid Handle to handle the FOTA internal state handling.
Parameters
[in]cmdProcessorHandlecommand processor handle for the FOTA thread execution.
Returns
RETCODE_OK on success, or an error code otherwise.

Variable Documentation

LWM2MObjectFirmwareUpdate_Resource_T LWM2MObjectFirmwareUpdateResources

All rights reserved. The use is subject to the XDK SDK EULA by Bosch Connected Devices and Solutions GmbH.
This documentation file has been automatically generated on Thu Mar 14 2019 19:12:40 by doxygen 1.8.8