mqtt_sn.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 René Beckmann
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_NET_MQTT_SN_H_
#define ZEPHYR_INCLUDE_NET_MQTT_SN_H_
 
#include <stddef.h>
 
#include <zephyr/net_buf.h>
#include <zephyr/types.h>
 
#include <sys/types.h>
 
#ifdef CONFIG_MQTT_SN_TRANSPORT_UDP
#include <zephyr/net/net_ip.h>
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum mqtt_sn_qos {
        MQTT_SN_QOS_0, 
        MQTT_SN_QOS_1, 
        MQTT_SN_QOS_2, 
        MQTT_SN_QOS_M1 
};
 
enum mqtt_sn_topic_type {
        MQTT_SN_TOPIC_TYPE_NORMAL,
        MQTT_SN_TOPIC_TYPE_PREDEF,
        MQTT_SN_TOPIC_TYPE_SHORT
};
 
enum mqtt_sn_return_code {
        MQTT_SN_CODE_ACCEPTED = 0x00,            
        MQTT_SN_CODE_REJECTED_CONGESTION = 0x01, 
        MQTT_SN_CODE_REJECTED_TOPIC_ID = 0x02,   
        MQTT_SN_CODE_REJECTED_NOTSUP = 0x03,     
};
 
struct mqtt_sn_data {
        const uint8_t *data; 
        size_t size;         
};
 
#define MQTT_SN_DATA_STRING_LITERAL(literal) ((struct mqtt_sn_data){literal, sizeof(literal) - 1})
 
#define MQTT_SN_DATA_BYTES(...)                                                                    \
        ((struct mqtt_sn_data){(uint8_t[]){__VA_ARGS__}, sizeof((uint8_t[]){__VA_ARGS__})})
 
enum mqtt_sn_evt_type {
        MQTT_SN_EVT_CONNECTED,    
        MQTT_SN_EVT_DISCONNECTED, 
        MQTT_SN_EVT_ASLEEP,       
        MQTT_SN_EVT_AWAKE,        
        MQTT_SN_EVT_PUBLISH,      
        MQTT_SN_EVT_PINGRESP,     
        MQTT_SN_EVT_ADVERTISE,    
        MQTT_SN_EVT_GWINFO,       
        MQTT_SN_EVT_SEARCHGW      
};
 
union mqtt_sn_evt_param {
        struct {
                struct mqtt_sn_data data;
                enum mqtt_sn_topic_type topic_type;
                uint16_t topic_id;
        } publish;
};
 
struct mqtt_sn_evt {
        enum mqtt_sn_evt_type type;
        union mqtt_sn_evt_param param;
};
 
struct mqtt_sn_client;
 
typedef void (*mqtt_sn_evt_cb_t)(struct mqtt_sn_client *client, const struct mqtt_sn_evt *evt);
 
struct mqtt_sn_transport {
        int (*init)(struct mqtt_sn_transport *transport);
 
        void (*deinit)(struct mqtt_sn_transport *transport);
 
        int (*sendto)(struct mqtt_sn_client *client, void *buf, size_t sz, const void *dest_addr,
                      size_t addrlen);
 
        ssize_t (*recvfrom)(struct mqtt_sn_client *client, void *rx_buf, size_t rx_len,
                            void *src_addr, size_t *addrlen);
 
        int (*poll)(struct mqtt_sn_client *client);
};
 
#ifdef CONFIG_MQTT_SN_TRANSPORT_UDP
struct mqtt_sn_transport_udp {
        struct mqtt_sn_transport tp;
 
        int sock;
 
        struct sockaddr bcaddr;
        socklen_t bcaddrlen;
};
 
#define UDP_TRANSPORT(transport) CONTAINER_OF(transport, struct mqtt_sn_transport_udp, tp)
 
int mqtt_sn_transport_udp_init(struct mqtt_sn_transport_udp *udp, struct sockaddr *gwaddr,
                               socklen_t addrlen);
#endif
 
struct mqtt_sn_client {
        struct mqtt_sn_data client_id;
 
        struct mqtt_sn_data will_topic;
 
        struct mqtt_sn_data will_msg;
 
        enum mqtt_sn_qos will_qos;
 
        bool will_retain;
 
        struct mqtt_sn_transport *transport;
 
        struct net_buf_simple tx;
 
        struct net_buf_simple rx;
 
        struct net_buf_simple rx_addr;
 
        mqtt_sn_evt_cb_t evt_cb;
 
        uint16_t next_msg_id;
 
        sys_slist_t publish;
 
        sys_slist_t topic;
 
        sys_slist_t gateway;
 
        int state;
 
        int64_t last_ping;
 
        uint8_t ping_retries;
 
        int64_t ts_searchgw;
 
        int64_t ts_gwinfo;
 
        int64_t radius_gwinfo;
 
        struct k_work_delayable process_work;
};
 
int mqtt_sn_client_init(struct mqtt_sn_client *client, const struct mqtt_sn_data *client_id,
                        struct mqtt_sn_transport *transport, mqtt_sn_evt_cb_t evt_cb, void *tx,
                        size_t txsz, void *rx, size_t rxsz);
 
void mqtt_sn_client_deinit(struct mqtt_sn_client *client);
 
int mqtt_sn_add_gw(struct mqtt_sn_client *client, uint8_t gw_id, struct mqtt_sn_data gw_addr);
 
int mqtt_sn_search(struct mqtt_sn_client *client, uint8_t radius);
 
int mqtt_sn_connect(struct mqtt_sn_client *client, bool will, bool clean_session);
 
int mqtt_sn_disconnect(struct mqtt_sn_client *client);
 
int mqtt_sn_sleep(struct mqtt_sn_client *client, uint16_t duration);
 
int mqtt_sn_subscribe(struct mqtt_sn_client *client, enum mqtt_sn_qos qos,
                      struct mqtt_sn_data *topic_name);
 
int mqtt_sn_unsubscribe(struct mqtt_sn_client *client, enum mqtt_sn_qos qos,
                        struct mqtt_sn_data *topic_name);
 
int mqtt_sn_publish(struct mqtt_sn_client *client, enum mqtt_sn_qos qos,
                    struct mqtt_sn_data *topic_name, bool retain, struct mqtt_sn_data *data);
 
int mqtt_sn_input(struct mqtt_sn_client *client);
 
int mqtt_sn_get_topic_name(struct mqtt_sn_client *client, uint16_t id,
                           struct mqtt_sn_data *topic_name);
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_NET_MQTT_SN_H_ */