zephyr/samples/net
David B. Kinder 2cb045420c doc: fix .rst files canonical heading order
The headings on some .rst files were not following the expected
heading order of using # for h1, * for h2, = for h3, and - for h4
This patch fixes that, and the doc/templates/*.tmpl files created
for folks to use as templates for creating board and sample docs.

Change-Id: I0263b005648558d5ea41a681ceaa4798c9594dd9
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-01-20 16:06:36 -08:00
..
common license: Replace Apache boilerplate with SPDX tag 2017-01-19 03:50:58 +00:00
dhcpv4_client net: samples: Print assigned address from DHCPv4 server 2017-01-20 16:23:21 +02:00
dns_client doc: fix .rst files canonical heading order 2017-01-20 16:06:36 -08:00
echo_client samples: net: Enable buffer warning and errors in echo apps on qemu 2017-01-20 16:23:19 +02:00
echo_server net: echo-server: Discard 0 byte received packets 2017-01-20 16:23:21 +02:00
ieee802154 license: Replace Apache boilerplate with SPDX tag 2017-01-19 03:50:58 +00:00
leds_demo license: Replace Apache boilerplate with SPDX tag 2017-01-19 03:50:58 +00:00
mbedtls_dtlsclient doc: fix .rst files canonical heading order 2017-01-20 16:06:36 -08:00
mbedtls_dtlsserver doc: fix .rst files canonical heading order 2017-01-20 16:06:36 -08:00
mbedtls_sslclient license: Replace Apache boilerplate with SPDX tag 2017-01-19 03:50:58 +00:00
wpan_serial wpan_serial: Fix possible NULL pointer dereference 2017-01-20 16:23:21 +02:00
wpanusb license: Replace Apache boilerplate with SPDX tag 2017-01-19 03:50:58 +00:00
zoap_client net: zoap-client: Add bluetooth support 2017-01-20 16:23:20 +02:00
zoap_server samples/zoap_server: Do not error if there's no payload or queries 2017-01-20 16:23:19 +02:00
zperf doc: fix .rst files canonical heading order 2017-01-20 16:06:36 -08:00
README samples/net: Update DNS client README file to RST format 2017-01-13 10:29:00 +01:00
net.rst net: doc: add section about networking with qemu 2017-01-16 14:04:20 -05:00
qemu_setup.rst net: doc: add section about networking with qemu 2017-01-16 14:04:20 -05:00

README

Description of various IP stack test applications
=================================================

echo_server
-----------

The echo server test implements a network server that listens
UDP sockets. If that socket receives data, the server reverses
the data and sends it back.

The echo client can be running in the host system in which
case you need to use SLIP to connect to qemu. This usage scenario
is described in net-tools project README file [1]. This is the default
if you type "make run" in echo_server test application directory.
The network IP stack hooks right under IP stack (network level)
and sends the IP packet to host using SLIP. The layer 2 is the
SLIP layer in this case, no radio layer is simulated or used.

The echo server qemu instance can also be running against echo
client that is running in another qemu. For this you need two
terminal windows. In terminal 1 go to echo_server directory
and type "make server". This will start the echo server and setup
qemu pipes in suitable way and it will also start monitor application
that will store the transferred network traffic into pcap file
for later analysis. Then in terminal 2 go to echo_client directory and
type "make client". This will start the echo client that will
start to send data to the server and verify that it has received
the data back correctly. In the two qemu case we are simulating
the whole radio network meaning that the saved pcap file will
contain 802.15.4 network packets.


echo_client
-----------

The echo client test implements a network client that will
send UDP data to the echo server. The client verifies that
it has received data to the sent message and that the data
is correct.

The echo server can be running in the host system in which case
you need to use SLIP to connect to qemu. This usage scenario
is described in net-tools project README file [1]. This is the default
if you type "make run" in echo_client test application directory.
The network IP stack hooks right under IP stack (network level)
and sends the IP packet to host using SLIP. The layer 2 is the
SLIP layer in this case, no radio layer is simulated or used.

The echo client qemu instance can also be running against echo
server that is running in another qemu. This test scenario is
described in echo_server chapter above.


zoap_server
-----------

The Zoap server application implements a trivial CoAP server
which exposes a single resource "a/light", that only provides the
GET method.

It can be run similar to the echo_server sample: using two terminals,
(1) for zoap_server, run 'make server' in its directory, (2) for
zoap_client, run 'make client' in the zoap_client test directory.


zoap_client
-----------

The Zoap client application does a single request against a 'a/light'
resource, which has the first response lost (so retransmissions are
basically verified).

Please refer to the section above about how to run these applications
together.

wpanusb
-------

The wpanusb application exports IEEE 802.15.4 radio over USB to be used in
other Operating Systems like Linux. In this scenario Linux SoftMAC driver
must be used implementing IEEE 802.15.4 stack inside Linux.

wpan_serial
-----------

The wpan_serial application implements IEEE 802.15.4 "serial-radio" protocol.
This is the protocol used in Contiki-based native border routers.

[1] https://gerrit.zephyrproject.org/r/gitweb?p=net-tools.git;a=summary