nRF5 SDK for Thread and Zigbee v4.1.0
Zigbee Light Control example

Table of Contents

This information applies to the following SoCs: nRF52833 and nRF52840.

The Zigbee light control example demonstrates a basic Zigbee network. It provides a minimal implementation of the following devices:

The coordinator establishes the network and commissions the light bulb and light switch. Once the light switch is successfully commissioned, it sends a broadcast message to find any device with implemented Level Control and On/Off clusters. It remembers the device network address from the first response and is controlled through on-board buttons.


Setup

You can find the source code and the makefiles in the following folders:

The light switch can be used with the CLI Agent example to establish control with a light bulb. The light switch also shows an additional way of reducing current consumption when the sleepy behavior is enabled.

LED and button assignments

All devices use LED assignments as described in Zigbee BSP LED and button reference for the following LEDs:

Moreover, the following LEDs reserved for user application purposes are assigned in this example:

The following buttons reserved for user application purposes are assigned in this example:

Note
If you decrease the brightness level to the minimum, the effect of turning on the light bulb might not be noticeable.

By default, the light bulb controls the WS2812 LED chain (for example, the Adafruit NeoPixel Shield for Arduino), which can be connected to the P1.07 pin of the evaluation board. When connected, the LED chain lights up simultaneously with LED4. Not connecting the WS2812 does not affect the operation of the example. Controlling the WS2812 LED chain can be also disabled by setting APP_BULB_USE_WS2812_LED_CHAIN macro in sdk_config.h to 0.

Note
When you use the light bulb or light coordinator on the nRF52840 Dongle (PCA10059), it is the LED3 that informs about the successful network joining.

The switch does support the Sleepy End Device behavior, meaning that the stack can make the CPU enter the sleep mode, which results in a significant conservation of energy and prolonged battery life. The device will automatically wake itself up on an event. Moreover, the CPU will wake itself from time to time to ensure the correct processing of stack internals.


Testing

Precondition
To test the Zigbee light control example, prepare at least three boards.
Note
The network stays opened for 180 seconds after the coordinator start-up. Use Button 1 on the coordinator node to reopen the network if needed.

To test the example:

  1. Build the example according to the instructions in Building examples.
  2. Program one board for each example: Light coordinator, Light switch, and Light bulb.
  3. Turn on the Light coordinator node. LED3 turns on. The node becomes the Coordinator of the network.
  4. Turn on the Light bulb node. LED3 turns on. The node becomes a Router inside the network.
  5. Turn on the Light switch node. LED3 turns on. The node becomes an End Device, connected directly to the Coordinator.
  6. Wait until LED4 on the light switch node turns on. This LED indicates that the switch found a light bulb to control.

You can now use buttons on the board to control the light bulb, as described in LED and button assignments.


Testing Zigbee Light Switch with ZCL Groups

The Zigbee light control example also incorporates a light switch with the ZCL Groups functionality. Such switch sends a broadcast message to find the devices with implemented Level Control and On/Off clusters, but instead of controlling the first discovered light bulb, it creates a group out of all the suitable devices and controls them at once.

The testing procedure is different when you use ZCL Groups, and you need at least five boards:

  1. Build the example according to the instructions in Building examples.
  2. Program one board for each example: Light coordinator and Light switch with ZCL Groups.
  3. Program three boards with the Light bulb example.
  4. Turn on the Light coordinator node. LED3 turns on. The node becomes the Coordinator of the network.
  5. Turn on all the Light bulb nodes. LED3 turns on on each of them. The nodes become Routers inside the network.
  6. Turn on the Light switch with ZCL Groups node. LED3 turns on. The node becomes an End Device, connected directly to the Coordinator.
  7. Wait until LED4 on the light switch node turns on. This LED indicates that the switch found at least one light bulb to control.

You can now use buttons on the board to control the light bulb, as described in LED and button assignments.


Documentation feedback | Developer Zone | Subscribe | Updated