aiot_ota_api.h

浏览该文件的文档.

#ifndef __AIOT_OTA_API_H__
#define __AIOT_OTA_API_H__

#if defined(__cplusplus)
extern "C" {
#endif

#include <stdint.h>

typedef enum {

    AIOT_OTARECV_FOTA,

    AIOT_OTARECV_COTA
} aiot_ota_recv_type_t;

typedef enum {

    AIOT_OTA_DIGEST_MD5,

    AIOT_OTA_DIGEST_SHA256,
    AIOT_OTA_DIGEST_MAX
} aiot_ota_digest_type_t;

typedef enum {

    AIOT_OTA_PROTOCOL_HTTPS,

    AIOT_OTA_PROTOCOL_MQTT,
    AIOT_OTA_PROTOCOL_MAX
} aiot_ota_protocol_type_t;

typedef struct {

    char       *product_key;

    char       *device_name;

    /*
     * @brief 下载固件所需的链接
     *
     */
    char       *url;
    /*
     * @brief mqtt文件下载，标识文件流的streamid
     *
     */
    uint32_t   stream_id;
    /*
     * @brief mqtt文件下载,标识文件的fileid
     *
     */
    uint32_t   stream_file_id;
    /*
     * @brief 固件的大小, 单位为Byte
     *
     */
    uint32_t    size_total;

    /*
     * @brief 云端对的固件进行数字签名的方式, 具体见@ref aiot_ota_digest_type_t
     *
     */
    uint8_t     digest_method;

    /*
     * @brief 云端对固件计算数字签名得出来的结果
     *
     */
    char       *expect_digest;

    char       *version;

    char       *module;

    void       *mqtt_handle;

    char       *extra_data;

    char  *file_name;

    uint32_t file_num;

    uint32_t file_id;
    aiot_ota_protocol_type_t protocol_type;

} aiot_download_task_desc_t;

typedef struct {

    aiot_ota_recv_type_t        type;

    aiot_download_task_desc_t   *task_desc;
} aiot_ota_recv_t;

typedef void (* aiot_ota_recv_handler_t)(void *handle, const aiot_ota_recv_t *const msg, void *userdata);

typedef enum {

    AIOT_DLRECV_HTTPBODY
} aiot_download_recv_type_t;

typedef struct {

    aiot_download_recv_type_t type;

    struct {

        uint8_t *buffer;

        uint32_t len;

        int32_t  percent;
    } data;
} aiot_download_recv_t;


typedef void (* aiot_download_recv_handler_t)(void *handle, const aiot_download_recv_t *packet,
        void *userdata);

typedef enum {

    AIOT_OTAERR_UPGRADE_FAILED = -1,

    AIOT_OTAERR_FETCH_FAILED = -2,

    AIOT_OTAERR_CHECKSUM_MISMATCH = -3,

    AIOT_OTAERR_BURN_FAILED = -4
} aiot_ota_protocol_errcode_t;

typedef enum {

    AIOT_OTAOPT_RECV_HANDLER,

    AIOT_OTAOPT_MQTT_HANDLE,

    AIOT_OTAOPT_USERDATA,

    AIOT_OTAOPT_MODULE,
    AIOT_OTAOPT_MAX
} aiot_ota_option_t;

typedef enum {

    AIOT_DLOPT_NETWORK_CRED,

    AIOT_DLOPT_NETWORK_PORT,

    AIOT_DLOPT_RECV_TIMEOUT_MS,

    AIOT_DLOPT_RECV_HANDLER,

    AIOT_DLOPT_USERDATA,

    AIOT_DLOPT_TASK_DESC,

    AIOT_DLOPT_RANGE_START,

    AIOT_DLOPT_RANGE_END,

    AIOT_DLOPT_BODY_BUFFER_MAX_LEN,
    AIOT_DLOPT_MAX
} aiot_download_option_t;

int32_t aiot_ota_query_firmware(void *handle);

void   *aiot_ota_init();

int32_t aiot_ota_deinit(void **handle);

int32_t aiot_ota_report_version(void *handle, char *version);

int32_t aiot_ota_report_version_ext(void *handle, char *product_key, char *device_name, char *version);

int32_t aiot_ota_setopt(void *handle, aiot_ota_option_t option, void *data);

void   *aiot_download_init();

int32_t aiot_download_deinit(void **handle);

int32_t aiot_download_recv(void *handle); /* 返回条件: 网络出错 | 校验出错 | 读到EOF | buf填满 */

int32_t aiot_download_setopt(void *handle, aiot_download_option_t option, void *data);

int32_t aiot_download_report_progress(void *handle, int32_t percent);

int32_t aiot_download_send_request(void *handle);

#define STATE_OTA_BASE                                              (-0x0900)

#define STATE_OTA_DIGEST_MATCH                                      (-0x0901)

#define STATE_OTA_REPORT_FAILED                                     (-0x0902)

#define STATE_DOWNLOAD_RECV_ERROR                                   (-0x0903)

#define STATE_OTA_DIGEST_MISMATCH                                   (-0x0904)

#define STATE_OTA_PARSE_JSON_ERROR                                  (-0x0905)

#define STATE_DOWNLOAD_SEND_REQUEST_FAILED                          (-0x0906)

#define STATE_DOWNLOAD_RANGE_FINISHED                               (-0x0907)

#define STATE_OTA_PARSE_JSON_MALLOC_FAILED                          (-0x0908)

#define STATE_OTA_DEINIT_HANDLE_IS_NULL                             (-0x0909)

#define STATE_OTA_SETOPT_HANDLE_IS_NULL                             (-0x090A)

#define STATE_OTA_SETOPT_DATA_IS_NULL                               (-0x090B)

#define STATE_DOWNLOAD_DEINIT_HANDLE_IS_NULL                        (-0x090C)

#define STATE_DOWNLOAD_SETOPT_HANDLE_IS_NULL                        (-0x090D)

#define STATE_DOWNLOAD_SETOPT_DATA_IS_NULL                          (-0x090E)

#define STATE_DOWNLOAD_SETOPT_COPIED_DATA_IS_NULL                   (-0x090F)

#define STATE_OTA_REPORT_HANDLE_IS_NULL                             (-0x0910)

#define STATE_OTA_REPORT_VERSION_IS_NULL                            (-0x0911)

#define STATE_OTA_REPORT_MQTT_HANDLE_IS_NULL                        (-0x0912)

#define STATE_OTA_REPORT_EXT_HANELD_IS_NULL                         (-0x0913)

#define STATE_OTA_REPORT_EXT_VERSION_NULL                           (-0x0914)

#define STATE_OTA_REPORT_EXT_PRODUCT_KEY_IS_NULL                    (-0x0915)

#define STATE_OTA_REPORT_EXT_DEVICE_NAME_IS_NULL                    (-0x0916)

#define STATE_OTA_REPORT_EXT_MQTT_HANDLE_IS_NULL                    (-0x0917)

#define STATE_DOWNLOAD_REPORT_HANDLE_IS_NULL                        (-0x0918)

#define STATE_DOWNLOAD_REPORT_TASK_DESC_IS_NULL                     (-0x0919)

#define STATE_DOWNLOAD_RECV_HANDLE_IS_NULL                          (-0x091A)

#define STATE_DOWNLOAD_REQUEST_HANDLE_IS_NULL                       (-0x091B)

#define STATE_DOWNLOAD_REQUEST_TASK_DESC_IS_NULL                    (-0x091C)

#define STATE_DOWNLOAD_REQUEST_URL_IS_NULL                          (-0x091D)

#define STATE_OTA_UNKNOWN_DIGEST_METHOD                             (-0x091E)

#define STATE_DOWNLOAD_FINISHED                                     (-0x091F)

#define STATE_DOWNLOAD_HTTPRSP_CODE_ERROR                           (-0x0920)

#define STATE_DOWNLOAD_HTTPRSP_HEADER_ERROR                         (-0x0921)

#define STATE_DOWNLOAD_RENEWAL_REQUEST_SENT                         (-0x0922)

#define STATE_DOWNLOAD_SETOPT_MALLOC_SHA256_CTX_FAILED              (-0x0923)

#define STATE_DOWNLOAD_SETOPT_MALLOC_MD5_CTX_FAILED                 (-0x0924)

#define STATE_OTA_PARSE_URL_HOST_IS_NULL                            (-0x0925)

#define STATE_OTA_PARSE_URL_PATH_IS_NULL                            (-0x0926)

#define STATE_DOWNLOAD_FETCH_TOO_MANY                               (-0x0927)

#define STATE_OTA_QUERY_FIRMWARE_HANDLE_IS_NULL                     (-0x0928)

#define STATE_OTA_HOST_STRING_OVERFLOW                              (-0x0929)

#define STATE_OTA_PATH_STRING_OVERFLOW                              (-0x092A)

#if defined(__cplusplus)
}
#endif

#endif  /* #ifndef __AIOT_OTA_API_H__ */