Wi-Fi AT 命令集

[English]

介绍

重要

默认的 AT 固件支持此页面下除 AT+CWJEAP 之外的所有 AT 命令。如果您需要修改 ESP32-C3 默认支持的命令,请自行 编译 ESP-AT 工程,在第五步配置工程里选择(下面每项是独立的,根据您的需要选择):

  • 启用 EAP 命令(AT+CWJEAP): Component config -> AT -> AT WPA2 Enterprise command support

  • 禁用 WPS 命令(AT+WPS):Component config -> AT -> AT WPS command support

  • 禁用 mDNS 命令(AT+MDNS):Component config -> AT -> AT MDNS command support

  • 禁用 smartconfig 命令(AT+CWSTARTSMARTAT+CWSTOPSMART):Component config -> AT -> AT smartconfig command support

  • 禁用所有 Wi-Fi 命令(不推荐。一旦禁用,所有 Wi-Fi 以及以上的功能将无法使用,您需要自行实现这些 AT 命令): Component config -> AT -> AT wifi command support

AT+CWINIT:初始化/清理 Wi-Fi 驱动程序

查询命令

功能:

查询 ESP32-C3 设备的 Wi-Fi 初始化状态

命令:

AT+CWINIT?

响应:

+CWINIT:<init>

OK

设置命令

功能:

初始化或清理 ESP32-C3 设备的 Wi-Fi 驱动程序

命令:

AT+CWINIT=<init>

响应:

OK

参数

  • <init>

    • 0: 清理 Wi-Fi 驱动程序

    • 1: 初始化 Wi-Fi 驱动程序(默认值)

说明

  • 本设置不保存到 flash,重启后会恢复为默认值 1。

  • 当您 RAM 资源不足时,在不使用 Wi-Fi 的前提下,可以使用此命令清理 Wi-Fi 驱动程序,以释放 RAM 资源。

示例

// 清理 Wi-Fi 驱动程序
AT+CWINIT=0

AT+CWMODE:查询/设置 Wi-Fi 模式 (Station/SoftAP/Station+SoftAP)

查询命令

功能:

查询 ESP32-C3 设备的 Wi-Fi 模式

命令:

AT+CWMODE?

响应:

+CWMODE:<mode>
OK

设置命令

功能:

设置 ESP32-C3 设备的 Wi-Fi 模式

命令:

AT+CWMODE=<mode>[,<auto_connect>]

响应:

OK

参数

  • <mode>:模式

    • 0: 无 Wi-Fi 模式,并且关闭 Wi-Fi RF

    • 1: Station 模式

    • 2: SoftAP 模式

    • 3: SoftAP+Station 模式

  • <auto_connect>:切换 ESP32-C3 设备的 Wi-Fi 模式时(例如,从 SoftAP 或无 Wi-Fi 模式切换为 Station 模式或 SoftAP+Station 模式),是否启用自动连接 AP 的功能,默认值:1。参数缺省时,使用默认值,也就是能自动连接。

    • 0: 禁用自动连接 AP 的功能

    • 1: 启用自动连接 AP 的功能,若之前已经将自动连接 AP 的配置保存到 flash 中,则 ESP32-C3 设备将自动连接 AP

说明

示例

AT+CWMODE=3

AT+CWSTATE:查询 Wi-Fi 状态和 Wi-Fi 信息

查询命令

功能:

查询 ESP32-C3 设备的 Wi-Fi 状态和 Wi-Fi 信息

命令:

AT+CWSTATE?

响应:

+CWSTATE:<state>,<"ssid">

OK

参数

  • <state>:当前 Wi-Fi 状态

    • 0: ESP32-C3 station 尚未进行任何 Wi-Fi 连接

    • 1: ESP32-C3 station 已经连接上 AP,但尚未获取到 IPv4 地址

    • 2: ESP32-C3 station 已经连接上 AP,并已经获取到 IPv4 地址

    • 3: ESP32-C3 station 正在进行 Wi-Fi 连接或 Wi-Fi 重连

    • 4: ESP32-C3 station 处于 Wi-Fi 断开状态

  • <”ssid”>:目标 AP 的 SSID

说明

  • 当 ESP32-C3 station 没有连接上 AP 时,推荐使用此命令查询 Wi-Fi 信息;当 ESP32-C3 station 已连接上 AP 后,推荐使用 AT+CWJAP 命令查询 Wi-Fi 信息

AT+CWJAP:连接 AP

查询命令

功能:

查询与 ESP32-C3 Station 连接的 AP 信息

命令:

AT+CWJAP?

响应:

+CWJAP:<ssid>,<bssid>,<channel>,<rssi>,<pci_en>,<reconn_interval>,<listen_interval>,<scan_mode>,<pmf>
OK

设置命令

功能:

设置 ESP32-C3 Station 需连接的 AP

命令:

AT+CWJAP=[<ssid>],[<pwd>][,<bssid>][,<pci_en>][,<reconn_interval>][,<listen_interval>][,<scan_mode>][,<jap_timeout>][,<pmf>]

响应:

WIFI CONNECTED
WIFI GOT IP

OK
[WIFI GOT IPv6 LL]
[WIFI GOT IPv6 GL]

+CWJAP:<error code>
ERROR

执行命令

功能:

将 ESP32-C3 station 连接至上次 Wi-Fi 配置中的 AP

命令:

AT+CWJAP

响应:

WIFI CONNECTED
WIFI GOT IP

OK
[WIFI GOT IPv6 LL]
[WIFI GOT IPv6 GL]

+CWJAP:<error code>
ERROR

参数

  • <ssid>:目标 AP 的 SSID

    • 如果 SSID 和密码中有 ,"\\ 等特殊字符,需转义

    • AT 支持连接 SSID 为中文的 AP,但是某些路由器或者热点的中文 SSID 不是 UTF-8 编码格式。您可以先扫描 SSID,然后使用扫描到的 SSID 进行连接。

  • <pwd>:密码最长 63 字节 ASCII

  • <bssid>:目标 AP 的 MAC 地址,当多个 AP 有相同的 SSID 时,该参数不可省略

  • <channel>:信道号

  • <rssi>:信号强度

  • <pci_en>:PCI 认证

    • 0: ESP32-C3 station 可与任何一种加密方式的 AP 连接,包括 OPEN 和 WEP

    • 1: ESP32-C3 station 可与除 OPEN 和 WEP 之外的任何一种加密方式的 AP 连接

  • <reconn_interval>:Wi-Fi 重连间隔,单位:秒,默认值:1,最大值:7200

    • 0: 断开连接后,ESP32-C3 station 不重连 AP

    • [1,7200]: 断开连接后,ESP32-C3 station 每隔指定的时间与 AP 重连

  • <listen_interval>:监听 AP beacon 的间隔,单位为 AP beacon 间隔,默认值:3,范围:[1,100]

  • <scan_mode>:扫描模式

    • 0: 快速扫描,找到目标 AP 后终止扫描,ESP32-C3 station 与第一个扫描到的 AP 连接

    • 1: 全信道扫描,所有信道都扫描后才终止扫描,ESP32-C3 station 与扫描到的信号最强的 AP 连接

  • <jap_timeout>AT+CWJAP 命令超时的最大值,单位:秒,默认值:15,范围:[3,600]

  • <pmf>:PMF(Protected Management Frames,受保护的管理帧),默认值 1

    • 0 表示禁用 PMF

    • bit 0: 具有 PMF 功能,提示支持 PMF,如果其他设备具有 PMF 功能,则 ESP32-C3 设备将优先选择以 PMF 模式连接

    • bit 1: 需要 PMF,提示需要 PMF,设备将不会关联不支持 PMF 功能的设备

  • <error code>:错误码,仅供参考

    • 1: 连接超时

    • 2: 密码错误

    • 3: 无法找到目标 AP

    • 4: 连接失败

    • 其它值: 发生未知错误

说明

  • 如果 AT+SYSSTORE=1,配置更改将保存到 NVS 分区

  • 使用本命令需要开启 station 模式

  • 当 ESP32-C3 station 已连接上 AP 后,推荐使用此命令查询 Wi-Fi 信息;当 ESP32-C3 station 没有连接上 AP 时,推荐使用 AT+CWSTATE 命令查询 Wi-Fi 信息

  • 本命令中的 <reconn_interval> 参数与 AT+CWRECONNCFG 命令中的 <interval_second> 参数相同。如果运行本命令时不设置 <reconn_interval> 参数,Wi-Fi 重连间隔时间将采用默认值 1

  • 如果同时省略 <ssid><password> 参数,将使用上一次设置的值

  • 执行命令与设置命令的超时时间相同,默认为 15 秒,可通过参数 <jap_timeout> 设置

  • 不支持通过 WAPI 鉴权方式连接路由器。

  • 想要获取 IPv6 地址,需要先设置 AT+CIPV6=1

  • 回复 OK 代表 IPv4 网络已经准备就绪,而不代表 IPv6 网络准备就绪。当前 ESP-AT 以 IPv4 网络为主,IPv6 网络为辅。

  • WIFI GOT IPv6 LL 代表已经获取到本地链路 IPv6 地址,这个地址是通过 EUI-64 本地计算出来的,不需要路由器参与。由于并行时序,这个打印可能在 OK 之前,也可能在 OK 之后。

  • WIFI GOT IPv6 GL 代表已经获取到全局 IPv6 地址,该地址是由 AP 下发的前缀加上内部计算出来的后缀进行组合而来的,需要路由器参与。由于并行时序,这个打印可能在 OK 之前,也可能在 OK 之后;也可能由于 AP 不支持 IPv6 而不打印。

示例

// 如果目标 AP 的 SSID 是 "abc",密码是 "0123456789",则命令是:
AT+CWJAP="abc","0123456789"

// 如果目标 AP 的 SSID 是 "ab\,c",密码是 "0123456789"\",则命令是:
AT+CWJAP="ab\\\,c","0123456789\"\\"

// 如果多个 AP 有相同的 SSID "abc",可通过 BSSID 找到目标 AP:
AT+CWJAP="abc","0123456789","ca:d7:19:d8:a6:44"

// 如果 ESP-AT 要求通过 PMF 连接 AP,则命令是:
AT+CWJAP="abc","0123456789",,,,,,,3

AT+CWRECONNCFG:查询/设置 Wi-Fi 重连配置

查询命令

功能:

查询 Wi-Fi 重连配置

命令:

AT+CWRECONNCFG?

响应:

+CWRECONNCFG:<interval_second>,<repeat_count>
OK

设置命令

功能:

设置 Wi-Fi 重连配置

命令:

AT+CWRECONNCFG=<interval_second>,<repeat_count>

响应:

OK

参数

  • <interval_second>:Wi-Fi 重连间隔,单位:秒,默认值:0,最大值 7200

    • 0: 断开连接后,ESP32-C3 station 不重连 AP

    • [1,7200]: 断开连接后,ESP32-C3 station 每隔指定的时间与 AP 重连

  • <repeat_count>:ESP32-C3 设备尝试重连 AP 的次数,本参数在 <interval_second> 不为 0 时有效,默认值:0,最大值:1000

    • 0: ESP32-C3 station 始终尝试连接 AP

    • [1,1000]: ESP32-C3 station 按照本参数指定的次数重连 AP

示例

// ESP32-C3 station 每隔 1 秒尝试重连 AP,共尝试 100 次
AT+CWRECONNCFG=1,100

// ESP32-C3 station 在断开连接后不重连 AP
AT+CWRECONNCFG=0,0

说明

  • 本命令中的 <interval_second> 参数与 AT+CWJAP 中的 [<reconn_interval>] 参数相同

  • 该命令适用于被动断开 AP、Wi-Fi 模式切换和开机后 Wi-Fi 自动连接

AT+CWLAPOPT:设置 AT+CWLAP 命令扫描结果的属性

设置命令

命令:

AT+CWLAPOPT=<reserved>,<print mask>[,<rssi filter>][,<authmode mask>]

响应:

OK

或者

ERROR

参数

  • <reserved>:保留项

  • <print mask>AT+CWLAP 的扫描结果是否显示以下参数,默认值:0x7FF,若 bit 设为 1,则显示对应参数,若设为 0,则不显示对应参数

    • bit 0: 是否显示 <ecn>

    • bit 1: 是否显示 <ssid>

    • bit 2: 是否显示 <rssi>

    • bit 3: 是否显示 <mac>

    • bit 4: 是否显示 <channel>

    • bit 5: 是否显示 <freq_offset>

    • bit 6: 是否显示 <freqcal_val>

    • bit 7: 是否显示 <pairwise_cipher>

    • bit 8: 是否显示 <group_cipher>

    • bit 9: 是否显示 <bgn>

    • bit 10: 是否显示 <wps>

  • [<rssi filter>]AT+CWLAP 的扫描结果是否按照本参数过滤,也即,是否过滤掉信号强度低于 rssi filter 参数值的 AP,单位:dBm,默认值:–100,范围:[–100,40]

  • [<authmode mask>]AT+CWLAP 的扫描结果是否显示以下认证方式的 AP,默认值:0xFFFF,如果 bit x 设为 1,则显示对应认证方式的 AP,若设为 0,则不显示

    • bit 0: 是否显示 OPEN 认证方式的 AP

    • bit 1: 是否显示 WEP 认证方式的 AP

    • bit 2: 是否显示 WPA_PSK 认证方式的 AP

    • bit 3: 是否显示 WPA2_PSK 认证方式的 AP

    • bit 4: 是否显示 WPA_WPA2_PSK 认证方式的 AP

    • bit 5: 是否显示 WPA2_ENTERPRISE 认证方式的 AP

    • bit 6: 是否显示 WPA3_PSK 认证方式的 AP

    • bit 7: 是否显示 WPA2_WPA3_PSK 认证方式的 AP

    • bit 8: 是否显示 WAPI_PSK 认证方式的 AP

    • bit 9: 是否显示 OWE 认证方式的 AP

示例

// 第一个参数为 1,表示 AT+CWLAP 命令扫描结果按照信号强度 RSSI 值排序
// 第二个参数为 31,即 0x1F,表示所有值为 1 的 bit 对应的参数都会显示出来
AT+CWLAPOPT=1,31
AT+CWLAP

// 只显示认证方式为 OPEN 的 AP
AT+CWLAPOPT=1,31,-100,1
AT+CWLAP

AT+CWLAP:扫描当前可用的 AP

设置命令

功能:

列出符合特定条件的 AP,如指定 SSID、MAC 地址或信道号

命令:

AT+CWLAP=[<ssid>,<mac>,<channel>,<scan_type>,<scan_time_min>,<scan_time_max>]

执行命令

功能:

列出当前可用的 AP

命令:

AT+CWLAP

响应:

+CWLAP:<ecn>,<ssid>,<rssi>,<mac>,<channel>,<freq_offset>,<freqcal_val>,<pairwise_cipher>,<group_cipher>,<bgn>,<wps>
OK

参数

  • <ecn>:加密方式

    • 0: OPEN

    • 1: WEP

    • 2: WPA_PSK

    • 3: WPA2_PSK

    • 4: WPA_WPA2_PSK

    • 5: WPA2_ENTERPRISE

    • 6: WPA3_PSK

    • 7: WPA2_WPA3_PSK

    • 8: WAPI_PSK

    • 9: OWE

  • <ssid>:字符串参数,AP 的 SSID

  • <rssi>:信号强度

  • <mac>:字符串参数,AP 的 MAC 地址

  • <channel>:信道号

  • <scan_type>:Wi-Fi 扫描类型,默认值为:0

    • 0: 主动扫描

    • 1: 被动扫描

  • <scan_time_min>:每个信道最短扫描时间,单位:毫秒,范围:[0,1500],如果扫描类型为被动扫描,本参数无效

  • <scan_time_max>:每个信道最长扫描时间,单位:毫秒,范围:[0,1500],如果设为 0,固件采用参数默认值,主动扫描为 120 ms,被动扫描为 360 ms

  • <freq_offset>:频偏(保留项目)

  • <freqcal_val>:频率校准值(保留项目)

  • <pairwise_cipher>:成对加密类型

    • 0: None

    • 1: WEP40

    • 2: WEP104

    • 3: TKIP

    • 4: CCMP

    • 5: TKIP and CCMP

    • 6: AES-CMAC-128

    • 7: 未知

  • <group_cipher>:组加密类型,与 <pairwise_cipher> 参数的枚举值相同

  • <bgn>:802.11 b/g/n,若 bit 设为 1,则表示使能对应模式,若设为 0,则表示禁用对应模式

    • bit 0: 是否使能 802.11b 模式

    • bit 1: 是否使能 802.11g 模式

    • bit 2: 是否使能 802.11n 模式

  • <wps>:wps flag

    • 0: 不支持 WPS

    • 1: 支持 WPS

示例

AT+CWLAP="Wi-Fi","ca:d7:19:d8:a6:44",6,0,400,1000

// 寻找指定 SSID  AP
AT+CWLAP="Wi-Fi"

AT+CWQAP:断开与 AP 的连接

执行命令

命令:

AT+CWQAP

响应:

OK

AT+CWSAP:配置 ESP32-C3 SoftAP 参数

查询命令

功能:

查询 ESP32-C3 SoftAP 的配置参数

命令:

AT+CWSAP?

响应:

+CWSAP:<ssid>,<pwd>,<channel>,<ecn>,<max conn>,<ssid hidden>
OK

设置命令

功能:

设置 ESP32-C3 SoftAP 的配置参数

命令:

AT+CWSAP=<ssid>,<pwd>,<chl>,<ecn>[,<max conn>][,<ssid hidden>]

响应:

OK

参数

  • <ssid>:字符串参数,接入点名称

  • <pwd>:字符串参数,密码,范围:8 ~ 63 字节 ASCII

  • <channel>:信道号

  • <ecn>:加密方式,不支持 WEP

    • 0: OPEN

    • 2: WPA_PSK

    • 3: WPA2_PSK

    • 4: WPA_WPA2_PSK

  • [<max conn>]:允许连入 ESP32-C3 SoftAP 的最多 station 数目,取值范围:参考 max_connection 描述

  • [<ssid hidden>]

    • 0: 广播 SSID(默认)

    • 1: 不广播 SSID

说明

  • 本指令只有当 AT+CWMODE=2 或者 AT+CWMODE=3 时才有效

  • AT+SYSSTORE=1,配置更改将保存在 NVS 分区

  • 默认 SSID 因设备而异,因为它由设备的 MAC 地址组成。 您可以使用 AT+CWSAP? 查询默认的SSID。

示例

AT+CWSAP="ESP","1234567890",5,3

AT+CWLIF:查询连接到 ESP32-C3 SoftAP 的 station 信息

执行命令

命令:

AT+CWLIF

响应:

+CWLIF:<ip addr>,<mac>

OK

参数

  • <ip addr>:连接到 ESP32-C3 SoftAP 的 station 的 IP 地址

  • <mac>:连接到 ESP32-C3 SoftAP 的 station 的 MAC 地址

说明

  • 本指令无法查询静态 IP,仅支持在 ESP32-C3 SoftAP 和连入的 station DHCP 均使能的情况下有效

AT+CWQIF:断开 station 与 ESP32-C3 SoftAP 的连接

执行命令

功能:

断开所有连入 ESP32-C3 SoftAP 的 station

命令:

AT+CWQIF

响应:

OK

设置命令

功能:

断开某个连入 ESP32-C3 SoftAP 的 station

命令:

AT+CWQIF=<mac>

响应:

OK

参数

  • <mac>:需断开连接的 station 的 MAC 地址

AT+CWDHCP:启用/禁用 DHCP

查询命令

命令:

AT+CWDHCP?

响应:

+CWDHCP:<state>
OK

设置命令

功能:

启用/禁用 DHCP

命令:

AT+CWDHCP=<operate>,<mode>

响应:

OK

参数

  • <operate>

    • 0: 禁用

    • 1: 启用

  • <mode>

    • Bit0: Station 的 DHCP

    • Bit1: SoftAP 的 DHCP

  • <state>:DHCP 的状态

    • Bit0:

      • 0: 禁用 Station 的 DHCP

      • 1: 启用 Station 的 DHCP

    • Bit1:

      • 0: 禁用 SoftAP 的 DHCP

      • 1: 启用 SoftAP 的 DHCP

    • Bit2:

      • 0: 禁用 Ethernet 的 DHCP

      • 1: 启用 Ethernet 的 DHCP

说明

  • AT+SYSSTORE=1,配置更改将保存到 NVS 分区

  • 本设置命令与设置静态 IPv4 地址的命令会相互影响,如 AT+CIPSTAAT+CIPAP

    • 若启用 DHCP,则静态 IPv4 地址会被禁用

    • 若启用静态 IPv4,则 DHCP 会被禁用

    • 最后一次配置会覆盖上一次配置

示例

// 启用 Station DHCP,如果原 DHCP mode 为 2,则现 DHCP mode 为 3
AT+CWDHCP=1,1

// 禁用 SoftAP DHCP,如果原 DHCP mode 为 3,则现 DHCP mode 为 1
AT+CWDHCP=0,2

AT+CWDHCPS:查询/设置 ESP32-C3 SoftAP DHCP 分配的 IPv4 地址范围

查询命令

命令:

AT+CWDHCPS?

响应:

+CWDHCPS:<lease time>,<start IP>,<end IP>
OK

设置命令

功能:

设置 ESP32-C3 SoftAP DHCP 服务器分配的 IPv4 地址范围

命令:

AT+CWDHCPS=<enable>,<lease time>,<start IP>,<end IP>

响应:

OK

参数

  • <enable>

    • 1: 设置 DHCP server 信息,后续参数必须填写

    • 0: 清除 DHCP server 信息,恢复默认值,后续参数无需填写

  • <lease time>:租约时间,单位:分钟,取值范围:[1,2880]

  • <start IP>:ESP32-C3 SoftAP DHCP 服务器 IPv4 地址池的起始 IP

  • <end IP>:ESP32-C3 SoftAP DHCP 服务器 IPv4 地址池的结束 IP

说明

  • AT+SYSSTORE=1,配置更改将保存到 NVS 分区

  • 本命令必须在 ESP32-C3 SoftAP 模式使能,且开启 DHCP server 的情况下使用

  • 设置的 IPv4 地址范围必须与 ESP32-C3 SoftAP 在同一网段

示例

AT+CWDHCPS=1,3,"192.168.4.10","192.168.4.15"

AT+CWDHCPS=0 // 清除设置,恢复默认值

AT+CWAUTOCONN:查询/设置上电是否自动连接 AP

查询命令

命令:

AT+CWAUTOCONN?

响应:

+CWAUTOCONN:<enable>
OK

设置命令

命令:

AT+CWAUTOCONN=<enable>

响应:

OK

参数

  • <enable>

    • 1: 上电自动连接 AP(默认)

    • 0: 上电不自动连接 AP

说明

  • 本设置保存到 NVS 区域

示例

AT+CWAUTOCONN=1

AT+CWAPPROTO:查询/设置 SoftAP 模式下 802.11 b/g/n 协议标准

查询命令

命令:

AT+CWAPPROTO?

响应:

+CWAPPROTO:<protocol>
OK

设置命令

命令:

AT+CWAPPROTO=<protocol>

响应:

OK

参数

说明

  • 默认情况下,ESP32-C3 设备的 PHY mode 是 802.11bgn 模式

AT+CWSTAPROTO:设置 Station 模式下 802.11 b/g/n 协议标准

查询命令

命令:

AT+CWSTAPROTO?

响应:

+CWSTAPROTO:<protocol>
OK

设置命令

命令:

AT+CWSTAPROTO=<protocol>

响应:

OK

参数

说明

  • 默认情况下,ESP32-C3 设备的 PHY mode 是 802.11bgn 模式

AT+CIPSTAMAC:查询/设置 ESP32-C3 Station 的 MAC 地址

查询命令

功能:

查询 ESP32-C3 Station 的 MAC 地址

命令:

AT+CIPSTAMAC?

响应:

+CIPSTAMAC:<mac>
OK

设置命令

功能:

设置 ESP32-C3 Station 的 MAC 地址

命令:

AT+CIPSTAMAC=<mac>

响应:

OK

参数

  • <mac>:字符串参数,表示 ESP32-C3 Station 的 MAC 地址

说明

  • AT+SYSSTORE=1,配置更改将保存到 NVS 分区

  • ESP32-C3 Station 的 MAC 地址与 ESP32-C3 SoftAP 不同,不要为二者设置同样的 MAC 地址

  • MAC 地址的 Bit 0 不能为 1,例如,MAC 地址可以是 “1a:…”,但不可以是 “15:…”

  • FF:FF:FF:FF:FF:FF 和 00:00:00:00:00:00 是无效地址,不能设置

示例

AT+CIPSTAMAC="1a:fe:35:98:d3:7b"

AT+CIPAPMAC:查询/设置 ESP32-C3 SoftAP 的 MAC 地址

查询命令

功能:

查询 ESP32-C3 SoftAP 的 MAC 地址

命令:

AT+CIPAPMAC?

响应:

+CIPAPMAC:<mac>
OK

设置命令

功能:

设置 ESP32-C3 SoftAP 的 MAC 地址

命令:

AT+CIPAPMAC=<mac>

响应:

OK

参数

  • <mac>:字符串参数,表示 ESP32-C3 SoftAP 的 MAC 地址

说明

  • AT+SYSSTORE=1,配置更改将保存到 NVS 分区

  • ESP32-C3 SoftAP 的 MAC 地址与 ESP32-C3 Station 不同,不要为二者设置同样的 MAC 地址

  • MAC 地址的 Bit 0 不能为 1,例如,MAC 地址可以是 “18:…”,但不可以是 “15:…”

  • FF:FF:FF:FF:FF:FF 和 00:00:00:00:00:00 是无效地址,不能设置

示例

AT+CIPAPMAC="18:fe:35:98:d3:7b"

AT+CIPSTA:查询/设置 ESP32-C3 Station 的 IP 地址

查询命令

功能:

查询 ESP32-C3 Station 的 IP 地址

命令:

AT+CIPSTA?

响应:

+CIPSTA:ip:<"ip">
+CIPSTA:gateway:<"gateway">
+CIPSTA:netmask:<"netmask">
+CIPSTA:ip6ll:<"ipv6 addr">
+CIPSTA:ip6gl:<"ipv6 addr">

OK

设置命令

功能:

设置 ESP32-C3 Station 的 IPv4 地址

命令:

AT+CIPSTA=<"ip">[,<"gateway">,<"netmask">]

响应:

OK

参数

  • <”ip”>:字符串参数,表示 ESP32-C3 station 的 IPv4 地址

  • <”gateway”>:网关

  • <”netmask”>:子网掩码

  • <”ipv6 addr”>:ESP32-C3 station 的 IPv6 地址

说明

  • 使用查询命令时,只有当 ESP32-C3 station 连入 AP 或者配置过静态 IP 地址后,才能查询到它的 IP 地址

  • AT+SYSSTORE=1,配置更改将保存到 NVS 分区

  • 本设置命令与设置 DHCP 的命令相互影响,如 AT+CWDHCP

    • 若启用静态 IPv4 地址,则禁用 DHCP

    • 若启用 DHCP,则禁用静态 IPv4 地址

    • 最后一次配置会覆盖上一次配置

示例

AT+CIPSTA="192.168.6.100","192.168.6.1","255.255.255.0"

AT+CIPAP:查询/设置 ESP32-C3 SoftAP 的 IP 地址

查询命令

功能:

查询 ESP32-C3 SoftAP 的 IP 地址

命令:

AT+CIPAP?

响应:

+CIPAP:ip:<"ip">
+CIPAP:gateway:<"gateway">
+CIPAP:netmask:<"netmask">
+CIPAP:ip6ll:<"ipv6 addr">

OK

设置命令

功能:

设置 ESP32-C3 SoftAP 的 IPv4 地址

命令:

AT+CIPAP=<"ip">[,<"gateway">,<"netmask">]

响应:

OK

参数

  • <”ip”>:字符串参数,表示 ESP32-C3 SoftAP 的 IPv4 地址

  • <”gateway”>:网关

  • <”netmask”>:子网掩码

  • <”ipv6 addr”>:ESP32-C3 SoftAP 的 IPv6 地址

说明

  • 本设置命令仅适用于 IPv4 网络,不适用于 IPv6 网络

  • AT+SYSSTORE=1,配置更改将保存到 NVS 分区

  • 本设置命令与设置 DHCP 的命令相互影响,如 AT+CWDHCP

    • 若启用静态 IPv4 地址,则禁用 DHCP

    • 若启用 DHCP,则禁用静态 IPv4 地址

    • 最后一次配置会覆盖上一次配置

示例

AT+CIPAP="192.168.5.1","192.168.5.1","255.255.255.0"

AT+CWSTARTSMART:开启 SmartConfig

执行命令

功能:

开启 ESP-TOUCH+AirKiss 兼容模式

命令:

AT+CWSTARTSMART

设置命令

功能:

开启某指定类型的 SmartConfig

命令:

AT+CWSTARTSMART=<type>[,<auth floor>][,<"esptouch v2 key">]

响应:

OK

参数

  • <type>:类型

    • 1: ESP-TOUCH

    • 2: AirKiss

    • 3: ESP-TOUCH+AirKiss

    • 4: ESP-TOUCH v2

  • <auth floor>:Wi-Fi 认证模式阈值,ESP-AT 不会连接到 authmode 低于此阈值的 AP

    • 0: OPEN(默认)

    • 1: WEP

    • 2: WPA_PSK

    • 3: WPA2_PSK

    • 4: WPA_WPA2_PSK

    • 5: WPA2_ENTERPRISE

    • 6: WPA3_PSK

    • 7: WPA2_WPA3_PSK

  • <”esptouch v2 key”>:ESP-TOUCH v2 的解密秘钥,用于解密 Wi-Fi 密码和自定义数据。长度应为 16 字节。

说明

  • 更多有关 SmartConfig 的信息,请参考 ESP-TOUCH 使用指南

  • SmartConfig 仅支持在 ESP32-C3 Station 模式下调用;

  • 消息 Smart get Wi-Fi info 表示 SmartConfig 成功获取到 AP 信息,之后 ESP32-C3 尝试连接 AP;

  • 消息 +SCRD:<length>,<rvd data> 表示 ESP-Touch v2 成功获取到自定义数据;

  • 消息 Smartconfig connected Wi-Fi 表示成功连接到 AP;

  • 因为 ESP32-C3 设备需要将 SmartConfig 配网结果同步给手机端,所以建议在消息 Smartconfig connected Wi-Fi 输出后延迟超过 6 秒再调用 AT+CWSTOPSMART

  • 可调用 AT+CWSTOPSMART 停止 SmartConfig,然后再执行其他命令。注意,在 SmartConfig 过程中请勿执行其他命令。

示例

AT+CWMODE=1
AT+CWSTARTSMART

AT+CWSTOPSMART:停止 SmartConfig

执行命令

命令:

AT+CWSTOPSMART

响应:

OK

说明

  • 无论 SmartConfig 成功与否,都请在执行其他命令之前调用 AT+CWSTOPSMART 释放 SmartConfig 占用的内存

示例

AT+CWMODE=1
AT+CWSTARTSMART
AT+CWSTOPSMART

AT+WPS:设置 WPS 功能

设置命令

命令:

AT+WPS=<enable>[,<auth floor>]

响应:

OK

参数

  • <enable>

    • 1: 开启 PBC 类型的 WPS

    • 0: 关闭 PBC 类型的 WPS

  • <auth floor>: Wi-Fi 认证模式阈值,ESP-AT 不会连接到 authmode 低于此阈值的 AP

    • 0: OPEN(默认)

    • 1: WEP

    • 2: WPA_PSK

    • 3: WPA2_PSK

    • 4: WPA_WPA2_PSK

    • 5: WPA2_ENTERPRISE

    • 6: WPA3_PSK

    • 7: WPA2_WPA3_PSK

说明

  • WPS 功能必须在 ESP32-C3 Station 使能的情况下调用

  • WPS 不支持 WEP 加密方式

示例

AT+CWMODE=1
AT+WPS=1

AT+MDNS:设置 mDNS 功能

设置命令

命令:

AT+MDNS=<enable>[,<hostname>,<service_name>,<port>]

响应:

OK

参数

  • <enable>

    • 1: 开启 mDNS 功能,后续参数需要填写

    • 0: 关闭 mDNS 功能,后续参数无需填写

  • <hostname>:mDNS 主机名称

  • <service_name>:mDNS 服务名称

  • <port>:mDNS 端口

示例

AT+CWMODE=1
AT+CWJAP="1234567890","1234567890"
AT+MDNS=1,"espressif","_iot",8080
AT+MDNS=0

AT+CWJEAP:连接 WPA2 企业版 AP

查询命令

功能:

查询 ESP32-C3 station 连入的企业版 AP 的配置信息

命令:

AT+CWJEAP?

响应:

+CWJEAP:<ssid>,<method>,<identity>,<username>,<password>,<security>
OK

设置命令

功能:

连接到目标企业版 AP

命令:

AT+CWJEAP=<ssid>,<method>,<identity>,<username>,<password>,<security>[,<jeap_timeout>]

响应:

OK

+CWJEAP:Timeout
ERROR

参数

  • <ssid>:企业版 AP 的 SSID

    • 如果 SSID 或密码中包含 ,"\\ 等特殊字符,需转义

  • <method>:WPA2 企业版认证方式

    • 0: EAP-TLS

    • 1: EAP-PEAP

    • 2: EAP-TTLS

  • <identity>:阶段 1 的身份,字符串限制为 1 ~ 32

  • <username>:阶段 2 的用户名,范围:1 ~ 32 字节,EAP-PEAP、EAP-TTLS 两种认证方式需设置本参数,EAP-TLS 方式无需设置本参数

  • <password>:阶段 2 的密码,范围:1 ~ 32 字节,EAP-PEAP、EAP-TTLS 两种认证方式需设置本参数,EAP-TLS 方式无需设置本参数

  • <security>

    • Bit0: 客户端证书

    • Bit1: 服务器证书

  • [<jeap_timeout>]AT+CWJEAP 命令的最大超时时间,单位:秒,默认值:15,范围:[3,600]

示例

// 连接至 EAP-TLS 认证方式的企业版 AP,设置身份,验证服务器证书,加载客户端证书
AT+CWJEAP="dlink11111",0,"example@espressif.com",,,3

// 连接至 EAP-PEAP 认证方式的企业版 AP,设置身份、用户名、密码,不验证服务器证书,不加载客户端证书
AT+CWJEAP="dlink11111",1,"example@espressif.com","espressif","test11",0

错误代码:

WPA2 企业版错误码以 ERR CODE:0x<%08x> 格式打印:

AT_EAP_MALLOC_FAILED

0x8001

AT_EAP_GET_NVS_CONFIG_FAILED

0x8002

AT_EAP_CONN_FAILED

0x8003

AT_EAP_SET_WIFI_CONFIG_FAILED

0x8004

AT_EAP_SET_IDENTITY_FAILED

0x8005

AT_EAP_SET_USERNAME_FAILED

0x8006

AT_EAP_SET_PASSWORD_FAILED

0x8007

AT_EAP_GET_CA_LEN_FAILED

0x8008

AT_EAP_READ_CA_FAILED

0x8009

AT_EAP_SET_CA_FAILED

0x800A

AT_EAP_GET_CERT_LEN_FAILED

0x800B

AT_EAP_READ_CERT_FAILED

0x800C

AT_EAP_GET_KEY_LEN_FAILED

0x800D

AT_EAP_READ_KEY_FAILED

0x800E

AT_EAP_SET_CERT_KEY_FAILED

0x800F

AT_EAP_ENABLE_FAILED

0x8010

AT_EAP_ALREADY_CONNECTED

0x8011

AT_EAP_GET_SSID_FAILED

0x8012

AT_EAP_SSID_NULL

0x8013

AT_EAP_SSID_LEN_ERROR

0x8014

AT_EAP_GET_METHOD_FAILED

0x8015

AT_EAP_CONN_TIMEOUT

0x8016

AT_EAP_GET_IDENTITY_FAILED

0x8017

AT_EAP_IDENTITY_LEN_ERROR

0x8018

AT_EAP_GET_USERNAME_FAILED

0x8019

AT_EAP_USERNAME_LEN_ERROR

0x801A

AT_EAP_GET_PASSWORD_FAILED

0x801B

AT_EAP_PASSWORD_LEN_ERROR

0x801C

AT_EAP_GET_SECURITY_FAILED

0x801D

AT_EAP_SECURITY_ERROR

0x801E

AT_EAP_METHOD_SECURITY_UNMATCHED

0x801F

AT_EAP_PARAMETER_COUNTS_ERROR

0x8020

AT_EAP_GET_WIFI_MODE_ERROR

0x8021

AT_EAP_WIFI_MODE_NOT_STA

0x8022

AT_EAP_SET_CONFIG_FAILED

0x8023

AT_EAP_METHOD_ERROR

0x8024

说明

  • AT+SYSSTORE=1,配置更改将保存到 NVS 分区

  • 使用本命令需开启 Station 模式

  • 使用 TLS 认证方式需使能客户端证书

AT+CWHOSTNAME:查询/设置 ESP32-C3 Station 的主机名称

查询命令

功能:

查询 ESP32-C3 Station 的主机名称

命令:

AT+CWHOSTNAME?

响应:

+CWHOSTNAME:<hostname>

OK

设置命令

功能:

设置 ESP32-C3 Station 的主机名称

命令:

AT+CWHOSTNAME=<hostname>

响应:

OK

若没开启 Station 模式,则返回:

ERROR

参数

  • <hostname>:ESP32-C3 Station 的主机名称,最大长度:32 字节

说明

  • 配置更改不保存到 flash

示例

AT+CWMODE=3
AT+CWHOSTNAME="my_test"

AT+CWCOUNTRY:查询/设置 Wi-Fi 国家代码

查询命令

功能:

查询 Wi-Fi 国家代码

命令:

AT+CWCOUNTRY?

响应:

+CWCOUNTRY:<country_policy>,<country_code>,<start_channel>,<total_channel_count>

OK

设置命令

功能:

设置 Wi-Fi 国家代码

命令:

AT+CWCOUNTRY=<country_policy>,<country_code>,<start_channel>,<total_channel_count>

响应:

OK

参数

  • <country_policy>

    • 0: 将国家代码改为 ESP32-C3 设备连入的 AP 的国家代码

    • 1: 不改变国家代码,始终保持本命令设置的国家代码

  • <country_code>:国家代码,最大长度:3 个字符,各国国家代码请参考 ISO 3166-1 alpha-2 标准。

  • <start_channel>:起始信号道,范围:[1,14]

  • <total_channel_count>:信道总个数

说明

示例

AT+CWMODE=3
AT+CWCOUNTRY=1,"CN",1,13