ESP8266 RTOS开发之路(4)— 连接到WiFi
本次开发是在Ubuntu下的,使用的模块是ESP12F,32Mbit的flash。程序基于ESP8266_RTOS_SDK-3.x的工程 。
一、使用ssid和password连接到wifi
在ESP8266_RTOS_SDK的例程里面,设置wifi连接之前初始化了NVS,我猜想可能WiFi连接需要用到NVS,所以我们也将NVS初始化,然后开始WiFi连接初始化;简单来说,NVS提供的是一种掉电不丢失的数据存储方法。
/* 初始化非易失性存储库 (NVS) */
ESP_ERROR_CHECK( nvs_flash_init() );
printf("ESP_WIFI_MODE_STA \n");
wifi_init_sta();
然后我们实现wifi_init_sta()函数,开始WiFi初始化连接
因为wifi的连接是需要建立时间的,所以需要创建一个事件标示组,通过事件标志组等待wifi连接。
/* 宏定义WiFi名称和密码 */
#define MY_WIFI_SSID "WiFi-William"
#define MY_WIFI_PASSWD "passwd-william"
/* 宏定义WiFi连接事件标志位和连接失败标志位 */
#define WIFI_CONNECTED_BIT BIT0
#define WIFI_FAIL_BIT BIT1
/* 定义一个WiFi连接FreeRTOS事件标志组句柄 */
static EventGroupHandle_t wifi_event_group_handler;
使用xEventGroupCreate()函数创建时间标志组,返回值为事件标志组句柄
/* 创建一个事件标志组 */
wifi_event_group_handler = xEventGroupCreate()
然后初始化底层TCP/IP需要用到的堆栈,
/* 初始化底层TCP/IP堆栈。在应用程序启动时,应该调用此函数一次。*/
tcpip_adapter_init();
事件循环库是esp提供的一种事件处理方法,而默认事件循环是用于系统事件(例如WiFi事件)的特殊循环类型,这里创建一个默认事件循环用以处理wifi连接事件;在此,ESP_ERROR_CHECK()是用来检查函数返回值的错误代码,并在代码不是ESP_OK的情况下终止程序。将错误代码,错误位置和失败的语句输出到串行终端。
/* 创建默认事件循环,*/
ESP_ERROR_CHECK(esp_event_loop_create_default());
接下来就是WiFi在STA模式下的初始化
/* 使用WIFI_INIT_CONFIG_DEFAULT() 来获取一个默认的wifi配置参数结构体变量*/
wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
/* 根据cfg参数初始化wifi连接所需要的资源 */
ESP_ERROR_CHECK(esp_wifi_init(&cfg));
/* 将事件处理程序注册到系统默认事件循环,分别是WiFi事件和IP地址事件 */
ESP_ERROR_CHECK(esp_event_handler_register(WIFI_EVENT, ESP_EVENT_ANY_ID, &event_handler, NULL));
ESP_ERROR_CHECK(esp_event_handler_register(IP_EVENT, IP_EVENT_STA_GOT_IP, &event_handler, NULL));
/* 定义WiFi连接的ssid和password参数 */
wifi_config_t wifi_config = {
.sta = {
.ssid = MY_WIFI_SSID,
.password = MY_WIFI_PASSWD
},
};
/* 设置WiFi的工作模式为 STA */
ESP_ERROR_CHECK(esp_wifi_set_mode(WIFI_MODE_STA) );
/* 设置WiFi连接的参数,主要是ssid和password */
ESP_ERROR_CHECK(esp_wifi_set_config(ESP_IF_WIFI_STA, &wifi_config) );
/* 启动WiFi连接 */
ESP_ERROR_CHECK(esp_wifi_start() );
printf("wifi_init_sta finished. \n");
我们需要实现系统默认事件循环处理函数,其event_base参数是系统事件类型,event_id是系统事件类型对应的id,用来区分系统事件类型里不同的动作
/* 系统事件循环处理函数 */
static void event_handler(void* arg, esp_event_base_t event_base, int32_t event_id, void* event_data)
{
static int retry_num = 0; /* 记录wifi重连次数 */
/* 系统事件为WiFi事件 */
if (event_base == WIFI_EVENT)
{
if(event_id == WIFI_EVENT_STA_START) /* 事件id为STA开始 */
esp_wifi_connect();
else if (event_id == WIFI_EVENT_STA_DISCONNECTED) /* 事件id为失去STA连接 */
{
if (retry_num < 10) /* WiFi重连次数小于10 */
{
esp_wifi_connect();
retry_num++;
printf("retry to connect to the AP %d times. \n",retry_num);
}
else
{
/* 将WiFi连接事件标志组的WiFi连接失败事件位置1 */
xEventGroupSetBits(wifi_event_group_handler, WIFI_FAIL_BIT);
}
}
}
/* 系统事件为ip地址事件,且事件id为成功获取ip地址 */
else if (event_base == IP_EVENT && event_id == IP_EVENT_STA_GOT_IP)
{
ip_event_got_ip_t* event = (ip_event_got_ip_t*) event_data; /* 获取IP地址信息*/
printf("got ip:%s",ip4addr_ntoa(&event->ip_info.ip)); /* 打印ip地址*/
s_retry_num = 0; /* WiFi重连次数清零 */
/* 将WiFi连接FreeRTOS事件标志组的WiFi连接成功事件位置1 */
xEventGroupSetBits(s_wifi_event_group, WIFI_CONNECTED_BIT);
}
}
然后我们通过事件标志组来等待wifi连接状态即可
/* 使用事件标志组等待连接建立(WIFI_CONNECTED_BIT)或连接失败(WIFI_FAIL_BIT)事件 */
EventBits_t bits; /* 定义一个事件位变量来接收事件标志组等待函数的返回值 */
bits = xEventGroupWaitBits( wifi_event_group_handler, /* 需要等待的事件标志组的句柄 */
WIFI_CONNECTED_BIT | WIFI_FAIL_BIT, /* 需要等待的事件位 */
pdFALSE, /* 为pdFALSE时,在退出此函数之前所设置的这些事件位不变,为pdFALSE则清零*/
pdFALSE, /* 为pdFALSE时,设置的这些事件位任意一个置1就会返回,为pdFALSE则需全为1才返回 */
portMAX_DELAY); /* 设置为最长阻塞等待时间,单位为时钟节拍 */
/* 根据事件标志组等待函数的返回值获取WiFi连接状态 */
if (bits & WIFI_CONNECTED_BIT) /* WiFi连接成功事件 */
{
printf("connected to ap SSID:%s \n",MY_WIFI_SSID);
}
else if (bits & WIFI_FAIL_BIT) /* WiFi连接失败事件 */
{
printf("Failed to connect to SSID:%s \n",MY_WIFI_SSID);
}
else
{
printf("UNEXPECTED EVENT"); /* 没有等待到事件 */
}
ESP_ERROR_CHECK(esp_event_handler_unregister(IP_EVENT, IP_EVENT_STA_GOT_IP, &event_handler));
ESP_ERROR_CHECK(esp_event_handler_unregister(WIFI_EVENT, ESP_EVENT_ANY_ID, &event_handler));
vEventGroupDelete(wifi_event_group_handler);
烧录下载,可以看到wifi已经连接成功,且获得了IP地址:
二、使用smartconfig连接网络
当WiFi密码被修改了,或者WiFi不能使用了的时候,那么在程序中写入的ssid及其password 就没有用了,而且我们总不能总是去修改源代码吧,那我们接下来就在wifi连接失败的情况下使用smartconfig来连接网络。
接下来实现smartconfig_init_start()函数,我们在增添一个智能配网标志位
然后开始智能配网的配置,esp提供了两种智能配网类型,ESPTouch和AirKiss,鉴于ESPTouch乐鑫官方只提供了app的Java源码,所以我也没办法使用,所以我们就忘记他吧。
static void smartconfig_init_start(void)
{
/* 设置智能配网类型为 ESPTouch 和 AirKiss */
smartconfig_start_config_t cfg = SMARTCONFIG_START_CONFIG_DEFAULT();
/* 开始智能配网,并设置智能配网的回调函数*/
ESP_ERROR_CHECK( esp_smartconfig_start(smartconfig_callback) );
printf("smartconfig start ....... \n");
/* 使用事件标志组等待连接建立(WIFI_CONNECTED_BIT)或连接失败(WIFI_FAIL_BIT)事件 */
EventBits_t uxBits; /* 定义一个事件位变量来接收事件标志组等待函数的返回值 */
/* 等待事件标志组,退出前清除设置的事件标志,任意置1就会返回*/
uxBits = xEventGroupWaitBits(wifi_event_group_handler, WIFI_CONNECTED_BIT | SMART_CONFIG_BIT,
true, false, portMAX_DELAY);
if(uxBits & WIFI_CONNECTED_BIT)
{
printf("WiFi Connected to ap ok.");
}
if(uxBits & SMART_CONFIG_BIT)
{
printf("smartconfig over");
esp_smartconfig_stop(); /* 关闭智能配网 */
}
}
然后我们来实现智能配网回调函数
/* 智能配网回调函数 */
static void smartconfig_callback(smartconfig_status_t status, void *pdata)
{
switch (status)
{
case SC_STATUS_WAIT: /* 正在等待启动连接*/
printf("Waiting to start connect. \n");
break;
case SC_STATUS_FIND_CHANNEL: /* 正在寻找目标通道*/
printf("Finding target channel.\n");
break;
case SC_STATUS_GETTING_SSID_PSWD: /* 正在获取智能配网设备提供的ssid和password */
printf("Getting SSID and password of target AP. \n");
break;
case SC_STATUS_LINK: /* 准备连接到目标AP */
printf("Connecting to target AP. \n");
/* 获取智能配网设备端提供的数据信息 */
wifi_config_t *wifi_config = pdata;
printf("SSID:%s \t PASSWORD:%s \n", wifi_config->sta.ssid,wifi_config->sta.password);
/* 根据得到的WiFi名称和密码连接WiFi*/
ESP_ERROR_CHECK( esp_wifi_disconnect() );
ESP_ERROR_CHECK( esp_wifi_set_config(ESP_IF_WIFI_STA, wifi_config) );
ESP_ERROR_CHECK( esp_wifi_connect() );
break;
case SC_STATUS_LINK_OVER: /* 连接成功 */
printf("Connected to AP successfully\n");
if (pdata != NULL)
{
sc_callback_data_t *sc_callback_data = (sc_callback_data_t *)pdata;
switch (sc_callback_data->type)
{
case SC_ACK_TYPE_ESPTOUCH:
printf("Phone ip: %d.%d.%d.%d\n", sc_callback_data->ip[0], sc_callback_data->ip[1], sc_callback_data->ip[2], sc_callback_data->ip[3]);
printf("TYPE: ESPTOUCH\n");
break;
case SC_ACK_TYPE_AIRKISS:
printf("TYPE: AIRKISS");
break;
default:
printf("TYPE: ERROR");
break;
}
}
xEventGroupSetBits(wifi_event_group_handler, SMART_CONFIG_BIT);
break;
default:
break;
}
}
然后烧录下载,我们看到,在WiFi连接失败后,开启了智能配网
然后我们用手机打开微信,搜索并关注安信可科技微信公众号,点击【WiFi配置】,【开始配置】,输入WiFi密码后点击【连接】
然后我们就可以看到,连接到WiFi智能配网通道,得到WiFi名称和密码,连接成功并获得IP地址,手机上也可以看到连接成功的信息和ESP8266返回的应答消息
三、代码
最后,贴上app_main.c的代码
#include <string.h>
#include <stdlib.h>
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "freertos/event_groups.h"
#include "esp_wifi.h"
#include "esp_event.h"
#include "esp_log.h"
#include "esp_system.h"
#include "nvs_flash.h"
#include "tcpip_adapter.h"
#include "esp_smartconfig.h"
#include "smartconfig_ack.h"
#include "driver/gpio.h"
#define GPIO_LED_NUM 2
/* 宏定义WiFi名称和密码 */
#define MY_WIFI_SSID "WiFi-William"
#define MY_WIFI_PASSWD "passwd-william"
/* 宏定义WiFi连接事件标志位、连接失败标志位及智能配网标志位 */
#define WIFI_CONNECTED_BIT BIT0
#define WIFI_FAIL_BIT BIT1
#define SMART_CONFIG_BIT BIT2
/* 定义一个WiFi连接FreeRTOS事件标志组句柄 */
static EventGroupHandle_t wifi_event_group_handler;
static void wifi_init_sta(void);
void app_main(void)
{
/* 打印Hello world! */
printf("Hello world!\n");
/* 初始化非易失性存储库 (NVS) */
ESP_ERROR_CHECK( nvs_flash_init() );
printf("ESP_WIFI_MODE_STA \n");
wifi_init_sta();
/* 定义一个gpio配置结构体 */
gpio_config_t gpio_config_structure;
/* 初始化gpio配置结构体*/
gpio_config_structure.pin_bit_mask = (1ULL << GPIO_LED_NUM);/* 选择gpio2 */
gpio_config_structure.mode = GPIO_MODE_OUTPUT; /* 输出模式 */
gpio_config_structure.pull_up_en = 0; /* 不上拉 */
gpio_config_structure.pull_down_en = 0; /* 不下拉 */
gpio_config_structure.intr_type = GPIO_INTR_DISABLE; /* 禁止中断 */
/* 根据设定参数初始化并使能 */
gpio_config(&gpio_config_structure);
while(1)
{
gpio_set_level(GPIO_LED_NUM, 0); /* 熄灭 */
vTaskDelay(500 / portTICK_PERIOD_MS); /* 延时500ms*/
gpio_set_level(GPIO_LED_NUM, 1); /* 点亮 */
vTaskDelay(500 / portTICK_PERIOD_MS); /* 延时500ms*/
}
}
/* 系统事件循环处理函数 */
static void event_handler(void* arg, esp_event_base_t event_base, int32_t event_id, void* event_data)
{
static int retry_num = 0; /* 记录wifi重连次数 */
/* 系统事件为WiFi事件 */
if (event_base == WIFI_EVENT)
{
if(event_id == WIFI_EVENT_STA_START) /* 事件id为STA开始 */
esp_wifi_connect();
else if (event_id == WIFI_EVENT_STA_DISCONNECTED) /* 事件id为失去STA连接 */
{
if (retry_num < 10) /* WiFi重连次数小于10 */
{
esp_wifi_connect();
retry_num++;
printf("retry to connect to the AP %d times. \n",retry_num);
}
else
{
/* 将WiFi连接事件标志组的WiFi连接失败事件位置1 */
xEventGroupSetBits(wifi_event_group_handler, WIFI_FAIL_BIT);
}
}
}
/* 系统事件为ip地址事件,且事件id为成功获取ip地址 */
else if (event_base == IP_EVENT && event_id == IP_EVENT_STA_GOT_IP)
{
ip_event_got_ip_t* event = (ip_event_got_ip_t*) event_data; /* 获取IP地址信息*/
printf("got ip:%s \n",ip4addr_ntoa(&event->ip_info.ip)); /* 打印ip地址*/
retry_num = 0; /* WiFi重连次数清零 */
/* 将WiFi连接FreeRTOS事件标志组的WiFi连接成功事件位置1 */
xEventGroupSetBits(wifi_event_group_handler, WIFI_CONNECTED_BIT);
}
}
/* 智能配网回调函数 */
static void smartconfig_callback(smartconfig_status_t status, void *pdata)
{
switch (status)
{
case SC_STATUS_WAIT: /* 正在等待启动连接*/
printf("Waiting to start connect. \n");
break;
case SC_STATUS_FIND_CHANNEL: /* 正在寻找目标通道*/
printf("Finding target channel.\n");
break;
case SC_STATUS_GETTING_SSID_PSWD: /* 正在获取智能配网设备提供的ssid和password */
printf("Getting SSID and password of target AP. \n");
break;
case SC_STATUS_LINK: /* 准备连接到目标AP */
printf("Connecting to target AP. \n");
/* 获取智能配网设备端提供的数据信息 */
wifi_config_t *wifi_config = pdata;
printf("SSID:%s \t PASSWORD:%s \n", wifi_config->sta.ssid,wifi_config->sta.password);
/* 根据得到的WiFi名称和密码连接WiFi*/
ESP_ERROR_CHECK( esp_wifi_disconnect() );
ESP_ERROR_CHECK( esp_wifi_set_config(ESP_IF_WIFI_STA, wifi_config) );
ESP_ERROR_CHECK( esp_wifi_connect() );
break;
case SC_STATUS_LINK_OVER: /* 连接成功 */
printf("Connected to AP successfully\n");
if (pdata != NULL)
{
sc_callback_data_t *sc_callback_data = (sc_callback_data_t *)pdata;
switch (sc_callback_data->type)
{
case SC_ACK_TYPE_ESPTOUCH:
printf("Phone ip: %d.%d.%d.%d\n", sc_callback_data->ip[0], sc_callback_data->ip[1], sc_callback_data->ip[2], sc_callback_data->ip[3]);
printf("TYPE: ESPTOUCH\n");
break;
case SC_ACK_TYPE_AIRKISS:
printf("TYPE: AIRKISS\n");
break;
default:
printf("TYPE: ERROR\n");
break;
}
}
xEventGroupSetBits(wifi_event_group_handler, SMART_CONFIG_BIT);
break;
default:
break;
}
}
static void smartconfig_init_start(void)
{
/* 设置智能配网类型为 ESPTouch 和 AirKiss */
ESP_ERROR_CHECK( esp_smartconfig_set_type(SC_TYPE_AIRKISS) );
/* 开始智能配网,并设置智能配网的回调函数*/
ESP_ERROR_CHECK( esp_smartconfig_start(smartconfig_callback) );
printf("smartconfig start ....... \n");
/* 使用事件标志组等待连接建立(WIFI_CONNECTED_BIT)或连接失败(WIFI_FAIL_BIT)事件 */
EventBits_t uxBits; /* 定义一个事件位变量来接收事件标志组等待函数的返回值 */
/* 等待事件标志组,退出前清除设置的事件标志,任意置1就会返回*/
uxBits = xEventGroupWaitBits(wifi_event_group_handler, WIFI_CONNECTED_BIT | SMART_CONFIG_BIT,
true, false, portMAX_DELAY);
if(uxBits & WIFI_CONNECTED_BIT)
{
printf("WiFi Connected to ap ok.");
}
if(uxBits & SMART_CONFIG_BIT)
{
printf("smartconfig over");
esp_smartconfig_stop(); /* 关闭智能配网 */
}
}
static void wifi_init_sta(void)
{
/* 创建一个FreeRTOS事件标志组 */
wifi_event_group_handler = xEventGroupCreate();
/* 初始化底层TCP/IP堆栈。在应用程序启动时,应该调用此函数一次。*/
tcpip_adapter_init();
/* 创建默认事件循环,*/
ESP_ERROR_CHECK(esp_event_loop_create_default());
/* 使用WIFI_INIT_CONFIG_DEFAULT() 来获取一个默认的wifi配置参数结构体变量*/
wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
/* 根据cfg参数初始化wifi连接所需要的资源 */
ESP_ERROR_CHECK(esp_wifi_init(&cfg));
/* 将事件处理程序注册到系统默认事件循环,分别是WiFi事件和IP地址事件 */
ESP_ERROR_CHECK(esp_event_handler_register(WIFI_EVENT, ESP_EVENT_ANY_ID, &event_handler, NULL));
ESP_ERROR_CHECK(esp_event_handler_register(IP_EVENT, IP_EVENT_STA_GOT_IP, &event_handler, NULL));
/* 定义WiFi连接的ssid和password参数 */
wifi_config_t wifi_config = {
.sta = {
.ssid = MY_WIFI_SSID,
.password = MY_WIFI_PASSWD
},
};
/* 设置WiFi的工作模式为 STA */
ESP_ERROR_CHECK(esp_wifi_set_mode(WIFI_MODE_STA) );
/* 设置WiFi连接的参数,主要是ssid和password */
ESP_ERROR_CHECK(esp_wifi_set_config(ESP_IF_WIFI_STA, &wifi_config) );
/* 启动WiFi连接 */
ESP_ERROR_CHECK(esp_wifi_start() );
printf("wifi_init_sta finished. \n");
/* 使用事件标志组等待连接建立(WIFI_CONNECTED_BIT)或连接失败(WIFI_FAIL_BIT)事件 */
EventBits_t bits; /* 定义一个事件位变量来接收事件标志组等待函数的返回值 */
bits = xEventGroupWaitBits( wifi_event_group_handler, /* 需要等待的事件标志组的句柄 */
WIFI_CONNECTED_BIT | WIFI_FAIL_BIT, /* 需要等待的事件位 */
pdFALSE, /* 为pdFALSE时,在退出此函数之前所设置的这些事件位不变,为pdFALSE则清零*/
pdFALSE, /* 为pdFALSE时,设置的这些事件位任意一个置1就会返回,为pdFALSE则需全为1才返回 */
portMAX_DELAY); /* 设置为最长阻塞等待时间,单位为时钟节拍 */
/* 根据事件标志组等待函数的返回值获取WiFi连接状态 */
if (bits & WIFI_CONNECTED_BIT) /* WiFi连接成功事件 */
{
printf("connected to ap SSID:%s \n",MY_WIFI_SSID);
}
else if (bits & WIFI_FAIL_BIT) /* WiFi连接失败事件 */
{
printf("Failed to connect to SSID:%s \n",MY_WIFI_SSID);
smartconfig_init_start(); /* 开启智能配网*/
}
else
{
printf("UNEXPECTED EVENT"); /* 没有等待到事件 */
smartconfig_init_start(); /* 开启智能配网*/
}
ESP_ERROR_CHECK(esp_event_handler_unregister(IP_EVENT, IP_EVENT_STA_GOT_IP, &event_handler));
ESP_ERROR_CHECK(esp_event_handler_unregister(WIFI_EVENT, ESP_EVENT_ANY_ID, &event_handler));
vEventGroupDelete(wifi_event_group_handler);
}