目錄
一、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