RIOT/cpu/esp_common/esp-wifi/doc.txt

/*
 * Copyright (C) 2019 Gunar Schorcht
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */

/**
 * @defgroup    cpu_esp_common_esp_wifi ESP-WiFi netdev interface
 * @ingroup     cpu_esp_common
 * @ingroup     cpu_esp32
 * @ingroup     cpu_esp8266
 * @brief       Network device driver for the ESP SoC WiFi interface
 *
 * @author      Gunar Schorcht <gunar@schorcht.net>

This module realizes a `netdev` interface for the built-in WiFi interface of
ESP SoCs. To enable the WiFi interface, module `esp_wifi` has to be used.
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 as clear text (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=...
```

@note The Wifi network interface (module `esp_wifi`) and the
ESP-NOW network interface (module `esp_now`)
can be used simultaneously, for example, to realize a border router for
a mesh network which uses ESP-NOW.
 */