mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00

History

Hauke Petersen 2290a9f69b net/gcoap: added remote sock ep to resp handler cb When receiving a response to a request send our earlier, it is in some cases essential, to know something about who send the reponse. This is needed for example when sending requests to multicast addresses to be able to react to different incoming responses.		2017-07-31 11:11:06 +02:00
..
gcoap_cli.c	net/gcoap: added remote sock ep to resp handler cb	2017-07-31 11:11:06 +02:00
main.c	gcoap: Remove coap.h include file, which is no longer used.	2017-01-20 22:00:25 -05:00
Makefile	examples/gcoap: remove non-necessary dependencies	2017-05-22 12:23:43 +02:00
Makefile.slip	examples/gcoap: remove non-necessary dependencies	2017-05-22 12:23:43 +02:00
README-slip.md	gcoap: CLI example	2016-10-31 22:41:52 -04:00
README.md	net/gcoap: moved implemenation status to gcoap.h	2017-05-24 09:25:11 +02:00
slip_params.h	gcoap: CLI example	2016-10-31 22:41:52 -04:00

README.md

gcoap Example

This application provides command line access to gcoap, a high-level API for CoAP messaging. See the CoAP spec for background, and the Modules>Networking>CoAP topic in the source documentation for detailed usage instructions and implementation notes.

We support two setup options for this example:

Native networking

Build with the standard Makefile. Follow the setup instructions for the gnrc_networking example.

SLIP-based border router

Build with Makefile.slip. Follow the setup instructions in README-slip.md, which are based on the SLIP instructions for the gnrc_border_router example. We also plan to provide or reference the ethos/UHCP instructions, but we don't have it working yet.

Example Use

This example uses gcoap as a server on RIOT native. Then we send a request from a libcoap example client on the Linux host.

Verify setup from RIOT terminal

> coap info

Expected response:

CoAP server is listening on port 5683
 CLI requests sent: 0
CoAP open requests: 0

Query from libcoap example client

gcoap does not provide any output to the CoAP terminal when it handles a request. We recommend use of Wireshark to see the request and response. You also can add some debug output in the endpoint function callback.

./coap-client -N -m get -p 5683 coap://[fe80::1843:8eff:fe40:4eaa%tap0]/.well-known/core

Example response:

v:1 t:NON c:GET i:0daa {} [ ]
</cli/stats>

The response shows the endpoint registered by the gcoap CLI example.

Send query to libcoap example server

Start the libcoap example server with the command below.

./coap-server

Enter the query below in the RIOT CLI.

> coap get fe80::d8b8:65ff:feee:121b 5683 /.well-known/core

CLI output:

gcoap_cli: sending msg ID 743, 75 bytes
> gcoap: response Success, code 2.05, 105 bytes
</>;title="General Info";ct=0,</time>;if="clock";rt="Ticks";title="Internal Clock";ct=0;obs,</async>;ct=0