rt-thread AT组件学习梳理

目录

一、at组件简介

二、数据结构

1、响应数据 at_response

2、URC数据 at_urc

3、at客服端句柄 at_client

三、API

1、at client 数据收发

2、at client 数据解析

3、urc数据列表初始化

4、其他

四、at client 流程梳理

---

一、at组件简介

AT 组件是基于RT-Thread 系统的AT Server 和AT Client 的实现，组件完成AT 命令的发送、命令格式及参数判断、命令的响应、响应数据的接收、响应数据的解析、URC 数据处理等整个AT 命令数据交互流程。

通过AT 组件，设备可以作为AT Client 使用串口连接其他设备发送并接收解析数据，可以作为AT Server 让其他设备甚至电脑端连接完成发送数据的响应，也可以在本地shell 启动CLI 模式使设备同时支持AT Server 和AT Client 功能，该模式多用于设备开发调试。

• 响应数据：AT Client 发送命令之后收到的AT Server 响应状态和信息。
• URC 数据：AT Server 主动发送给AT Client 的数据，一般出现在一些特殊的情况，比如WIFI 连接断开、TCP 接收数据等，这些情况往往需要用户做出相应操作。

AT 组件资源占用：

• AT Client 功能：4.6K ROM 和2.0K RAM；
• AT Server 功能：4.0K ROM 和2.5K RAM；
• AT CLI 功能：1.5K ROM ，几乎没有使用RAM

以上摘自《rtthread用户编程手册》，下面是对at组件代码的分析和流程的梳理，我仅分析了AT Client的代码；将分为数据和方法(接口api)两方面进行讲解，所有api的是在对数据进行读、写、搬运，以实现想要的功能，在搬运数据的过程中还需要对数据存储空间进行管理，申请的动态缓冲区用完后一定要释放。

二、数据结构

1、响应数据 at_response

struct at_response

{

    char *buf; /* response buffer */

    rt_size_t buf_size; /* the maximum response buffer size */

    rt_size_t line_num; /* the number of setting response lines

    * == 0: the response data will auto return when received 'OK' or 'ERROR'
    
    * != 0: the response data will return when received setting lines number data*/

    rt_size_t line_counts; /* the count of received response lines */

    rt_int32_t timeout; /* the maximum response time */

};

typedef struct at_response *at_response_t;

2、URC数据 at_urc

/* URC(Unsolicited Result Code) object, such as: 'RING', 'READY' request by AT server */

struct at_urc

{

    const char *cmd_prefix; //需要匹配的头部命令

    const char *cmd_suffix; //需要匹配的尾部命令

    void (*func)(const char *data, rt_size_t size);//匹配成功后执行的处理回调函数

};

typedef struct at_urc *at_urc_t;

3、at客服端句柄 at_client

struct at_client

{

    rt_device_t device;

    at_status_t status; //未初始化、已经初始化完成、忙碌

    char end_sign; //可设置的接收结束匹配标识

    char * recv_buffer;//at_client_init时申请的recv_bufsz大小接收数据缓 冲区，定长，
                        长期占用

    rt_size_t recv_bufsz;//接收缓冲区的最大长度

    rt_size_t cur_recv_len;//当前接收的数据长度

    rt_sem_t rx_notice; //uart接收中断与parser线程之间同步的信号量

    rt_mutex_t lock; //发送数据时的资源保护互斥锁

    at_response_t resp; //用户自行注册管理的响应数据缓冲区

    rt_sem_t resp_notice; //parser线程与用户线程之间同步的信号量

    at_resp_status_t resp_status; //响应数据接收状态，ok、error、timeout、full

    const struct at_urc *urc_table; //用户自行创建的urc匹配表项

    rt_size_t urc_table_size;//urc命令条数

    rt_thread_t parser; //响应数据接收、urc数据接收处理的处理线程

};

三、API

1、at client 数据收发

创建响应结构体并申请响应数据接收缓冲区

at_response_t at_create_resp(rt_size_t buf_size, rt_size_t line_num, rt_int32_t timeout);

 

删除响应结构体并释放响应数据接收缓冲区

void at_delete_resp(at_response_t resp);

 

设置响应结构体信息

at_response_t at_resp_set_info(at_response_t resp, rt_size_t buf_size, rt_size_t line_num, rt_int32_t timeout);

 

发送命令并接收响应

rt_err_t at_exec_cmd(at_response_t resp, const char *cmd_expr, ...);

2、at client 数据解析

获取指定行号的响应数据

const char *at_resp_get_line(at_response_t resp, rt_size_t resp_line);

 

获取指定行号的响应数据

const char *at_resp_get_line_by_kw(at_response_t resp, const char *keyword);

 

根据resp_expr格式使用标准sscanf 解析语法，解析指定行的响应数据

int at_resp_parse_line_args(at_response_t resp, rt_size_t resp_line, const char *resp_expr, ...);

 

根据resp_expr格式使用标准sscanf 解析语法，解析指定关键字的响应数据

int at_resp_parse_line_args_by_kw(at_response_t resp, const char *keyword, const char *resp_expr, ...);

3、urc数据列表初始化

void at_set_urc_table(const struct at_urc *table, rt_size_t size);

4、其他

设置接收数据行结束符

void at_set_end_sign(char ch);

 

等待模块初始化完成，用于AT 模块启动时循环发送AT 命令，直到模块响应数据

int at_client_wait_connect(rt_uint32_t timeout);

四、at client 流程梳理

在整个流程中会使用到3个缓存buffer：

client->recv_buffer，响应数据和urc数据接收缓存，在at_client_init(AT_DEVICE_NAME,recv_bufsz)时申请的recv_bufsz大小空间，长期占用；

client->resp->buf，响应数据接收缓存buffer，由用户自行申请释放，大小不定

send_buf[AT_CMD_MAX_LEN]，at命令发送时的缓存静态buffer