Initial list of Wi-Fi API

diff --git a/docs/COPYRIGHT.rst b/docs/COPYRIGHT.rst
index da5f5b204a2d10b5fafc7c9cf3980e3685b9b921..67b3d9bf1c1e93fac34b9b0de3da5f34f35f8059 100644 (file)
--- a/docs/COPYRIGHT.rst
+++ b/docs/COPYRIGHT.rst
@@ -1,3 +1,6 @@
+Copyrights and Licenses
+***********************
+
 Software Copyrights
 ===================
 
@@ -87,8 +90,7 @@ developments under license policy of following terms.
 Copyright (C) 2011, ChaN, all right reserved.
 
 * The TJpgDec module is a free software and there is NO WARRANTY.
-* No restriction on use. You can use, modify and redistribute it for
-personal, non-profit or commercial products UNDER YOUR RESPONSIBILITY.
+* No restriction on use. You can use, modify and redistribute it for personal, non-profit or commercial products UNDER YOUR RESPONSIBILITY.
 * Redistributions of source code must retain the above copyright notice.
 
 

diff --git a/docs/Doxyfile b/docs/Doxyfile
index 795bfa5e8958c265f54d39b566864b61e87bafc5..9c8fb81df8d3df0c226eec0f9cea2652bbbab1b1 100644 (file)
--- a/docs/Doxyfile
+++ b/docs/Doxyfile
@@ -4,9 +4,9 @@ GENERATE_LATEX   = NO
 GENERATE_MAN     = NO
 GENERATE_RTF     = NO
 CASE_SENSE_NAMES = NO
-INPUT            = ../components/driver/include
+INPUT            = ../components/esp32/include/esp_wifi.h
 RECURSIVE        = YES
 QUIET            = YES
 JAVADOC_AUTOBRIEF = YES
 GENERATE_HTML = NO
-GENERATE_XML = YES
\ No newline at end of file
+GENERATE_XML = YES

diff --git a/docs/api/esp_wifi.rst b/docs/api/esp_wifi.rst
new file mode 100644 (file)
index 0000000..48b4db2
--- /dev/null
+++ b/docs/api/esp_wifi.rst
@@ -0,0 +1,59 @@
+Wi-Fi API
+=========
+
+Macros
+------
+
+.. doxygendefine:: WIFI_INIT_CONFIG_DEFAULT
+
+
+Typedefs
+--------
+
+.. doxygentypedef:: wifi_promiscuous_cb_t
+.. doxygentypedef:: wifi_rxcb_t
+.. doxygentypedef:: esp_vendor_ie_cb_t
+
+
+Functions
+---------
+
+.. doxygenfunction:: esp_wifi_init
+.. doxygenfunction:: esp_wifi_deinit
+.. doxygenfunction:: esp_wifi_set_mode
+.. doxygenfunction:: esp_wifi_get_mode
+.. doxygenfunction:: esp_wifi_start
+.. doxygenfunction:: esp_wifi_stop
+.. doxygenfunction:: esp_wifi_connect
+.. doxygenfunction:: esp_wifi_disconnect
+.. doxygenfunction:: esp_wifi_clear_fast_connect
+.. doxygenfunction:: esp_wifi_kick_station
+.. doxygenfunction:: esp_wifi_scan_start
+.. doxygenfunction:: esp_wifi_scan_stop
+.. doxygenfunction:: esp_wifi_get_ap_num
+.. doxygenfunction:: esp_wifi_get_ap_list
+.. doxygenfunction:: esp_wifi_set_ps
+.. doxygenfunction:: esp_wifi_get_ps
+.. doxygenfunction:: esp_wifi_set_protocol
+.. doxygenfunction:: esp_wifi_get_protocol
+.. doxygenfunction:: esp_wifi_set_bandwidth
+.. doxygenfunction:: esp_wifi_get_bandwidth
+.. doxygenfunction:: esp_wifi_set_channel
+.. doxygenfunction:: esp_wifi_get_channel
+.. doxygenfunction:: esp_wifi_set_country
+.. doxygenfunction:: esp_wifi_get_country
+.. doxygenfunction:: esp_wifi_set_mac
+.. doxygenfunction:: esp_wifi_get_mac
+.. doxygenfunction:: esp_wifi_set_promiscuous_rx_cb
+.. doxygenfunction:: esp_wifi_set_promiscuous
+.. doxygenfunction:: esp_wifi_get_promiscuous
+.. doxygenfunction:: esp_wifi_set_config
+.. doxygenfunction:: esp_wifi_get_config
+.. doxygenfunction:: esp_wifi_get_station_list
+.. doxygenfunction:: esp_wifi_free_station_list
+.. doxygenfunction:: esp_wifi_set_storage
+.. doxygenfunction:: esp_wifi_reg_rxcb
+.. doxygenfunction:: esp_wifi_set_auto_connect
+.. doxygenfunction:: esp_wifi_get_auto_connect
+.. doxygenfunction:: esp_wifi_set_vendor_ie
+.. doxygenfunction:: esp_wifi_set_vendor_ie_cb

diff --git a/docs/api/example.rst b/docs/api/example.rst
new file mode 100644 (file)
index 0000000..88ecb46
--- /dev/null
+++ b/docs/api/example.rst
@@ -0,0 +1,41 @@
+Example Visualizations
+======================
+
+Function prototpe
+-----------------
+
+.. c:function:: esp_err_t esp_wifi_get_ap_list (uint16_t *number, wifi_ap_list_t *ap_list)
+.. c:function:: esp_err_t esp_wifi_set_protocol (wifi_interface_t ifx, uint8_t protocol_bitmap)
+
+
+Function definition
+-------------------
+
+Wi-Fi
+^^^^^
+.. doxygenfunction:: esp_wifi_init
+.. doxygenfunction:: esp_wifi_set_config
+
+GPIO
+^^^^
+.. doxygenfunction:: gpio_isr_register
+
+Led Control
+^^^^^^^^^^^
+
+.. doxygenfunction:: ledc_timer_set    
+
+
+Enum definition
+---------------
+
+.. doxygenenum:: wifi_auth_mode_t
+
+
+Struct definition
+-----------------
+
+.. doxygenstruct:: wifi_scan_config_t
+   :members:
+
+

diff --git a/docs/build_system.rst b/docs/build_system.rst
index 4df65b1b5c947b57da3ed17de0f55aa971976382..34db487e0ab7c4a7fb07e69f501c6db8278f2b3a 100644 (file)
--- a/docs/build_system.rst
+++ b/docs/build_system.rst
@@ -1,5 +1,5 @@
 Build System
-------------
+************
 
 This document explains the Espressif IoT Development Framework build system and the
 concept of "components"

diff --git a/docs/contributor-agreement.rst b/docs/contributor-agreement.rst
index 7c194e77284701b6ce2113f34aae5487288dde18..de294740c4eebc1c0f4578700f5dd266e69f93c9 100644 (file)
--- a/docs/contributor-agreement.rst
+++ b/docs/contributor-agreement.rst
@@ -1,5 +1,5 @@
 Contributor Agreement
----------------------
+=====================
 
 Individual Contributor Non-Exclusive License Agreement
 ------------------------------------------------------

diff --git a/docs/eclipse-setup.rst b/docs/eclipse-setup.rst
index 21d83a7f06788ed24e98adba6c94f65f2e544444..32d60a17a0cad7a496088a25ba00915b18a86411 100644 (file)
--- a/docs/eclipse-setup.rst
+++ b/docs/eclipse-setup.rst
@@ -1,3 +1,6 @@
+Build and Falsh with Eclipse IDE
+********************************
+
 Installing Eclipse IDE
 ======================
 

diff --git a/docs/index.rst b/docs/index.rst
index f74a3acae1bf0199c720e6296a8c0573c1332cf3..30e981e8ef4697fb587f30864f7e773c1b49069f 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,54 +1,41 @@
 .. Read the Docs Template documentation master file
 
-Welcome to ESP32 Programming Guide
-==================================
+ESP32 Programming Guide
+=======================
 
+Contents:
 
-Example C functions
--------------------
-
-.. c:function:: esp_err_t esp_wifi_get_ap_list (uint16_t *number, wifi_ap_list_t *ap_list)
-
-.. c:function:: esp_err_t esp_wifi_set_protocol (wifi_interface_t ifx, uint8_t protocol_bitmap)
-
-
-Example C function integration
-------------------------------
-
-.. doxygenfunction:: esp_wifi_init
-.. doxygenfunction:: esp_wifi_set_config
-
-.. doxygenfunction:: gpio_isr_register
-.. doxygenfunction:: ledc_timer_set    
-
-
-Example C enum integration
---------------------------
-
-.. doxygenenum:: wifi_auth_mode_t
-
+.. toctree::
+   :caption: Setup Toolchain
+   :maxdepth: 1
 
-Example C struct integration
-----------------------------
+   Windows <windows-setup>
+   Linux <linux-setup>
+   Mac OS <macos-setup>
 
-.. doxygenstruct:: wifi_scan_config_t
-   :members:
+.. Configure - TBA
 
+.. Connect - TBA
 
-Contents:
+.. toctree::
+   :caption: Build and Flash
+   :maxdepth: 1
 
-.. About - TBA
+   Eclipse IDE <eclipse-setup>
 
 .. toctree::
-   :caption: Toolchain Setup
+   :caption: Tweak
    :maxdepth: 1
+   
+   partition-tables
+   build_system
 
-   windows-setup
-   linux-setup
-   macos-setup
-   eclipse-setup
+.. toctree::
+   :caption: API Reference
+   :maxdepth: 1
 
-.. API Reference - TBA
+   Wi-Fi <api/esp_wifi>
+   api/example
 
 .. Technical Reference - TBA
 
@@ -68,17 +55,14 @@ Contents:
    contributor-agreement
 
 .. toctree::
-   :caption: Copyrights and Licenses
+   :caption: Legal
    :maxdepth: 1
 
    COPYRIGHT
 
-.. toctree::
-   :caption: Flapping Documents
-   :maxdepth: 1
-   
-   partition-tables
-   build_system
+.. About - TBA
+
+
 
    
 Indices and tables

diff --git a/docs/linux-setup.rst b/docs/linux-setup.rst
index 13e1b3a9c031ab6ee0f5c84474e03488af557b17..cf5e78b63dd80cd1f3d44c15579257e2897c967b 100644 (file)
--- a/docs/linux-setup.rst
+++ b/docs/linux-setup.rst
@@ -1,3 +1,6 @@
+Set up of Toolchain for Linux
+*****************************
+
 Step 0: Prerequisites
 =====================
 

diff --git a/docs/macos-setup.rst b/docs/macos-setup.rst
index 8178a17ada90b5d39d993e801680d5f46ab3ebb8..53c6fe54c8df73a3c00df59b4bf4d8737cc7506e 100644 (file)
--- a/docs/macos-setup.rst
+++ b/docs/macos-setup.rst
@@ -1,3 +1,6 @@
+Set up of Toolchain for Mac OS
+******************************
+
 Step 0: Prerequisites
 =====================
 

diff --git a/docs/openocd.rst b/docs/openocd.rst
index 57ee93db4a30758b966036754ce9821aed5b3f3e..6a6f50e3f42128afe761cdb1bff0b1479679d18b 100644 (file)
--- a/docs/openocd.rst
+++ b/docs/openocd.rst
@@ -1,3 +1,6 @@
+Debugging
+=========
+
 OpenOCD setup for ESP32
 -----------------------
 

diff --git a/docs/partition-tables.rst b/docs/partition-tables.rst
index e0a39126b59ee21c1a911c32e5bc03fa8307adc7..88597532d2bbf70a407f8d1b00cc7eb7e22a267a 100644 (file)
--- a/docs/partition-tables.rst
+++ b/docs/partition-tables.rst
@@ -1,5 +1,8 @@
 Partition Tables
-----------------
+================
+
+Overview
+--------
 
 A single ESP32's flash can contain multiple apps, as well as many different kinds of data (calibration data, filesystems, parameter storage, etc). For this reason a partition table is flashed to offset 0x4000 in the flash.
 

diff --git a/docs/windows-setup.rst b/docs/windows-setup.rst
index baea1ac40b27a1a7c4ac67fc295537cde893bc30..a425f5b3a05a4b2045b14d4d05a10573c9133806 100644 (file)
--- a/docs/windows-setup.rst
+++ b/docs/windows-setup.rst
@@ -1,5 +1,8 @@
-Step 1: Toolchain for Windows: Quick Steps
-==================================
+Set up of Toolchain for Windows
+*******************************
+
+Step 1: Quick Steps
+===================
 
 Windows doesn't have a built-in "make" environment, so as well as installing the toolchain you will need a GNU-compatible environment. We use the MSYS2_ environment to provide.
  You don't need to use this environment all the time (you can use Eclipse_ or some other front-end), but it runs behind the scenes.