31-ESP32-S3-WIFI篇-02 Event Group (事件标记组)

ESP32-S3-WIFI 事件标记组

介绍

在ESP32-S3的WiFi驱动程序中，事件标记组（Event Group）是一个非常重要的概念。它是FreeRTOS中的一种同步机制，用于在任务之间传递和同步事件。在WiFi驱动程序中，我们使用事件标记组来通知不同的任务有关WiFi状态的变化。

在上一篇文章我们在Event_loop（定义事件处理程序其实就是event task任务）针对id，分别创建wifi_scan_task和wifi_show_task两个任务来执行相应的功能，那这时我们共创建了3个app task，造成了任务滥用的情况，那我们可以把这三个任务合在一起吗，当然可以，这就要用到Free RTOS 中的Event Group机制了。需要注意Event loop是ESP中的概念，而Event Group是Free RTOS 中的概念。

WiFi事件标记组的创建

在初始化WiFi驱动程序时，我们会创建一个事件标记组。这个事件标记组将被用来存储WiFi的状态信息。

EventGroupHandle_t wifi_event_group;

void app_main(void)
{
    wifi_event_group = xEventGroupCreate();
    
}

WiFi事件的处理

当WiFi状态发生变化时，例如连接到AP，断开连接，获取IP等，WiFi驱动程序会通过调用xEventGroupSetBits函数来设置相应的事件标记，xEventGroupSetBits函数第一个参数是事件标记组的句柄，第二个参数是要设置的位。

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) {
        xEventGroupSetBits(wifi_event_group, WIFI_CONNECT_BIT);
    } else if (event_base == WIFI_EVENT && event_id == WIFI_EVENT_STA_DISCONNECTED) {
        xEventGroupSetBits(wifi_event_group, WIFI_DISCONNECT_BIT);
    } else if (event_base == IP_EVENT && event_id == IP_EVENT_STA_GOT_IP) {
        xEventGroupSetBits(wifi_event_group, WIFI_GOT_IP_BIT);
    }
}

WiFi事件的检查

在其他任务中，我们可以通过调用xEventGroupWaitBits函数来等待特定的WiFi事件xEventGroupWaitBits函数第一个参数是事件标记组的句柄，第二个参数是我们关心的位，第三个参数决定是否在返回前清除这些位，第四个参数决定是否需要所有的位都被设置，第五个参数是等待的最大时间，而返回值可以用来判断哪些位被设置了。

void task_function(void *pvParameters)
{
    EventBits_t bits = xEventGroupWaitBits(wifi_event_group,
                                           WIFI_CONNECT_BIT | WIFI_DISCONNECT_BIT | WIFI_GOT_IP_BIT,
                                           pdFALSE,
                                           pdFALSE,
                                           portMAX_DELAY);
    if (bits & WIFI_CONNECT_BIT) {
        printf("WiFi connected\n");
    } else if (bits & WIFI_DISCONNECT_BIT) {
        printf("WiFi disconnected\n");
    } else if (bits & WIFI_GOT_IP_BIT) {
        printf("Got IP address\n");
    }
}

总结

🚨需要注意
在FreeRTOS中，事件标记组的位数取决于configUSE_16_BIT_TICKS的设置。如果configUSE_16_BIT_TICKS设置为1，那么事件标记组中的位数为8位。如果configUSE_16_BIT_TICKS设置为0，那么事件标记组中的位数为24位。

📚参考资料
freertos官方编程手册
微软copilot