Initial list of Wi-Fi API

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
+* No restriction on use. You can use, modify and redistribute it for personal, non-profit or commercial products UNDER YOUR RESPONSIBILITY.
-personal, non-profit or commercial products UNDER YOUR RESPONSIBILITY.
 * Redistributions of source code must retain the above copyright notice.
 
 

docs/Doxyfile

@@ -4,7 +4,7 @@ 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

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

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:
+
+

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"

docs/contributor-agreement.rst

@@ -1,5 +1,5 @@
 Contributor Agreement
----------------------
+=====================
 
 Individual Contributor Non-Exclusive License Agreement
 ------------------------------------------------------

docs/eclipse-setup.rst

@@ -1,3 +1,6 @@
+Build and Falsh with Eclipse IDE
+********************************
+
 Installing Eclipse IDE
 ======================
 

docs/index.rst

@@ -1,54 +1,41 @@
 .. Read the Docs Template documentation master file
 
-Welcome to ESP32 Programming Guide
+ESP32 Programming Guide
-==================================
+=======================
-
-
-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
-
-
-Example C struct integration
-----------------------------
-
-.. doxygenstruct:: wifi_scan_config_t
-   :members:
-
 
 Contents:
 
-.. About - TBA
-
 .. toctree::
-   :caption: Toolchain Setup
+   :caption: Setup Toolchain
    :maxdepth: 1
 
-   windows-setup
+   Windows <windows-setup>
-   linux-setup
+   Linux <linux-setup>
-   macos-setup
+   Mac OS <macos-setup>
-   eclipse-setup
 
-.. API Reference - TBA
+.. Configure - TBA
+
+.. Connect - TBA
+
+.. toctree::
+   :caption: Build and Flash
+   :maxdepth: 1
+
+   Eclipse IDE <eclipse-setup>
+
+.. toctree::
+   :caption: Tweak
+   :maxdepth: 1
+   
+   partition-tables
+   build_system
+
+.. toctree::
+   :caption: API Reference
+   :maxdepth: 1
+
+   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::
+.. About - TBA
-   :caption: Flapping Documents
+
-   :maxdepth: 1
 
-   partition-tables
-   build_system
 
    
 Indices and tables

docs/linux-setup.rst

@@ -1,3 +1,6 @@
+Set up of Toolchain for Linux
+*****************************
+
 Step 0: Prerequisites
 =====================
 

docs/macos-setup.rst

@@ -1,3 +1,6 @@
+Set up of Toolchain for Mac OS
+******************************
+
 Step 0: Prerequisites
 =====================
 

docs/openocd.rst

@@ -1,3 +1,6 @@
+Debugging
+=========
+
 OpenOCD setup for ESP32
 -----------------------
 

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.
 

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.