azure_iot_hub.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef AZURE_IOT_HUB__
#define AZURE_IOT_HUB__
 
#include <stdio.h>
#include <zephyr/net/mqtt.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum azure_iot_hub_evt_type {
        AZURE_IOT_HUB_EVT_CONNECTING = 0x1,
 
        AZURE_IOT_HUB_EVT_CONNECTED,
 
        AZURE_IOT_HUB_EVT_CONNECTION_FAILED,
 
        AZURE_IOT_HUB_EVT_READY,
 
        AZURE_IOT_HUB_EVT_DISCONNECTED,
 
        AZURE_IOT_HUB_EVT_DATA_RECEIVED,
 
        AZURE_IOT_HUB_EVT_PUBACK,
 
        AZURE_IOT_HUB_EVT_PINGRESP,
 
        AZURE_IOT_HUB_EVT_TWIN_RECEIVED,
 
        AZURE_IOT_HUB_EVT_TWIN_DESIRED_RECEIVED,
 
        AZURE_IOT_HUB_EVT_TWIN_RESULT_SUCCESS,
 
        AZURE_IOT_HUB_EVT_TWIN_RESULT_FAIL,
 
        AZURE_IOT_HUB_EVT_DIRECT_METHOD,
 
        AZURE_IOT_HUB_EVT_FOTA_START,
 
        AZURE_IOT_HUB_EVT_FOTA_DONE,
 
        AZURE_IOT_HUB_EVT_FOTA_ERASE_PENDING,
 
        AZURE_IOT_HUB_EVT_FOTA_ERASE_DONE,
 
        AZURE_IOT_HUB_EVT_FOTA_ERROR,
 
        AZURE_IOT_HUB_EVT_ERROR_MSG_SIZE,
 
        AZURE_IOT_HUB_EVT_ERROR
};
 
enum azure_iot_hub_topic_type {
        AZURE_IOT_HUB_TOPIC_DEVICEBOUND,
 
        AZURE_IOT_HUB_TOPIC_DIRECT_METHOD,
 
        AZURE_IOT_HUB_TOPIC_TWIN_DESIRED,
 
        AZURE_IOT_HUB_TOPIC_TWIN_REQUEST_RESULT,
 
        AZURE_IOT_HUB_TOPIC_DPS,
 
        AZURE_IOT_HUB_TOPIC_EVENT,
 
        AZURE_IOT_HUB_TOPIC_TWIN_REPORTED,
 
        AZURE_IOT_HUB_TOPIC_TWIN_REQUEST,
 
        AZURE_IOT_HUB_TOPIC_UNKNOWN,
};
 
struct azure_iot_hub_buf {
        /* Pointer to buffer. */
        char *ptr;
 
        /* Size of buffer. */
        size_t size;
};
 
struct azure_iot_hub_property {
        struct azure_iot_hub_buf key;
 
        struct azure_iot_hub_buf value;
};
 
struct azure_iot_hub_topic_data {
        enum azure_iot_hub_topic_type type;
 
        struct azure_iot_hub_buf name;
 
        /* Array of property bags. */
        struct azure_iot_hub_property *properties;
 
        /* Number of property bag elements in the properties array. */
        size_t property_count;
};
 
struct azure_iot_hub_msg {
        struct azure_iot_hub_topic_data topic;
 
        struct azure_iot_hub_buf payload;
 
        struct azure_iot_hub_buf request_id;
 
        enum mqtt_qos qos;
 
        uint16_t message_id;
 
        uint8_t dup_flag;
 
        uint8_t retain_flag;
};
 
struct azure_iot_hub_method {
        struct azure_iot_hub_buf name;
 
        struct azure_iot_hub_buf request_id;
 
        struct azure_iot_hub_buf payload;
};
 
struct azure_iot_hub_result {
        struct azure_iot_hub_buf request_id;
 
        uint32_t status;
 
        struct azure_iot_hub_buf payload;
};
 
struct azure_iot_hub_evt {
        enum azure_iot_hub_evt_type type;
        union {
                struct azure_iot_hub_msg msg;
                struct azure_iot_hub_method method;
                struct azure_iot_hub_result result;
                int err;
                bool persistent_session;
                uint16_t message_id;
        } data;
        /* Associated topic, not relevant for all events. */
        struct azure_iot_hub_topic_data topic;
};
 
typedef void (*azure_iot_hub_evt_handler_t)(struct azure_iot_hub_evt *evt);
 
struct azure_iot_hub_config {
        struct azure_iot_hub_buf hostname;
        struct azure_iot_hub_buf device_id;
 
        bool use_dps;
};
 
int azure_iot_hub_init(azure_iot_hub_evt_handler_t event_handler);
 
int azure_iot_hub_connect(const struct azure_iot_hub_config *config);
 
int azure_iot_hub_disconnect(void);
 
int azure_iot_hub_send(const struct azure_iot_hub_msg *const tx_data);
 
int azure_iot_hub_method_respond(struct azure_iot_hub_result *result);
 
#ifdef __cplusplus
}
#endif
 
#endif /* AZURE_IOT_HUB__ */