瀏覽代碼

mqtt: Add docs on MQTT_CUSTOM_OUTBOX implentation

Closes https://github.com/espressif/esp-mqtt/issues/217
David Cermak 4 年之前
父節點
當前提交
c9794ad08f
共有 1 個文件被更改,包括 5 次插入1 次删除
  1. 5 1
      components/mqtt/Kconfig

+ 5 - 1
components/mqtt/Kconfig

@@ -137,8 +137,12 @@ menu "ESP-MQTT Configurations"
         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
+            Set to true if a specific implementation of message outbox is needed (e.g. persistent outbox in NVM or
             similar).
+            Note: Implementation of the custom outbox must be added to the mqtt component. These CMake commands
+            could be used to append the custom implementation to lib-mqtt sources:
+            idf_component_get_property(mqtt mqtt COMPONENT_LIB)
+            set_property(TARGET ${mqtt} PROPERTY SOURCES ${PROJECT_DIR}/custom_outbox.c APPEND)
 
     config MQTT_OUTBOX_EXPIRED_TIMEOUT_MS
         int "Outbox message expired timeout[ms]"