mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
60 lines
2.3 KiB
Markdown
60 lines
2.3 KiB
Markdown
|
| Supported Targets | ESP32 | ESP32-C2 | ESP32-C3 | ESP32-S2 | ESP32-S3 |
|
||
|
|
| ----------------- | ----- | -------- | -------- | -------- | -------- |
|
||
|
|
|
||
|
|
|
||
|
|
# TCP TRANSPORT Client example
|
||
|
|
|
||
|
|
(See the README.md file in the upper level 'examples' directory for more information about examples.)
|
||
|
|
|
||
|
|
The application creates a TCP transport connection and tries to connect to the server with predefined IP address and port number. When a connection is successfully established, the application sends message and waits for the answer. After the server's reply, application prints received reply as ASCII text, waits for 2 seconds and sends another message.
|
||
|
|
|
||
|
|
## How to use example
|
||
|
|
|
||
|
|
In order to create TCP server that communicates with TCP TRANSPORT Client 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](http://netcat.sourceforge.net) 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 server using netcat
|
||
|
|
```
|
||
|
|
nc -l 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 `IPV4 Address` that represents remote host the example will connect to.
|
||
|
|
|
||
|
|
* Set `Port` number that represents remote port the example will connect to.
|
||
|
|
|
||
|
|
Configure Wi-Fi or Ethernet under "Example Connection Configuration" menu. See "Establishing Wi-Fi or Ethernet Connection" section in [examples/protocols/README.md](../../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).
|