zephyr/samples/net/zoap_server
David B. Kinder 7bc4890202 doc: add labels to net sample docs for linking
Docs need a label at the top so we can use :ref:`labelname`
to create a link to that doc from other docs.

Change-Id: I46cd75d714449de806a85dde08756c8e190488dc
Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2017-04-04 19:52:06 +00:00
..
src samples/net: Uses CONFIG_NET_APP_IEEE802154_* options relevantly 2017-03-31 11:24:27 +02:00
Makefile samples/zoap_server: Allow overriding the BOARD variable 2017-02-03 15:59:14 +02:00
prj_bt.conf net: samples: Add CONFIG_NET_L2_BLUETOOTH_ZEP1656 2017-02-03 15:59:20 +02:00
prj_cc2520.conf samples/net: Uses CONFIG_NET_APP_IEEE802154_* options relevantly 2017-03-31 11:24:27 +02:00
prj.conf net: Remove NET_SLIP choice from Kconfig 2017-01-13 10:29:02 +01:00
README.rst doc: add labels to net sample docs for linking 2017-04-04 19:52:06 +00:00
testcase.ini samples/zoap_server: Add a 802.15.4 case to the test suite 2017-02-03 15:59:14 +02:00

.. _zoap-server-sample:

CoAP Server
###########

Overview
********

A simple CoAP server showing how to expose a simple resource.

This demo assumes that the platform of choice has networking support,
some adjustments to the configuration may be needed.

The sample will listen for requests in the CoAP UDP port (5683) in the
site-local IPv6 multicast address reserved for CoAP nodes.

The sample exports the following resources:

.. code-block:: none

   /test
   /seg1/seg2/seg3
   /query
   /separate
   /large
   /location-query
   /large-update

These resources allow a good part of the ETSI testcases to be run
against zoap-server.

Building And Running
********************

This project has no output in case of success, the correct
functionality can be verified by using some external tool like tcpdump
or wireshark.

See the `net-tools`_ project for more details

It can be built and executed on QEMU as follows:

.. code-block:: console

    make run


Use this command on the host to run the`libcoap`_ implementation of
the ETSI testcases:

.. code-block:: console

   sudo ./examples/etsi_coaptest.sh -i tap0 2001:db8::1

To build the version supporting the TI CC2520 radio, use the supplied
configuration file enabling IEEE 802.15.4:

.. code-block:: console

    make CONF_FILE=prj_cc2520.conf run


.. _`net-tools`: https://gerrit.zephyrproject.org/r/gitweb?p=net-tools.git;a=tree

.. _`libcoap`: https://github.com/obgm/libcoap