zephyr

History

Anas Nashif 5060ca6a30 cmake: increase minimal required version to 3.13.1 Move to latest cmake version with many bug fixes and enhancements. Signed-off-by: Anas Nashif <anas.nashif@intel.com> Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>		2019-01-03 11:51:29 -05:00
..
src	samples: net: Convert to use generic logging macros	2018-12-07 12:00:04 +02:00
CMakeLists.txt	cmake: increase minimal required version to 3.13.1	2019-01-03 11:51:29 -05:00
prj_tls.conf	net: Remove obsolete config options from samples and tests	2018-10-11 14:44:14 -04:00
prj.conf	samples: net: ws_console: Convert to new logging system	2018-10-04 14:13:57 +03:00
README.rst
sample.yaml	net: websocket: Use system provided base64 function	2018-03-23 08:30:26 -04:00

README.rst

.. _websocket-console-sample:

Websocket Console
#################

Overview
********

The websocket-console sample application for Zephyr implements a console
over a websocket. The websocket-console sample application listens for incoming
IPv4 or IPv6 HTTP(S) requests and provides Zephyr console to the browser over
a websocket.

The source code for this sample application can be found at:
:file:`samples/net/ws_console`.

Requirements
************

- :ref:`networking_with_qemu`

Building and Running
********************

There are multiple ways to use this application. One of the most common
usage scenario is to run websocket-console application inside QEMU. This is
described in :ref:`networking_with_qemu`.

Build ws_console sample application like this:

.. zephyr-app-commands::
   :zephyr-app: samples/net/ws_console
   :board: qemu_x86
   :goals: run
   :compact:

The default make BOARD configuration for this sample is ``qemu_x86``.

Connect to the console from your browser using these URLs http://[2001:db8::1]
or http://192.0.2.1 as configured in the project's ``prj.conf`` file.