README.md
1# Asio TCP echo server example
2
3Simple Asio TCP echo server using WiFi STA or Ethernet.
4
5## Example workflow
6
7- Wi-Fi or Ethernet connection is established, and IP address is obtained.
8- Asio TCP server is started on port number defined through the project configuration.
9- Server receives and echoes back messages transmitted from client.
10
11## Running the example
12
13- Open the project configuration menu (`idf.py menuconfig`) to configure Wi-Fi or Ethernet. See "Establishing Wi-Fi or Ethernet Connection" section in [examples/protocols/README.md](../../README.md) for more details.
14- Set server port number in menuconfig, "Example configuration".
15- Run `idf.py -p PORT flash monitor` to build and upload the example to your board and connect to it's serial terminal.
16- Wait for the board to connect to WiFi or Ethernet (note the IP address).
17- You can now send a TCP message and check it is repeated, for example using netcat `nc IP PORT`.
18
19See the README.md file in the upper level 'examples' directory for more information about examples.
20
