Initial list of Wi-Fi API

2026-05-06 08:37:29 +02:00 · 2016-10-24 20:44:57 +02:00
parent 6ce1af5898
commit 8ae97a2855
13 changed files with 162 additions and 58 deletions
@@ -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
@@ -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:
+
+