Skip to content

Latest commit

 

History

History
134 lines (88 loc) · 6.29 KB

quick-start.rst

File metadata and controls

134 lines (88 loc) · 6.29 KB

Quick start guide

Note

This guide demonstrates some of the basic concepts of the Zigbee network using the |addon| for the |NCS| and the |nRFVSC|. It guides you through programming and testing of the required samples.

As part of this guide, you are going to program three Zigbee samples onto three different development kits in order to set up a basic Zigbee network composed of three devices, or nodes. A node is "a testable implementation of a Zigbee application on a single stack with a single network address, and on a single network".

Zigbee star topology setup for this guide

Zigbee star topology setup for this guide

The figure shows the Zigbee network star topology you are going to set up. See :ref:`zigbee_topologies` for more information.

Each of the samples you will use for forming the network is based on the single-chip, single-protocol architecture, uses the default configuration (that is, without any additional sample extensions enabled) and has a clearly defined role:

All these samples also implement the Basic and Identify clusters, which are the basic Zigbee clusters.

For this quick start guide, you need to meet all software requirements listed on the :ref:`zigbee_setup` page. When installing the |NCS|, use |VSC| and the |nRFVSC|.

You also need three nRF54L15 development kits:

Note

Make sure that you have three development kits before proceeding to the next steps.

.. rst-class:: numbered-step

To program the samples, complete the following steps:

  1. Program the Zigbee network coordinator sample to one of the boards:

    1. Connect your development kit using the serial port.

    2. In the :guilabel:`Connected Devices View`, click :guilabel:`Refresh Connected Devices`. Your development kit appears on the list.

    3. In the :guilabel:`Actions View`, click :guilabel:`Flash`.

      nRF Connect for Visual Studio Code - Refresh Connected Devices and Flash buttons

    When the programming is done, the LED 1 on the development kit turns on to indicate that the Zigbee network is open. After some time, it turns off and the Zigbee network needs to be reopened (see below).

  2. Add the Zigbee light switch sample.

    Repeat Steps 2 and 3 for the sample.

  3. Add the Zigbee light bulb sample.

    Repeat Steps 2 and 3 for the sample. The LED 2 turns on when the application is started.

  4. Press Button 0 on the development kit programmed with the network coordinator sample to reopen the Zigbee network. After some time, the devices join the Zigbee network.

    • On the development kit programmed with the light bulb sample, LED 1 turns on when the light bulb joins the network.
    • On the development kit programmed with the light switch sample, LED 1 turns on when the device joins the network and LED 2 turns on when the light switch finds a light bulb to control.
Reopening the network

If you find that you are having issues with your devices joining the Zigbee network, it may be because the network needs to be reopened manually. By default, the network remains open for 180 seconds at startup and after Button 0 is pressed. After 180 seconds have passed, the network will close and needs to be re-opened.

When the network is open, LED 1 on the development kit programmed with the network coordinator sample will be on. If LED 1 is not on, then the network is closed and needs to be reopened again.

To reopen the network, press Button 0 on the development kit that has been programmed as the network coordinator.

For more information, see the :ref:`User interface <zigbee_network_coordinator_user_interface>` section for the :ref:`Zigbee Network coordinator <zigbee_network_coordinator_sample>` sample.

.. rst-class:: numbered-step

After forming the Zigbee network, test the interaction between the devices:

  1. Press Button 1 once on the development kit programmed with the light switch sample to turn off the light bulb's LED 1.
  2. Press Button 0 once on the development kit programmed with the light switch sample to turn on the light bulb's LED 1.
  3. Press and hold Button 0 on the development kit programmed with the light switch sample to decrease the light bulb's LED 1 brightness.
  4. Press and hold Button 1 on the development kit programmed with the light switch sample to increase the light bulb's LED 1 brightness.

After you complete this quick start guide, we recommend that you get familiar with the following topics: