Fn-link 3121系列模组at指令集 v1.01

You might also like

Download as pdf or txt
Download as pdf or txt
You are on page 1of 16

3121 系列模组

AT 指令集
V1.0.01
3121 系列模组 AT 指令集

修改记录
文档版本 发布日期 发布人 修改说明
V1.0.01 2020.02.26 wade 创建

FN-LINK TECHNOLOGY LIMITED Proprietary & Confidential Information


3121 系列模组 AT 指令集

目录

1 概述 ............................................................................................................................. 1
2 工作模式描述 .............................................................................................................. 1
2.1 串口配置 ............................................................................................................ 1
2.2 工作模式切换 ..................................................................................................... 1
3 AT 指令说明 ................................................................................................................ 2
3.1 指令格式 ............................................................................................................ 2
1.1 AT 指令一览表 ................................................................................................... 2
4 AT 指令集详解 ............................................................................................................ 3
4.1 通用指令 ............................................................................................................ 3
4.1.1 AT+ECHO ...............................................................................................3
4.1.2 AT+EXIT .................................................................................................4
4.1.3 AT+LOG..................................................................................................4
4.1.4 AT+MODE ..............................................................................................4
4.1.5 AT+MID ..................................................................................................5
4.1.6 AT+GMR .................................................................................................5
4.1.7 AT+RESTORE .........................................................................................5
4.1.8 AT+RST ..................................................................................................5
4.1.9 AT+MAC .................................................................................................5
4.1.10 AT+HEAPSIZE ........................................................................................6
4.1.11 AT+HELP ................................................................................................6
4.2 串口指令 ............................................................................................................ 6
4.2.1 AT+UART ...............................................................................................6
4.3 网络相关指令 ..................................................................................................... 7
4.3.1 AT+TOPONUM .......................................................................................7
4.3.2 AT+TOPOINFO .......................................................................................7
4.3.3 AT+WHNUM ..........................................................................................8
4.3.4 AT+WHINFO ..........................................................................................8
4.3.5 AT+WHADD ...........................................................................................8
4.3.6 AT+WHDEL ............................................................................................9
4.3.7 AT+WHCLR ............................................................................................9
4.3.8 AT+WHSTATUS ......................................................................................9
4.3.9 AT+SEND................................................................................................9
4.3.10 AT+NOTIFY.......................................................................................... 10
4.3.11 AT+IDFSTATUS .................................................................................... 10
4.4 GPIO 相关指令 ................................................................................................. 11

FN-LINK TECHNOLOGY LIMITED Proprietary & Confidential Information


3121 系列模组 AT 指令集

4.4.1 AT+IOPARAM ...................................................................................... 11


4.4.2 AT+IOCTRL .......................................................................................... 11

FN-LINK TECHNOLOGY LIMITED Proprietary & Confidential Information


3121 系列模组 AT 指令集

1 概述
本文档重点描述 FN-LINK 3121 系列模组的串口指令使用方法。

2 工作模式描述
PLC-IOT 模组固件提供两种工作模式,包括:AT 指令控制模式、透明传输模式。
 AT 指令控制模式:用户在该模式下可以读取或设置模组参数,比如可以获取 PLC 网
络拓扑结构、设置 CCO 白名单,设置 GPIO 工作模式等。
 透明传输工作模式:用户在该模式下可以在 CCO 和 STA 之间透明传输数据,通过 CCO
透传数据,数据为广播发送,所有 STA 可收到数据;通过 STA 透传数据,CCO 可收
到数据。

2.1 串口配置

PLC-IOT 模组上电后默认工作在透明传输模式,用户可以连接模组 UART0 串口,通过串


口命令切换到其他工作模式,模组的缺省 UART 参数配置如下:

图 1 缺省 UART 参数

在 AT 指令模式下,用户可以通过 AT+指令通过 UART 对模块进行配置。

2.2 工作模式切换

 AT 指令控制模式透明传输工作模式/模组协议工作模式
发送指令“AT+EXIT”,进入模组初始默认的工作模式。
 透明传输工作模式/模组协议工作模式AT 指令控制模式
发送指令“+++”
,进入 AT 指令控制模式。

FN-LINK TECHNOLOGY LIMITED 1 Proprietary & Confidential Information


3121 系列模组 AT 指令集

3 AT 指令说明

3.1 指令格式

AT 指令采用基于 ASCII 码的命令行,格式如下:


命令消息
AT+<CMD>[op][para1,para2,para3…]<CR><LP>
 AT+ :命令前缀
 CMD:指令码
 op:指令操作符,表示该指令为设置命令或查询命令;
“=”:表示参数设置
“NULL”:表示参数查询
 para:设置命令输入的参数
 <CR><LF>:结束符,回车换行,编程代码实现以“\r\n”结束。

响应消息
+<rsp>[op][para1,para2,para3…]<CR><LP><CR><LP>
 rsp :响应字符串
“ok”:表示成功
“err”:表示失败
 [op]:=
 paraN:查询时返回的参数
 <CR>:ASCII 码 0x0d
 <LF>:ASCII 码 0x0a
 错误码
错误码 说明
-1 无此指令
-2 不允许执行
-3 执行失败
-4 参数有错误

1.1 AT 指令一览表

AT 指令集 指令集描述
通用指令
AT+ECHO 打开/关闭回显功能
AT+EXIT 退出 AT 指令控制模式,进入初始默认的工作模式
AT+LOG 打开/关闭日志

FN-LINK TECHNOLOGY LIMITED 2 Proprietary & Confidential Information


3121 系列模组 AT 指令集

AT+MODE 设置初始工作模式
AT+MID 查询模组型号
AT+GMR 查询模组软件版本
AT+RESTORE 恢复出厂设置
AT+RST 重启模块
AT+MAC 设置/获取 mac 地址
AT+HEAPSIZE 获取模组空闲堆栈大小
AT+HELP 帮助指令
串口指令
AT+UART 设置/查询 UART 参数
网络相关指令
AT+TOPONUM 获取网络拓扑节点数量
AT+TOPOINFO 获取网络拓扑节点信息
AT+WHNUM 获取白名单数量
AT+WHINFO 获取白名单信息
AT+WHADD 添加白名单
AT+WHDEL 删除白名单
AT+WHCLR 清除白名单
AT+WHSTATUS 设置/查询白名单状态
AT+SEND 数据发送
AT+NOTIFY 开启/关闭入网通知
AT+IDFSTATUS 开启/关闭自动组网
GPIO 相关指令
AT+IOPARAM 设置/查询 GPIO 初始值
AT+IOCTRL 设置/查询 GPIO 状态

4 AT 指令集详解

4.1 通用指令

4.1.1 AT+ECHO

 功能:打开/关闭回显功能
 格式:
SEND:AT+ECHO=<status><CR><LF>
RECV:+ok<CR><LF><CR><LF>/+err<CR><LF><CR><LF>
 参数:

FN-LINK TECHNOLOGY LIMITED 3 Proprietary & Confidential Information


3121 系列模组 AT 指令集

status:回显状态
可设置为:1:打开回显;0:关闭回显
 说明:
模组回显功能默认关闭。

4.1.2 AT+EXIT

 功能:退出 AT 指令控制模式,进入初始默认的模式
 格式:
SEND:AT+EXIT<CR><LF>
RECV:+ok<CR><LF><CR><LF>/+err<CR><LF><CR><LF>

4.1.3 AT+LOG

 功能:打开/关闭日志打印功能
 格式:
SEND:AT+LOG=<status><CR><LF>
RECV:+ok<CR><LF><CR><LF>/+err<CR><LF><CR><LF>
 参数:
status:日志状态
可设置为:1:开启日志打印;0:关闭日志打印
 说明:
在透明传输工作模式时,做数据吞吐测试前,建议先关闭日志打印。

4.1.4 AT+MODE

 功能:设置/查询模组初始默认的工作模式
 格式:
 查询
SEND:AT+MODE<CR><LF>
RECV:+ok =<mode><CR><LF><CR><LF>
 设置
SEND:AT+MODE=<mode><CR><LF>
RECV:+ok<CR><LF><CR><LF>
 参数:
mode:工作模式
可设置为:0:透传传输工作模式; 2:AT指令控制模式
 说明:
设置后重启模组生效,模组以设置的工作模式启动。

FN-LINK TECHNOLOGY LIMITED 4 Proprietary & Confidential Information


3121 系列模组 AT 指令集

4.1.5 AT+MID

 功能:查询模组硬件型号
 格式:
SEND:AT+MID <CR><LF>
RECV:+mid=<module_id><CR><LF><CR><LF>
 参数:
module_id:PLC-IOT模组型号,如:3121N-H。

4.1.6 AT+GMR

 功能:查询模组软件版本
 格式:
SEND:AT+GMR<CR><LF>
RECV:+ver=<ver><CR><LF><CR><LF>
 参数:
ver:模组软件版本号,如:2.10.01。

4.1.7 AT+RESTORE

 功能:恢复出厂设置
 格式:
SEND:AT+RESTORE <CR><LF>
RECV:+ok<CR><LF><CR><LF>/+err<CR><LF><CR><LF>
 说明:
模块恢复出厂设置,擦除所有配置过的信息,操作成功后,需使用 AT+RST 指令重启模组。

4.1.8 AT+RST

 功能:模块重启
 格式:
SEND:AT+RST<CR><LF>
 RECV:+ok<CR><LF><CR><LF>/+err<CR><LF><CR><LF>

4.1.9 AT+MAC
 功能:设置/查询 MAC 地址
 格式:
 查询
SEND:AT+MAC<CR><LF>
RECV:+ok=<mac><CR><LF><CR><LF>

FN-LINK TECHNOLOGY LIMITED 5 Proprietary & Confidential Information


3121 系列模组 AT 指令集

 设置
SEND:AT+MAC=<mac<CR><LF>
RECV:+ok<CR><LF><CR><LF>
 参数:
mac:模组 mac 地址

4.1.10 AT+HEAPSIZE

 功能:获取模组空闲堆栈大小
 格式:
SEND:AT+HEAPSIZE<CR><LF>
RECV:+heap=<heap><CR><LF><CR><LF>
 参数:
heap:模组空闲堆栈大小,如:31.2k。

4.1.11 AT+HELP

 功能:帮助指令
 格式:
SEND:AT+HELP <CR><LF>
RECV:+ok=<cmd_help><CR><LF><CR><LF>
 参数:
cmd_help:命令帮助清单。

4.2 串口指令

4.2.1 AT+UART

 功能:设置/查询 UART 波特率


 格式:
 查询
SEND:AT+UART <CR><LF>
RECV:+ok=<baundrate>, <data_bits>,< stop_bits>, <parity_bits><CR><LF>
<CR><LF>
 设置
SEND:AT+UART= < baundrate>, <data_bits>,< stop_bits>,< parity_bits>
<CR><LF>
RECV:+ok<CR><LF><CR><LF>
 参数:
 baundrate:串口波特率

FN-LINK TECHNOLOGY LIMITED 6 Proprietary & Confidential Information


3121 系列模组 AT 指令集

默认为 115200,可设置为 2400、9600、38400、115200、380400、921600


 data_bits:数据位
默认为 8,可设置 5、6、7、8
 stop_bits:停止位
默认为 1,可设置为 1、2
 parity_bits:校验位
默认为 2,可设置为 0(无校验),1(奇校验),2(偶校验)
 说明:
设置波特率成功后,需要重启模块后生效。

4.3 网络相关指令

4.3.1 AT+TOPONUM

 功能:获取网络拓扑节点数量
 格式:
SEND:AT+TOPONUM<CR><LF>
RECV:+ok=<num><CR><LF><CR><LF>
 参数:
num:网络拓扑节点数量,包含CCO节点。
 说明:
该指令只适用于CCO模组。

4.3.2 AT+TOPOINFO

 功能:获取网络拓扑节点信息
 格式:
SEND:AT+TOPOINFO=<req_start>,<req_cnt><CR><LF>
RECV:+info=<mac>,<tei>,< proxy_tei>,<level>,<ability>,<snr>,<atten>,<phase>
<CR><LF>

 参数:
 req_start:起始序号,其中 1 为主节点,后续为从节点。
 req_cnt:查询的节点数量
 mac:节点的 mac 地址,6 字节,大端排序
 tei:节点标识
 proxy_tei:本站点的代理站点节点标识
 level:层级,0-15
 ablity:节点角色
 snr:平均信噪比

FN-LINK TECHNOLOGY LIMITED 7 Proprietary & Confidential Information


3121 系列模组 AT 指令集

 atten:衰减
 phase:相位
 说明:
该指令只适用于CCO模组。

4.3.3 AT+WHNUM

 功能:获取白名单数量
 格式:
SEND:AT+WHNUM<CR><LF>
RECV:+ok=<num ><CR><LF><CR><LF>
 参数:
num:白名单数量
 说明:
该指令只适用于CCO模组。

4.3.4 AT+WHINFO

 功能:获取白名单信息
 格式:
SEND:AT+WHINFO=<req_start>,<req_cnt><CR><LF>
RECV:+ok=< mac><CR><LF>

 参数:
 req_start:起始序号
 req_cnt:查询的白名单数量
 mac: 设备 mac 地址
 说明:
该指令只适用于CCO模组。

4.3.5 AT+WHADD

 功能:添加白名单
 格式:
SEND:AT+WHADD=<cnt>,<mac>….<CR><LF>
RECV:+ok<CR><LF><CR><LF>/+err<CR><LF><CR><LF>
 参数:
 cnt:待添加的白名单数量
 mac:待添加白名单设备 mac 地址,按照 cnt 数量依次添加。
 说明:
该指令只适用于 CCO 模组。生效时间依赖网络优化周期而定,大概 90s 左右。

FN-LINK TECHNOLOGY LIMITED 8 Proprietary & Confidential Information


3121 系列模组 AT 指令集

4.3.6 AT+WHDEL

 功能:删除白名单
 格式:
SEND:AT+WHDEL=<cnt>,<mac>….<CR><LF>
RECV:+ok<CR><LF><CR><LF>/+err<CR><LF><CR><LF>
 参数:
 cnt:待删除的白名单数量
 mac:待删除白名单设备 mac 地址,按照 cnt 数量依次删除。
 说明:
该指令只适用于 CCO 模组。生效时间依赖网络优化周期而定,大概 90s 左右。

4.3.7 AT+WHCLR

 功能:清除白名单
 格式:
SEND:AT+WHCLR<CR><LF>
RECV:+ok<CR><LF><CR><LF>/+error<CR><LF><CR><LF>
 说明:
该指令只适用于CCO模组。生效时间依赖网络优化周期而定,大概90s左右。

4.3.8 AT+WHSTATUS

 功能:设置/查询白名单状态
 格式:
 查询
SEND:AT+WHSTATUS<CR><LF>
RECV:+ok =<status><CR><LF><CR><LF>
 设置
SEND:AT+WHSTATUS=<status><CR><LF>
RECV:+ok<CR><LF><CR><LF>
 参数:
status:白名单状态
可设置为:1:白名单开启;0:白名单关闭
 说明:
该指令只适用于CCO模组。生效时间依赖网络优化周期而定,大概90s左右。

4.3.9 AT+SEND
 功能:数据发送
 格式:

FN-LINK TECHNOLOGY LIMITED 9 Proprietary & Confidential Information


3121 系列模组 AT 指令集

SEND:AT+SEND=<mac>,<len>,<data><CR><LF>
RECV:+ok<CR><LF><CR><LF>
 参数:
 mac:远程控制的 STA 模组地址
16 进制字符串,如 112233445566。
 len:待发送数据的长度
 data:待发送的数据
16 进制字符串
 说明:
该指令可以实现 CCO 模组向 STA 模组点对点数据发送,也可实现 STA 模组往 CCO
模组数据发送。

4.3.10 AT+NOTIFY
 功能:开启/关闭入网通知
 格式:
 查询
SEND:AT+NOTIFY<CR><LF>
RECV:+ok=<status><CR><LF><CR><LF>
 设置
SEND:AT+NOTIFY=<status><CR><LF>
RECV:+ok<CR><LF><CR><LF>
 参数:
status:入网通知状态
0:关闭通知;1:开启通知
 说明:
开启入网通知后,STA 入网时,会主动向串口发送“+online:<mac>”消息。

4.3.11 AT+IDFSTATUS
 功能:开启/关闭自动组网
 格式:
SEND:AT+IDFSTATUS=<status><CR><LF>
RECV:+ok<CR><LF><CR><LF>
 参数:
status:自动组网状态
0:关闭自动组网;1:开启自动组网
 说明
该指令只适用于 CCO 模组。通过该指令开启自动组网后,需重启模组,CCO 模组会
将 5min 之内上电的 STA 模组自动添加到白名单,并开启白名单,完成自动组网。

FN-LINK TECHNOLOGY LIMITED 10 Proprietary & Confidential Information


3121 系列模组 AT 指令集

4.4 GPIO 相关指令

4.4.1 AT+IOPARAM
 功能:设置/查询 GPIO 初始值
 格式:
 查询
SEND:AT+IOPARAM<CR><LF>
RECV:
+info=<pin >,<type>,<state>,<pwm_freq>,<pwm_ctl_mode>,<pwm_adjust_time><CR><LF>

 设置
SEND:AT+IOPARAM=<pin >,<type>,<state>,<pwm_freq>,<pwm_ctl_mode>,
<pwm_adjust_time><CR><LF>
RECV:+ok<CR><LF><CR><LF>
 参数:
 pin:引脚编号
可设置为 0-5,19,20。其中 0-5 可设置为 GPIO 电平模式和 PWM 模式,19,20 只能
设置为 GPIO 电平模式,原则上不建议用户修改引脚编号。
 type:引脚类型
1:GPIO 电平模式;2:PWM 模式
 state:引脚状态值
当 type 引脚类型为 GPIO 电平模式时,0:低电平;1:高电平
当 type 引脚类型为 PWM 模式时,可设置 0-100
 pwm_freq:PWM 频率
 pwm_ctl_mode:PWM 调频模式
0:实时调频;1:线性渐变调频;2:对数渐变调频
 pwm_adjust_time:PWM 调频渐变时长
 说明:
该指令只适用于 STA 模组。

4.4.2 AT+IOCTRL
 功能:设置/查询 GPIO 状态
 格式:
 查询
SEND:AT+IOCTRL=<mac>,<pin><CR><LF>
RECV:+getgpio=<mac >,<pin>,<state><CR><LF>
+ok<CR><LF><CR><LF>
 设置

FN-LINK TECHNOLOGY LIMITED 11 Proprietary & Confidential Information


3121 系列模组 AT 指令集

SEND:AT+IOCTRL=<mac >,<pin>,<state><CR><LF>
RECV:+ok<CR><LF><CR><LF>
 参数:
 mac:远程控制的 STA 模组地址
16 进制字符串,如 112233445566
 pin:引脚编号,
可设置为 0-5,19,20。其中 0-5 可设置为 GPIO 电平模式和 PWM 模式,19,20 只能
设置为 GPIO 电平模式,原则上不建议用户修改引脚编号。
 state:引脚状态值
需要与对应 pin 引脚类型 type 一致。
当 type 引脚类型为 GPIO 电平模式时,0:低电平;1:高电平
当 type 引脚类型为 PWM 模式时,可设置 0-100
 说明:
该指令只适用于 CCO 模组,通过 CCO 对 STA 模组进行远程 GPIO 控制。

FN-LINK TECHNOLOGY LIMITED 12 Proprietary & Confidential Information

You might also like