Zigbee: Light switch¶
The Zigbee light switch sample can be used to change the state of light sources on other devices within the same Zigbee network.
This sample supports the optional Sleepy End Device behavior and Multiprotocol Bluetooth LE extension. It also supports Zigbee FOTA. See Configuration files for sample extensions for details about how to enable these variants.
The sample supports the following development kits:
You can use one or more of the development kits listed above and mix different development kits.
For this sample to work, the following samples also need to be programmed:
The Zigbee network coordinator sample on one separate device.
The Zigbee: Light bulb sample on one or more separate devices.
The light switch sample demonstrates the Zigbee End Device role and implements the Dimmer Light Switch profile.
Once the light switch is successfully commissioned, it sends a broadcast message to find devices with the implemented Level Control and On/Off clusters. The light switch remembers the device network address from the first response, at which point it can be controlled with the development kit buttons.
The light switch supports the Sleepy End Device behavior that enables the sleepy behavior for the end device, for a significant conservation of energy.
The sleepy behavior can be enabled by pressing Button 3 while the light switch sample is booting.
This optional extension demonstrates dynamic concurrent switching between two protocols, Bluetooth LE and Zigbee. It uses Nordic UART Service (NUS) library.
When this extension is enabled, you can use:
Buttons on the light switch device to operate on the Zigbee network
Nordic UART Service to operate on the Bluetooth LE network
Both networks are independent from each other.
To support both protocols at the same time, the Zigbee stack uses the IEEE 802.15.4 radio during the inactive time of the Bluetooth LE radio (using Multiprotocol Service Layer’s Timeslot API). Depending on the Bluetooth LE connection interval, the nRF52 development kits can spend up to 99% of the radio time on the Zigbee protocol.
Transmitting and receiving data when using this example does not break connection from any of the used radio protocols, either Bluetooth LE or Zigbee.
For more information about the multiprotocol feature, see Multiprotocol support.
See Configuring your application for information about how to permanently or temporarily change the configuration.
This sample is split into the following source files:
mainfile to handle initialization and light switch basic behavior.
nus_cmdfile for handling NUS commands.
The sample provides predefined configuration files for optional extensions.
You can find the configuration files in the
Activating optional extensions¶
To activate the optional extensions supported by this sample, modify OVERLAY_CONFIG in the following manner:
overlay-fota.conffile can be used only for nRF52840 DK.
For the Multiprotocol Bluetooth LE extension, set
overlay-multiprotocol_ble.conf. Check Board names for the board name to use instead of the
Software FEM support is not present on nRF53 Series devices yet. For now, it also cannot be combined with multiprotocol operation.
You can add support for the nRF21540 front-end module to the sample. See Radio front-end module (FEM) support for more information.
To add support for the nRF21540 FEM, add the provided
dts-nrf21540-fem.overlay devicetree overlay file when building.
The file is located in the
Make sure that the GPIOs in the file correspond to those in which your front-end module is connected.
You must add the provided overlay file if you use the nRF21540 EK. If you use the nRF21540 DK, build your application for the nrf21540dk_nrf52840 board. The devicetree for the nRF21540 DK already contains the required FEM configuration, so you do not need to add the overlay file.
See Set devicetree overlays for different ways of adding the overlay file.
The easiest way to add the file when building is to set it in the
However, doing so will override the default settings.
For some boards, this sample requires additional overlay files, which are automatically included when building with the default settings.
When you set the
DTC_OVERLAY_FILE variable, you must specify all overlay files that are needed for building.
boards folder to see the additional overlay files.
Follow the instructions in Providing CMake options to specify the
For example, to build the sample from the command line for an nRF52833 DK with an attached nRF21540 EK, invoke the following command within the sample directory:
west build -b nrf52833dk_nrf52833 -- -DDTC_OVERLAY_FILE="boards/nrf52833dk_nrf52833.overlay;../common/dts-nrf21540-fem.overlay"
Alternatively, you can copy the contents of
dts-nrf21540-fem.overlay to the board’s overlay file.
To add support for other front-end modules, add the respective overlay files in the same way.
- LED 3:
On and solid when the device is connected to a Zigbee network.
- LED 4:
On and solid when the light switch has found a light bulb to control.
- Button 1:
When the light bulb is turned off, turn it back on.
Pressing this button for a longer period of time increases the brightness of the light bulb.
- Button 2:
Turn off the light bulb connected to the network (light bulb’s LED 4). This option is available after the successful commissioning (light switch’s LED 3 turned on).
Pressing this button for a longer period of time decreases the brightness of the LED 4 of the connected light bulb.
If the brightness level is at the minimum level, the effect of turning on the light bulb might not be noticeable.
- Button 3:
When pressed while resetting the kit, enable the Sleepy End Device behavior.
- LED 1:
On and solid when a Bluetooth LE Central is connected to the NUS service. Available when using Nordic UART Service (NUS) in the multiprotocol configuration.
- UART command assignments:
The following command assignments are configured and used in nRF Toolbox when Testing multiprotocol Bluetooth LE extension:
n- Turn on the Zigbee light bulb.
f- Turn off the Zigbee light bulb.
t- Toggle the Zigbee light bulb on or off.
i- Increase the brightness level of the Zigbee light bulb.
d- Decrease the brightness level of the Zigbee light bulb.
If more than one light bulb is available in the network, these commands apply to all light bulbs in the network. See Testing multiprotocol Bluetooth LE extension for details.
Make sure to enable the Zigbee stack before building and testing this sample. See Zigbee for more information.
This sample can be found under
samples/zigbee/light_switch in the nRF Connect SDK folder structure.
See Building and programming a sample application for information about how to build and program the application.
After programming the sample to your development kits, test it by performing the following steps:
Turn on the development kit that runs the network coordinator sample. When LED 3 turns on, this development kit has become the Coordinator of the Zigbee network.
Turn on the development kit that runs the light bulb sample. When LED 3 turns on, the light bulb has become a Router inside the network.
If LED 3 does not turn on, press Button 1 on the Coordinator to reopen the network.
Turn on the development kit that runs the light switch sample. When LED 3 turns on, the light switch has become an End Device, connected directly to the Coordinator.
Wait until LED 4 on the light switch node turns on. This LED indicates that the light switch found a light bulb to control.
You can now use buttons on the development kit to control the light bulb, as described in User interface.
Testing multiprotocol Bluetooth LE extension¶
To test the multiprotocol Bluetooth LE extension, complete the following steps after the standard Testing procedure:
Set up nRF Toolbox by completing the following steps:
Tap UART to open the UART application in nRF Toolbox.
Configure the UART commands by completing the following steps:
Tap the EDIT button in the top right corner of the application. The button configuration window appears.
Create the active application buttons by completing the following steps:
ncommand to one of the buttons, with EOL set to LF and an icon of your choice.
fcommand to one of the buttons, with EOL set to LF and an icon of your choice.
tcommand to one of the buttons, with EOL set to LF and an icon of your choice.
dcommand to one of the buttons, with EOL set to LF and an icon of your choice.
icommand to one of the buttons, with EOL set to LF and an icon of your choice.
Tap the DONE button in the top right corner of the application.
Tap CONNECT and select the
Zigbee_Switchdevice from the list of devices.
Observe that LED 1 on the light switch node is solid, which indicates that the Bluetooth LE connection is established.
In nRF Toolbox, tap the buttons you assigned:
fcommand buttons to turn the LED on the Zigbee light bulb node on and off, respectively.
tcommand button two times to toggle the LED on the Zigbee light bulb node on and off.
dcommand buttons to make adjustments to the brightness level.
You can now control the devices either with the buttons on the development kits or with the NUS UART command buttons in the nRF Toolbox application.
This sample uses the following nRF Connect SDK libraries:
This sample uses the following sdk-nrfxlib libraries:
In addition, it uses the following Zephyr libraries:
The following dependencies are added by the multiprotocol Bluetooth LE extension: