Historia

Angus Gratton 66fb5a29bb Whitespace: Automated whitespace fixes (large commit) Apply the pre-commit hook whitespace fixes to all files in the repo. (Line endings, blank lines at end of file, trailing whitespace)		2020-11-11 07:36:35 +00:00
..
main	Whitespace: Automated whitespace fixes (large commit)	2020-11-11 07:36:35 +00:00
CMakeLists.txt	examples/protocols/coap: use common network component	2019-04-15 03:32:05 +00:00
Makefile	Whitespace: Automated whitespace fixes (large commit)	2020-11-11 07:36:35 +00:00
README.md	coap: refactor examples, stylistic cleanups, move certs to independent dir	2019-08-06 10:37:41 +05:30
sdkconfig.defaults	coap: move mbedTLS config options from component to examples	2020-05-19 17:23:29 +05:30

README.md

CoAP server example

(See the README.md file in the upper level 'examples' directory for more information about examples.)
This CoAP server example is very simplified adaptation of one of the libcoap examples.

CoAP server example will startup a daemon task, receive requests / data from CoAP client and transmit data to CoAP client.

If the incoming request requests the use of DTLS (connecting to port 5684), then the CoAP server will try to establish a DTLS session using the previously defined Pre-Shared Key (PSK) - which must be the same as the one that the CoAP client is using, or Public Key Infrastructure (PKI) where the PKI information must match as requested.

NOTE: Client sessions trying to use coaps+tcp:// are not currently supported, even though both libcoap and MbedTLS support it.

The Constrained Application Protocol (CoAP) is a specialized web transfer protocol for use with constrained nodes and constrained networks in the Internet of Things.
The protocol is designed for machine-to-machine (M2M) applications such as smart energy and building automation.

Please refer to RFC7252 for more details.

How to use example

Configure the project

idf.py menuconfig

Example Connection Configuration --->

Set WiFi SSID under Example Configuration
Set WiFi Password under Example Configuration Example CoAP Client Configuration --->
If PSK, Set CoAP Preshared Key to use in connection to the server Component config ---> CoAP Configuration --->
- Set encryption method definition, PSK (default) or PKI
- Enable CoAP debugging if required

Build and Flash

Build the project and flash it to the board, then run monitor tool to view serial output:

idf.py build
idf.py -p PORT flash monitor

(To exit the serial monitor, type Ctrl-].)

See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects.

Example Output

current CoAP server would startup a daemon task,
and the log is such as the following:

...
I (332) wifi: mode : sta (30:ae:a4:04:1b:7c)
I (1672) wifi: n:11 0, o:1 0, ap:255 255, sta:11 0, prof:1
I (1672) wifi: state: init -> auth (b0)
I (1682) wifi: state: auth -> assoc (0)
I (1692) wifi: state: assoc -> run (10)
I (1692) wifi: connected with huawei_cw, channel 11
I (1692) wifi: pm start, type: 1

I (2622) event: sta ip: 192.168.3.84, mask: 255.255.255.0, gw: 192.168.3.1
I (2622) CoAP_server: Connected to AP
...

If a CoAP client queries the /Espressif resource, CoAP server will return "Hello World!"
until a CoAP client does a PUT with different data.

libcoap Documentation

This can be found at https://libcoap.net/doc/reference/4.2.0/

Troubleshooting

Please make sure CoAP client fetchs or puts data under path: /Espressif or fetches /.well-known/core
CoAP logging can be enabled by running 'idf.py menuconfig -> Component config -> CoAP Configuration' and setting appropriate log level