32-ESP32-S3-WIFI篇-03 Event Loop (事件循环)

ESP32-S3-WIFI 事件循环

介绍

在ESP32-S3的WiFi驱动程序中，事件循环是一个非常重要的概念。事件循环是一个无限循环，用于处理和分发系统中发生的各种事件。在WiFi驱动程序中，我们使用事件循环来处理和分发WiFi相关的事件。

创建事件循环

在初始化WiFi驱动程序时，我们会创建一个事件循环。这个事件循环将被用来处理和分发WiFi的事件。

• esp_event_loop_args_t：这个结构体，用于指定事件循环的属性，
• esp_event_loop_create()：这个函数用于创建一个事件循环。它接受一个esp_event_loop_args_t类型的参数，用于指定事件循环的属性，然后返回一个esp_event_loop_handle_t类型的句柄，这个句柄可以用来引用事件循环

// 定义事件循环句柄
esp_event_loop_handle_t event_loop;

void app_main(void)
{
    // 定义事件循环参数
    esp_event_loop_args_t event_loop_args = {
        .queue_size = 5,  // 事件队列的大小
        .task_name = "wifi_event_loop",  // 事件循环任务的名称
        .task_priority = ESP_TASK_MAIN_PRIO,  // 事件循环任务的优先级
        .task_stack_size = 2048,  // 事件循环任务的堆栈大小
        .task_core_id = tskNO_AFFINITY  // 事件循环任务运行的CPU核心ID
    };

    // 创建事件循环
    esp_event_loop_create(&event_loop_args, &event_loop);
    ...
}

注册事件处理函数

在事件循环中，我们可以注册事件处理函数。当特定的事件发生时，相应的事件处理函数就会被调用。

// 定义事件处理函数
void event_handler(void* arg, esp_event_base_t event_base, 
                               int32_t event_id, void* event_data)
{
    // 根据事件的类型和ID进行相应的处理
    ...
}

void app_main(void)
{
    ...
    // 将事件处理函数注册到事件循环中
    esp_event_handler_register_with(event_loop,WIFI_EVENT, ESP_EVENT_ANY_ID, &event_handler, NULL);
}

运行事件循环

事件循环在一个单独的任务中运行。当事件发生时，事件循环会调用相应的事件处理函数。

esp_event_loop_run()：这个函数用于运行事件循环。它会在一个无限循环中等待事件的发生，然后调用相应的事件处理函数。

void app_main(void)
{
    ...
    // 运行事件循环
    while (true) {
        esp_event_loop_run(event_loop, portMAX_DELAY);
    }
}

WiFi事件循环示例

这个程序中，我们创建一个WiFi STA（Station模式）并连接到一个AP（Access Point）。

#include "esp_event.h"
#include "esp_wifi.h"

// 定义WiFi STA的SSID和密码
#define WIFI_SSID "your_ssid"
#define WIFI_PASSWORD "your_password"

// 定义事件处理函数
void event_handler(void* arg, esp_event_base_t event_base, 
                               int32_t event_id, void* event_data)
{
    if (event_base == WIFI_EVENT && event_id == WIFI_EVENT_STA_START) {
        // WiFi STA已经启动，开始连接到AP
        esp_wifi_connect();
    } else if (event_base == WIFI_EVENT && event_id == WIFI_EVENT_STA_DISCONNECTED) {
        // WiFi STA已经断开连接，重新连接到AP
        esp_wifi_connect();
    } else if (event_base == IP_EVENT && event_id == IP_EVENT_STA_GOT_IP) {
        // WiFi STA已经获取到IP地址
        ip_event_got_ip_t* event = (ip_event_got_ip_t*) event_data;
        printf("Got IP: %s\n", ip4addr_ntoa(&event->ip_info.ip));
    }
}

void app_main(void)
{
    // 初始化ESP-IDF的事件库
    esp_event_loop_args_t event_loop_args = {
        .queue_size = 5,
        .task_name = "wifi_event_loop",
        .task_priority = ESP_TASK_MAIN_PRIO,
        .task_stack_size = 2048,
        .task_core_id = tskNO_AFFINITY
    };
    esp_event_loop_handle_t event_loop;
    esp_event_loop_create(&event_loop_args, &event_loop);

    // 初始化WiFi驱动程序
    wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
    esp_wifi_init(&cfg);

    // 设置WiFi为STA模式
    esp_wifi_set_mode(WIFI_MODE_STA);

    // 设置WiFi STA的SSID和密码
    wifi_config_t wifi_config = {
        .sta = {
            .ssid = WIFI_SSID,
            .password = WIFI_PASSWORD,
        },
    };
    esp_wifi_set_config(ESP_IF_WIFI_STA, &wifi_config);

    // 将事件处理函数注册到自定义的事件循环中
    esp_event_handler_register_with(event_loop, WIFI_EVENT, ESP_EVENT_ANY_ID, &event_handler, NULL);
    esp_event_handler_register_with(event_loop, IP_EVENT, IP_EVENT_STA_GOT_IP, &event_handler, NULL);

    // 启动WiFi
    esp_wifi_start();

    // 运行事件循环
    while (true) {
        esp_event_loop_run(event_loop, portMAX_DELAY);
    }
}

这个例子中，我们首先初始化了ESP-IDF的事件库和WiFi驱动程序，然后设置WiFi为STA模式，并设置了WiFi STA的SSID和密码。然后，我们注册了一个事件处理函数，用于处理WiFi的事件。最后，我们启动了WiFi，并运行了事件循环。

在事件处理函数中，我们处理了三种事件：WiFi STA启动，WiFi STA断开连接，和WiFi STA获取到IP地址。当WiFi STA启动时，我们开始连接到AP。当WiFi STA断开连接时，我们重新连接到AP。当WiFi STA获取到IP地址时，我们打印出获取到的IP地址。

总结

事件循环是ESP32-S3 WiFi驱动程序中的一个重要概念，它使我们能够在任务之间同步和传递WiFi状态信息。

🚨需要注意在ESP-IDF中，esp_event_loop_create()和esp_event_loop_run()函数是用于创建和运行用户定义的事件循环。然而，ESP-IDF也提供了一个默认的事件循环，这个默认的事件循环在系统启动时就已经被创建，并且在系统运行期间一直在后台运行。

因此，如果你的应用程序只需要处理一些常见的系统事件（例如WiFi事件），那么你可以直接使用默认的事件循环，而不需要自己创建和运行事件循环。你只需要使用esp_event_handler_register()函数将你的事件处理函数注册到默认的事件循环中，然后当相应的事件发生时，你的事件处理函数就会被调用。

但是，如果你的应用程序需要处理一些特殊的事件，或者你需要更细粒度的控制事件的处理，那么你可以创建和运行你自己的事件循环。你可以使用esp_event_loop_create()函数创建你自己的事件循环，然后使用esp_event_loop_run()函数在一个单独的任务中运行你的事件循环，但此时要使用esp_event_handler_register_with()将你的事件处理函数注册到默认的事件循环中。

📚参考资料
乐鑫编程指南-事件循环库