【添加】 AT Socket 对于 ESP8266 和 M26 设备的支持、ESP8266 AT Client 示例、README.md

Signed-off-by: chenyong <1521761801@qq.com>
This commit is contained in:
chenyong 2018-07-09 18:17:49 +08:00
parent bd52a5ef8d
commit 62bdc169de
5 changed files with 1562 additions and 2 deletions

View File

@ -1,2 +1,50 @@
# at_device
AT component porting or samples for different devices
# AT device #
## 1. 简介 ##
AT device 软件包是由 RT-Thread AT 组件针对不同 AT 设备的移植文件和示例代码组成,目前支持的 AT 设备有ESP32、ESP8266、M26等其中 ESP8266 和 M26 设备完成对 `AT socket` 功能的移植,及设备通过 AT 命令实现标准 socket 编程接口,完成 socket 通讯的功能,具体功能介绍可参考 [RT-Thread AT 用户手册](https://git.rt-thread.com/packages/rt_at/blob/master/README.md)。
### 1.1. 文件结构 ###
| 名称 | 说明 |
| ---- | ---- |
| at_socket_esp8266.c | ESP8266 模块针对 AT 组件的移植文件,实现 AT socket |
| at_socket_m26.c | M26 模块针对 AT 组件的移植文件,实现 AT socket |
| at_client_sample.c | ESP8266 模块 AT Client 功能示例文件 |
### 1.2 许可证 ###
### 1.3 依赖 ###
- RT_Thread 3.0+
- RT_Thread AT 组件
- RT_Thread SAL 组件
## 2. 获取方式 ##
AT device 软件包是对 AT 组件库和 AT socket 功能的移植,需开启 AT 组件库和 AT socket 功能来获取 AT device 软件包。
先要开启 AT 组件库和 AT socket 功能, 具体路径如下所示:
RT-Thread Components --->
Network stack --->
Socket abstraction layer --->
protocol family type --->
[ ] Support lwIP stack
[*] Support AT Commands stack
开启 AT socket 功能之后,默认开启 AT device 软件包, 具体路径如下所示:
Privated Packages of RealThread --->
-*- AT DEVICE: RT-Thread AT component porting or samples for different device
AT socket device modules (Not selected, please select) --->
Version (latest) --->
- `AT socket device modules`: AT 设备选择,目前支持 ESP8266、M26 等设备;
- `Version`: 下载软件包版本;
## 3. 注意事项 ##
- AT device 软件包默认设备类型为未选择,使用时需要指定使用设备型号;
- AT device 软件包目前处于 `beta` 测试阶段, 推荐在 menuconfig 选项中选择 `latest` 版本;

16
SConscript Normal file
View File

@ -0,0 +1,16 @@
from building import *
cwd = GetCurrentDir()
if GetDepend(['AT_DEVICE_M26']):
src = Glob('at_socket_m26.c')
if GetDepend(['AT_DEVICE_ESP8266']):
src = Glob('at_socket_esp8266.c')
if GetDepend(['AT_DEVICE_NOT_SELECTED']):
src = Glob('*.c')
group = DefineGroup('at_device', src, depend = ['PKG_USING_AT_DEVICE','RT_AT_USING_CLIENT'], CPPPATH = cwd)
Return('group')

112
at_client_sample.c Normal file
View File

@ -0,0 +1,112 @@
/*
* File : at_client_sample.c
* This file is part of RT-Thread RTOS
* COPYRIGHT (C) 2006 - 2018, RT-Thread Development Team
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Change Logs:
* Date Author Notes
* 2018-07-06 chenyong first version
*/
#include <stdlib.h>
#include <string.h>
#include <rtthread.h>
#include <rt_at.h>
/* AT+CIFSR Query local IP address and MAC */
int at_client_test(int argc, char **argv)
{
rt_at_response_t resp = RT_NULL;
int result = 0;
if (argc != 1)
{
LOG_E("at_client_test - AT client send commands to AT server.");
return -1;
}
resp = rt_at_create_resp(RT_AT_CLIENT_RECV_BUFF_LEN, 0, rt_tick_from_millisecond(5000));
if (resp == RT_NULL)
{
LOG_E("No memory for response structure!");
return -2;
}
result = rt_at_exec_cmd(resp, "AT+CIFSR");
if (result != RT_EOK)
{
LOG_E("AT client send commands failed or return response error!");
goto __exit;
}
/* Print response line buffer */
{
const char *line_buffer = RT_NULL;
LOG_D("Response buffer");
for(rt_size_t line_num = 1; line_num <= resp->line_counts; line_num++)
{
if((line_buffer = at_resp_get_line(resp, line_num)) != RT_NULL)
{
LOG_D("line %d buffer : %s", line_num, line_buffer);
}
else
{
LOG_E("Parse line buffer error!");
}
}
}
{
char resp_arg[RT_AT_CMD_MAX_LEN] = { 0 };
const char * resp_expr = "%*[^\"]\"%[^\"]\"";
LOG_D(" Parse arguments");
if (at_resp_parse_line_args(resp, 2, resp_expr, resp_arg) == 1)
{
LOG_D("Station IP : %s", resp_arg);
memset(resp_arg, 0x00, RT_AT_CMD_MAX_LEN);
}
else
{
LOG_E("Parse error, current line buff : %s", at_resp_get_line(resp, 4));
}
if (at_resp_parse_line_args(resp, 3, resp_expr, resp_arg) == 1)
{
LOG_D("Station MAC : %s", resp_arg);
}
else
{
LOG_E("Parse error, current line buff : %s", at_resp_get_line(resp, 5));
goto __exit;
}
}
__exit:
if(resp)
{
rt_at_delete_resp(resp);
}
return result;
}
#ifdef FINSH_USING_MSH
#include <finsh.h>
MSH_CMD_EXPORT(at_client_test, AT client send cmd and get response);
#endif

657
at_socket_esp8266.c Normal file
View File

@ -0,0 +1,657 @@
/*
* File : at_socket_esp8266.c
* This file is part of RT-Thread RTOS
* COPYRIGHT (C) 2006 - 2018, RT-Thread Development Team
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Change Logs:
* Date Author Notes
* 2018-06-20 chenyong first version
*/
#include <stdio.h>
#include <string.h>
#include <rtthread.h>
#include <sys/socket.h>
#include <rt_at.h>
#include <at_socket.h>
#ifndef AT_DEVICE_NOT_SELECTED
#define ESP8266_MODULE_SEND_MAX_SIZE 2048
/* set real event by current socket and current state */
#define SET_EVENT(socket, event) (((socket + 1) << 16) | (event))
/* AT socket event type */
#define ESP8266_EVENT_CONN_OK (1L << 0)
#define ESP8266_EVENT_SEND_OK (1L << 1)
#define ESP8266_EVENT_RECV_OK (1L << 2)
#define ESP8266_EVNET_CLOSE_OK (1L << 3)
#define ESP8266_EVENT_CONN_FAIL (1L << 4)
#define ESP8266_EVENT_SEND_FAIL (1L << 5)
static int cur_socket;
static int cur_send_bfsz;
static rt_event_t at_socket_event;
static rt_mutex_t at_event_lock;
static at_evt_cb_t at_evt_cb_set[] = {
[AT_SOCKET_EVT_RECV] = NULL,
[AT_SOCKET_EVT_CLOSED] = NULL,
};
static int at_socket_event_send(uint32_t event)
{
return (int) rt_event_send(at_socket_event, event);
}
static int at_socket_event_recv(uint32_t event, uint32_t timeout, rt_uint8_t option)
{
int result = 0;
uint32_t recved;
result = rt_event_recv(at_socket_event, event, option | RT_EVENT_FLAG_CLEAR, timeout, &recved);
if (result != RT_EOK)
{
return -RT_ETIMEOUT;
}
return recved;
}
/**
* close socket by AT commands.
*
* @param current socket
*
* @return 0: close socket success
* -1: send AT commands error
* -2: wait socket event timeout
* -5: no memory
*/
static int esp8266_socket_close(int socket)
{
rt_at_response_t resp = RT_NULL;
resp = rt_at_create_resp(64, 0, rt_tick_from_millisecond(5000));
if (!resp)
{
LOG_E("No memory for response structure!");
return -RT_ENOMEM;
}
if (rt_at_exec_cmd(resp, "AT+CIPCLOSE=%d", socket) < 0)
{
LOG_E("socket(%d) close failed.", socket);
rt_at_delete_resp(resp);
return -RT_ERROR;
}
if (resp)
{
rt_at_delete_resp(resp);
}
return RT_EOK;
}
/**
* create TCP/UDP client or server connect by AT commands.
*
* @param socket current socket
* @param ip server or client IP address
* @param port server or client port
* @param type connect socket type(tcp, udp)
* @param is_client connection is client
*
* @return 0: connect success
* -1: connect failed, send commands error or type error
* -2: wait socket event timeout
* -5: no memory
*/
static int esp8266_socket_connect(int socket, char *ip, int32_t port, enum at_socket_type type, rt_bool_t is_client)
{
rt_at_response_t resp = RT_NULL;
int result = RT_EOK;
rt_bool_t retryed = RT_FALSE;
RT_ASSERT(ip);
RT_ASSERT(port >= 0);
resp = rt_at_create_resp(128, 0, rt_tick_from_millisecond(5000));
if (!resp)
{
LOG_E("No memory for response structure!");
return -RT_ENOMEM;
}
__retry:
if (is_client)
{
switch (type)
{
case AT_SOCKET_TCP:
/* send AT commands to connect TCP server */
if (rt_at_exec_cmd(resp, "AT+CIPSTART=%d,\"TCP\",\"%s\",%d,60", socket, ip, port) < 0)
{
result = -RT_ERROR;
}
break;
case AT_SOCKET_UDP:
if (rt_at_exec_cmd(resp, "AT+CIPSTART=%d,\"UDP\",\"%s\",%d", socket, ip, port) < 0)
{
result = -RT_ERROR;
}
break;
default:
LOG_E("Not supported connect type : %d.", type);
result = -RT_ERROR;
goto __exit;
}
}
if (result != RT_EOK && !retryed)
{
LOG_D("udp socket (%d) connect failed, maybe the socket was not be closed at the last time and now will retry.", socket);
if (esp8266_socket_close(socket) < 0)
{
goto __exit;
}
retryed = RT_TRUE;
result = RT_EOK;
goto __retry;
}
__exit:
if (result != RT_EOK)
{
LOG_E("socket (%d) connect failed, failed to establish a connection.", socket);
}
if (resp)
{
rt_at_delete_resp(resp);
}
return result;
}
/**
* send data to server or client by AT commands.
*
* @param socket current socket
* @param buff send buffer
* @param bfsz send buffer size
* @param type connect socket type(tcp, udp)
*
* @return >=0: the size of send success
* -1: send AT commands error or send data error
* -2: waited socket event timeout
* -5: no memory
*/
static int esp8266_socket_send(int socket, const char *buff, size_t bfsz, enum at_socket_type type)
{
int result = RT_EOK;
int event_result = 0;
rt_at_response_t resp = RT_NULL;
size_t cur_pkt_size = 0, sent_size = 0;
RT_ASSERT(buff);
RT_ASSERT(bfsz > 0);
resp = rt_at_create_resp(128, 2, rt_tick_from_millisecond(5000));
if (!resp)
{
LOG_E("No memory for response structure!");
return -RT_ENOMEM;
}
rt_mutex_take(at_event_lock, RT_WAITING_FOREVER);
/* set current socket for send URC event */
cur_socket = socket;
/* set AT client end sign to deal with '>' sign.*/
extern int rt_at_set_end_sign(char ch);
rt_at_set_end_sign('>');
while (sent_size < bfsz)
{
if (bfsz - sent_size < ESP8266_MODULE_SEND_MAX_SIZE)
{
cur_pkt_size = bfsz - sent_size;
}
else
{
cur_pkt_size = ESP8266_MODULE_SEND_MAX_SIZE;
}
/* send the "AT+CIPSEND" commands to AT server than receive the '>' response on the first line. */
if (rt_at_exec_cmd(resp, "AT+CIPSEND=%d,%d", socket, cur_pkt_size) < 0)
{
result = -RT_ERROR;
goto __exit;
}
/* send the real data to server or client */
result = (int) rt_at_client_send(buff + sent_size, cur_pkt_size);
if (result == 0)
{
result = -RT_ERROR;
goto __exit;
}
/* waiting result event from AT URC */
if (at_socket_event_recv(SET_EVENT(socket, 0), rt_tick_from_millisecond(1 * 1000), RT_EVENT_FLAG_OR) < 0)
{
LOG_E("socket (%d) send failed, wait connect result timeout.", socket);
result = -RT_ETIMEOUT;
goto __exit;
}
/* waiting OK or failed result */
if ((event_result = at_socket_event_recv(ESP8266_EVENT_SEND_OK | ESP8266_EVENT_SEND_FAIL, rt_tick_from_millisecond(1 * 1000),
RT_EVENT_FLAG_OR)) < 0)
{
LOG_E("socket (%d) send failed, wait connect OK|FAIL timeout.", socket);
result = -RT_ETIMEOUT;
goto __exit;
}
/* check result */
if (event_result & ESP8266_EVENT_SEND_FAIL)
{
LOG_E("socket (%d) send failed, return failed.", socket);
result = -RT_ERROR;
goto __exit;
}
if (type == AT_SOCKET_TCP)
{
cur_pkt_size = cur_send_bfsz;
}
sent_size += cur_pkt_size;
}
__exit:
/* reset the end sign for data */
rt_at_set_end_sign(0);
rt_mutex_release(at_event_lock);
if (resp)
{
rt_at_delete_resp(resp);
}
return result;
}
/**
* domain resolve by AT commands.
*
* @param name domain name
* @param ip parsed IP address, it's length must be 16
*
* @return 0: domain resolve success
* -2: wait socket event timeout
* -5: no memory
*/
static int esp8266_domain_resolve(const char *name, char ip[16])
{
int result = RT_EOK;
char recv_ip[16] = { 0 };
rt_at_response_t resp = RT_NULL;
RT_ASSERT(name);
RT_ASSERT(ip);
resp = rt_at_create_resp(128, 0, rt_tick_from_millisecond(5000));
if (!resp)
{
LOG_E("No memory for response structure!");
return -RT_ENOMEM;
}
rt_mutex_take(at_event_lock, RT_WAITING_FOREVER);
__restart:
if (rt_at_exec_cmd(resp, "AT+CIPDOMAIN=\"%s\"", name) < 0)
{
result = -RT_ERROR;
goto __exit;
}
/* parse the third line of response data, get the IP address */
at_resp_parse_line_args(resp, 1, "+CIPDOMAIN:%s", recv_ip);
if (strlen(recv_ip) < 8)
{
rt_thread_delay(rt_tick_from_millisecond(100));
/* resolve failed, maybe receive an URC CRLF */
goto __restart;
}
strncpy(ip, recv_ip, 15);
ip[15] = '\0';
__exit:
rt_mutex_release(at_event_lock);
if (resp)
{
rt_at_delete_resp(resp);
}
return result;
}
/**
* set AT socket event notice callback
*
* @param event notice event
* @param cb notice callback
*/
static void esp8266_socket_set_event_cb(at_socket_evt_t event, at_evt_cb_t cb)
{
if (event < sizeof(at_evt_cb_set) / sizeof(at_evt_cb_set[1]))
{
at_evt_cb_set[event] = cb;
}
}
static void urc_send_func(const char *data, rt_size_t size)
{
RT_ASSERT(data && size);
if (strstr(data, "SEND OK"))
{
at_socket_event_send(SET_EVENT(cur_socket, ESP8266_EVENT_SEND_OK));
}
else if (strstr(data, "SEND FAIL"))
{
at_socket_event_send(SET_EVENT(cur_socket, ESP8266_EVENT_SEND_FAIL));
}
}
static void urc_send_bfsz_func(const char *data, rt_size_t size)
{
int send_bfsz = 0;
RT_ASSERT(data && size);
sscanf(data, "Recv %d bytes", &send_bfsz);
cur_send_bfsz = send_bfsz;
}
static void urc_close_func(const char *data, rt_size_t size)
{
int socket = 0;
RT_ASSERT(data && size);
sscanf(data, "%d,CLOSED", &socket);
/* notice the socket is disconnect by remote */
if (at_evt_cb_set[AT_SOCKET_EVT_CLOSED])
{
at_evt_cb_set[AT_SOCKET_EVT_CLOSED](socket, AT_SOCKET_EVT_CLOSED, RT_NULL, 0);
}
}
static void urc_recv_func(const char *data, rt_size_t size)
{
int socket = 0;
rt_size_t bfsz = 0, temp_size = 0;
char *recv_buf = RT_NULL, temp[8];
RT_ASSERT(data && size);
/* get the current socket and receive buffer size by receive data */
sscanf(data, "+IPD,%d,%d:", &socket, (int *) &bfsz);
if (socket < 0 || bfsz == 0)
return;
recv_buf = rt_calloc(1, bfsz);
if (!recv_buf)
{
LOG_E("no memory for URC receive buffer (%d)!", bfsz);
/* read and clean the coming data */
while (temp_size < bfsz)
{
if (bfsz - temp_size > sizeof(temp))
{
rt_at_client_recv(temp, sizeof(temp));
}
else
{
rt_at_client_recv(temp, bfsz - temp_size);
}
temp_size += sizeof(temp);
}
return;
}
/* sync receive data */
if (rt_at_client_recv(recv_buf, bfsz) != bfsz)
{
LOG_E("receive size(%d) data failed!", bfsz);
rt_free(recv_buf);
return;
}
/* notice the receive buffer and buffer size */
if (at_evt_cb_set[AT_SOCKET_EVT_RECV])
{
at_evt_cb_set[AT_SOCKET_EVT_RECV](socket, AT_SOCKET_EVT_RECV, recv_buf, bfsz);
}
}
static void urc_busy_p_func(const char *data, rt_size_t size)
{
RT_ASSERT(data && size);
LOG_D("system is processing a commands and it cannot respond to the current commands.");
}
static void urc_busy_s_func(const char *data, rt_size_t size)
{
RT_ASSERT(data && size);
LOG_D("system is sending data and it cannot respond to the current commands.");
}
static void urc_func(const char *data, rt_size_t size)
{
RT_ASSERT(data && size);
if(strstr(data, "WIFI CONNECTED"))
{
LOG_I("ESP8266 WIFI is connected.");
}
else if(strstr(data, "WIFI DISCONNECT"))
{
LOG_I("ESP8266 WIFI is disconnect.");
}
}
static struct rt_at_urc urc_table[] = {
{"SEND OK", "\r\n", urc_send_func},
{"SEND FAIL", "\r\n", urc_send_func},
{"Recv", "bytes\r\n", urc_send_bfsz_func},
{"", ",CLOSED\r\n", urc_close_func},
{"+IPD", ":", urc_recv_func},
{"busy p", "\r\n", urc_busy_p_func},
{"busy s", "\r\n", urc_busy_s_func},
{"WIFI CONNECTED", "\r\n", urc_func},
{"WIFI DISCONNECT", "\r\n", urc_func},
};
/* AT client port initialization */
int rt_at_client_port_init(void)
{
/* create current AT socket event */
at_socket_event = rt_event_create("at_sock_event", RT_IPC_FLAG_FIFO);
if (!at_socket_event)
{
LOG_E("RT AT client port initialize failed! at_sock_event create failed!");
return -RT_ENOMEM;
}
/* create current AT socket lock */
at_event_lock = rt_mutex_create("at_event_lock", RT_IPC_FLAG_FIFO);
if (!at_event_lock)
{
LOG_E("RT AT client port initialize failed! at_sock_lock create failed!");
rt_event_delete(at_socket_event);
return -RT_ENOMEM;
}
/* register URC data execution function */
rt_at_set_urc_table(urc_table, sizeof(urc_table) / sizeof(urc_table[0]));
return RT_EOK;
}
#define AT_SEND_CMD(resp, cmd) \
do \
{ \
if (rt_at_exec_cmd(rt_at_resp_set_info(resp, 256, 0, rt_tick_from_millisecond(5000)), cmd) < 0) \
{ \
LOG_E("RT AT send commands(%s) error!", cmd); \
return -1; \
} \
} while(0); \
static int esp8266_net_init(void)
{
rt_at_response_t resp = RT_NULL;
rt_size_t i;
resp = rt_at_create_resp(128, 0, rt_tick_from_millisecond(5000));
if (!resp)
{
LOG_E("No memory for response structure!");
return -RT_ENOMEM;
}
/* reset module */
AT_SEND_CMD(resp, "AT+RST");
/* reset waiting delay */
rt_thread_delay(rt_tick_from_millisecond(1000));
/* disable echo */
AT_SEND_CMD(resp, "ATE0");
/* set current mode to Wi-Fi station */
AT_SEND_CMD(resp, "AT+CWMODE=1");
/* get module version */
AT_SEND_CMD(resp, "AT+GMR");
/* show module version */
for (i = 0; i < resp->line_counts - 1; i++)
{
LOG_D("%s", at_resp_get_line(resp, i + 1))
}
/* connect to WiFi AP */
if (rt_at_exec_cmd(rt_at_resp_set_info(resp, 128, 0, 20 * RT_TICK_PER_SECOND), "AT+CWJAP=\"%s\",\"%s\"",
AT_DEVICE_WIFI_SSID, AT_DEVICE_WIFI_PASSWORD) != RT_EOK)
{
LOG_E("AT network initialize failed, check ssid(%s) and password(%s).", AT_DEVICE_WIFI_SSID, AT_DEVICE_WIFI_PASSWORD);
return -RT_ERROR;
}
AT_SEND_CMD(resp, "AT+CIPMUX=1");
if (resp)
{
rt_at_delete_resp(resp);
}
LOG_I("AT network initialize success!");
return RT_EOK;
}
int esp8266_ping(int argc, char **argv)
{
rt_at_response_t resp = RT_NULL;
static int icmp_seq;
int req_time;
if (argc != 2)
{
rt_kprintf("Please input: at_ping <host address>\n");
return -RT_ERROR;
}
resp = rt_at_create_resp(64, 0, rt_tick_from_millisecond(5000));
if (!resp)
{
rt_kprintf("No memory for response structure!\n");
return -RT_ENOMEM;
}
for(icmp_seq = 1; icmp_seq <= 4; icmp_seq++)
{
if (rt_at_exec_cmd(resp, "AT+PING=\"%s\"", argv[1]) < 0)
{
rt_kprintf("ping: unknown remote server host\n");
rt_at_delete_resp(resp);
return -RT_ERROR;
}
at_resp_parse_line_args(resp, 1, "+%d", &req_time);
if (req_time)
{
rt_kprintf("32 bytes from %s icmp_seq=%d time=%d ms\n", argv[1], icmp_seq, req_time);
}
}
if (resp)
{
rt_at_delete_resp(resp);
}
return RT_EOK;
}
#ifdef FINSH_USING_MSH
#include <finsh.h>
MSH_CMD_EXPORT_ALIAS(esp8266_net_init, at_net_init, initialize AT network);
MSH_CMD_EXPORT_ALIAS(esp8266_ping, at_ping, AT ping network host);
#endif
static const struct at_device_ops esp8266_socket_ops = {
.connect = esp8266_socket_connect,
.close = esp8266_socket_close,
.send = esp8266_socket_send,
.domain_resolve = esp8266_domain_resolve,
.set_event_cb = esp8266_socket_set_event_cb,
};
static int at_socket_device_init(void)
{
esp8266_net_init();
at_scoket_device_register(&esp8266_socket_ops);
return 0;
}
INIT_APP_EXPORT(at_socket_device_init);
#endif /* AT_DEVICE_NOT_SELECTED */

727
at_socket_m26.c Normal file
View File

@ -0,0 +1,727 @@
/*
* File : at_socket_m26.c
* This file is part of RT-Thread RTOS
* COPYRIGHT (C) 2006 - 2018, RT-Thread Development Team
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Change Logs:
* Date Author Notes
* 2018-06-12 chenyong first version
*/
#include <stdio.h>
#include <string.h>
#include <rtthread.h>
#include <sys/socket.h>
#include <rt_at.h>
#include <at_socket.h>
#ifndef AT_DEVICE_NOT_SELECTED
#define M26_MODULE_SEND_MAX_SIZE 1460
/* set real event by current socket and current state */
#define SET_EVENT(socket, event) (((socket + 1) << 16) | (event))
/* AT socket event type */
#define M26_EVENT_CONN_OK (1L << 0)
#define M26_EVENT_SEND_OK (1L << 1)
#define M26_EVENT_RECV_OK (1L << 2)
#define M26_EVNET_CLOSE_OK (1L << 3)
#define M26_EVENT_CONN_FAIL (1L << 4)
#define M26_EVENT_SEND_FAIL (1L << 5)
static int cur_socket;
static rt_event_t at_socket_event;
static rt_mutex_t at_event_lock;
static at_evt_cb_t at_evt_cb_set[] = {
[AT_SOCKET_EVT_RECV] = NULL,
[AT_SOCKET_EVT_CLOSED] = NULL,
};
static int at_socket_event_send(uint32_t event)
{
return (int) rt_event_send(at_socket_event, event);
}
static int at_socket_event_recv(uint32_t event, uint32_t timeout, rt_uint8_t option)
{
int result = 0;
uint32_t recved;
result = rt_event_recv(at_socket_event, event, option | RT_EVENT_FLAG_CLEAR, timeout, &recved);
if (result != RT_EOK)
{
return -RT_ETIMEOUT;
}
return recved;
}
/**
* close socket by AT commands.
*
* @param current socket
*
* @return 0: close socket success
* -1: send AT commands error
* -2: wait socket event timeout
* -5: no memory
*/
static int m26_socket_close(int socket)
{
int result = 0;
rt_mutex_take(at_event_lock, RT_WAITING_FOREVER);
cur_socket = socket;
if (rt_at_exec_cmd(RT_NULL, "AT+QICLOSE=%d", socket) < 0)
{
result = -RT_ERROR;
goto __exit;
}
if (at_socket_event_recv(SET_EVENT(socket, M26_EVNET_CLOSE_OK), rt_tick_from_millisecond(300*3), RT_EVENT_FLAG_AND) < 0)
{
LOG_E("socket (%d) close failed, wait close OK timeout.", socket);
result = -RT_ETIMEOUT;
goto __exit;
}
__exit:
rt_mutex_release(at_event_lock);
return result;
}
/**
* create TCP/UDP client or server connect by AT commands.
*
* @param socket current socket
* @param ip server or client IP address
* @param port server or client port
* @param type connect socket type(tcp, udp)
* @param is_client connection is client
*
* @return 0: connect success
* -1: connect failed, send commands error or type error
* -2: wait socket event timeout
* -5: no memory
*/
static int m26_socket_connect(int socket, char *ip, int32_t port, enum at_socket_type type, rt_bool_t is_client)
{
int result = 0, event_result = 0;
rt_bool_t retryed = RT_FALSE;
RT_ASSERT(ip);
RT_ASSERT(port >= 0);
/* lock AT socket connect */
rt_mutex_take(at_event_lock, RT_WAITING_FOREVER);
__retry:
if (is_client)
{
switch (type)
{
case AT_SOCKET_TCP:
/* send AT commands(eg: AT+QIOPEN=0,"TCP","x.x.x.x", 1234) to connect TCP server */
if (rt_at_exec_cmd(RT_NULL, "AT+QIOPEN=%d,\"TCP\",\"%s\",%d", socket, ip, port) < 0)
{
result = -RT_ERROR;
goto __exit;
}
break;
case AT_SOCKET_UDP:
if (rt_at_exec_cmd(RT_NULL, "AT+QIOPEN=%d,\"UDP\",\"%s\",%d", socket, ip, port) < 0)
{
result = -RT_ERROR;
goto __exit;
}
break;
default:
LOG_E("Not supported connect type : %d.", type);
return -RT_ERROR;
}
}
/* waiting result event from AT URC, the device default connection timeout is 75 seconds, but it set to 10 seconds is convenient to use.*/
if (at_socket_event_recv(SET_EVENT(socket, 0), rt_tick_from_millisecond(10 * 1000), RT_EVENT_FLAG_OR) < 0)
{
LOG_E("socket (%d) connect failed, wait connect result timeout.", socket);
result = -RT_ETIMEOUT;
goto __exit;
}
/* waiting OK or failed result */
if ((event_result = at_socket_event_recv(M26_EVENT_CONN_OK | M26_EVENT_CONN_FAIL, rt_tick_from_millisecond(1 * 1000),
RT_EVENT_FLAG_OR)) < 0)
{
LOG_E("socket (%d) connect failed, wait connect OK|FAIL timeout.", socket);
result = -RT_ETIMEOUT;
goto __exit;
}
/* check result */
if (event_result & M26_EVENT_CONN_FAIL)
{
if (!retryed)
{
LOG_E("socket (%d) connect failed, maybe the socket was not be closed at the last time and now will retry.", socket);
if (m26_socket_close(socket) < 0)
{
goto __exit;
}
retryed = RT_TRUE;
goto __retry;
}
LOG_E("socket (%d) connect failed, failed to establish a connection.", socket);
result = -RT_ERROR;
goto __exit;
}
__exit:
/* unlock AT socket connect */
rt_mutex_release(at_event_lock);
return result;
}
static int at_get_send_size(int socket, size_t *size, size_t *acked, size_t *nacked)
{
rt_at_response_t resp = rt_at_create_resp(64, 0, rt_tick_from_millisecond(5000));
int result = 0;
if (!resp)
{
LOG_E("No memory for response structure!");
result = -RT_ENOMEM;
goto __exit;
}
if (rt_at_exec_cmd(resp, "AT+QISACK=%d", socket) < 0)
{
result = -RT_ERROR;
goto __exit;
}
if (at_resp_parse_line_args(resp, 2, "+QISACK: %d, %d, %d", size, acked, nacked) <= 0)
{
result = -RT_ERROR;
goto __exit;
}
__exit:
if (resp)
{
rt_at_delete_resp(resp);
}
return result;
}
static int at_wait_send_finish(int socket, size_t settings_size)
{
rt_tick_t timeout = rt_tick_from_millisecond(settings_size);
rt_tick_t last_time = rt_tick_get();
size_t size = 0, acked = 0, nacked = 0xFFFF;
while (rt_tick_get() - last_time <= timeout)
{
at_get_send_size(socket, &size, &acked, &nacked);
if (nacked == 0)
{
return RT_EOK;
}
rt_thread_delay(rt_tick_from_millisecond(50));
}
return -RT_ETIMEOUT;
}
/**
* send data to server or client by AT commands.
*
* @param socket current socket
* @param buff send buffer
* @param bfsz send buffer size
* @param type connect socket type(tcp, udp)
*
* @return >=0: the size of send success
* -1: send AT commands error or send data error
* -2: waited socket event timeout
* -5: no memory
*/
static int m26_socket_send(int socket, const char *buff, size_t bfsz, enum at_socket_type type)
{
int result = 0, event_result = 0;
rt_at_response_t resp = RT_NULL;
size_t cur_pkt_size = 0, sent_size = 0;
RT_ASSERT(buff);
RT_ASSERT(bfsz);
resp = rt_at_create_resp(128, 2, rt_tick_from_millisecond(5000));
if (!resp)
{
LOG_E("No memory for response structure!");
return -RT_ENOMEM;
}
rt_mutex_take(at_event_lock, RT_WAITING_FOREVER);
/* set current socket for send URC event */
cur_socket = socket;
/* set AT client end sign to deal with '>' sign.*/
extern int rt_at_set_end_sign(char ch);
rt_at_set_end_sign('>');
while (sent_size < bfsz)
{
if (bfsz - sent_size < M26_MODULE_SEND_MAX_SIZE)
{
cur_pkt_size = bfsz - sent_size;
}
else
{
cur_pkt_size = M26_MODULE_SEND_MAX_SIZE;
}
/* send the "AT+QISEND" commands to AT server than receive the '>' response on the first line. */
if (rt_at_exec_cmd(resp, "AT+QISEND=%d,%d", socket, cur_pkt_size) < 0)
{
result = -RT_ERROR;
goto __exit;
}
/* send the real data to server or client */
result = (int) rt_at_client_send(buff + sent_size, cur_pkt_size);
if (result == 0)
{
result = -RT_ERROR;
goto __exit;
}
/* waiting result event from AT URC */
if (at_socket_event_recv(SET_EVENT(socket, 0), rt_tick_from_millisecond(300*3), RT_EVENT_FLAG_OR) < 0)
{
LOG_E("socket (%d) send failed, wait connect result timeout.", socket);
result = -RT_ETIMEOUT;
goto __exit;
}
/* waiting OK or failed result */
if ((event_result = at_socket_event_recv(M26_EVENT_SEND_OK | M26_EVENT_SEND_FAIL, rt_tick_from_millisecond(1 * 1000),
RT_EVENT_FLAG_OR)) < 0)
{
LOG_E("socket (%d) send failed, wait connect OK|FAIL timeout.", socket);
result = -RT_ETIMEOUT;
goto __exit;
}
/* check result */
if (event_result & M26_EVENT_SEND_FAIL)
{
LOG_E("socket (%d) send failed, return failed.", socket);
result = -RT_ERROR;
goto __exit;
}
if (type == AT_SOCKET_TCP)
{
at_wait_send_finish(socket, cur_pkt_size);
}
sent_size += cur_pkt_size;
}
__exit:
/* reset the end sign for data conflict */
rt_at_set_end_sign(0);
rt_mutex_release(at_event_lock);
if (resp)
{
rt_at_delete_resp(resp);
}
return result;
}
/**
* domain resolve by AT commands.
*
* @param name domain name
* @param ip parsed IP address, it's length must be 16
*
* @return 0: domain resolve success
* -1: send AT commands error or response error
* -2: wait socket event timeout
* -5: no memory
*/
static int m26_domain_resolve(const char *name, char ip[16])
{
int result = 0;
char recv_ip[16] = { 0 };
rt_at_response_t resp = RT_NULL;
RT_ASSERT(name);
RT_ASSERT(ip);
resp = rt_at_create_resp(128, 4, rt_tick_from_millisecond(5000));
if (!resp)
{
LOG_E("No memory for response structure!");
return -RT_ENOMEM;
}
rt_mutex_take(at_event_lock, RT_WAITING_FOREVER);
__restart:
if (rt_at_exec_cmd(resp, "AT+QIDNSGIP=\"%s\"", name) < 0)
{
result = -RT_ERROR;
goto __exit;
}
/* parse the third line of response data, get the IP address */
at_resp_parse_line_args(resp, 4, "%s", recv_ip);
if (strlen(recv_ip) < 8)
{
rt_thread_delay(rt_tick_from_millisecond(100));
/* resolve failed, maybe receive an URC CRLF */
goto __restart;
}
strncpy(ip, recv_ip, 15);
ip[15] = '\0';
__exit:
rt_mutex_release(at_event_lock);
if (resp)
{
rt_at_delete_resp(resp);
}
return result;
}
/**
* set AT socket event notice callback
*
* @param event notice event
* @param cb notice callback
*/
static void m26_socket_set_event_cb(at_socket_evt_t event, at_evt_cb_t cb)
{
if (event < sizeof(at_evt_cb_set) / sizeof(at_evt_cb_set[1]))
{
at_evt_cb_set[event] = cb;
}
}
static void urc_connect_func(const char *data, rt_size_t size)
{
int socket = 0;
RT_ASSERT(data && size);
sscanf(data, "%d%*[^0-9]", &socket);
if (strstr(data, "CONNECT OK"))
{
at_socket_event_send(SET_EVENT(socket, M26_EVENT_CONN_OK));
}
else
{
at_socket_event_send(SET_EVENT(socket, M26_EVENT_CONN_FAIL));
}
}
static void urc_send_func(const char *data, rt_size_t size)
{
RT_ASSERT(data && size);
if (strstr(data, "SEND OK"))
{
at_socket_event_send(SET_EVENT(cur_socket, M26_EVENT_SEND_OK));
}
else if (strstr(data, "SEND FAIL"))
{
at_socket_event_send(SET_EVENT(cur_socket, M26_EVENT_SEND_FAIL));
}
}
static void urc_close_func(const char *data, rt_size_t size)
{
int socket = 0;
RT_ASSERT(data && size);
if (strstr(data, "CLOSE OK"))
{
at_socket_event_send(SET_EVENT(cur_socket, M26_EVNET_CLOSE_OK));
}
else if (strstr(data, "CLOSED"))
{
sscanf(data, "%d, CLOSED", &socket);
/* notice the socket is disconnect by remote */
if (at_evt_cb_set[AT_SOCKET_EVT_CLOSED])
{
at_evt_cb_set[AT_SOCKET_EVT_CLOSED](socket, AT_SOCKET_EVT_CLOSED, NULL, 0);
}
}
}
static void urc_recv_func(const char *data, rt_size_t size)
{
int socket = 0;
rt_size_t bfsz = 0, temp_size = 0;
char *recv_buf = RT_NULL, temp[8];
RT_ASSERT(data && size);
/* get the current socket and receive buffer size by receive data */
sscanf(data, "+RECEIVE: %d, %d", &socket, (int *) &bfsz);
if (socket < 0 || bfsz == 0)
return;
recv_buf = rt_calloc(1, bfsz);
if (!recv_buf)
{
LOG_E("no memory for URC receive buffer (%d)!", bfsz);
/* read and clean the coming data */
while (temp_size < bfsz)
{
if (bfsz - temp_size > sizeof(temp))
{
rt_at_client_recv(temp, sizeof(temp));
}
else
{
rt_at_client_recv(temp, bfsz - temp_size);
}
temp_size += sizeof(temp);
}
return;
}
/* sync receive data */
if (rt_at_client_recv(recv_buf, bfsz) != bfsz)
{
LOG_E("receive size(%d) data failed!", bfsz);
rt_free(recv_buf);
return;
}
/* notice the receive buffer and buffer size */
if (at_evt_cb_set[AT_SOCKET_EVT_RECV])
{
at_evt_cb_set[AT_SOCKET_EVT_RECV](socket, AT_SOCKET_EVT_RECV, recv_buf, bfsz);
}
}
static void urc_ping_func(const char *data, rt_size_t size)
{
static int icmp_seq = 0;
int result, recv_len, time, ttl;
char dst_ip[16] = { 0 };
RT_ASSERT(data && size);
sscanf(data, "+QPING: %d,%[^,],%d,%d,%d", &result, dst_ip, &recv_len, &time, &ttl);
switch(result)
{
case 0:
rt_kprintf("%d bytes from %s icmp_seq=%d ttl=%d time=%d ms\n", recv_len, dst_ip, icmp_seq++, ttl, time);
break;
case 1:
rt_kprintf("ping request timeout!\n");
break;
case 2:
icmp_seq = 0;
break;
case 3:
rt_kprintf("ping: TCP/IP protocol stack is busy\n");
break;
case 4:
rt_kprintf("ping: unknown remote server host\n");
break;
default:
break;
}
}
static void urc_func(const char *data, rt_size_t size)
{
RT_ASSERT(data && size);
LOG_I("URC data : %.*s", size, data);
}
static const struct rt_at_urc urc_table[] = {
{"RING", "\r\n", urc_func},
{"Call Ready", "\r\n", urc_func},
{"RDY", "\r\n", urc_func},
{"NO CARRIER", "\r\n", urc_func},
{"", ", CONNECT OK\r\n", urc_connect_func},
{"", ", CONNECT FAIL\r\n", urc_connect_func},
{"SEND OK", "\r\n", urc_send_func},
{"SEND FAIL", "\r\n", urc_send_func},
{"", ", CLOSE OK\r\n", urc_close_func},
{"", ", CLOSED\r\n", urc_close_func},
{"+RECEIVE:", "\r\n", urc_recv_func},
{"+QPING:", "\r\n", urc_ping_func},
};
/* AT client port initialization */
int rt_at_client_port_init(void)
{
/* create current AT socket event */
at_socket_event = rt_event_create("at_sock_event", RT_IPC_FLAG_FIFO);
if (!at_socket_event)
{
LOG_E("RT AT client port initialize failed! at_sock_event create failed!");
return -RT_ENOMEM;
}
/* create current AT socket lock */
at_event_lock = rt_mutex_create("at_event_lock", RT_IPC_FLAG_FIFO);
if (!at_event_lock)
{
LOG_E("RT AT client port initialize failed! at_sock_lock create failed!");
rt_event_delete(at_socket_event);
return -RT_ENOMEM;
}
/* register URC data execution function */
rt_at_set_urc_table(urc_table, sizeof(urc_table) / sizeof(urc_table[0]));
return RT_EOK;
}
#define AT_SEND_CMD(resp, resp_line, cmd) \
do \
{ \
if (rt_at_exec_cmd(rt_at_resp_set_info(resp, 64, resp_line, rt_tick_from_millisecond(5000)), cmd) < 0) \
{ \
LOG_E("RT AT send commands(%s) error!", cmd); \
return -RT_ERROR; \
} \
} while(0); \
int m26_net_init(void)
{
rt_at_response_t resp = RT_NULL;
resp = rt_at_create_resp(64, 0, rt_tick_from_millisecond(5000));
if (!resp)
{
LOG_E("No memory for response structure!");
return -RT_ENOMEM;
}
if (rt_at_exec_cmd(rt_at_resp_set_info(resp, 64, 2, rt_tick_from_millisecond(5000)), "AT+QILOCIP") == RT_EOK)
{
LOG_I("AT network is already initialized!");
return RT_EOK;
}
AT_SEND_CMD(resp, 0, "ATE0");
AT_SEND_CMD(resp, 0, "AT+QIFGCNT=0");
AT_SEND_CMD(resp, 0, "AT+QICSGP=1, \"CMNET\"");
AT_SEND_CMD(resp, 0, "AT+QIMUX=1");
AT_SEND_CMD(resp, 2, "AT+QIDEACT");
AT_SEND_CMD(resp, 0, "AT+QIREGAPP");
AT_SEND_CMD(resp, 0, "AT+QIACT");
AT_SEND_CMD(resp, 2, "AT+QILOCIP");
if (resp)
{
rt_at_delete_resp(resp);
}
LOG_I("AT network initialize success!");
return RT_EOK;
}
int m26_ping(int argc, char **argv)
{
rt_at_response_t resp = RT_NULL;
if (argc != 2)
{
rt_kprintf("Please input: at_ping <host address>\n");
return -RT_ERROR;
}
resp = rt_at_create_resp(64, 0, rt_tick_from_millisecond(5000));
if (!resp)
{
rt_kprintf("No memory for response structure!\n");
return -RT_ENOMEM;
}
if (rt_at_exec_cmd(resp, "AT+QPING=\"%s\"", argv[1]) < 0)
{
rt_kprintf("AT send ping commands error!\n");
return -RT_ERROR;
}
if (resp)
{
rt_at_delete_resp(resp);
}
return RT_EOK;
}
#ifdef FINSH_USING_MSH
#include <finsh.h>
MSH_CMD_EXPORT_ALIAS(m26_net_init, at_net_init, initialize AT network);
MSH_CMD_EXPORT_ALIAS(m26_ping, at_ping, AT ping network host);
#endif
static const struct at_device_ops m26_socket_ops = {
.connect = m26_socket_connect,
.close = m26_socket_close,
.send = m26_socket_send,
.domain_resolve = m26_domain_resolve,
.set_event_cb = m26_socket_set_event_cb,
};
static int at_socket_device_init(void)
{
m26_net_init();
at_scoket_device_register(&m26_socket_ops);
return 0;
}
INIT_APP_EXPORT(at_socket_device_init);
#endif /* AT_DEVICE_NOT_SELECTED */