sys/rest_client: add MQTT and MQTT-SN transport

RIOT-OS · HendrikVE · Jan 10, 2022 · Jan 10, 2022 · Jan 18, 2022 · Jan 18, 2022
commit 0c07b0a338586a16a7dd9fee39ad0e5114bbe9de
diff --git a/sys/Makefile.dep b/sys/Makefile.dep
@@ -35,6 +35,19 @@ ifneq (,$(filter rest_client_transport_coaps,$(USEMODULE)))
   USEMODULE += sock_util
 endif
 
+ifneq (,$(filter rest_client_transport_mqtt%,$(USEMODULE)))
+  USEMODULE += wolfmqtt
+  USEMODULE += posix_netdb
+  USEMODULE += posix_sockets
+  USEMODULE += posix_select
+  USEMODULE += ztimer_sec
+  USEMODULE += uuid
+endif
+
+ifneq (,$(filter rest_client_transport_mqtt,$(USEMODULE)))
+  USEMODULE += sock_tcp
+endif
+
 ifneq (,$(filter arduino,$(USEMODULE)))
   FEATURES_OPTIONAL += periph_adc
   FEATURES_OPTIONAL += periph_i2c

diff --git a/sys/include/rest_client.h b/sys/include/rest_client.h
@@ -30,6 +30,11 @@
 #include <sys/socket.h>
 #include "net/sock/udp.h"
 
+#if IS_USED(MODULE_REST_CLIENT_TRANSPORT_MQTT) || IS_USED(MODULE_REST_CLIENT_TRANSPORT_MQTTSN)
+#include "wolfmqtt/mqtt_socket.h"
+#include "wolfmqtt/mqtt_client.h"
+#endif
+
 #define REST_CLIENT_DEFAULT_PORT_COAP         5683
 #define REST_CLIENT_DEFAULT_PORT_COAP_SECURE  5684
 #define REST_CLIENT_DEFAULT_PORT_HTTP         80
@@ -135,6 +140,70 @@ typedef struct rest_client_response_listener_t {
     void (*listener) (struct rest_client_response_listener_t*);
 } rest_client_response_listener_t;
 
+// Todo: #if ... || defined(DOXYGEN)
+#if IS_USED(MODULE_REST_CLIENT_TRANSPORT_MQTT) || IS_USED(MODULE_REST_CLIENT_TRANSPORT_MQTTSN)
+/* MQTT Client state */
+typedef enum {
+    WMQ_BEGIN = 0,
+    WMQ_NET_INIT,
+    WMQ_INIT,
+    WMQ_TCP_CONN,
+    WMQ_MQTT_CONN,
+    WMQ_SUB,
+    WMQ_PUB,
+    WMQ_WAIT_MSG,
+    WMQ_UNSUB,
+    WMQ_DISCONNECT,
+    WMQ_NET_DISCONNECT,
+    WMQ_DONE
+} rest_client_mqtt_context_state_t;
+
+/* MQTT Client context */
+typedef struct {
+    rest_client_mqtt_context_state_t stat;
+
+    //void* app_ctx; /* For storing application specific data */
+    rest_client_response_listener_t* listener;
+
+    /* client and net containers */
+    MqttClient client;
+    MqttNet net;
+
+    /* temp mqtt containers */
+    MqttConnect connect;
+    MqttSubscribe subscribe;
+    MqttUnsubscribe unsubscribe;
+    /* Todo: convert to single value */
+    MqttTopic topics[1];
+    MqttPublish publish;
+    MqttDisconnect disconnect;
+
+#ifdef WOLFMQTT_SN
+    SN_Publish publish_sn;
+#endif
+
+    /* configuration */
+    const char *app_name;
+    const char *host;
+    bool is_numeric_host;
+    uint16_t port;
+    _ipvx_addr_t *addr;
+    const char *username;
+    const char *password;
+    uint8_t *tx_buf, *rx_buf;
+#ifdef WOLFMQTT_NONBLOCK
+    uint32_t start_sec; /* used for keep-alive */
+    unsigned int use_non_block_mode:1; /* set to use non-blocking mode. network callbacks can return
+                                       MQTT_CODE_CONTINUE to indicate "would block" */
+#endif
+#ifdef WOLFMQTT_CLIENT_ID
+    uint8_t clean_session;
+    const char *client_id;
+    unsigned int dynamic_client_id:1;
+#endif
+} rest_client_mqtt_context_t;
+#endif /* IS_USED(MODULE_REST_CLIENT_TRANSPORT_MQTT) || IS_USED(MODULE_REST_CLIENT_TRANSPORT_MQTTSN) */
+
 #if IS_USED(MODULE_REST_CLIENT_TRANSPORT_COAP)
 typedef struct rest_client_coap_proxy_t {
     rest_client_scheme_t scheme;
@@ -160,16 +229,39 @@ typedef struct {
 } rest_client_coap_context_t;
 #endif
 
+#if IS_USED(MODULE_REST_CLIENT_TRANSPORT_MQTTSN)
+typedef struct {
+    char *hostname;
+    bool is_numeric_hostname;
+    uint16_t port;
+    _ipvx_addr_t _addr; /* For internal use only */
+} rest_client_mqttsn_gateway_t;
+#endif
+
+/**
+ * @brief   Structure containing all information to connect to an endpoint. Besides basic
+ *          information like the hostname and port this struct also contains transport
+ *          specific members such as a reference to rest_client_coap_proxy_t when using CoAP.
+ */
 typedef struct {
     rest_client_scheme_t scheme;
     char *hostname;
     bool is_numeric_hostname;
     uint16_t port;
     _ipvx_addr_t _addr; /* For internal use only */
+
 #if IS_USED(MODULE_REST_CLIENT_TRANSPORT_COAP)
     rest_client_coap_context_t coap_context;
     rest_client_coap_proxy_t *coap_proxy;
 #endif
+
+#if IS_USED(MODULE_REST_CLIENT_TRANSPORT_MQTT) || IS_USED(MODULE_REST_CLIENT_TRANSPORT_MQTTSN)
+    rest_client_mqtt_context_t mqtt_context;
+#endif
+
+#if IS_USED(MODULE_REST_CLIENT_TRANSPORT_MQTTSN)
+    rest_client_mqttsn_gateway_t *mqttsn_gateway;
+#endif
 } rest_client_t;
 
 /**

diff --git a/sys/include/rest_client/internal/mqtt.h b/sys/include/rest_client/internal/mqtt.h
@@ -0,0 +1,98 @@
+/*
+ * Copyright (C) 2022 Freie Universität Berlin
+ *
+ * This file is subject to the terms and conditions of the GNU Lesser
+ * General Public License v2.1. See the file LICENSE in the top level
+ * directory for more details.
+*/
+
+/**
+ * @ingroup     sys_rest_client_mqtt
+ * @{
+ *
+ * @file
+ * @brief       Internal functions for MQTT-based transport modules
+ *
+ * @author      Hendrik van Essen <hendrik.ve@fu-berlin.de>
+ *
+ * @}
+*/
+
+#ifndef REST_CLIENT_INTERNAL_MQTT_H
+#define REST_CLIENT_INTERNAL_MQTT_H
+
+#include "uuid.h"
+
+#include "rest_client.h"
+
+/**
+ * @brief   Struct for custom MQTT payload, including header fields and payload
+ */
+typedef struct {
+    uuid_t *request_id;
+    rest_client_content_type_t content_type;
+    rest_client_content_type_t accept;
+    rest_client_content_type_t target_content_type;
+    rest_client_content_type_t target_accept;
+    char *authorization;
+    char *query_string;
+    uint8_t *body;
+    int body_len;
+} _mqtt_payload_t;
+
+/**
+ * @brief   Create a request topic string from access method and path.
+ *          Example request topic: GET/api/user/profile
+ *
+ * @param[out] buf      Output buffer
+ * @param[in]  buf_len  Output buffer size
+ * @param[in]  method   Access method (like GET or POST)
+ * @param[in]  path     Resource path
+ */
+void _rest_client_internal_mqtt_build_mqtt_request_topic(
+        char *buf, size_t buf_len, rest_client_method_t method, const char *path);
+
+/**
+ * @brief   Create response topic from access method, path and a uuid
+ *          Example response topic: GET/api/user/profile
+ *
+ * @param[out] buf      Output buffer
+ * @param[in]  buf_len  Output buffer size
+ * @param[in]  method   Access method (like GET or POST)
+ * @param[in]  path     Resource path
+ * @param[in]  uuid     Unique request ID
+ */
+void _rest_client_internal_mqtt_build_mqtt_response_topic(
+        char *buf, size_t buf_len, rest_client_method_t method, const char *path, const char *uuid);
+
+/**
+ * @brief   Encode custom MQTT payload
+ *
+ * @param[out] mqtt_payload     MQTT payload struct
+ * @param[in]  encoder_buf      Encoder buffer
+ * @param[in]  encoder_buf_len  Encoder buffer size
+ *
+ * @return  Length of encoded data
+ */
+size_t _rest_client_internal_mqtt_encode_mqtt_payload(
+        _mqtt_payload_t *mqtt_payload, uint8_t *encoder_buf, size_t encoder_buf_len);
+
+/**
+ * @brief   Parse custom MQTT payload
+ *
+ * @param[in] buf                   Input buffer
+ * @param[in] buf_size              Input buffer size
+ * @param[in] http_status           HTTP status
+ * @param[in] content_type          Content type
+ * @param[in] cbor_payload_buf      Buffer for extracted body
+ * @param[in] cbor_payload_buf_size Length of the extracted body
+ *
+ * @retval  0   On success
+ * @retval  1   On error
+ */
+int _rest_client_internal_mqtt_parse_mqtt_payload(
+        const uint8_t *buf, size_t buf_size,
+        int *http_status, rest_client_content_type_t *content_type,
+        uint8_t *cbor_payload_buf, size_t *cbor_payload_buf_size);
+
+#endif /* REST_CLIENT_INTERNAL_MQTT_H */
diff --git a/sys/include/rest_client/mqttexample.h b/sys/include/rest_client/mqttexample.h
@@ -0,0 +1,63 @@
+/*
+ * Copyright (C) 2022 Freie Universität Berlin
+ *
+ * This file is subject to the terms and conditions of the GNU Lesser
+ * General Public License v2.1. See the file LICENSE in the top level
+ * directory for more details.
+*/
+
+/**
+ * @ingroup     sys_rest_client_mqttexample
+ * @{
+ *
+ * @file
+ * @brief       Helper functions wolfMQTT interactions
+ *
+ * @author      Hendrik van Essen <hendrik.ve@fu-berlin.de>
+ *
+ * @}
+*/
+
+#ifndef REST_CLIENT_MQTTEXAMPLE_H
+#define REST_CLIENT_MQTTEXAMPLE_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include "rest_client.h"
+
+#ifndef CONFIG_REST_CLIENT_MQTT_CMD_TIMEOUT_MS
+    #define CONFIG_REST_CLIENT_MQTT_CMD_TIMEOUT_MS          30000
+#endif
+
+#ifndef CONFIG_REST_CLIENT_MQTT_CON_TIMEOUT_MS
+    #define CONFIG_REST_CLIENT_MQTT_CON_TIMEOUT_MS          5000
+#endif
+
+#ifndef CONFIG_REST_CLIENT_MQTT_DEFAULT_KEEP_ALIVE_SEC
+    #define CONFIG_REST_CLIENT_MQTT_DEFAULT_KEEP_ALIVE_SEC  60
+#endif
+
+#ifndef CONFIG_REST_CLIENT_MQTT_PRINT_BUFFER_SIZE
+    #define CONFIG_REST_CLIENT_MQTT_PRINT_BUFFER_SIZE       180
+#endif
+
+#ifndef CONFIG_REST_CLIENT_MQTT_CLIENT_ID
+    #define CONFIG_REST_CLIENT_MQTT_CLIENT_ID               "riot-os"
+#endif
+
+void mqtt_init_ctx(rest_client_mqtt_context_t *mqtt_context);
+void mqtt_free_ctx(rest_client_mqtt_context_t *mqtt_context);
+
+uint16_t mqtt_get_packetid(void);
+
+#ifdef WOLFMQTT_NONBLOCK
+int mqtt_check_timeout(int rc, uint32_t *start_sec, uint32_t timeout_sec);
+#endif
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* REST_CLIENT_MQTTEXAMPLE_H */
diff --git a/sys/include/rest_client/mqttnet.h b/sys/include/rest_client/mqttnet.h
@@ -0,0 +1,45 @@
+/*
+ * Copyright (C) 2022 Freie Universität Berlin
+ *
+ * This file is subject to the terms and conditions of the GNU Lesser
+ * General Public License v2.1. See the file LICENSE in the top level
+ * directory for more details.
+*/
+
+/**
+ * @ingroup     sys_rest_client_mqttnet
+ * @{
+ *
+ * @file
+ * @brief       Definitions for basic wolfMQTT interactions
+ *
+ * @author      Hendrik van Essen <hendrik.ve@fu-berlin.de>
+ *
+ * @}
+*/
+
+#ifndef REST_CLIENT_MQTTNET_H
+#define REST_CLIENT_MQTTNET_H
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#include "rest_client/mqttexample.h"
+
+#ifndef DEFAULT_MQTT_HOST
+#define DEFAULT_MQTT_HOST       "mqtt.eclipse.org" /* broker.hivemq.com */
+#endif
+
+int mqttnet_init(MqttNet *net, rest_client_mqtt_context_t *mqtt_context);
+int mqttnet_deinit(MqttNet *net);
+
+#ifdef WOLFMQTT_SN
+int mqttnet_sn_init(MqttNet *net, rest_client_mqtt_context_t *mqtt_context);
+#endif
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* REST_CLIENT_MQTTNET_H */
diff --git a/sys/include/rest_client/transport/mqtt.h b/sys/include/rest_client/transport/mqtt.h
@@ -0,0 +1,37 @@
+/*
+ * Copyright (C) 2021 Freie Universität Berlin
+ *
+ * This file is subject to the terms and conditions of the GNU Lesser
+ * General Public License v2.1. See the file LICENSE in the top level
+ * directory for more details.
+*/
+
+/**
+ * @ingroup     sys_rest_client_transport_mqtt
+ * @{
+ *
+ * @file
+ * @brief       REST client transport module for MQTT
+ *
+ * @author      Hendrik van Essen <hendrik.ve@fu-berlin.de>
+ *
+ * @}
+ */
+
+#ifndef REST_CLIENT_TRANSPORT_MQTT_H
+#define REST_CLIENT_TRANSPORT_MQTT_H
+
+#include "rest_client.h"
+
+rest_client_result_t rest_client_transport_mqtt_send(
+        rest_client_t *rest_client, rest_client_response_listener_t *listener,
+        rest_client_method_t method, rest_client_qos_t qos,
+        rest_client_header_t *headers, char *path, char *query_string, uint8_t *body, int body_len);
+
+rest_client_result_t rest_client_transport_mqtt_init(rest_client_t *rest_client);
+rest_client_result_t rest_client_transport_mqtt_deinit(rest_client_t *rest_client);
+rest_client_result_t rest_client_transport_mqtt_connect(rest_client_t *rest_client);
+rest_client_result_t rest_client_transport_mqtt_disconnect(rest_client_t *rest_client);
+
+
+#endif /* REST_CLIENT_TRANSPORT_MQTT_H */