Skip to content

Commit

Permalink
net: lib: nrf_cloud_fota: improve status reporting
Browse files Browse the repository at this point in the history 
Improve job status reporting by using the PUBACK
event to ensure that the cloud received the job
status update. In the event of a disconnect, use
the SUBACK event on reconnect to retry updating the
job status.
IRIS-8364

Signed-off-by: Justin Morton <[email protected]>
  • Loading branch information
@jayteemo @rlubos
jayteemo authored and rlubos committed Apr 9, 2024
1 parent 59bfff2 commit d58aa2f
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 24 deletions.
4 changes: 4 additions & 0 deletions doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -516,6 +516,10 @@ Libraries for networking
* The :kconfig:option:`CONFIG_NRF_CLOUD_LOCATION_ANCHOR_LIST` Kconfig option to enable including Wi-Fi anchor names in the location callback.
* The :kconfig:option:`CONFIG_NRF_CLOUD_LOCATION_ANCHOR_LIST_BUFFER_SIZE` Kconfig option to control the buffer size used for the anchor names.

* Updated:

* Improved FOTA job status reporting.

* :ref:`lib_mqtt_helper` library:

* Changed the library to read certificates as standard PEM format. Previously the certificates had to be manually converted to string format before compiling the application.
Expand Down
82 changes: 58 additions & 24 deletions subsys/net/lib/nrf_cloud/src/nrf_cloud_fota.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,11 @@ static bool fota_dl_initialized;
/** Flag to indicate that a pending FOTA job was validated and a reboot is required */
static bool reboot_on_init;

/** Flag to indicate that the device is waiting on an ACK after sending a job status
* update to the cloud
*/
static bool fota_report_ack_pending;

static void send_fota_done_event_if_done(void)
{
/* This event should cause reboot or modem-reinit.
Expand Down Expand Up @@ -238,6 +243,8 @@ int nrf_cloud_fota_init(nrf_cloud_fota_callback_t cb)
LOG_ERR("Failed to process pending FOTA job, error: %d", ret);
}

fota_report_ack_pending = false;

initialized = true;
return ret;
}
Expand Down Expand Up @@ -381,6 +388,7 @@ static int publish_validated_job_status(void)
}

if (job.info.type != NRF_CLOUD_FOTA_TYPE__INVALID) {
LOG_DBG("Sending job update for validated (%d) job", saved_job.validate);
ret = publish_job_status(&job);
if (ret) {
LOG_ERR("Error sending job update: %d", ret);
Expand All @@ -407,6 +415,10 @@ int nrf_cloud_fota_endpoint_set_and_report(struct mqtt_client *const client,
*/
ret = publish_job_status(&current_fota);
if (ret < 0) {
/* If the job update fails to be sent here, proceed to inform
* the application of a complete job so it can be validated.
* Job update will be sent on reboot/re-init.
*/
send_fota_done_event_if_done();
}
} else {
Expand Down Expand Up @@ -630,6 +642,8 @@ static void http_fota_handler(const struct fota_download_evt *evt)
break;

case FOTA_DOWNLOAD_EVT_ERROR:
LOG_DBG("FOTA_DOWNLOAD_EVT_ERROR cause: %d", evt->cause);

nrf_cloud_download_end();
current_fota.status = NRF_CLOUD_FOTA_FAILED;

Expand All @@ -642,17 +656,14 @@ static void http_fota_handler(const struct fota_download_evt *evt)
current_fota.error = NRF_CLOUD_FOTA_ERROR_DOWNLOAD;
}

/* Save as ERROR status in case send_job_update() fails
* so that the job status can be updated later.
/* Save validate status as ERROR in case the cloud does not
* receive the job status update; it can be sent later.
*/
save_validate_status(current_fota.info.id,
current_fota.info.type,
NRF_CLOUD_FOTA_VALIDATE_ERROR);
ret = publish_job_status(&current_fota);
send_event(NRF_CLOUD_FOTA_EVT_ERROR, &current_fota);
if (ret == 0) {
cleanup_job(&current_fota);
}
break;

case FOTA_DOWNLOAD_EVT_PROGRESS:
Expand Down Expand Up @@ -821,11 +832,6 @@ static int start_job(struct nrf_cloud_fota_job *const job, const bool send_evt)
/* Send job status to the cloud */
(void)publish_job_status(job);

/* Cleanup if the job failed to start */
if (ret) {
cleanup_job(job);
}

return ret;
}

Expand Down Expand Up @@ -898,6 +904,11 @@ static int publish_and_free_obj(struct nrf_cloud_obj *const pub_data,
pub_param->message.payload.data = (uint8_t *)pub_data->encoded_data.ptr;
pub_param->message.payload.len = pub_data->encoded_data.len;
err = publish(pub_param);

if ((!err) && (pub_param->message_id == NCT_MSG_ID_FOTA_REPORT)) {
fota_report_ack_pending = true;
}

(void)nrf_cloud_obj_cloud_encoded_free(pub_data);
}

Expand Down Expand Up @@ -942,14 +953,7 @@ static int publish_job_status(struct nrf_cloud_fota_job *const job)
return -ENOMEM;
}

ret = publish_and_free_obj(&update_obj, &topic_updt, &param);
if (ret == 0 && is_job_status_terminal(job->status)) {
/* If job was updated to terminal status, save job ID */
strncpy(last_job, job->info.id, sizeof(last_job) - 1);
last_job[sizeof(last_job) - 1] = '\0';
}

return ret;
return publish_and_free_obj(&update_obj, &topic_updt, &param);
}

int nrf_cloud_fota_update_check(void)
Expand Down Expand Up @@ -1116,12 +1120,31 @@ int nrf_cloud_fota_mqtt_evt_handler(const struct mqtt_evt *evt)
}
case MQTT_EVT_SUBACK:
{
int ret = -1;

if (evt->param.suback.message_id != NCT_MSG_ID_FOTA_SUB) {
return 1;
}
LOG_DBG("MQTT_EVT_SUBACK");

nrf_cloud_fota_update_check();
if (fota_report_ack_pending) {
if (current_fota.info.type != NRF_CLOUD_FOTA_TYPE__INVALID) {
LOG_DBG("Sending job updated due to missing ACK");
ret = publish_job_status(&current_fota);
} else {
/* No current job info, check for a validated job */
ret = publish_validated_job_status();
if (ret == 1) {
/* No validated job either, clear flag */
fota_report_ack_pending = false;
}
}
}

if (ret != 0) {
/* Check for an update if job status was not published */
nrf_cloud_fota_update_check();
}

break;
}
Expand All @@ -1135,11 +1158,11 @@ int nrf_cloud_fota_mqtt_evt_handler(const struct mqtt_evt *evt)
}
case MQTT_EVT_PUBACK:
{
bool do_update_check = false;
bool fota_report_ack = false;

switch (evt->param.puback.message_id) {
case NCT_MSG_ID_FOTA_REPORT:
do_update_check = true;
fota_report_ack = true;
case NCT_MSG_ID_FOTA_REQUEST:
case NCT_MSG_ID_FOTA_BLE_REPORT:
case NCT_MSG_ID_FOTA_BLE_REQUEST:
Expand All @@ -1151,25 +1174,36 @@ int nrf_cloud_fota_mqtt_evt_handler(const struct mqtt_evt *evt)
LOG_DBG("MQTT_EVT_PUBACK: msg id %d",
evt->param.puback.message_id);

if (!do_update_check) {
if (!fota_report_ack) {
/* Nothing to do */
break;
}

/* Job status updated on the cloud, now process the local saved status */
fota_report_ack_pending = false;

/* If job was updated to terminal status, save job ID and cleanup*/
if (is_job_status_terminal(current_fota.status)) {
strncpy(last_job, current_fota.info.id, sizeof(last_job) - 1);
last_job[sizeof(last_job) - 1] = '\0';
cleanup_job(&current_fota);
}

switch (saved_job.validate) {
case NRF_CLOUD_FOTA_VALIDATE_ERROR:
case NRF_CLOUD_FOTA_VALIDATE_PASS:
case NRF_CLOUD_FOTA_VALIDATE_UNKNOWN:
case NRF_CLOUD_FOTA_VALIDATE_FAIL:
case NRF_CLOUD_FOTA_VALIDATE_ERROR:
save_validate_status(saved_job.id, saved_job.type,
NRF_CLOUD_FOTA_VALIDATE_DONE);
NRF_CLOUD_FOTA_VALIDATE_DONE);
break;
case NRF_CLOUD_FOTA_VALIDATE_PENDING:
send_fota_done_event_if_done();
break;
default:
break;
}

break;
}
case MQTT_EVT_DISCONNECT:
Expand Down

0 comments on commit d58aa2f

Please sign in to comment.