mqtt_helper.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef MQTT_HELPER__
#define MQTT_HELPER__
 
#include <stdio.h>
#include <zephyr/net/mqtt.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum mqtt_state {
        MQTT_STATE_UNINIT,
        MQTT_STATE_DISCONNECTED,
        MQTT_STATE_TRANSPORT_CONNECTING,
        MQTT_STATE_CONNECTING,
        MQTT_STATE_TRANSPORT_CONNECTED,
        MQTT_STATE_CONNECTED,
        MQTT_STATE_DISCONNECTING,
 
        MQTT_STATE_COUNT,
};
 
enum mqtt_helper_error {
        MQTT_HELPER_ERROR_MSG_SIZE,
};
 
struct mqtt_helper_buf {
        char *ptr;
 
        size_t size;
};
 
typedef bool (*mqtt_helper_on_all_events_t)(struct mqtt_client *const client,
                                            const struct mqtt_evt *const event);
typedef void (*mqtt_helper_on_connack_t)(enum mqtt_conn_return_code return_code,
                                         bool session_present);
typedef void (*mqtt_helper_on_disconnect_t)(int result);
typedef void (*mqtt_helper_on_publish_t)(struct mqtt_helper_buf topic_buf,
                                         struct mqtt_helper_buf payload_buf);
typedef void (*mqtt_helper_on_puback_t)(uint16_t message_id, int result);
typedef void (*mqtt_helper_on_suback_t)(uint16_t message_id, int result);
typedef void (*mqtt_helper_on_pingresp_t)(void);
typedef void (*mqtt_helper_on_error_t)(enum mqtt_helper_error error);
 
struct mqtt_helper_cfg {
        struct {
                mqtt_helper_on_all_events_t on_all_events;
                mqtt_helper_on_connack_t on_connack;
                mqtt_helper_on_disconnect_t on_disconnect;
                mqtt_helper_on_publish_t on_publish;
                mqtt_helper_on_puback_t on_puback;
                mqtt_helper_on_suback_t on_suback;
                mqtt_helper_on_pingresp_t on_pingresp;
                mqtt_helper_on_error_t on_error;
        } cb;
};
 
struct mqtt_helper_conn_params {
        /* The hostname must be null-terminated. */
        struct mqtt_helper_buf hostname;
        struct mqtt_helper_buf device_id;
        struct mqtt_helper_buf user_name;
        struct mqtt_helper_buf password;
};
 
int mqtt_helper_init(struct mqtt_helper_cfg *cfg);
 
 
int mqtt_helper_connect(struct mqtt_helper_conn_params *conn_params);
 
int mqtt_helper_disconnect(void);
 
int mqtt_helper_subscribe(struct mqtt_subscription_list *sub_list);
 
int mqtt_helper_publish(const struct mqtt_publish_param *param);
 
uint16_t mqtt_helper_msg_id_get(void);
 
int mqtt_helper_deinit(void);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* MQTT_HELPER__ */