《ESP32-S3使用指南—IDF版 V1.6》第五十三章 TCPClient实验

第五十三章 TCPClient实验

1）实验平台：正点原子DNESP32S3开发板

2）章节摘自【正点原子】ESP32-S3使用指南—IDF版 V1.6

3）购买链接：https://detail.tmall.com/item.htm?&id=768499342659

4）全套实验源码+手册+视频下载地址：http://www.openedv.com/docs/boards/esp32/ATK-DNESP32S3.html

5）正点原子官方B站：https://space.bilibili.com/394620890

6）正点原子DNESP32S3开发板技术交流群：132780729

本章作者重点讲解lwIP的Socket接口如何配置TCP客户端，并在此基础上实现收发功能。
本章分为如下几个部分：
53.1 Socket编程TCPClient连接流程
53.2 硬件设计
53.3 软件设计
53.4 下载验证

53.1 Socket编程TCPClient连接流程
在实现TCP协议之前，用户需要按照以下步骤配置结构体sockaddr_in的成员变量，以便建立TCPClient连接：
①：配置ESP32-S3设备连接网络（必须的，因为WiFi是无线通信，所以需搭建通信桥梁）。
②：将sin_family设置为AF_INET，表示使用IPv4网络协议。
③：设置sin_port为所需的端口号，例如8080。
④：设置sin_addr.s_addr为远程IP地址。
⑤：调用函数Socket创建Socket连接。请注意，该函数的第二个参数指定连接类型。SOCK_STREAM表示TCP连接，而SOCK_DGRAM表示UDP连接。
⑥：调用函数connect连接远程IP地址。
⑦：调用适当的收发函数来接收或发送数据。
通过遵循这些步骤，用户可成功地配置并建立TCPClient连接，以实现数据的发送和接收。

53.2 硬件设计

1.例程功能
本章实验功能简介：
本实验主要通过Socket编程接口实现了一个TCPClient客户端。这个客户端具有以下功能：
①：可以通过按键发送TCPClient数据发送至服务器。
②：能够接收服务器发送的数据。
③：实时将接收到的数据显示在LCD屏幕上。
通过这个实验，用户可深入了解TCP协议的工作原理，并掌握如何使用Socket编程接口来实现TCP通信。这对于开发基于TCP的网络应用程序非常有用，例如实时传输、文件传输等。

2.硬件资源
1）LED灯
LED-IO1
2）XL9555
IIC_INT-IO0（需在P5连接IO0）
IIC_SDA-IO41
IIC_SCL-IO42
3）SPILCD
CS-IO21
SCK-IO12
SDA-IO11
DC-IO40（在P5端口，使用跳线帽将IO_SET和LCD_DC相连）
PWR- IO1_3（XL9555）
RST- IO1_2（XL9555）
4）ESP32-S3内部WiFi

3.原理图
本章实验使用的WiFi为ESP32-S3的片上资源，因此并没有相应的连接原理图。

53.3 软件设计
53.3.1 程序流程图
程序流程图能帮助我们更好的理解一个工程的功能和实现的过程，对学习和设计工程有很好的主导作用。下面看看本实验的程序流程图：

图53.3.1.1 程序流程图

53.3.2 程序解析
在本章节中，我们主要关注两个文件：lwip_demo.c和lwip_demo.h。lwip_demo.h文件主要定义了发送标志位并声明了lwip_demo函数，这部分相对简单，所以我们暂不详细解释。主要关注点是lwip_demo.c文件中的函数。在lwip_demo函数中，我们配置了相关的TCPClient参数，并创建了一个名为lwip_send_thread的发送数据线程。这个线程通过调用scokec函数来发送数据到服务器。接下来，我们将分别详细解释lwip_demo函数和lwip_send_thread任务。

/* 需要自己设置远程IP地址 */
#define IP_ADDR   "192.168.101.33"

#define LWIP_DEMO_RX_BUFSIZE    	100          	         /* 最大接收数据长度 */
#define LWIP_DEMO_PORT           	8080                	 /* 连接的本地端口号 */
#define LWIP_SEND_THREAD_PRIO  		( tskIDLE_PRIORITY + 3 )/* 发送数据线程优先级 */
/* 接收数据缓冲区 */
uint8_t g_lwip_demo_recvbuf[LWIP_DEMO_RX_BUFSIZE]; 

/* 发送数据内容 */
uint8_t g_lwip_demo_sendbuf[] = "ALIENTEK DATA \r\n";
/* 数据发送标志位 */
uint8_t g_lwip_send_flag;
int g_sock = -1;
int g_lwip_connect_state = 0;
static void lwip_send_thread(void *arg);


/**
 * @brief       发送数据线程
 * @param       无
 * @retval      无
 */
void lwip_data_send(void)
{
xTaskCreate(lwip_send_thread, "lwip_send_thread", 4096, 
NULL, LWIP_SEND_THREAD_PRIO, NULL);
}

/**
 * @brief       lwip_demo实验入口
 * @param       无
 * @retval      无
 */
void lwip_demo(void)
{
    struct sockaddr_in atk_client_addr;
    err_t err;
    int recv_data_len;
    char *tbuf;
    
    lwip_data_send();                        		/* 创建发送数据线程 */
    
    while (1)
    {
sock_start:
        g_lwip_connect_state = 0;
        atk_client_addr.sin_family = AF_INET; 		/* 表示IPv4网络协议 */
        atk_client_addr.sin_port = htons(LWIP_DEMO_PORT);       /* 端口号 */
        atk_client_addr.sin_addr.s_addr = inet_addr(IP_ADDR);   /* 远程IP地址 */
        g_sock = socket(AF_INET, SOCK_STREAM, 0);/* 可靠数据流交付服务既是TCP协议 */
        memset(&(atk_client_addr.sin_zero), 0,
               sizeof(atk_client_addr.sin_zero));
        
        tbuf = malloc(200);                                     /* 申请内存 */
        sprintf((char *)tbuf, "Port:%d", LWIP_DEMO_PORT);       /* 客户端端口号 */
        lcd_show_string(5, 170, 200, 16, 16, tbuf, MAGENTA);
        
        /* 连接远程IP地址 */
        err = connect(g_sock, (struct sockaddr *)&atk_client_addr, 
sizeof(struct sockaddr));

        if (err == -1)
        {
            lcd_show_string(5, 190, 200, 16, 16, "State:Disconnect", MAGENTA);
            g_sock = -1;
            closesocket(g_sock);
            free(tbuf);
            vTaskDelay(10);
            goto sock_start;
        }

        lcd_show_string(5,190,200,16,16,"State:Connection Successful", MAGENTA);
        g_lwip_connect_state = 1;
        
        while (1)
        {
            recv_data_len = recv(g_sock,g_lwip_demo_recvbuf,
                                 LWIP_DEMO_RX_BUFSIZE,0);
            if (recv_data_len <= 0 )
            {
                closesocket(g_sock);
                g_sock = -1;
                lcd_fill(5, 190, lcd_self.width,320, WHITE);
                lcd_show_string(5, 190, 200,16,16,"State:Disconnect", MAGENTA);
                free(tbuf);
                goto sock_start;
            }
            
            printf("%s\r\n",g_lwip_demo_recvbuf);
            vTaskDelay(10);
        }
    }
}

/**
 * @brief       发送数据线程函数
 * @param       pvParameters : 传入参数(未用到)
 * @retval      无
 */
void lwip_send_thread(void *pvParameters)
{
    pvParameters = pvParameters;
    
    err_t err;
    
    while (1)
    {
        while (1)
        {
            if(((g_lwip_send_flag & LWIP_SEND_DATA) == LWIP_SEND_DATA) 
&& (g_lwip_connect_state == 1)) /* 有数据要发送 */
            {
                err = write(g_sock, g_lwip_demo_sendbuf,
                            sizeof(g_lwip_demo_sendbuf));
                
                if (err < 0)
                {
                    break;
                }
                
                g_lwip_send_flag &= ~LWIP_SEND_DATA;
            }
            
            vTaskDelay(10);
        }
        
        closesocket(g_sock);
    }
}

在上述源码中，首先创建了一个用于发送ESP32-S3设备数据的任务。然后，对TCPClient进行网络参数配置，并调用connect函数来建立与远程服务器的连接。当连接成功时，系统将进入接收轮询任务。如果出现断开连接的情况，系统将尝试重新连接服务器。在发送线程中，发送数据前会检查标志位。如果标志位有效，则通过write函数发送数据并重置标志位。

53.4 下载验证
在程序中，首先需要设置好能够连接的网络账号和密码。然后，使用笔记本电脑作为终端，确保它与ESP32-S3设备处于同一网络段内。当ESP32-S3设备成功连接到网络时，它的LCD显示屏上会显示相应的内容：

图53.4.1 设备连接到网络时，LCD显示的信息
打开网络调试助手，然后配置网络参数，如TCPServer协议、端口号等，设置内容如下图所示。

在确保网络连接正常后，可以通过按下开发板上的KEY0按键来发送数据至网络调试助手。当网络调试助手接收到“ALIENTEK DATA”字符串时，它会在显示区域展示这个信息。此外，用户还可以在调试助手的发送区域自行输入要发送的数据，然后点击发送键，将数据发送至ESP32-S3设备。此时，ESP32-S3的串口将打印接收到的数据，具体操作和输出如下图所示。

图53.4.3 接收网络调试助手的数据