feedc0de/esp-protocols
1
0
Fork 0
forked from espressif/esp-protocols
Code Pull Requests Activity
Files
0d1d73eb35a9689e6464ea35d1941d4584ce7aa7
esp-protocols/examples/protocols/asio/chat_client/README.md

21 lines
1.2 KiB
Markdown
Raw Normal View History

examples/protocols/asio: use common network component * Original commit: espressif/esp-idf@aa4a7804ec5bd1f8a1da046dfe1fd7368ded2205
2018-11-21 00:44:31 +08:00
# Asio chat client example
asio: initial idf port of asio library without ssl * Original commit: espressif/esp-idf@1ef13c524c484e9fb62e6c0b11482c30c5383728
2018-05-29 11:25:24 +02:00
examples/protocols/asio: use common network component * Original commit: espressif/esp-idf@aa4a7804ec5bd1f8a1da046dfe1fd7368ded2205
2018-11-21 00:44:31 +08:00
Simple Asio chat client using WiFi STA or Ethernet.
asio: initial idf port of asio library without ssl * Original commit: espressif/esp-idf@1ef13c524c484e9fb62e6c0b11482c30c5383728
2018-05-29 11:25:24 +02:00
## Example workflow
examples/protocols/asio: use common network component * Original commit: espressif/esp-idf@aa4a7804ec5bd1f8a1da046dfe1fd7368ded2205
2018-11-21 00:44:31 +08:00
- Wi-Fi or Ethernet connection is established, and IP address is obtained.
build system: Use CMake-based build system as default when describing commands * Original commit: espressif/esp-idf@47bbb107a8deaa80692ebc3b9369ae0618c3bc56
2019-06-23 11:54:31 +10:00
- Asio chat client connects to the corresponding server whose port number and IP are defined through the project configuration menu.
examples: change default build instructions in docs to CMake * Original commit: espressif/esp-idf@e7dba7d7bc6218eea440dfe6f55592b8c21f6083
2019-08-02 09:01:20 +05:30
- Chat client receives all messages from other chat clients, also it sends message received from stdin using `idf.py -p PORT monitor`.
asio: initial idf port of asio library without ssl * Original commit: espressif/esp-idf@1ef13c524c484e9fb62e6c0b11482c30c5383728
2018-05-29 11:25:24 +02:00
## Running the example
build system: Use CMake-based build system as default when describing commands * Original commit: espressif/esp-idf@47bbb107a8deaa80692ebc3b9369ae0618c3bc56
2019-06-23 11:54:31 +10:00
- 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.
examples/protocols/asio: use common network component * Original commit: espressif/esp-idf@aa4a7804ec5bd1f8a1da046dfe1fd7368ded2205
2018-11-21 00:44:31 +08:00
- Set server IP address and port number in menuconfig, "Example configuration".
- Start chat server either on host machine or as another ESP device running chat_server example.
build system: Use CMake-based build system as default when describing commands * Original commit: espressif/esp-idf@47bbb107a8deaa80692ebc3b9369ae0618c3bc56
2019-06-23 11:54:31 +10:00
- Run `idf.py -p PORT flash monitor` to build and upload the example to your board and connect to it's serial terminal.
examples/protocols/asio: use common network component * Original commit: espressif/esp-idf@aa4a7804ec5bd1f8a1da046dfe1fd7368ded2205
2018-11-21 00:44:31 +08:00
- Wait for the board to connect to WiFi or Ethernet.
asio: initial idf port of asio library without ssl * Original commit: espressif/esp-idf@1ef13c524c484e9fb62e6c0b11482c30c5383728
2018-05-29 11:25:24 +02:00
- Receive and send messages to/from other clients on stdin/stdout via serial terminal.
See the README.md file in the upper level 'examples' directory for more information about examples.
Copy Permalink