Zigbee: Network coordinator

This Network coordinator sample establishes the Zigbee network and commissions Zigbee devices that want to join the network.

You can use this sample together with the Zigbee Light bulb and the Zigbee Light switch to set up a basic Zigbee network.

Requirements

The sample supports the following development kits:

Hardware platforms

PCA

Board name

Board target

nRF54L15 DK

PCA10156

nrf54l15dk

nrf54l15dk/nrf54l15/cpuapp

Optionally, you can use this sample with one or both of the following samples:

You can mix different development kits.

Overview

This Zigbee Network coordinator sample demonstrates the Zigbee Coordinator role and implements two clusters (Basic and Identify) that used to be required by the Zigbee Home Automation profile. It is a minimal implementation that supports only the network steering commissioning mechanism. The Basic cluster provides attributes and commands for determining basic information about the node. The Identify cluster allows to set the device into the identification mode, which provides a way to locate the device.

Configuration

See Configuring and building in the nRF Connect SDK documentation for information about how to permanently or temporarily change the configuration.

User interface

LED 0:

Blinks to indicate that the main application thread is running.

LED 2:

Indicates whether the network is open or closed:

  • On - The network is open.

  • Off - The network is closed.

LED 3:

Blinks when the Network coordinator is in Identify mode.

Button 0:

Reopens the network for 180 seconds.

Note

The network is also opened after startup.

Button 3:

Depending on how long the button is pressed:

  • If pressed for less than five seconds, it starts or cancels the Identify mode.

  • If pressed for five seconds, it initiates the factory reset of the device. The length of the button press can be edited using the CONFIG_FACTORY_RESET_PRESS_TIME_SECONDS Kconfig option from Zigbee application utilities. Releasing the button within this time does not trigger the factory reset procedure.

Building and running

Make sure to configure the Zigbee stack before building and testing this sample. See Configuring Zigbee add-on for more information.

This sample can be found under samples/network_coordinator in the Zigbee add-on folder structure.

To build the sample, follow the instructions in Building an application in the nRF Connect SDK documentation for your preferred building environment. See also Programming an application for programming steps and Testing and optimization for general information about testing and debugging in the nRF Connect SDK.

Note

When building repository applications in the Zigbee add-on which is an SDK repository, building with sysbuild is enabled by default. If you work with out-of-tree freestanding applications, you need to manually pass the --sysbuild parameter to every build command or configure west to always use it.

Testing

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

  1. Turn on the development kit that runs the coordinator sample.

    • When LED 0 starts blinking, the main application thread has started.

    • When LED 2 turns on, this development kit has become the Coordinator of the Zigbee network and the network is established.

  2. Turn on the other development kits that you programmed.

    • When LED 2 turns on the development kit that runs the Light bulb sample, it has become a Router inside the network.

    • When LED 2 turns on the development kit that runs the Light switch sample, it has become an End Device, connected directly to the Coordinator.

    Note

    If LED 2 on the development kits does not turn on, press Button 0 on the Coordinator to reopen the network.

  3. Optionally, if you are testing with both the Light bulb and the Light switch samples, complete the following additional steps:

    1. Wait until LED 3 on the development kit that runs the Light switch sample turns on.

      This LED indicates that the switch found a light bulb to control.

    2. Use buttons on the development kit that runs the Light switch sample to control the light bulb, as described in the Light switch sample’s user interface section.

      The result of using the buttons is reflected on the light bulb’s LED 1.

You can now use buttons on the light switch to control the light bulb, as described in the User interface section of the Light switch sample page.

Dependencies

This sample uses the following nRF Connect SDK libraries:

This sample uses the ZBOSS stack:

In addition, it uses the following Zephyr libraries:

  • include/zephyr.h

  • include/device.h

  • Logging