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

# Asio chat server example

Simple Asio chat server using WiFi STA or Ethernet.

## Example workflow

- Wi-Fi or Ethernet connection is established, and IP address is obtained.
- Asio chat server is started on port number defined through the project configuration.
- Chat server echoes a message (received from any client) to all connected clients.

## Running the example

- Open 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 port number in menuconfig, "Example configuration".
- 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 (note the IP address).
- Connect to the server using multiple clients, for example using any option below.
    - build and run asi chat client on your host machine
    - run chat_client asio example on ESP platform
    - since chat message consist of ascii size and message, it is possible to 
        netcat `nc IP PORT` and type for example `   4ABC<CR>` to transmit 'ABC\n'

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 server 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 server 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 server is started on port number defined through the project configuration.`
examples/protocols/asio: use common network component 2018-11-20 16:44:31 +00:00			`- Chat server echoes a message (received from any client) to all connected clients.`
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 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 port number in menuconfig, "Example configuration".`
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 (note the IP address).`
			`- Connect to the server using multiple clients, for example using any option below.`
asio: initial idf port of asio library without ssl 2018-05-29 09:25:24 +00:00			`- build and run asi chat client on your host machine`
			`- run chat_client asio example on ESP platform`
			`- since chat message consist of ascii size and message, it is possible to`
			netcat `nc IP PORT` and type for example ` 4ABC<CR>` to transmit 'ABC\n'

			`See the README.md file in the upper level 'examples' directory for more information about examples.`