TCP/IP AT 命令¶
- AT+CIPV6: 启用/禁用 IPv6 网络 (IPv6)
- AT+CIPSTATUS:查询 TCP/UDP/SSL 连接状态和信息
- AT+CIPDOMAIN:域名解析
- AT+CIPSTART:建立 TCP 连接、UDP 传输或 SSL 连接
- AT+CIPSTARTEX:建立自动分配 ID 的 TCP 连接、UDP 传输或 SSL 连接
- [仅适用透传模式] +++: 退出 透传模式
- AT+CIPSEND:在 普通传输模式 或 Wi-Fi 透传模式 下发送数据
- AT+CIPSENDEX:在 普通传输模式 下采用扩展的方式发送数据
- AT+CIPCLOSE:关闭 TCP/UDP/SSL 连接
- AT+CIFSR:查询本地 IP 地址和 MAC 地址
- AT+CIPMUX:启用/禁用多连接模式
- AT+CIPSERVER:建立/关闭 TCP 或 SSL 服务器
- AT+CIPSERVERMAXCONN:查询/设置服务器允许建立的最大连接数
- AT+CIPMODE:查询/设置传输模式
- AT+SAVETRANSLINK:设置开机 透传模式 信息
- AT+CIPSTO:查询/设置本地 TCP 服务器超时时间
- AT+CIPSNTPCFG:查询/设置时区和 SNTP 服务器
- AT+CIPSNTPTIME:查询 SNTP 时间
- AT+CIUPDATE:通过 Wi-Fi 升级固件
- AT+CIPDINFO:设置 +IPD 消息详情
- AT+CIPSSLCCONF:查询/设置 SSL 客户端配置
- AT+CIPSSLCCN:查询/设置 SSL 客户端的公用名 (common name)
- AT+CIPSSLCSNI:查询/设置 SSL 客户端的 SNI
- AT+CIPSSLCALPN:查询/设置 SSL 客户端 ALPN
- AT+CIPSSLCPSK:查询/设置 SSL 客户端的 PSK
- AT+CIPRECONNINTV:查询/设置 Wi-Fi 透传模式 下的 TCP/UDP/SSL 重连间隔
- AT+CIPRECVMODE:查询/设置 socket 接收模式
- AT+CIPRECVDATA:获取被动接收模式下的 socket 数据
- AT+CIPRECVLEN:查询被动接收模式下 socket 数据的长度
- AT+PING:ping 对端主机
- AT+CIPDNS:查询/设置 DNS 服务器信息
- AT+CIPTCPOPT:查询/设置 socket 选项
AT+CIPV6: 启用/禁用 IPv6 网络 (IPv6)¶
参数¶
- <enable>: IPv6 网络使能状态。 默认值:0
- 0: 禁用 IPv6 网络
- 1: 启用 IPv6 网络
说明¶
- 在使用基于 IPv6 网络的上层应用前,需要先启用 IPv6 网络。(例如:基于 IPv6 网络使用 TCP/UDP/SSL/PING/DNS,也称为 TCP6/UDP6/SSL6/PING6/DNS6 或 TCPv6/UDPv6/SSLv6/PINGv6/DNSv6)
AT+CIPSTATUS:查询 TCP/UDP/SSL 连接状态和信息¶
执行命令¶
命令:
AT+CIPSTATUS
响应:
STATUS:<stat>
+CIPSTATUS:<link ID>,<"type">,<"remote IP">,<remote port>,<local port>,<tetype>
OK
参数¶
- <stat>:ESP station 接⼝的状态
- 0: ESP station 为未初始化状态
- 1: ESP station 为已初始化状态,但还未开始 Wi-Fi 连接
- 2: ESP station 已连接 AP,获得 IP 地址
- 3: ESP station 已建立 TCP、UDP 或 SSL 传输
- 4: ESP 设备所有的 TCP、UDP 和 SSL 均断开
- 5: ESP station 开始过 Wi-Fi 连接,但尚未连接上 AP 或从 AP 断开
- <link ID>:网络连接 ID (0 ~ 4),用于多连接的情况
- <”type”>:字符串参数,表示传输类型:”TCP”、”UDP”、”SSL”、”TCPv6”、”UDPv6” 或 “SSLv6”
- <”remote IP”>:字符串参数,表示远端 IPv4 地址或 IPv6 地址
- <remote port>:远端端口值
- <local port>:ESP 本地端口值
- <tetype>:
- 0: ESP 设备作为客户端
- 1: ESP 设备作为服务器
AT+CIPDOMAIN:域名解析¶
参数¶
- <”domain name”>:待解析的域名
- <ip network>:首选 IP 网络。默认值:1
- 1:首选解析为 IPv4 地址
- 2:只解析为 IPv4 地址
- 3:只解析为 IPv6 地址
- <”IP address”>:解析出的 IP 地址
示例¶
AT+CWMODE=1 // 设置 station 模式
AT+CWJAP="SSID","password" // 连接网络
AT+CIPDOMAIN="iot.espressif.cn" // 域名解析
// 域名解析,只解析为 IPv4 地址
AT+CIPDOMAIN="iot.espressif.cn",2
// 域名解析,只解析为 IPv6 地址
AT+CIPDOMAIN="ipv6.test-ipv6.com",3
// 域名解析,首选解析为 IPv4 地址
AT+CIPDOMAIN="ds.test-ipv6.com",1
AT+CIPSTART:建立 TCP 连接、UDP 传输或 SSL 连接¶
建立 TCP 连接¶
设置命令¶
命令:
// 单连接 (AT+CIPMUX=0):
AT+CIPSTART=<"type">,<"remote host">,<remote port>[,<keep alive>][,<"local IP">]
// 多连接 (AT+CIPMUX=1):
AT+CIPSTART=<link ID>,<"type">,<"remote host">,<remote port>[,<keep alive>][,<"local IP">]
响应:
CONNECT
OK
参数¶
- <link ID>:网络连接 ID (0 ~ 4),用于多连接的情况
- <”type”>:字符串参数,表示网络连接类型,”TCP” 或 “TCPv6”。默认值:”TCP”
- <”remote host”>:字符串参数,表示远端 IPv4 地址、IPv6 地址,或域名
- <remote port>:远端端口值
- <keep alive>:TCP keep-alive 间隔,默认值:0
- 0: 禁用 TCP keep-alive 功能
- 1 ~ 7200: 检测间隔,单位:秒
- <”local IP”>:连接绑定的本机 IPv4 地址或 IPv6 地址,该参数在本地多网络接口时和本地多 IP 地址时非常有用。默认为禁用,如果您想使用,需自行设置,空值也为有效值
说明¶
- 如果想基于 IPv6 网络建立 TCP 连接,需要先设置 AT+CIPV6=1,再通过 AT+CWJAP 获取到一个 IPv6 地址
<keep alive>
参数最终会配置到 socket 选项TCP_KEEPIDLE
,keepalive 另外的 socket 选项TCP_KEEPINTVL
默认会使用1
,TCP_KEEPCNT
默认会使用3
示例¶
AT+CIPSTART="TCP","iot.espressif.cn",8000
AT+CIPSTART="TCP","192.168.101.110",1000
AT+CIPSTART="TCP","192.168.101.110",1000,,"192.168.101.100"
AT+CIPSTART="TCPv6","test-ipv6.com",80
AT+CIPSTART="TCPv6","fe80::860d:8eff:fe9d:cd90",1000,,"fe80::411c:1fdb:22a6:4d24"
// esp-at 已通过 AT+CWJAP 获取到 IPv6 全局地址
AT+CIPSTART="TCPv6","2404:6800:4005:80b::2004",80,,"240e:3a1:2070:11c0:32ae:a4ff:fe80:65ac"
建立 UDP 传输¶
设置命令¶
命令:
// 单连接:(AT+CIPMUX=0)
AT+CIPSTART=<"type">,<"remote host">,<remote port>[,<local port>,<mode>,<"local IP">]
// 多连接:(AT+CIPMUX=1)
AT+CIPSTART=<link ID>,<"type">,<"remote host">,<remote port>[,<local port>,<mode>,<"local IP">]
响应:
CONNECT
OK
参数¶
- <link ID>:网络连接 ID (0 ~ 4),用于多连接的情况
- <”type”>:字符串参数,表示网络连接类型,”UDP” 或 “UDPv6”。默认值:”TCP”
- <”remote host”>:字符串参数,表示远端 IPv4 地址、IPv6 地址,或域名
- <remote port>:远端端口值
- <local port>:ESP 设备的 UDP 端口值
- <mode>:在 UDP Wi-Fi 透传下,本参数的值必须设为 0
- 0: 接收到 UDP 数据后,不改变对端 UDP 地址信息(默认)
- 1: 仅第一次接收到与初始设置不同的对端 UDP 数据时,改变对端 UDP 地址信息为发送数据设备的 IP 地址和端口
- 2: 每次接收到 UDP 数据时,都改变对端 UDP 地址信息为发送数据的设备的 IP 地址和端口
- <”local IP”>:连接绑定的本机 IPv4 地址或 IPv6 地址,该参数在本地多网络接口时和本地多 IP 地址时非常有用。默认为禁用,如果您想使用,需自行设置,空值也为有效值
说明¶
- 如果 UDP 连接中的远端 IP 地址是 IPv4 组播地址 (224.0.0.0 ~ 239.255.255.255),ESP 设备将发送和接收 UDPv4 组播
- 如果 UDP 连接中的远端 IP 地址是 IPv4 广播地址 (255.255.255.255),ESP 设备将发送和接收 UDPv4 广播
- 如果 UDP 连接中的远端 IP 地址是 IPv6 组播地址 (FF00:0:0:0:0:0:0:0 ~ FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF:FFFF),ESP 设备将基于 IPv6 网络,发送和接收 UDP 组播
- 使用参数
<mode>
前,需先设置参数<local port>
- 如果想基于 IPv6 网络建立 UDP 连接,需要先设置 AT+CIPV6=1, 再通过 AT+CWJAP 获取到一个 IPv6 地址
示例¶
// UDPv4 单播
AT+CIPSTART="UDP","192.168.101.110",1000,1002,2
AT+CIPSTART="UDP","192.168.101.110",1000,,,"192.168.101.100"
// 基于 IPv6 网络的 UDP 单播
AT+CIPSTART="UDPv6","fe80::32ae:a4ff:fe80:65ac",1000,,,"fe80::5512:f37f:bb03:5d9b"
// 基于 IPv6 网络的 UDP 多播
AT+CIPSTART="UDPv6","FF02::FC",1000,1002,0
建立 SSL 连接¶
设置命令¶
命令:
AT+CIPSTART=[<link ID>,]<"type">,<"remote host">,<remote port>[,<keep alive>,<"local IP">]
响应:
OK
参数¶
- <link ID>:网络连接 ID (0 ~ 4),用于多连接的情况
- <”type”>:字符串参数,表示网络连接类型,”SSL” 或 “SSLv6”。默认值:”TCP”
- <”remote host”>:字符串参数,表示远端 IPv4 地址、IPv6 地址,或域名
- <remote port>:远端端口值
- <keep alive>:SSL 保留配置,默认值:0
- <”local IP”>:连接绑定的本机 IPv4 地址或 IPv6 地址,该参数在本地多网络接口时和本地多 IP 地址时非常有用。默认为禁用,如果您想使用,需自行设置,空值也为有效值
说明¶
- SSL 连接数量取决于可用内存和最大连接数量;由于内存的限制,ESP8266 只能够创建一条 SSL 连接
- SSL 连接需占用大量内存,内存不足会导致系统重启
- 如果
AT+CIPSTART
命令是基于 SSL 连接,且每个数据包的超时时间为 10 秒,则总超时时间会变得更长,具体取决于握手数据包的个数 - 如果想基于 IPv6 网络建立 SSL 连接,需要先设置 AT+CIPV6=1, 再通过 AT+CWJAP 获取到一个 IPv6 地址
<keep alive>
参数最终会配置到 socket 选项TCP_KEEPIDLE
,keepalive 另外的 socket 选项TCP_KEEPINTVL
默认会使用1
,TCP_KEEPCNT
默认会使用3
示例¶
AT+CIPSTART="SSL","iot.espressif.cn",8443
AT+CIPSTART="SSL","192.168.101.110",1000,,"192.168.101.100"
// esp-at 已通过 AT+CWJAP 获取到 IPv6 全局地址
AT+CIPSTART="SSLv6","240e:3a1:2070:11c0:6972:6f96:9147:d66d",1000,,"240e:3a1:2070:11c0:55ce:4e19:9649:b75"
AT+CIPSTARTEX:建立自动分配 ID 的 TCP 连接、UDP 传输或 SSL 连接¶
本命令与 AT+CIPSTART 相似,不同点在于:在多连接的情况下 (AT+CIPMUX=1) 无需手动分配 ID,系统会自动为新建的连接分配 ID。
AT+CIPSEND:在 普通传输模式 或 Wi-Fi 透传模式 下发送数据¶
设置命令¶
功能:
普通传输模式 下,指定长度发送数据
命令:
// 单连接:(AT+CIPMUX=0)
AT+CIPSEND=<length>
// 多连接:(AT+CIPMUX=1)
AT+CIPSEND=<link ID>,<length>
// UDP 传输可指定对端主机和端口
AT+CIPSEND=[<link ID>,]<length>[,<"remote host">,<remote port>]
响应:
OK
>
上述响应表示 AT 已准备好接收串行数据,此时您可以输入数据,当 AT 接收到的数据长度达到 <length>
后,数据传输开始。
如果未建立连接或数据传输时连接被断开,返回:
ERROR
如果数据传输成功,返回:
SEND OK
执行命令¶
功能:
进入 Wi-Fi 透传模式
命令:
AT+CIPSEND
响应:
OK
>
或
ERROR
进入 Wi-Fi 透传模式,ESP8266 设备每次最大接收 2048 字节,最大发送 1460 字节;其他 ESP 设备每次最大接收 8192 字节,最大发送 2920 字节。如果当前接收的数据长度大于最大发送字节数,AT 将立即发送;否则,接收的数据将在 20 ms 内发送。当输入单独一包 +++ 时,退出 透传模式 下的数据发送模式,请至少间隔 1 秒再发下一条 AT 命令。
本命令必须在开启 透传模式 以及单连接下使用。若为 Wi-Fi UDP 透传,AT+CIPSTART 命令的参数 <mode>
必须设置为 0。
参数¶
- <link ID>:网络连接 ID (0 ~ 4),用于多连接的情况
- <length>:数据长度,最大值:2048 字节
- <”remote host”>:UDP 传输可以指定对端主机:IPv4 地址、IPv6 地址,或域名
- <remote port>:UDP 传输可以指定对端端口
AT+CIPSENDEX:在 普通传输模式 下采用扩展的方式发送数据¶
设置命令¶
功能:
普通传输模式 下,指定长度发送数据,或者使用字符串 \0
(0x5c, 0x30 ASCII) 触发数据发送
命令:
// 单连接:(AT+CIPMUX=0)
AT+CIPSENDEX=<length>
// 多连接:(AT+CIPMUX=1)
AT+CIPSENDEX=<link ID>,<length>
// UDP 传输可指定对端 IP 地址和端口:
AT+CIPSENDEX=[<link ID>,]<length>[,<"remote host">,<remote port>]
响应:
OK
>
上述响应表示 AT 已准备好接收串行数据,此时您可以输入指定长度的数据,当 AT 接收到的数据长度达到 <length>
后或数据中出现 \0
字符时,数据传输开始。
如果未建立连接或数据传输时连接被断开,返回:
ERROR
如果数据传输成功,返回:
SEND OK
参数¶
- <link ID>:网络连接 ID (0 ~ 4),用于多连接的情况
- <length>:数据长度,最大值:2048 字节
- <”remote host”>:UDP 传输可以指定对端主机:IPv4 地址、IPv6 地址,或域名
- <remote port>:UDP 传输可以指定对端端口
说明¶
- 当数据长度满足要求时,或数据中出现
\0
字符时 (0x5c,0x30 ASCII),数据传输开始,系统返回普通命令模式,等待下一条 AT 命令 - 如果数据中包含
\<any>
,则会去掉反斜杠,只使用<any>
符号 - 如果需要发送
\0
,请转义为\\0
AT+CIPCLOSE:关闭 TCP/UDP/SSL 连接¶
参数¶
- <link ID>:需关闭的网络连接 ID,如果设为 5,则表示关闭所有连接
AT+CIFSR:查询本地 IP 地址和 MAC 地址¶
执行命令¶
命令:
AT+CIFSR
响应:
+CIFSR:APIP,<"APIP">
+CIFSR:APIP6LL,<"APIP6LL">
+CIFSR:APIP6GL,<"APIP6GL">
+CIFSR:APMAC,<"APMAC">
+CIFSR:STAIP,<"STAIP">
+CIFSR:STAIP6LL,<"STAIP6LL">
+CIFSR:STAIP6GL,<"STAIP6GL">
+CIFSR:STAMAC,<"STAMAC">
+CIFSR:ETHIP,<"ETHIP">
+CIFSR:ETHIP6LL,<"ETHIP6LL">
+CIFSR:ETHIP6GL,<"ETHIP6GL">
+CIFSR:ETHMAC,<"ETHMAC">
OK
参数¶
- <”APIP”>: ESP SoftAP 的 IPv4 地址
- <”APIP6LL”>: ESP SoftAP 的 IPv6 本地链路地址
- <”APIP6GL”>: ESP SoftAP 的 IPv6 全局地址
- <”APMAC”>: ESP SoftAP 的 MAC 地址
- <”STAIP”>: ESP station 的 IPv4 地址
- <”STAIP6LL”>: ESP station 的 IPv6 本地链路地址
- <”STAIP6GL”>: ESP station 的 IPv6 全局地址
- <”STAMAC”>: ESP station 的 MAC 地址
- <”ETHIP”>: ESP ethernet 的 IPv4 地址
- <”ETHIP6LL”>: ESP ethernet 的 IPv6 本地链路地址
- <”ETHIP6GL”>: ESP ethernet 的 IPv6 全局地址
- <”ETHMAC”>: ESP ethernet 的 MAC 地址
说明¶
- 只有当 ESP 设备获取到有效接口信息后,才能查询到它的 IP 地址和 MAC 地址
AT+CIPMUX:启用/禁用多连接模式¶
参数¶
- <mode>:连接模式,默认值:0
- 0: 单连接
- 1: 多连接
说明¶
- 只有当所有连接都断开时才可更改连接模式
- 只有 普通传输模式 (AT+CIPMODE=0),才能设置为多连接
- 如果建立了 TCP/SSL 服务器,想切换为单连接,必须关闭服务器 (AT+CIPSERVER=0)
示例¶
AT+CIPMUX=1
AT+CIPSERVER:建立/关闭 TCP 或 SSL 服务器¶
查询命令¶
功能:
查询 TCP/SSL 服务器状态
命令:
AT+CIPSERVER?
响应:
+CIPSERVER:<mode>[,<port>,<"type">][,<CA enable>]
OK
参数¶
- <mode>:
- 0: 关闭服务器
- 1: 建立服务器
- <param2>:参数
<mode>
不同,则此参数意义不同:
- 如果
<mode>
是 1,<param2>
代表端口号。默认值:333- 如果
<mode>
是 0,<param2>
代表服务器是否关闭所有客户端。默认值:0
- 0:关闭服务器并保留现有客户端连接
- 1:关闭服务器并关闭所有连接
- <”type”>:服务器类型:”TCP”,”TCPv6”,”SSL”,或 “SSLv6”. 默认值:”TCP”。由于内存限制,此参数不适用于 ESP8266 设备
- <CA enable>:由于内存限制,此参数不适用于 ESP8266 设备
- 0:不使用 CA 认证
- 1:使用 CA 认证
说明¶
- 多连接情况下 (AT+CIPMUX=1),才能开启服务器
- 创建服务器后,自动建立服务器监听,最多只允许创建一个服务器
- 当有客户端接入,会自动占用一个连接 ID
- 如果想基于 IPv6 网络建立服务器,需要先设置 AT+CIPV6=1,再通过 AT+CWJAP 获取到一个 IPv6 地址
示例¶
// 建立 TCP 服务器
AT+CIPMUX=1
AT+CIPSERVER=1,80
// 建立 SSL 服务器
AT+CIPMUX=1
AT+CIPSERVER=1,443,"SSL",1
// 基于 IPv6 网络,创建 SSL 服务器
AT+CIPMUX=1
AT+CIPSERVER=1,443,"SSLv6",0
// 关闭服务器并且关闭所有连接
AT+CIPSERVER=0,1
AT+CIPSERVERMAXCONN:查询/设置服务器允许建立的最大连接数¶
参数¶
- <num>:TCP 或 SSL 服务器允许建立的最大连接数
说明¶
- 如需设置最大连接数 (
AT+CIPSERVERMAXCONN=<num>
),请在创建服务器之前设置。
示例¶
AT+CIPMUX=1
AT+CIPSERVERMAXCONN=2
AT+CIPSERVER=1,80
AT+SAVETRANSLINK:设置开机 透传模式 信息¶
设置开机进入 TCP/SSL 透传模式 信息¶
参数¶
说明¶
- 本设置将 Wi-Fi 开机 透传模式 信息保存在 NVS 区,若参数
<mode>
为 1 ,下次上电自动进入 透传模式。需重启生效。 - 只要远端 IP 地址(域名)、端口的值符合规范,本设置就会被保存到 flash。
- 如果想基于 IPv6 网络建立透传连接,需要先设置 AT+CIPV6=1,再通过 AT+CWJAP 获取到一个 IPv6 地址
示例¶
AT+SAVETRANSLINK=1,"192.168.6.110",1002,"TCP"
AT+SAVETRANSLINK=1,"www.baidu.com",443,"SSL"
AT+SAVETRANSLINK=1,"240e:3a1:2070:11c0:55ce:4e19:9649:b75",8080,"TCPv6"
AT+SAVETRANSLINK=1,"240e:3a1:2070:11c0:55ce:4e19:9649:b75",8080,"SSLv6
设置开机进入 UDP 透传模式 信息¶
参数¶
说明¶
- 本设置将 Wi-Fi 开机 透传模式 信息保存在 NVS 区,若参数
<mode>
为 1 ,下次上电自动进入 透传模式。需重启生效 - 只要远端 IP 地址(域名)、端口的值符合规范,本设置就会被保存到 flash
- 如果想基于 IPv6 网络建立透传连接,需要先设置 AT+CIPV6=1,再通过 AT+CWJAP 获取到一个 IPv6 地址
示例¶
AT+SAVETRANSLINK=1,"192.168.6.110",1002,"UDP",1005
AT+SAVETRANSLINK=1,"240e:3a1:2070:11c0:55ce:4e19:9649:b75",8081,"UDPv6",1005
AT+CIPSTO:查询/设置本地 TCP/SSL 服务器超时时间¶
参数¶
- <time>:本地 TCP/SSL 服务器超时时间,单位:秒,取值范围:[0,7200]
说明¶
- 当 TCP/SSL 客户端在
<time>
时间内未发生数据通讯时,ESP 服务器会断开此连接。 - 如果设置参数
<time>
为 0,则连接永远不会超时,不建议这样设置。 - 在设定的时间内,当客户端发起与服务器的通信时,计时器将重新计时。超时后,客户端被关闭。在设定的时间内,如果服务器发起与客户端的通信,计时器将不会重新计时。超时后,客户端被关闭。
示例¶
AT+CIPMUX=1
AT+CIPSERVER=1,1001
AT+CIPSTO=10
AT+CIPSNTPCFG:查询/设置时区和 SNTP 服务器¶
查询命令¶
命令:
AT+CIPSNTPCFG?
响应:
+CIPSNTPCFG:<enable>,<timezone>,<SNTP server1>[,<SNTP server2>,<SNTP server3>]
OK
参数¶
- <enable>:设置 SNTP 服务器:
- 1: 设置 SNTP 服务器;
- 0: 不设置 SNTP 服务器。
- <timezone>:支持以下两种格式:
- 第一种格式的范围:[-12,14],它以小时为单位,通过与协调世界时 (UTC) 的偏移来标记大多数时区(UTC−12:00 至 UTC+14:00);
- 第二种格式为
UTC 偏移量
,UTC 偏移量
指定了你需要加多少时间到 UTC 时间上才能得到本地时间,通常显示为[+|-][hh]mm
。如果当地时区在本初子午线以西,则为负数,如果在东边,则为正数。小时 (hh) 必须在 -12 到 14 之间,分钟 (mm) 必须在 0 到 59 之间。例如,如果您想把时区设置为新西兰查塔姆群岛,即UTC+12:45
,您应该把<timezone>
参数设置为1245
,更多信息请参考 UTC 偏移量。
- [<SNTP server1>]:第一个 SNTP 服务器。
- [<SNTP server2>]:第二个 SNTP 服务器。
- [<SNTP server3>]:第三个 SNTP 服务器。
说明¶
- 设置命令若未填写以上三个 SNTP 服务器参数,则默认使用 “cn.ntp.org.cn”、”ntp.sjtu.edu.cn” 和 “us.pool.ntp.org” 其中之一。
- 对于查询命令,查询的
<timezone>
参数可能会和设置的<timezone>
参数不一样。因为<timezone>
参数支持第二种 UTC 偏移量格式,例如:设置AT+CIPSNTPCFG=1,015
,那么查询时,ESP-AT 会忽略时区参数的前导 0,即设置值是15
。不属于第一种格式,所以按照第二种 UTC 偏移量格式解析,也就是UTC+00:15
,也就是查询出来的是 0 时区。
示例¶
// 使能 SNTP 服务器,设置中国时区 (UTC+08:00)
AT+CIPSNTPCFG=1,8,"cn.ntp.org.cn","ntp.sjtu.edu.cn"
或
AT+CIPSNTPCFG=1,800,"cn.ntp.org.cn","ntp.sjtu.edu.cn"
// 使能 SNTP 服务器,设置美国纽约的时区 (UTC−05:00)
AT+CIPSNTPCFG=1,-5,"0.pool.ntp.org","time.google.com"
或
AT+CIPSNTPCFG=1,-500,"0.pool.ntp.org","time.google.com"
// 使能 SNTP 服务器,设置新西兰时区查塔姆群岛的时区 (Chatham Islands, UTC+12:45)
AT+CIPSNTPCFG=1,1245,"0.pool.ntp.org","time.google.com"
AT+CIPSNTPTIME:查询 SNTP 时间¶
说明¶
- 有关 asctime 时间的定义请见 asctime man page。
示例¶
AT+CIPSNTPCFG=1,8,"cn.ntp.org.cn","ntp.sjtu.edu.cn"
OK
AT+CIPSNTPTIME?
+CIPSNTPTIME:Mon Dec 12 02:33:32 2016
OK
AT+CIUPDATE:通过 Wi-Fi 升级固件¶
ESP-AT 在运行时,通过 Wi-Fi 从指定的服务器上下载新固件到某些分区,从而升级固件。
设置命令¶
功能:
升级到服务器上指定版本的固件
命令:
AT+CIUPDATE=<ota mode>[,<version>][,<firmware name>][,<nonblocking>]
响应:
+CIPUPDATE:<state>
OK
或
ERROR
参数¶
<ota mode>:
- 0: 通过 HTTP OTA;
- 1: 通过 HTTPS OTA,如果无效,请检查
./build.py menuconfig
>Component config
>AT
>OTA based upon ssl
是否使能,更多信息请见 Build Your Own ESP-AT Project。
<version>:AT 版本,如
v1.2.0.0
、v1.1.3.0
或v1.1.2.0
。<firmware name>:升级的固件,如
ota
、mqtt_ca
、client_ca
或其它at_customize.csv
中自定义的分区。<nonblocking>:
- 0: 阻塞模式的 OTA(此模式下,直到 OTA 升级成功或失败后才可以发送 AT 命令);
- 1: 非阻塞模式的 OTA(此模式下,升级完成后 (+CIPUPDATE:4) 需手动重启)。
<state>:
- 0: 空闲;
- 1: 找到服务器;
- 2: 连接至服务器;
- 3: 获得升级版本;
- 4: 完成升级;
- -1: 升级失败。
说明¶
- 升级速度取决于网络状况。
- 如果网络条件不佳导致升级失败,AT 将返回
ERROR
,请等待一段时间再试。 - 如果您直接使用乐鑫提供的 AT BIN, 本命令将从 Espressif Cloud 下载 AT 固件升级。
- 如果您使用的是自行编译的 AT BIN,请自行实现 AT+CIUPDATE FOTA 功能,可参考 ESP-AT 工程提供的示例 FOTA。
- 建议升级 AT 固件后,调用 AT+RESTORE 恢复出厂设置。
- 不建议升级到旧版本。
示例¶
AT+CIUPDATE
AT+CIUPDATE=1
AT+CIUPDATE=1,"v1.2.0.0"
AT+CIUPDATE=1,"v2.2.0.0","mqtt_ca"
AT+CIUPDATE=1,"V2.2.0.0","ota",1
AT+CIUPDATE=1,,,1
AT+CIUPDATE=1,,"ota",1
AT+CIUPDATE=1,"V2.2.0.0",,1
AT+CIPDINFO:设置 +IPD 消息详情¶
参数¶
- <mode>:
- 0: 在 “+IPD” 和 “+CIPRECVDATA” 消息中,不提示对端 IP 地址和端口信息
- 1: 在 “+IPD” 和 “+CIPRECVDATA” 消息中,提示对端 IP 地址和端口信息
示例¶
AT+CIPDINFO=1
AT+CIPSSLCCONF:查询/设置 SSL 客户端配置¶
查询命令¶
功能:
查询 ESP 作为 SSL 客户端时每个连接的配置信息
命令:
AT+CIPSSLCCONF?
响应:
+CIPSSLCCONF:<link ID>,<auth_mode>,<pki_number>,<ca_number>
OK
设置命令¶
命令:
// 单连接:(AT+CIPMUX=0)
AT+CIPSSLCCONF=<auth_mode>[,<pki_number>][,<ca_number>]
// 多连接:(AT+CIPMUX=1)
AT+CIPSSLCCONF=<link ID>,<auth_mode>[,<pki_number>][,<ca_number>]
响应:
OK
参数¶
- <link ID>:网络连接 ID (0 ~ max),在多连接的情况下,若参数值设为 max,则表示所有连接,本参数默认值为 5。
- <auth_mode>:
- 0: 不认证,此时无需填写
<pki_number>
和<ca_number>
参数; - 1: ESP-AT 提供客户端证书供服务器端 CA 证书校验;
- 2: ESP-AT 客户端载入 CA 证书来校验服务器端的证书;
- 3: 相互认证。
- 0: 不认证,此时无需填写
- <pki_number>:证书和私钥的索引,如果只有一个证书和私钥,其值应为 0。
- <ca_number>:CA 的索引,如果只有一个 CA,其值应为 0。
说明¶
- 如果想要本配置立即生效,请在建立 SSL 连接前运行本命令。
- 配置更改将保存在 NVS 区,如果您使用 AT+SAVETRANSLINK 命令设置开机进入 Wi-Fi SSL 透传模式,ESP 将在下次上电时基于本配置建立 SSL 连接。
AT+CIPSSLCCN:查询/设置 SSL 客户端的公用名 (common name)¶
设置命令¶
命令:
// 单连接:(AT+CIPMUX=0)
AT+CIPSSLCCN=<"common name">
// 多连接:(AT+CIPMUX=1)
AT+CIPSSLCCN=<link ID>,<"common name">
响应:
OK
参数¶
- <link ID>:网络连接 ID (0 ~ max),在单连接的情况下,本参数值为 0;在多连接的情况下,若参数值设为 max,则表示所有连接;本参数默认值为 5。
- <”common name”>:本参数用来认证服务器发送的证书中的公用名。公用名最大长度为 64 字节。
说明¶
- 如果想要本配置立即生效,请在建立 SSL 连接前运行本命令。
AT+CIPSSLCSNI:查询/设置 SSL 客户端的 SNI¶
设置命令¶
命令:
单连接:(AT+CIPMUX=0)
AT+CIPSSLCSNI=<"sni">
多连接:(AT+CIPMUX=1)
AT+CIPSSLCSNI=<link ID>,<"sni">
响应:
OK
参数¶
- <link ID>:网络连接 ID (0 ~ max),在单连接的情况下,本参数值为 0;在多连接的情况下,若参数值设为 max,则表示所有连接;本参数默认值为 5。
- <”sni”>:ClientHello 里的 SNI。SNI 最大长度为 64 字节。
说明¶
- 如果想要本配置立即生效,请在建立 SSL 连接前运行本命令。
AT+CIPSSLCALPN:查询/设置 SSL 客户端 ALPN¶
查询命令¶
功能:
查询 ESP 作为 SSL 客户端时每个连接的 ALPN 配置
命令:
AT+CIPSSLCALPN?
响应:
+CIPSSLCALPN:<link ID>,<"alpn">[,<"alpn">][,<"alpn">]
OK
设置命令¶
命令:
// 单连接:(AT+CIPMUX=0)
AT+CIPSSLCALPN=<counts>[,<"alpn">][,<"alpn">][,<"alpn">]
// 多连接:(AT+CIPMUX=1)
AT+CIPSSLCALPN=<link ID>,<counts>[,<"alpn">][,<"alpn">[,<"alpn">]
响应:
OK
参数¶
- <link ID>:网络连接 ID (0 ~ max),在单连接的情况下,本参数值为 0;在多连接的情况下,若参数值设为 max,则表示所有连接;本参数默认值为 5。
- <counts>:ALPN 的数量。范围:[0,5]。
- 0: 清除 ALPN 配置。
- [1,5]: 设置 ALPN 配置。
- <”alpn”>:字符串参数,表示 ClientHello 中的 ALPN。ALPN 最大长度受限于命令的最大长度。
说明¶
- 如果想要本配置立即生效,请在建立 SSL 连接前运行本命令。
AT+CIPSSLCPSK:查询/设置 SSL 客户端的 PSK¶
查询命令¶
功能:
查询 ESP 作为 SSL 客户端时每个连接的 PSK 配置
命令:
AT+CIPSSLCPSK?
响应:
+CIPSSLCPSK:<link ID>,<"psk">,<"hint">
OK
设置命令¶
命令:
// 单连接:(AT+CIPMUX=0)
AT+CIPSSLCPSK=<"psk">,<"hint">
// 多连接:(AT+CIPMUX=1)
AT+CIPSSLCPSK=<link ID>,<"psk">,<"hint">
响应:
OK
参数¶
- <link ID>:网络连接 ID (0 ~ max),在单连接的情况下,本参数值为 0;在多连接的情况下,若参数值设为 max,则表示所有连接;本参数默认值为 5。
- <”psk”>:PSK identity,最大长度:32。
- <”hint”>:PSK hint,最大长度:32。
说明¶
- 如果想要本配置立即生效,请在建立 SSL 连接前运行本命令。
AT+CIPRECONNINTV:查询/设置 Wi-Fi 透传模式 下的 TCP/UDP/SSL 重连间隔¶
参数¶
- <interval>:自动重连间隔时间,单位:100 毫秒,默认值:1,范围:[1,36000]。
说明¶
- 若 AT+SYSSTORE=1 时,配置更改将保存在 NVS 区。
示例¶
AT+CIPRECONNINTV=10
AT+CIPRECVMODE:查询/设置 socket 接收模式¶
参数¶
<mode>:socket 数据接收模式,默认值:0。
- 0: 主动模式,ESP-AT 将所有接收到的 socket 数据立即发送给主机 MCU,头为 “+IPD”。
- 1: 被动模式,ESP-AT 将所有接收到的 socket 数据保存到内部缓存区 (socket 接收窗口,ESP8266 设备默认为 5760 字节,非 ESP8266 设备默认值为 5744 字节),等待 MCU 读取。对于 TCP 和 SSL 连接,如果缓存区满了,将阻止 socket 传输;对于 UDP 传输,如果缓存区满了,则会发生数据丢失。
说明¶
- 该配置不能用于 Wi-Fi 透传模式。
- 当 ESP-AT 在被动模式下收到 socket 数据时,会根据情况的不同提示不同的信息:
- 多连接时 (AT+CIPMUX=1),提示
+IPD,<link ID>,<len>
; - 单连接时 (AT+CIPMUX=0),提示
+IPD,<len>
。
- 多连接时 (AT+CIPMUX=1),提示
<len>
表示缓存区中 socket 数据的总长度。- 一旦有
+IPD
报出,应该运行 AT+CIPRECVDATA 来读取数据。否则,在前一个+IPD
被读取之前,下一个+IPD
将不会被报告给主机 MCU。 - 在断开连接的情况下,缓冲的 socket 数据仍然存在,MCU 仍然可以读取,直到发送 AT+CIPCLOSE。换句话说,如果
+IPD
已经被报告,那么在你发送 AT+CIPCLOSE 或通过 AT+CIPRECVDATA 命令读取所有数据之前,这个连接的CLOSED
信息永远不会出现。
示例¶
AT+CIPRECVMODE=1
AT+CIPRECVDATA:获取被动接收模式下的 socket 数据¶
设置命令¶
命令:
// 单连接:(AT+CIPMUX=0)
AT+CIPRECVDATA=<len>
// 多连接:(AT+CIPMUX=1)
AT+CIPRECVDATA=<link_id>,<len>
响应:
+CIPRECVDATA:<actual_len>,<data>
OK
或
+CIPRECVDATA:<actual_len>,<remote IP>,<remote port>,<data>
OK
参数¶
- <link_id>:多连接模式下的连接 ID。
- <len>:最大值为:0x7fffffff,如果实际收到的数据长度比本参数值小,则返回实际长度的数据。
- <actual_len>:实际获取的数据长度。
- <data>:获取的数据。
- [<remote IP>]:字符串参数,表示对端 IP 地址,通过 AT+CIPDINFO=1 命令使能。
- [<remote port>]:对端端口,通过 AT+CIPDINFO=1 命令使能。
示例¶
AT+CIPRECVMODE=1
// 例如,如果主机 MCU 从 0 号连接中收到 100 字节的数据,
// 则会提示消息 "+IPD,0,100",
// 然后,您可以通过运行以下命令读取这 100 字节的数据:
AT+CIPRECVDATA=0,100
AT+CIPRECVLEN:查询被动接收模式下 socket 数据的长度¶
查询命令¶
功能:
查询某一连接中缓存的所有的数据长度
命令:
AT+CIPRECVLEN?
响应:
+CIPRECVLEN:<data length of link0>,<data length of link1>,<data length of link2>,<data length of link3>,<data length of link4>
OK
参数¶
- <data length of link>:某一连接中缓冲的所有的数据长度。
说明¶
- SSL 连接中,ESP-AT 将返回加密数据的长度,所以返回的长度会大于真实数据的长度。
示例¶
AT+CIPRECVLEN?
+CIPRECVLEN:100,,,,,
OK
AT+PING:ping 对端主机¶
设置命令¶
功能:
ping 对端主机
命令:
AT+PING=<"host">
响应:
+PING:<time>
OK
或
+PING:TIMEOUT // 只有在域名解析失败或 PING 超时情况下,才会有这个回复
ERROR
参数¶
- <”host”>:字符串参数,表示对端主机的 IPv4 地址,IPv6 地址,或域名。
- <time>:ping 的响应时间,单位:毫秒。
说明¶
- 如果想基于 IPv6 网络 ping 对端主机,需要先设置 AT+CIPV6=1,再通过 AT+CWJAP 获取到一个 IPv6 地址
- 如果远端主机是域名字符串,则 ping 将先通过 DNS 进行域名解析(优先解析 IPv4 地址),再 ping 对端主机 IP 地址
示例¶
AT+PING="192.168.1.1"
AT+PING="www.baidu.com"
// 下一代互联网国家工程中心
AT+PING="240c::6666"
AT+CIPDNS:查询/设置 DNS 服务器信息¶
查询命令¶
功能:
查询当前 DNS 服务器信息
命令:
AT+CIPDNS?
响应:
+CIPDNS:<enable>[,<"DNS IP1">,<"DNS IP2">,<"DNS IP3">]
OK
参数¶
- <enable>:设置 DNS
- 0: 启用自动获取 DNS 设置,DNS 将会恢复为
208.67.222.222
,只有当 DHCP 更新时才会生效; - 1: 启用手动设置 DNS 信息,如果不设置参数
<DNS IPx>
的值,则使用默认值208.67.222.222
。
- 0: 启用自动获取 DNS 设置,DNS 将会恢复为
- <DNS IP1>:第一个 DNS IP 地址,对于设置命令,只有当 <enable> 参数为 1 时,也就是启用手动 DNS 设置,本参数才有效;如果设置 <enable> 为 1,并为本参数设置一个值,当您运行查询命令时,ESP-AT 将把该参数作为当前的 DNS 设置返回。
- <DNS IP2>:第二个 DNS IP 地址,对于设置命令,只有当 <enable> 参数为 1 时,也就是启用手动 DNS 设置,本参数才有效;如果设置 <enable> 为 1,并为本参数设置一个值,当您运行查询命令时,ESP-AT 将把该参数作为当前的 DNS 设置返回。
- <DNS IP3>:第三个 DNS IP 地址,对于设置命令,只有当 <enable> 参数为 1 时,也就是启用手动 DNS 设置,本参数才有效;如果设置 <enable> 为 1,并为本参数设置一个值,当您运行查询命令时,ESP-AT 将把该参数作为当前的 DNS 设置返回。
说明¶
- 若 AT+SYSSTORE=1,配置更改将保存在 NVS 区。
- 这三个参数不能设置在同一个服务器上。
- 当
<enable>
为 0 时,DNS 服务器可能会根据 ESP 设备所连接的路由器的配置而改变。
示例¶
AT+CIPDNS=0
AT+CIPDNS=1,"208.67.222.222","114.114.114.114","8.8.8.8"
// 第一个基于 IPv6 的 DNS 服务器:下一代互联网国家工程中心
// 第二个基于 IPv6 的 DNS 服务器:google-public-dns-a.google.com
// 第三个基于 IPv6 的 DNS 服务器:江苏省主 DNS 服务器
AT+CIPDNS=1,"240c::6666","2001:4860:4860::8888","240e:5a::6666"
AT+CIPTCPOPT:查询/设置 socket 选项¶
查询命令¶
功能:
查询当前 socket 选项
命令:
AT+CIPTCPOPT?
响应:
+CIPTCPOPT:<link_id>,<so_linger>,<tcp_nodelay>,<so_sndtimeo>
OK
设置命令¶
命令:
// 单连接:(AT+CIPMUX=0):
AT+CIPTCPOPT=[<so_linger>],[<tcp_nodelay>],[<so_sndtimeo>]
// 多连接:(AT+CIPMUX=1):
AT+CIPTCPOPT=<link ID>,[<so_linger>],[<tcp_nodelay>],[<so_sndtimeo>]
响应:
OK
或
ERROR
参数¶
- <link_id>:网络连接 ID (0 ~ max),在多连接的情况下,若参数值设为 max,则表示所有连接;本参数默认值为 5。
- <so_linger>:配置 socket 的
SO_LINGER
选项,单位:秒,默认值:-1。- = -1: 关闭;
- = 0: 开启,linger time = 0;
- > 0: 开启,linger time = <so_linger>;
- <tcp_nodelay>:配置 socket 的
TCP_NODELAY
选项,默认值:0。- 0: 禁用 TCP_NODELAY
- 1: 启用 TCP_NODELAY
- <so_sndtimeo>:配置 socket 的
SO_SNDTIMEO
选项,单位:毫秒,默认值:0。