Thread: CoAP Server

The Thread CoAP Server sample demonstrates controlling light resources within an OpenThread network. This sample exposes resources in the network. To access them, you need another sample that is compatible with the OpenThread network. The recommended sample referenced on this page is Thread: CoAP Client.

Requirements

The sample supports the following development kits:

Hardware platforms

PCA

Board name

Board target

nRF5340 DK

PCA10095

nrf5340dk

nrf5340dk/nrf5340/cpuapp/ns nrf5340dk/nrf5340/cpuapp

nRF52840 DK

PCA10056

nrf52840dk

nrf52840dk/nrf52840

nRF21540 DK

PCA10112

nrf21540dk

nrf21540dk/nrf52840

You can use one or more of these development kits as the Thread CoAP Server. You also need one or more compatible development kits programmed with the Thread: CoAP Client sample.

When built for a board target with the */ns variant, the sample is configured to compile and run as a non-secure application with Cortex-M Security Extensions enabled. Therefore, it automatically includes Trusted Firmware-M that prepares the required peripherals and secure services to be available for the application.

Overview

This sample demonstrates how to expose resources that can be accessed by other devices in the same Thread network. You can use this sample application as a starting point to implement a CoAP application.

The following CoAP resources are exposed on the network by this sample:

  • /light - used to control LED 4

  • /provisioning - used to perform provisioning

This sample uses the native OpenThread CoAP API for communication. For new application development, use Zephyr’s CoAP API. For example usage of the Zephyr CoAP API, see the Thread: CoAP Client sample.

User interface

Button 4:

Pressing results in entering the pairing mode for a limited period of time.

LED 1:

Lit when the OpenThread connection is established.

LED 3:

Blinks when the pairing mode is enabled.

LED 4:

Turned on and off by messages sent from the client nodes.

Configuration

See Configuring and building an application for information about how to permanently or temporarily change the configuration.

Snippets

The sample provides predefined Snippets for typical use cases, and to activate sample extensions. You can find the snippets in the snippets directory of the sample.

Specify the corresponding snippet names in the coap_server_SNIPPET CMake option. For more information about using snippets, see Using Snippets in the Zephyr documentation.

The following snippets are available:

  • debug - Enables debugging the Thread sample by enabling __ASSERT() statements globally.

  • logging - Enables logging using RTT. For additional options, refer to RTT logging.

FEM support

You can add support for the nRF21540 front-end module to this sample by using one of the following options, depending on your hardware:

  • Build the sample for one board that contains the nRF21540 FEM, such as nrf21540dk/nrf52840.

  • Manually create a devicetree overlay file that describes how FEM is connected to the nRF5 SoC in your device. See Set devicetree overlays for different ways of adding the overlay file.

  • Provide nRF21540 FEM capabilities by using a shield, for example the nRF21540 EK shield that is available in the nRF Connect SDK. In this case, build the project for a board connected to the shield you are using with an appropriate variable included in the build command, for example SHIELD=nrf21540ek. This variable instructs the build system to append the appropriate devicetree overlay file.

    To build the sample in the nRF Connect for VS Code IDE for an nRF52840 DK with the nRF21540 EK attached, add the shield variable in the build configuration’s Extra CMake arguments and rebuild the build configuration. For example: -DSHIELD=nrf21540ek.

    See nRF Connect for VS Code extension pack documentation for more information.

    See Programming nRF21540 EK for information about how to program when you are using a board with a network core, for example nRF5340 DK.

Each of these options adds the description of the nRF21540 FEM to the devicetree. See Working with RF front-end modules for more information about FEM in the nRF Connect SDK.

To add support for other front-end modules, add the respective devicetree file entries to the board devicetree file or the devicetree overlay file.

Building and running

Make sure to enable the OpenThread stack before building and testing this sample. See Thread for more information.

This sample can be found under samples/openthread/coap_server in the nRF Connect SDK folder structure.

When built as firmware image for a board target with the */ns variant, the sample has Cortex-M Security Extensions (CMSE) enabled and separates the firmware between Non-Secure Processing Environment (NSPE) and Secure Processing Environment (SPE). Because of this, it automatically includes the Trusted Firmware-M (TF-M). To read more about CMSE, see Processing environments.

To build the sample with Visual Studio Code, follow the steps listed on the How to build an application page in the nRF Connect for VS Code extension documentation. See Configuring and building an application for other building scenarios, Programming an application for programming steps, and Testing and optimization for general information about testing and debugging in the nRF Connect SDK.

Testing

After building the sample and programming it to your development kit, complete the following steps to test it:

  1. Program at least one development kit with the Thread: CoAP Client sample and reset it.

  2. Turn on the Simple CoAP Client node. This node becomes the Thread network Leader.

  3. Turn on all the other nodes, including the Simple CoAP Server nodes. They enter the network as Children, and gradually become Routers.

    Note

    It can take up to 15 seconds for Thread to establish the network.

  4. Press Button 2 on the client node to control LED 4 on all server nodes.

  5. To pair a client with a server, complete the following steps:

    1. Press Button 4 on a server node to enable pairing.

    2. Press Button 3 on a client node to pair it with the server node in the pairing mode.

  6. Press Button 1 on the client node to control the LED 4 on the paired server node.

Running OpenThread CLI commands

You can connect to any of the Simple CoAP Server or Simple CoAP Client nodes with a terminal emulator that supports VT100/ANSI escape characters (for example, nRF Connect Serial Terminal). See Testing and optimization for the required settings and steps.

Once the serial connection is ready, you can run OpenThread CLI commands. For complete CLI documentation, refer to OpenThread CLI Reference.

Note

In Zephyr shell, every OpenThread command needs to be preceded with the ot keyword. For example, ot channel 20.

Dependencies

This sample uses the following nRF Connect SDK libraries:

In addition, it uses the following Zephyr libraries:

OpenThread CoAP API is used in this sample:

In addition, it uses the following secure firmware component: