1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00

cpu/esp32: doc improvements in esp_wifi

This commit is contained in:
Gunar Schorcht 2019-01-14 12:13:49 +01:00 committed by Schorcht
parent e83a8679b4
commit 1cf415a8a9
4 changed files with 39 additions and 8 deletions

View File

@ -7,12 +7,42 @@
*/
/**
* @defgroup cpu_esp32_esp_wifi ESP WiFi netdev interface
* @defgroup cpu_esp32_esp_wifi ESP32 WiFi netdev interface
* @ingroup cpu_esp32
* @brief WiFi AP-based network device driver
*
* This module realizes a netdev interface using the built-in
* WiFi module and AP infrastructure.
* @brief Network device driver for the ESP32 WiFi interface
*
* @author Gunar Schorcht <gunar@schorcht.net>
This module realizes a `netdev` interface for the built-in WiFi interface
of ESP32. To enable the WiFi interface, module `esp_wifi` has to be used.
@note Due to symbol conflicts with the `crypto` and `hash` modules of RIOT
in module `esp_idf_wpa_supplicant_crypto`, which is required by module
`esp_wifi`, `esp_wifi` cannot be used for applications that use these modules.
Therefore, module `esp_wifi` is not automatically enabled when module
`netdev_default` is used. Instead, if necessary, the application has to add
the module `esp_wifi` in the Makefile.
```
USEMODULE += esp_wifi
```
Furthermore, the following configuration parameters have to be defined:
Configuration Parameter | Description
------------------------|------------
ESP_WIFI_SSID | SSID of the AP to be used.
ESP_WIFI_PASS | Passphrase used for the AP (max. 64 chars).
ESP_WIFI_STACKSIZE | Stack size used for the WiFi netdev driver thread.
These configuration parameter definitions, as well as enabling the `esp_wifi`
module, can be done either in the makefile of the project or at make command
line, e.g.:
```
USEMODULE=esp_wifi \
CFLAGS='-DESP_WIFI_SSID=\"MySSID\" -DESP_WIFI_PASS=\"MyPassphrase\" \
make -C examples/gnrc_networking BOARD=...
```
*/

View File

@ -11,7 +11,7 @@
* @{
*
* @file
* @brief Netdev interface for the ESP WiFi AP-based communication
* @brief Network device driver for the ESP32 WiFi interface
*
* @author Gunar Schorcht <gunar@schorcht.net>
*/

View File

@ -11,7 +11,7 @@
* @{
*
* @file
* @brief Netdev interface for the ESP WiFi AP-based communication
* @brief Network device driver for the ESP32 WiFi interface
*
* @author Gunar Schorcht <gunar@schorcht.net>
*/

View File

@ -8,10 +8,11 @@
/**
* @ingroup cpu_esp32_esp_wifi
* @ingroup cpu_esp32_conf
* @{
*
* @file
* @brief Parameters for the netdev interface for ESP WiFi module
* @brief Parameters for the ESP32 WiFi netdev interface
*
* @author Gunar Schorcht <gunar@schorcht.net>
*/