feedc0de/esp-idf
1
0
Fork 0
forked from espressif/esp-idf
Code Pull Requests Activity

esp_wifi_init: Update comment about init event_q

Browse Source 
Closes github #28 https://github.com/espressif/esp-idf/issues/28
This commit is contained in:
Angus Gratton
2016-12-22 12:37:03 +11:00
parent c1a6d55116
commit 1e44f72e98
1 changed files with 3 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
components/esp32/include/esp_wifi.h
View File

@@ -107,10 +107,8 @@ typedef struct {
* WiFi NVS structure etc, this WiFi also start WiFi task * WiFi NVS structure etc, this WiFi also start WiFi task
* *
* @attention 1. This API must be called before all other WiFi API can be called * @attention 1. This API must be called before all other WiFi API can be called
* @attention 2. Generally we should init event_q in *config, WiFi driver will post the event * @attention 2. event_handler field in cfg should be set to a valid event handler function.
* to this queue when event happens, such as, when station connects to WiFi, WiFi driver * In most cases, use the WIFI_INIT_CONFIG_DEFAULT macro which sets esp_event_send().
* will post station connected event to this queue. If the queue is not initialized, WiFi
* will not post any events
* *
* @param config provide WiFi init configuration * @param config provide WiFi init configuration
* *