hawkbit.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Linumiz
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_MGMT_HAWKBIT_H_
#define ZEPHYR_INCLUDE_MGMT_HAWKBIT_H_
 
#include <zephyr/net/tls_credentials.h>
 
#define HAWKBIT_JSON_URL "/default/controller/v1"
 
enum hawkbit_response {
        HAWKBIT_NETWORKING_ERROR,
        HAWKBIT_UNCONFIRMED_IMAGE,
        HAWKBIT_PERMISSION_ERROR,
        HAWKBIT_METADATA_ERROR,
        HAWKBIT_DOWNLOAD_ERROR,
        HAWKBIT_OK,
        HAWKBIT_UPDATE_INSTALLED,
        HAWKBIT_NO_UPDATE,
        HAWKBIT_CANCEL_UPDATE,
        HAWKBIT_NOT_INITIALIZED,
        HAWKBIT_PROBE_IN_PROGRESS,
};
 
struct hawkbit_runtime_config {
        char *server_addr;
        uint16_t server_port;
        char *auth_token;
        sec_tag_t tls_tag;
};
 
typedef int (*hawkbit_config_device_data_cb_handler_t)(const char *device_id, uint8_t *buffer,
                                                  const size_t buffer_size);
 
int hawkbit_set_custom_data_cb(hawkbit_config_device_data_cb_handler_t cb);
 
int hawkbit_init(void);
 
void hawkbit_autohandler(void);
 
enum hawkbit_response hawkbit_probe(void);
 
void hawkbit_reboot(void);
 
typedef bool (*hawkbit_get_device_identity_cb_handler_t)(char *id, int id_max_len);
 
int hawkbit_set_device_identity_cb(hawkbit_get_device_identity_cb_handler_t cb);
 
int hawkbit_set_config(struct hawkbit_runtime_config *config);
 
struct hawkbit_runtime_config hawkbit_get_config(void);
 
static inline int hawkbit_set_server_addr(char *addr_str)
{
        struct hawkbit_runtime_config set_config = {
                .server_addr = addr_str, .server_port = 0, .auth_token = NULL, .tls_tag = 0};
 
        return hawkbit_set_config(&set_config);
}
 
static inline int hawkbit_set_server_port(uint16_t port)
{
        struct hawkbit_runtime_config set_config = {
                .server_addr = NULL, .server_port = port, .auth_token = NULL, .tls_tag = 0};
 
        return hawkbit_set_config(&set_config);
}
 
static inline int hawkbit_set_ddi_security_token(char *token)
{
        struct hawkbit_runtime_config set_config = {
                .server_addr = NULL, .server_port = 0, .auth_token = token, .tls_tag = 0};
 
        return hawkbit_set_config(&set_config);
}
 
static inline int hawkbit_set_tls_tag(sec_tag_t tag)
{
        struct hawkbit_runtime_config set_config = {
                .server_addr = NULL, .server_port = 0, .auth_token = NULL, .tls_tag = tag};
 
        return hawkbit_set_config(&set_config);
}
 
static inline char *hawkbit_get_server_addr(void)
{
        return hawkbit_get_config().server_addr;
}
 
static inline uint16_t hawkbit_get_server_port(void)
{
        return hawkbit_get_config().server_port;
}
 
static inline char *hawkbit_get_ddi_security_token(void)
{
        return hawkbit_get_config().auth_token;
}
 
static inline sec_tag_t hawkbit_get_tls_tag(void)
{
        return hawkbit_get_config().tls_tag;
}
 
int32_t hawkbit_get_action_id(void);
 
int hawkbit_reset_action_id(void);
 
#endif /* _HAWKBIT_H_ */