OVMS3-idf/examples/protocols/asio/chat_client/README.md

# Asio chat client example

Simple Asio chat client using WiFi STA or Ethernet.

## Example workflow

- Wi-Fi or Ethernet connection is established, and IP address is obtained.
- Asio chat client connects to the corresponding server whose port number and IP are defined through the project configuration menu.
- Chat client receives all messages from other chat clients, also it sends message received from stdin using `idf.py -p PORT monitor`.

## Running the example

- 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.
- 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.
- Run `idf.py -p PORT flash monitor` to build and upload the example to your board and connect to it's serial terminal.
- Wait for the board to connect to WiFi or Ethernet.
- 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.
examples/protocols/asio: use common network component 2018-11-20 16:44:31 +00:00			`# Asio chat client example`
asio: initial idf port of asio library without ssl 2018-05-29 09:25:24 +00:00
examples/protocols/asio: use common network component 2018-11-20 16:44:31 +00:00			`Simple Asio chat client using WiFi STA or Ethernet.`
asio: initial idf port of asio library without ssl 2018-05-29 09:25:24 +00:00
			`## Example workflow`

examples/protocols/asio: use common network component 2018-11-20 16:44:31 +00: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 2019-06-23 01:54:31 +00: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 2019-08-02 03:31:20 +00:00			- 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 2018-05-29 09:25:24 +00:00
			`## Running the example`

build system: Use CMake-based build system as default when describing commands 2019-06-23 01:54:31 +00: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 2018-11-20 16:44:31 +00: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 2019-06-23 01:54:31 +00: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 2018-11-20 16:44:31 +00:00			`- Wait for the board to connect to WiFi or Ethernet.`
asio: initial idf port of asio library without ssl 2018-05-29 09:25:24 +00: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.`