Merge branch 'feature/update_mqtt_component_examples_from_idf' into 'master'

Feature/update mqtt component examples from idf

See merge request sdk/ESP8266_RTOS_SDK!1314

Author: donghengqaz

.gitmodules

@@ -9,3 +9,7 @@
 [submodule "components/lwip/lwip"]
 	path = components/lwip/lwip
 	url = ../../espressif/esp-lwip.git
+
+[submodule "components/mqtt/esp-mqtt"]
+	path = components/mqtt/esp-mqtt
+	url = ../../espressif/esp-mqtt.git

components/mqtt/CMakeLists.txt

@@ -1,10 +1,9 @@
-set(COMPONENT_ADD_INCLUDEDIRS "esp-mqtt/include")
-set(COMPONENT_PRIV_INCLUDEDIRS "esp-mqtt/lib/include")
-set(COMPONENT_SRCS "esp-mqtt/mqtt_client.c"
-                   "esp-mqtt/lib/mqtt_msg.c"
-                   "esp-mqtt/lib/mqtt_outbox.c"
-                   "esp-mqtt/lib/platform_idf.c")
+idf_component_register(SRCS "esp-mqtt/mqtt_client.c"
+                            "esp-mqtt/lib/mqtt_msg.c"
+                            "esp-mqtt/lib/mqtt_outbox.c"
+                            "esp-mqtt/lib/platform_esp32_idf.c"
+                    INCLUDE_DIRS esp-mqtt/include
+                    PRIV_INCLUDE_DIRS "esp-mqtt/lib/include"
+                    REQUIRES lwip http_parser mbedtls tcp_transport)
 
-set(COMPONENT_REQUIRES lwip http_parser tcp_transport freertos lwip mbedtls openssl)
-
-register_component()
+target_compile_definitions(${COMPONENT_LIB} PUBLIC -DMQTT_SUPPORTED_FEATURE_WS_SUBPROTOCOL -DMQTT_SUPPORTED_FEATURE_TRANSPORT_ERR_REPORTING)

components/mqtt/Kconfig

@@ -1,103 +1,111 @@
-menu "MQTT"
-
-config MQTT_PROTOCOL_311
-    bool "Enable MQTT protocol 3.1.1"
-    default y
-    help
-        If not, this library will use MQTT protocol 3.1
-
-config MQTT_TRANSPORT_SSL
-    bool "Enable MQTT over SSL"
-    default y
-    help
-        Enable MQTT transport over SSL with mbedtls
-
-config MQTT_TRANSPORT_WEBSOCKET
-    bool "Enable MQTT over Websocket"
-    default y
-    help
-        Enable MQTT transport over Websocket.
-
-config MQTT_TRANSPORT_WEBSOCKET_SECURE
-    bool "Enable MQTT over Websocket Secure"
-    default y
-    depends on MQTT_TRANSPORT_WEBSOCKET
-    depends on MQTT_TRANSPORT_SSL
-    help
-        Enable MQTT transport over Websocket Secure.
-
-config MQTT_USE_CUSTOM_CONFIG
-    bool "MQTT Using custom configurations"
-    default n
-    help
-        Custom MQTT configurations.
-
-config MQTT_TCP_DEFAULT_PORT
-    int "Default MQTT over TCP port"
-    default 1883
-    depends on MQTT_USE_CUSTOM_CONFIG
-    help
-        Default MQTT over TCP port
-
-config MQTT_SSL_DEFAULT_PORT
-    int "Default MQTT over SSL port"
-    default 8883
-    depends on MQTT_USE_CUSTOM_CONFIG
-    depends on MQTT_TRANSPORT_SSL
-    help
-        Default MQTT over SSL port
-        
-config MQTT_WS_DEFAULT_PORT
-    int "Default MQTT over Websocket port"
-    default 80
-    depends on MQTT_USE_CUSTOM_CONFIG
-    depends on MQTT_TRANSPORT_WEBSOCKET
-    help
-        Default MQTT over Websocket port
-
-config MQTT_WSS_DEFAULT_PORT
-    int "Default MQTT over Websocket Secure port"
-    default 443
-    depends on MQTT_USE_CUSTOM_CONFIG
-    depends on MQTT_TRANSPORT_WEBSOCKET
-    depends on MQTT_TRANSPORT_WEBSOCKET_SECURE
-    help
-        Default MQTT over Websocket Secure port
-
-config MQTT_BUFFER_SIZE
-    int "Default MQTT Buffer Size"
-    default 1024
-    depends on MQTT_USE_CUSTOM_CONFIG
-    help
-        This buffer size using for both transmit and receive
-
-config MQTT_TASK_STACK_SIZE
-    int "MQTT task stack size"
-    default 6144
-    depends on MQTT_USE_CUSTOM_CONFIG
-    help
-        MQTT task stack size
-
-config MQTT_TASK_CORE_SELECTION_ENABLED
-    bool "Enable MQTT task core selection"
-    default false
-    help
-        This will enable core selection
-
-choice MQTT_TASK_CORE_SELECTION
-    depends on MQTT_TASK_CORE_SELECTION_ENABLED
-    prompt "Core to use ?"
-    config MQTT_USE_CORE_0
-          bool "Core 0"
-    config MQTT_USE_CORE_1
-          bool "Core 1"
- endchoice
-
-config MQTT_CUSTOM_OUTBOX
-    bool "Enable custom outbox implementation"
-    default n
-    help
-        Set to true if a specific implementation of message outbox is needed (e.g. persistant outbox in NVM or similar).
+menu "ESP-MQTT Configurations"
 
+    config MQTT_PROTOCOL_311
+        bool "Enable MQTT protocol 3.1.1"
+        default y
+        help
+            If not, this library will use MQTT protocol 3.1
+
+    config MQTT_TRANSPORT_SSL
+        bool "Enable MQTT over SSL"
+        default y
+        help
+            Enable MQTT transport over SSL with mbedtls
+
+    config MQTT_TRANSPORT_WEBSOCKET
+        bool "Enable MQTT over Websocket"
+        default y
+        help
+            Enable MQTT transport over Websocket.
+
+    config MQTT_TRANSPORT_WEBSOCKET_SECURE
+        bool "Enable MQTT over Websocket Secure"
+        default y
+        depends on MQTT_TRANSPORT_WEBSOCKET
+        depends on MQTT_TRANSPORT_SSL
+        help
+            Enable MQTT transport over Websocket Secure.
+
+    config MQTT_USE_CUSTOM_CONFIG
+        bool "MQTT Using custom configurations"
+        default n
+        help
+            Custom MQTT configurations.
+
+    config MQTT_TCP_DEFAULT_PORT
+        int "Default MQTT over TCP port"
+        default 1883
+        depends on MQTT_USE_CUSTOM_CONFIG
+        help
+            Default MQTT over TCP port
+
+    config MQTT_SSL_DEFAULT_PORT
+        int "Default MQTT over SSL port"
+        default 8883
+        depends on MQTT_USE_CUSTOM_CONFIG
+        depends on MQTT_TRANSPORT_SSL
+        help
+            Default MQTT over SSL port
+
+    config MQTT_WS_DEFAULT_PORT
+        int "Default MQTT over Websocket port"
+        default 80
+        depends on MQTT_USE_CUSTOM_CONFIG
+        depends on MQTT_TRANSPORT_WEBSOCKET
+        help
+            Default MQTT over Websocket port
+
+    config MQTT_WSS_DEFAULT_PORT
+        int "Default MQTT over Websocket Secure port"
+        default 443
+        depends on MQTT_USE_CUSTOM_CONFIG
+        depends on MQTT_TRANSPORT_WEBSOCKET
+        depends on MQTT_TRANSPORT_WEBSOCKET_SECURE
+        help
+            Default MQTT over Websocket Secure port
+
+    config MQTT_BUFFER_SIZE
+        int "Default MQTT Buffer Size"
+        default 1024
+        depends on MQTT_USE_CUSTOM_CONFIG
+        help
+            This buffer size using for both transmit and receive
+
+    config MQTT_TASK_STACK_SIZE
+        int "MQTT task stack size"
+        default 6144
+        depends on MQTT_USE_CUSTOM_CONFIG
+        help
+            MQTT task stack size
+
+    config MQTT_DISABLE_API_LOCKS
+        bool "Disable API locks"
+        default n
+        depends on MQTT_USE_CUSTOM_CONFIG
+        help
+            Default config employs API locks to protect internal structures. It is possible to disable
+            these locks if the user code doesn't access MQTT API from multiple concurrent tasks
+
+    config MQTT_TASK_CORE_SELECTION_ENABLED
+        bool "Enable MQTT task core selection"
+        default false
+        help
+            This will enable core selection
+
+    choice MQTT_TASK_CORE_SELECTION
+        depends on MQTT_TASK_CORE_SELECTION_ENABLED
+        prompt "Core to use ?"
+        config MQTT_USE_CORE_0
+            bool "Core 0"
+        config MQTT_USE_CORE_1
+            bool "Core 1"
+    endchoice
+
+    config MQTT_CUSTOM_OUTBOX
+        bool "Enable custom outbox implementation"
+        default n
+        help
+            Set to true if a specific implementation of message outbox is needed (e.g. persistant outbox in NVM or
+            similar).
 
 endmenu

components/mqtt/component.mk

@@ -1,3 +1,6 @@
+COMPONENT_SUBMODULES += esp-mqtt
 COMPONENT_ADD_INCLUDEDIRS := esp-mqtt/include
 COMPONENT_SRCDIRS :=  esp-mqtt esp-mqtt/lib
 COMPONENT_PRIV_INCLUDEDIRS := esp-mqtt/lib/include
+#Due to RTOS version is lower than idf 4.0, so move some define in file mqtt_supported_features.h to here.
+CFLAGS += -DMQTT_SUPPORTED_FEATURE_WS_SUBPROTOCOL -DMQTT_SUPPORTED_FEATURE_TRANSPORT_ERR_REPORTING