alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
8f0d41d02b
esp-idf/examples/protocols/sockets/tcp_server
History
David Cermak 5f6cb31105 lwip: Support IPv6 only mode
2023-02-27 08:53:34 +01:00
..
main lwip: Support IPv6 only mode 2023-02-27 08:53:34 +01:00
CMakeLists.txt tools: Increase the minimal supported CMake version to 3.16 2022-06-01 06:35:02 +00:00
pytest_tcp_server.py CI: enable more wifi cases 2023-01-06 06:03:52 +00:00
README.md examples: enable build esp32c6 for wifi and network examples 2023-01-12 14:50:06 +08:00
sdkconfig.ci CI: update test cases to use different environment variables 2022-07-15 01:16:35 +08:00
sdkconfig.ci.1 CI: update test cases to use different environment variables 2022-07-15 01:16:35 +08:00
sdkconfig.ci.ipv6_only lwip: Support IPv6 only mode 2023-02-27 08:53:34 +01:00

README.md

Supported Targets ESP32 ESP32-C2 ESP32-C3 ESP32-C6 ESP32-S2 ESP32-S3

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.

Ref to the upper level README for more information.

TCP client using netcat

nc 192.168.0.167 3333

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).