Enhanced ShockBurst: Receiver
The sample shows how to use the Enhanced ShockBurst (ESB) protocol in receiver mode. It shows how to configure the Enhanced ShockBurst protocol to receive packets.
Requirements
The sample supports the following development kits:
Hardware platforms |
PCA |
Board name |
Board target |
Shields |
---|---|---|---|---|
PCA10156 |
|
|||
nRF54L15 DK |
PCA10156 |
|
||
PCA10175 |
|
|||
PCA10095 |
|
|
||
PCA10040 |
|
|||
PCA10040 |
|
|||
PCA10056 |
|
|||
PCA10100 |
|
|||
PCA10112 |
|
Additionally, if you want to test the Enhanced ShockBurst Transmitter functionality, you need to build and run the Enhanced ShockBurst: Transmitter sample. You can use any two of the listed development kits and mix different development kits.
Overview
The sample consists of one Receiver that uses the Enhanced ShockBurst library. After building and programming each sample on an nRF52 Series development kit, you can test that packets that are sent by the kit that runs the Transmitter sample are picked up by the kit that runs the Receiver sample. Successful communication is indicated by LED changes, which should be in sync on both kits.
The Receiver sample listens for packets and sends an ACK when a packet is received. If packets are successfully received from the Transmitter, the LED pattern changes every time a packet is received.
User interface
- All LEDs:
Indicate that packets are sent or received. The first four packets turn on the LEDs sequentially. The next four packets turn them off again in the same order.
Configuration
See Configuring and building for information about how to permanently or temporarily change the configuration.
Building and running
The Receiver sample can be found under samples/esb/esb_prx
in the nRF Connect SDK folder structure.
See Building an application and Programming an application for information about how to build and program the application, respectively.
Note
Programming the nRF54H20 SoC can sometimes fail due to conflicts in the resource configuration. This can happen if, for example, an application programmed to the nRF54H20 SoC configured the UICRs for one or more cores in a way that is incompatible with the configuration required by the application you are trying to program on the SoC.
To fix this error and erase the UICR for the application core, run the following command:
nrfutil device recover --core Application
If your sample also uses the radio core, you must also erase the UICRs for the radio core. To erase the UICR for the radio core, run the following command:
nrfutil device recover --core Network
For more information on the command, run:
nrfutil device recover --help
You can then run west flash
to program your application.
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 Developing with 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.
To build the sample from the command line for an nRF52840 DK with the nRF21540 EK attached, use the following command within the sample directory:
west build -b nrf52840dk/nrf52840 -- -DSHIELD=nrf21540ek
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 Developing with 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.
Testing
After programming the Transmitter sample on one of the development kits and the Receiver sample on the other kit, you can test their functionality.
Complete the following steps to test both the Transmitter and Receiver samples:
Power on both kits.
Observe that the LEDs change synchronously on both kits.
Optionally, connect to the kits with a terminal emulator (for example, nRF Connect Serial Terminal). See Testing and optimization for the required settings and steps.
Observe the logging output for both kits.
Dependencies
This sample uses the following nRF Connect SDK library:
In addition, it uses the following Zephyr libraries:
include/zephyr/types.h
-
include/kernel.h
include/irq.h
-
include/gpio.h