ESP32-C3入门教程 WiFi篇④——WiFi Smart Config 智能配网（基于EspTouchForAndroid）

系统管理员 2022-09-14 09:46 3378阅读 0赞

### 文章目录 ###

*  一、前言
 *  二、WiFi配网方式
 *  三、快速运行
 *  四、运行效果
 *  五、ESP32-C3程序流程
 *   *  5.1 主程序
     *  5.2 回调函数
     *  5.3 SmartConfig线程
     *  5.4 流程图
 *  六、关键函数
 *   *  6.1 设置SmartConfig的协议类型
     *  6.2 启动SmartConfig
     *  6.3 停止SmartConfig
 *  七、其他
 *  八、参考

# 一、前言 #

> 本文基于VS Code IDE进行编程、编译、下载、运行等操作  
> 基础知识点请查阅：[ESP32-C3入门教程 基础篇①——基于VS Code构建Hello World][ESP32-C3_ _VS Code_Hello World]

# 二、WiFi配网方式 #

WiFi配网即：用户通过App/小程序/网页等途径将WiFi的SSID和密码等信息发送给ESP32，方式有很多种：

*  SoftAP，ESP32开启热点，App连接到该热点AP，并将WiFi的信息发送给ESP32
 *  SmartConfig，App将WiFi信息通过UDP广播组播出去，ESP32监听网络中所有报文，得到App广播出来的WiFi信息
    
     *  SmartConfig有很多种，EspTouch、AirKiss、EspTouchV2等
 *  BluFi，App通过蓝牙的方式将WiFi信息发送给ESP32

本博文描述ESP32-C3通过SmartConfig EspTouch方式进行智能配网。

# 三、快速运行 #

*  示例项目中，选择`protocols`—>`wifi`\->`smart_config`
 *  `menuconfig`配置`ESP32C3-Specific`—>`Rec 0`
 *  芯片选择`ESP32-C3(Built-in USB JTAG)`
 *  快速运行`ESP-IDF Build, Flash and Monitor`（左下角）

![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5bCP5bq35biI5YWE_size_20_color_FFFFFF_t_70_g_se_x_16]

# 四、运行效果 #

*  下载、安装、打开[EspTouchForAndroid][] App
 *  输入WiFi密码，确认即可
 *  注意：ESP32只支持2.4GHz WiFi，还不支持5GHz WiFi

![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5bCP5bq35biI5YWE_size_10_color_FFFFFF_t_70_g_se_x_16]![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5bCP5bq35biI5YWE_size_10_color_FFFFFF_t_70_g_se_x_16 1]![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5bCP5bq35biI5YWE_size_10_color_FFFFFF_t_70_g_se_x_16 2]

![在这里插入图片描述][watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5bCP5bq35biI5YWE_size_20_color_FFFFFF_t_70_g_se_x_16 1]

# 五、ESP32-C3程序流程 #

## 5.1 主程序 ##

*  `nvs_flash_init`，初始化默认 NVS 分区
 *  `esp_netif_init`，初始化底层TCP/IP堆栈
 *  `esp_event_loop_create_default`，创建默认事件循环
 *  `esp_netif_create_default_wifi_sta`，使用默认WiFi Station配置创建`esp_netif`对象，将netif连接到WiFi并注册默认WiFi处理程序
 *  `esp_wifi_init`，为 WiFi 驱动初始化 WiFi 分配资源，如 WiFi 控制结构、RX/TX 缓冲区、WiFi NVS 结构等，这个 WiFi 也启动 WiFi 任务。必须先调用此API，然后才能调用所有其他WiFi API
 *  `esp_event_handler_instance_register`，监听`WIFI_EVENT`WiFi 任意事件，触发事件后，进入回调函数
 *  `esp_event_handler_instance_register`，监听`IP_EVENT`从连接的AP获得IP的事件，触发事件后，进入回调函数
 *  `esp_event_handler_instance_register`，监听`SC_EVENT`从SmartConfig任意事件，触发事件后，进入回调函数
 *  `esp_wifi_set_mode`，设置WiFi工作模式为station、soft-AP或station+soft-AP，默认模式为soft-AP模式。本程序设置为station
 *  `esp_wifi_start`，根据配置，启动WiFi

## 5.2 回调函数 ##

*  `WIFI_EVENT_STA_START`，WiFi station 模式启动时：
    
     *  创建`smartconfig_example_task`线程，开始SmartConfig
 *  `WIFI_EVENT_STA_DISCONNECTED`，WiFi station 模式失去连接
    
     *  清除`CONNECTED_BIT`标志位
 *  `IP_EVENT_STA_GOT_IP`，WiFi station 模式从连接的AP那获得IP
    
     *  设置`CONNECTED_BIT`标志位
 *  `SC_EVENT_SCAN_DONE`，SmartConfig 扫描AP列表结束
 *  `SC_EVENT_FOUND_CHANNEL`，SmartConfig 从目标AP找到频道
 *  `SC_EVENT_GOT_SSID_PSWD`，SmartConfig 获得WiFi信息（SSID和密码）时：
    
     *  解析出WiFi的SSID和密码
     *  `esp_wifi_disconnect`断开当前WiFi连接
     *  `esp_wifi_set_config`WiFI配置，设置`WIFI_IF_STA`模式，设置WiFi的SSID和密码
     *  `esp_wifi_connect`WiFi连接
 *  `SC_EVENT_SEND_ACK_DONE`，SmartConfig 给App发送完成ACK
    
     *  设置`ESPTOUCH_DONE_BIT`标志位

static 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) { 
            xTaskCreate(smartconfig_example_task, "smartconfig_example_task", 4096, NULL, 3, NULL);
        } else if (event_base == WIFI_EVENT && event_id == WIFI_EVENT_STA_DISCONNECTED) { 
            esp_wifi_connect();
            xEventGroupClearBits(s_wifi_event_group, CONNECTED_BIT);
        } else if (event_base == IP_EVENT && event_id == IP_EVENT_STA_GOT_IP) { 
            xEventGroupSetBits(s_wifi_event_group, CONNECTED_BIT);
        } else if (event_base == SC_EVENT && event_id == SC_EVENT_SCAN_DONE) { 
            ESP_LOGI(TAG, "Scan done");
        } else if (event_base == SC_EVENT && event_id == SC_EVENT_FOUND_CHANNEL) { 
            ESP_LOGI(TAG, "Found channel");
        } else if (event_base == SC_EVENT && event_id == SC_EVENT_GOT_SSID_PSWD) { 
            ESP_LOGI(TAG, "Got SSID and password");
    
            smartconfig_event_got_ssid_pswd_t *evt = (smartconfig_event_got_ssid_pswd_t *)event_data;
            wifi_config_t wifi_config;
            uint8_t ssid[33] = {  0 };
            uint8_t password[65] = {  0 };
            uint8_t rvd_data[33] = {  0 };
    
            bzero(&wifi_config, sizeof(wifi_config_t));
            memcpy(wifi_config.sta.ssid, evt->ssid, sizeof(wifi_config.sta.ssid));
            memcpy(wifi_config.sta.password, evt->password, sizeof(wifi_config.sta.password));
            wifi_config.sta.bssid_set = evt->bssid_set;
            if (wifi_config.sta.bssid_set == true) { 
                memcpy(wifi_config.sta.bssid, evt->bssid, sizeof(wifi_config.sta.bssid));
            }
    
            memcpy(ssid, evt->ssid, sizeof(evt->ssid));
            memcpy(password, evt->password, sizeof(evt->password));
            ESP_LOGI(TAG, "SSID:%s", ssid);
            ESP_LOGI(TAG, "PASSWORD:%s", password);
            if (evt->type == SC_TYPE_ESPTOUCH_V2) { 
                ESP_ERROR_CHECK( esp_smartconfig_get_rvd_data(rvd_data, sizeof(rvd_data)) );
                ESP_LOGI(TAG, "RVD_DATA:");
                for (int i=0; i<33; i++) { 
                    printf("%02x ", rvd_data[i]);
                }
                printf("\n");
            }
            ESP_ERROR_CHECK( esp_wifi_disconnect() );
            ESP_ERROR_CHECK( esp_wifi_set_config(WIFI_IF_STA, &wifi_config) );
            esp_wifi_connect();
        } else if (event_base == SC_EVENT && event_id == SC_EVENT_SEND_ACK_DONE) { 
            xEventGroupSetBits(s_wifi_event_group, ESPTOUCH_DONE_BIT);
        }
    }

## 5.3 SmartConfig线程 ##

*  `esp_smartconfig_set_type`设置SmartConfig的协议类型为`SC_TYPE_ESPTOUCH`。协议类型有：`SC_TYPE_ESPTOUCH`、`SC_TYPE_AIRKISS`、`SC_TYPE_ESPTOUCH_AIRKISS`、`SC_TYPE_ESPTOUCH_V2`等
 *  `esp_smartconfig_start`启动SmartConfig
 *  等待`ESPTOUCH_DONE_BIT`标志位
    
     *  `esp_smartconfig_stop`停止SmartConfig

static void smartconfig_example_task(void * parm)
    { 
        EventBits_t uxBits;
        ESP_ERROR_CHECK( esp_smartconfig_set_type(SC_TYPE_ESPTOUCH) );
        smartconfig_start_config_t cfg = SMARTCONFIG_START_CONFIG_DEFAULT();
        ESP_ERROR_CHECK( esp_smartconfig_start(&cfg) );
        while (1) { 
            uxBits = xEventGroupWaitBits(s_wifi_event_group, CONNECTED_BIT | ESPTOUCH_DONE_BIT, true, false, portMAX_DELAY);
            if(uxBits & CONNECTED_BIT) { 
                ESP_LOGI(TAG, "WiFi Connected to ap");
            }
            if(uxBits & ESPTOUCH_DONE_BIT) { 
                ESP_LOGI(TAG, "smartconfig over");
                esp_smartconfig_stop();
                vTaskDelete(NULL);
            }
        }
    }

## 5.4 流程图 ##

*  回调函数和SmartConfig线程是通过`xEventGroupWaitBits`、`xEventGroupSetBits`、`xEventGroupClearBits`等函数进行通信
    
     *  回调函数设置或清楚Bits,`xEventGroupSetBits`、`xEventGroupClearBits`
     *  SmartConfig线程通过循环等待`xEventGroupWaitBits`

主程序WiFi任务回调函数SmartConfig线程nvs\_flash\_initesp\_netif\_initesp\_event\_loop\_create\_defaultesp\_netif\_create\_default\_wifi\_staesp\_wifi\_init，初始化WiFi资源，启动WiFi任务esp\_event\_handler\_instance\_register，监听WiFi事件esp\_event\_handler\_instance\_register，监听IP事件esp\_event\_handler\_instance\_register，监听SmartConfig事件esp\_wifi\_set\_modeesp\_wifi\_start，根据配置启动WiFiWIFI\_EVENT\_STA\_START启动SmartConfig线程esp\_smartconfig\_set\_type设置SmartConfig通信类型esp\_smartconfig\_start根据配置启动SmartConfigxEventGroupWaitBits循环等待WIFI\_EVENT\_STA\_DISCONNECTED清除CONNECTED\_BIT标志位IP\_EVENT\_STA\_GOT\_IP设置CONNECTED\_BIT标志位SC\_EVENT\_SCAN\_DONESmartConfig 扫描AP列表结束SC\_EVENT\_FOUND\_CHANNELSmartConfig 从目标AP找到频道SC\_EVENT\_GOT\_SSID\_PSWD解析出WiFi的SSID和密码esp\_wifi\_disconnect断开当前WiFi连接esp\_wifi\_set\_config设置WiFi的SSID和密码esp\_wifi\_connect连接WiFiSC\_EVENT\_SEND\_ACK\_DONE设置ESPTOUCH\_DONE\_BIT标志位esp\_smartconfig\_stop停止SmartConfigvTaskDelete删除SmartConfig线程主程序WiFi任务回调函数SmartConfig线程

# 六、关键函数 #

## 6.1 设置SmartConfig的协议类型 ##

*  `type`：SmartConfig的协议类型，包含：`ESPTouch`、`AirKiss`、`ESPTOUCH_AIRKISS`、`ESPTOUCH_V2`等

typedef enum { 
        SC_TYPE_ESPTOUCH = 0,       /**< protocol: ESPTouch */
        SC_TYPE_AIRKISS,            /**< protocol: AirKiss */
        SC_TYPE_ESPTOUCH_AIRKISS,   /**< protocol: ESPTouch and AirKiss */
        SC_TYPE_ESPTOUCH_V2,        /**< protocol: ESPTouch v2*/
    } smartconfig_type_t;
    
    /** * @brief Set protocol type of SmartConfig. * * @attention If users need to set the SmartConfig type, please set it before calling * esp_smartconfig_start. * * @param type Choose from the smartconfig_type_t. * * @return * - ESP_OK: succeed * - others: fail */
    esp_err_t esp_smartconfig_set_type(smartconfig_type_t type);

## 6.2 启动SmartConfig ##

*  `config`：配置

/** Configure structure for esp_smartconfig_start */
    typedef struct { 
        bool enable_log;                /**< Enable smartconfig logs. */
        bool esp_touch_v2_enable_crypt; /**< Enable ESPTouch v2 crypt. */
        char *esp_touch_v2_key;         /**< ESPTouch v2 crypt key, len should be 16. */
    } smartconfig_start_config_t;
    
    esp_err_t esp_smartconfig_start(const smartconfig_start_config_t *config)

## 6.3 停止SmartConfig ##

esp_err_t esp_smartconfig_stop(void)

# 七、其他 #

Airkiss配网方式请查阅：[ESP32-C3入门教程 网络篇⑧——WiFi Smart Config 智能配网（基于AirKiss）][ESP32-C3_ _WiFi Smart Config _AirKiss]

# 八、参考 #

[SmartConfig - ESP32-C3 - —ESP-IDF 编程指南 latest 文档][SmartConfig - ESP32-C3 - _ESP-IDF _ latest]

***觉得好，就一键三连呗（点赞+收藏+关注）***

[ESP32-C3_ _VS Code_Hello World]: https://blog.csdn.net/kangweijian/article/details/120284617
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5bCP5bq35biI5YWE_size_20_color_FFFFFF_t_70_g_se_x_16]: /images/20220828/c904c3f572fa410e9e6ec57d807bde5f.png
[EspTouchForAndroid]: https://github.com/EspressifApp/EsptouchForAndroid
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5bCP5bq35biI5YWE_size_10_color_FFFFFF_t_70_g_se_x_16]: https://img-blog.csdnimg.cn/b26da7601f4c4f61bda523b0614518db.jpg?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5bCP5bq35biI5YWE,size_10,color_FFFFFF,t_70,g_se,x_16
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5bCP5bq35biI5YWE_size_10_color_FFFFFF_t_70_g_se_x_16 1]: https://img-blog.csdnimg.cn/6796f519ff4246f5aa59bc5ae3c7adb5.jpg?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5bCP5bq35biI5YWE,size_10,color_FFFFFF,t_70,g_se,x_16
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5bCP5bq35biI5YWE_size_10_color_FFFFFF_t_70_g_se_x_16 2]: /images/20220828/878ec1894e1044e4afc2c1effa6bc688.png
[watermark_type_ZHJvaWRzYW5zZmFsbGJhY2s_shadow_50_text_Q1NETiBA5bCP5bq35biI5YWE_size_20_color_FFFFFF_t_70_g_se_x_16 1]: /images/20220828/d25a501e2ad044afa54a3fca7e6b8536.png
[ESP32-C3_ _WiFi Smart Config _AirKiss]: https://blog.csdn.net/kangweijian/article/details/120628027
[SmartConfig - ESP32-C3 - _ESP-IDF _ latest]: https://docs.espressif.com/projects/esp-idf/zh_CN/latest/esp32c3/api-reference/network/esp_smartconfig.html?highlight=esptouch_v2#

发表评论取消回复

表情：

评论列表（有 0 条评论，3378人围观）

还没有评论，来说两句吧...

相关阅读

相关 ESP32-C3入门教程蓝牙篇③——基于微信小程序和Esp Blufi实现 WiFi配网

基于微信小程序和Esp Blufi实现 WiFi配网文章目录一、前言二、软件框架三、软件流程四、API介绍五、全部源码一

桃扇骨/ 2023年10月07日 19:27/ 0 赞/ 59 阅读

相关 ESP32-C3入门教程 WiFi篇⑦——基于SoftAP 的 WiFi 智能配网

文章目录一、前言二、WiFi配网方式三、功能简述四、源码实现一、前言 > 本文基于VS Code IDE进行编程、编译、下载、运

╰半夏微凉°/ 2023年10月07日 18:16/ 0 赞/ 46 阅读

相关 ESP8266 Smart Config配网

Smartconfig(一键配网)模式 Smartconfig原理 Smartconfig 简称一键配网，它可以将WIFI设备便捷快速的连接路由器。smartconfi

朱雀/ 2023年03月13日 05:21/ 0 赞/ 163 阅读

相关 ESP32-C3入门教程 WiFi篇④——WiFi Smart Config 智能配网（基于EspTouchForAndroid）

文章目录一、前言二、WiFi配网方式三、快速运行四、运行效果五、ESP32-C3程序流程 5.1 主程序

系统管理员/ 2022年09月14日 09:46/ 0 赞/ 3379 阅读

相关 ESP32-C3入门教程 WiFi篇③——WiFi SoftAP 模式开启AP热点

文章目录一、前言二、WiFi模式三、快速运行四、运行效果五、程序流程 5.1 主程序 5.2 注册事件回

「爱情、让人受尽委屈。」/ 2022年09月13日 00:24/ 0 赞/ 2056 阅读

相关 ESP32-C3入门教程 WiFi篇②——WiFi Station 模式连接到 AP 热点接入点

文章目录一、前言二、WiFi模式三、快速运行四、运行效果 4.1 连接失败 4.2 连接成功五、程序流程

太过爱你忘了你带给我的痛/ 2022年09月12日 13:51/ 0 赞/ 1543 阅读

相关 ESP32-C3入门教程 WiFi篇①——WiFi Scan 快速扫描附近AP无线热点

文章目录一、前言二、快速运行三、运行效果四、程序流程五、关键函数 5.1 扫描所有有效的AP 5.2 获

ゝ一世哀愁。/ 2022年09月12日 13:43/ 1 赞/ 1940 阅读

相关 ESP32-C3入门教程 WiFi篇⑤——WiFi Smart Config 智能配网（基于AirKiss）

文章目录一、前言二、代码修改三、运行效果一、前言 > 本文基于VS Code IDE进行编程、编译、下载、运行等操作 > 基础知识点

待我称王封你为后i/ 2022年08月28日 09:43/ 0 赞/ 761 阅读

相关智能家居篇之---WIFI通讯（ESP8266）

智能家居篇之---WIFI通讯（ESP8266）智能家居所谓智能就是可以通过手机端来收集数据、分析数据、进而控制。那么要实现这

待我称王封你为后i/ 2022年05月19日 07:11/ 0 赞/ 342 阅读

相关智能设备 WiFi 配网的两种方式

[2019独角兽企业重金招聘Python工程师标准>>> ][2019_Python_] ![hot3.png][] 智能家居的设备智能化，很多家电设备都安装上了 WiFi

淡淡的烟草味﹌/ 2022年01月13日 16:23/ 0 赞/ 1476 阅读