aws_fota.h

Go to the documentation of this file.

/*
 *Copyright (c) 2019 Nordic Semiconductor ASA
 *
 *SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */

 
#ifndef AWS_FOTA_H__
#define AWS_FOTA_H__
 
#include <dfu/dfu_target.h>
#include <zephyr/net/mqtt.h>

 
#ifdef __cplusplus
extern "C" {
#endif
 
enum aws_fota_evt_id {
        AWS_FOTA_EVT_START,
        AWS_FOTA_EVT_DONE,
        AWS_FOTA_EVT_ERROR,
        AWS_FOTA_EVT_ERASE_PENDING,
        AWS_FOTA_EVT_ERASE_DONE,
        AWS_FOTA_EVT_DL_PROGRESS,
};

enum aws_fota_error_cause {
        AWS_FOTA_ERROR_CAUSE_NO_ERROR = 0,
        AWS_FOTA_ERROR_CAUSE_CONNECT_FAILED,
        AWS_FOTA_ERROR_CAUSE_DOWNLOAD_FAILED,
        AWS_FOTA_ERROR_CAUSE_INVALID_UPDATE,
        AWS_FOTA_ERROR_CAUSE_TYPE_MISMATCH,
        AWS_FOTA_ERROR_CAUSE_INTERNAL,
        AWS_FOTA_ERROR_CAUSE_DFU,
        AWS_FOTA_ERROR_CAUSE_PROTO_NOT_SUPPORTED,
        AWS_FOTA_ERROR_CAUSE_INVALID_CONFIGURATION,
        AWS_FOTA_ERROR_CAUSE_INVALID_JOB_DOCUMENT,
        AWS_FOTA_ERROR_CAUSE_URL_TOO_LONG,
        AWS_FOTA_ERROR_CAUSE_NO_SEC_TAG,
        AWS_FOTA_ERROR_CAUSE_DOWNLOAD_START_FAILED,
        AWS_FOTA_ERROR_CAUSE_JOB_UPDATE_REJECTED,
        AWS_FOTA_ERROR_CAUSE_JOB_UPDATE_FAILED,
        AWS_FOTA_ERROR_CAUSE_UNKNOWN,
};
 
#define AWS_FOTA_EVT_DL_COMPLETE_VAL 100
struct aws_fota_event_dl {
        int progress; /* Download progress percent, 0-100 */
};
 
struct aws_fota_event {
        enum aws_fota_evt_id id;
        union {
                struct aws_fota_event_dl dl;
                enum dfu_target_image_type image;
                enum aws_fota_error_cause cause;
        };
};
 
typedef void (*aws_fota_callback_t)(struct aws_fota_event *fota_evt);

int aws_fota_init(aws_fota_callback_t evt_handler);

int aws_fota_mqtt_evt_handler(struct mqtt_client *const client, const struct mqtt_evt *evt);

int aws_fota_get_job_id(uint8_t *const job_id_buf, size_t buf_size);
 
#ifdef __cplusplus
}
#endif

 
#endif /* AWS_FOTA_H__ */