esp32: refactor to sniffer

1. TW8657, WIFI send the whole packet to smartconfig; 2. modify API annotation of smartconfig and sniffer; 3. export smartconfig APIs to programming guide;
2016-12-12 10:00:24 +08:00
parent eec743d04c
commit 3984d96acb
6 changed files with 125 additions and 64 deletions
--- a/docs/api/esp_smartconfig.rst
+++ b/docs/api/esp_smartconfig.rst
@@ -0,0 +1,25 @@
+Smart Config
+===
+
+API Reference
+-------------
+
+Header Files
+^^^^^^^^^^^^
+
+  * `esp32/include/esp_smartconfig.h <https://github.com/espressif/esp-idf/blob/master/components/esp32/include/esp_smartconfig.h>`_
+
+Type Definitions
+^^^^^^^^^^^^^^^^
+
+.. doxygentypedef:: sc_callback_t
+
+Functions
+^^^^^^^^^
+
+.. doxygenfunction:: esp_smartconfig_get_version
+.. doxygenfunction:: esp_smartconfig_start
+.. doxygenfunction:: esp_smartconfig_stop
+.. doxygenfunction:: esp_esptouch_set_timeout
+.. doxygenfunction:: esp_smartconfig_set_type
+.. doxygenfunction:: esp_smartconfig_fast_mode