Historia

Roland Dobai 766aa57084 Build & config: Remove leftover files from the unsupported "make" build system		2021-11-11 15:32:36 +01:00
..
main	Build & config: Remove leftover files from the unsupported "make" build system	2021-11-11 15:32:36 +01:00
CMakeLists.txt	asio coap: If LWIP IPV6 is disabled, automatically don't build asio & coap	2021-05-20 19:53:00 +10:00
README.md	examples: Make tcp_server example support tcp keepalive function	2021-02-23 18:26:03 +08:00
example_test.py	Split example_tests with Example_WIFI tag group into Example_OTA and Example_Protocols	2021-04-15 04:00:06 +00:00
sdkconfig.ci	Whitespace: Automated whitespace fixes (large commit)	2020-11-11 07:36:35 +00:00
sdkconfig.ci.1	examples: Use CONFIG_LWIP_IPV6 to strip tcp_server example	2021-02-23 18:26:03 +08:00

README.md

TCP Server example

(See the README.md file in the upper level 'examples' directory for more information about examples.)

The application creates a TCP socket with the specified port number and waits for a connection request from the client. After accepting a request from the client, connection between server and client is established and the application waits for some data to be received from the client. Received data are printed as ASCII text and retransmitted back to the client.

How to use example

In order to create TCP client that communicates with TCP server example, choose one of the following options.

There are many host-side tools which can be used to interact with the UDP/TCP server/client. One command line tool is netcat which can send and receive many kinds of packets. Note: please replace 192.168.0.167 3333 with desired IPV4/IPV6 address (displayed in monitor console) and port number in the following command.

In addition to those tools, simple Python scripts can be found under sockets/scripts directory. Every script is designed to interact with one of the examples.

TCP client using netcat

nc 192.168.0.167 3333

Python scripts

Script example_test.py could be used as a counter part to the tcp-server application, IP address and the message to be send to the server shall be stated as arguments. Example:

python example_test.py 192.168.0.167 Message

Note that this script is used in automated tests, as well, so the IDF test framework packages need to be imported; please add $IDF_PATH/tools/ci/python_packages to PYTHONPATH.

Hardware Required

This example can be run on any commonly available ESP32 development board.

Configure the project

idf.py menuconfig

Set following parameters under Example Configuration Options:

Set IP version of the example to be IPV4 or IPV6.
Set Port number of the socket, that server example will create.
Set TCP keep-alive idle time(s) value of TCP keep alive idle time. This time is the time between the last data transmission.
Set TCP keep-alive interval time(s) value of TCP keep alive interval time. This time is the interval time of keepalive probe packets.
Set TCP keep-alive packet retry send counts value of TCP keep alive packet retry send counts. This is the number of retries of the keepalive probe packet.

Configure Wi-Fi or Ethernet under "Example Connection Configuration" menu. See "Establishing Wi-Fi or Ethernet Connection" section in examples/protocols/README.md for more details.

Build and Flash

Build the project and flash it to the board, then run monitor tool to view serial output:

idf.py -p PORT flash monitor

(To exit the serial monitor, type Ctrl-].)

See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects.

Troubleshooting

Start server first, to receive data sent from the client (application).