nRF Connect SDK API 2.8.0
Loading...
Searching...
No Matches
nrf_cloud_fota_poll.h File Reference

Module to provide nRF Cloud FOTA assistance for applications connecting to nRF Cloud using REST or CoAP. More...

Go to the source code of this file.

Data Structures

struct  nrf_cloud_fota_poll_ctx
 

Typedefs

typedef void(* fota_reboot_handler_t) (enum nrf_cloud_fota_reboot_status status)
 Reboot event handler registered with the module to handle asynchronous reboot events from the module.
 
typedef void(* nrf_cloud_fota_poll_handler_t) (enum nrf_cloud_fota_status status, const char *const status_details)
 Status event handler registered with the module to handle asynchronous status events from the module.
 

Enumerations

enum  nrf_cloud_fota_reboot_status { FOTA_REBOOT_REQUIRED , FOTA_REBOOT_SUCCESS , FOTA_REBOOT_FAIL , FOTA_REBOOT_SYS_ERROR }
 

Functions

int nrf_cloud_fota_poll_init (struct nrf_cloud_fota_poll_ctx *ctx)
 Initialize nRF Cloud FOTA polling assistance. Must be called before any other module functions.
 
int nrf_cloud_fota_poll_process_pending (struct nrf_cloud_fota_poll_ctx *ctx)
 Process/validate a pending FOTA update job. This may initiate a reboot through the context's reboot function.
 
int nrf_cloud_fota_poll_process (struct nrf_cloud_fota_poll_ctx *ctx)
 Perform the following FOTA tasks: Report the status of an in progress FOTA job. Check for a queued FOTA job. Execute FOTA job. Save status and request reboot.
 

Detailed Description

Module to provide nRF Cloud FOTA assistance for applications connecting to nRF Cloud using REST or CoAP.