UG252: Lighting Reference Design Demo Board Kit User's Guide (RD-0035-0601, RD-0085-0401, RD-0098-0401) Silicon Labs' compact and cost-effective lighting reference design is based on the Zig- bee 3.0 standard and can be used in conjunction with a Zigbee 3.0 home automation system. This reference design kit features Silicon Labs’ EM3585 (RD-0035-0601), EFR32MG1P732F256GM32 (RD-0085-0401) or EFR32MG12P432F1024GM32 (RD-0098-0401) Wireless Microcontroller (MCU). This document contains instructions and guidelines for the following: a quick-start dem- onstration and next steps, system overview and operations, hardware, firmware and ecosystem considerations, and engineering and manufacturing testing. This guide ap- plies to EmberZNet PRO 6.0 and later. The reference design comes preprogrammed with the Zigbee Z3ColorControlLight sample application and is fully functional out of the box. All hardware design files are available within Simplicity Studio, Zigbee firmware application source code is available within the EmberZNet PRO stack, and Thread firmware application source is available within the Thread stack. Access to Zigbee and Thread stacks is available after pur- chasing and registering a wireless starter kit such as the SLWSTK6000B. Additional in- formation about acquiring a wireless starter kit is available: https://www.silabs.com/ products/development-tools/wireless/mesh-networking/mighty-gecko-starter-kit. A wire- less starter kit mainboard (sold seperately) and SLSDA001A Simplicity debug adapter board (included after December, 2017, and also sold separately) are required to pro- gram the RD-0085-0401 and RD-0098-0401. An ISA3 debug adapter (sold separately) is required to program the RD-0035-0601. Additional information about acquiring the SLSDA001A Simplicity debug adapter board is available: https://www.silabs.com/prod- ucts/development-tools/mcu/32-bit/simplicity-debug-adapter-board. The Lighting reference design RD-0098-0401 may be reprogrammed with the Dimma- ble Light sample application from the Thread 2.4 stack and later. While this document is specific to the Zigbee function, efforts have been made to achieve functional parity. Future versions of this document will discuss Thread functionality in detail. KEY POINTS • Quick-start demonstration • Recommended next steps • Kit overview • Device operation • Hardware and firmware considerations • Ecosystem considerations • Engineering and manufacturing testing silabs.com | Building a more connected world. Rev. 0.4
Silicon Labs' compact and cost-effective lighting reference design is based on the Zig-bee 3.0 standard and can be used in conjunction with a Zigbee 3.0 home automationsystem. This reference design kit features Silicon Labs’ EM3585 (RD-0035-0601),EFR32MG1P732F256GM32 (RD-0085-0401) or EFR32MG12P432F1024GM32(RD-0098-0401) Wireless Microcontroller (MCU).
This document contains instructions and guidelines for the following: a quick-start dem-onstration and next steps, system overview and operations, hardware, firmware andecosystem considerations, and engineering and manufacturing testing. This guide ap-plies to EmberZNet PRO 6.0 and later.
The reference design comes preprogrammed with the Zigbee Z3ColorControlLightsample application and is fully functional out of the box. All hardware design files areavailable within Simplicity Studio, Zigbee firmware application source code is availablewithin the EmberZNet PRO stack, and Thread firmware application source is availablewithin the Thread stack. Access to Zigbee and Thread stacks is available after pur-chasing and registering a wireless starter kit such as the SLWSTK6000B. Additional in-formation about acquiring a wireless starter kit is available: https://www.silabs.com/products/development-tools/wireless/mesh-networking/mighty-gecko-starter-kit. A wire-less starter kit mainboard (sold seperately) and SLSDA001A Simplicity debug adapterboard (included after December, 2017, and also sold separately) are required to pro-gram the RD-0085-0401 and RD-0098-0401. An ISA3 debug adapter (sold separately)is required to program the RD-0035-0601. Additional information about acquiring theSLSDA001A Simplicity debug adapter board is available: https://www.silabs.com/prod-ucts/development-tools/mcu/32-bit/simplicity-debug-adapter-board.
The Lighting reference design RD-0098-0401 may be reprogrammed with the Dimma-ble Light sample application from the Thread 2.4 stack and later. While this documentis specific to the Zigbee function, efforts have been made to achieve functional parity.Future versions of this document will discuss Thread functionality in detail.
KEY POINTS
• Quick-start demonstration• Recommended next steps• Kit overview• Device operation• Hardware and firmware considerations• Ecosystem considerations• Engineering and manufacturing testing
silabs.com | Building a more connected world. Rev. 0.4
The Silicon Labs Zigbee Lighting Reference Design modules and demonstration boards are designed to demonstrate Zigbee lightingapplications with EFR32MG or EM3585 Zigbee chipsets. The modules are preprogrammed for an "out of the box" demonstration usingthe demonstration board shown in the figure below. The modules can also be directly integrated into a connected lighting application asdescribed in 6.3 Module Hardware Integration Guidelines. An example of such an application is shown in the figure below. Hardwaredesign files and firmware application source code are available for all items in the kit.
This document will address quickstart for demonstration and next steps, system overview and operation, hardware and firmware con-siderations, ecosystem considerations, and engineering and manufacturing test.
Figure 1.1. Lighting Reference Design module and demonstration board
Figure 1.2. Connected Lighting Application Example
silabs.com | Building a more connected world. Rev. 0.4 | 2
2. Quick-Start Demonstration
The Lighting Reference Design demo board can be demonstrated as part of a Zigbee network. All Zigbee networks must have onedevice, such as a gateway, that plays the role of coordinator and allows commissioning of new devices on the network. Other Zigbeedevices may be present in order to evaluate interoperability with the lighting reference design. An example Zigbee network is shown inthe figure below.
Figure 2.1. Example Zigbee network used for demonstration and evaluation
2.1 Verify the Kit Contents
Make sure the following items are part of your Zigbee Lighting Reference Design kit.1. Zigbee Lighting Reference Design module and demo board assembled hardware2. micro-USB cable for power3. Quickstart card to obtain the latest reference design collateral
2.2 Set Up a Zigbee 3.0 Gateway
Silicon Labs offers RD-0002-0201 or RD-0001-0201 Zigbee gateways (sold separately) for the purpose of evaluating the Zigbee Light-ing Demo Board. However, a commercially available Zigbee 3.0 compliant gateway that supports level lighting with device profileID=0x0100, 0x0101 and 0x0102 may work for this purpose provided that the gateway does not require device whitelisting or optionalclusters not implemented in the reference design firmware of the Zigbee lighting module. See the section titled 2. Quick-Start Demon-stration 2. Quick-Start Demonstration for more information.
2.3 Supply Power to the Zigbee Lighting Demo Board
1. Use a cable such as the one provided in the kit to connect the micro-USB header on the demo board to a standard USB port or+5VDC power supply.
2. The demo board is powered when the supply indicator LED is lit.
2.4 Join the Zigbee Lighting Demo Board to the Zigbee Network
1. Follow the directions provided with the Zigbee gateway to enable new devices to join the network.2. Press the demo board power supply interrupt button S1 rapidly 10 times to begin the network join procedure. This mimics the effect
of power cycling a light bulb 10 times.3. The demo board has joined the Zigbee network when LEDS D1-D5 flash 10 times.4. On RD-0085-0401 and RD-0098-0401 network status is also indicated by the green network status LED. Solid green color means it
is on a network. LED off means the bulb is not on a network. Note that the slider switch S2 needs to be set towards "NETWORKSTATUS" to enable this feature.
silabs.com | Building a more connected world. Rev. 0.4 | 3
2.5 Demonstrate Lighting Control
1. Use the gateway interface to turn LEDs D1, D2, and D3-D5 (RD-0085-0401 and RD-0098-0401 only) on and off.2. Set the intensity (also called the brightness or dimming level).3. Set the color of D1.4. Set the color temperature.
a. On RD-0035-0601, color temperature is produced using RGB LED D1.b. On RD-0085-0401 and RD-0098-0401, color temperature is produced using RGB LED D1 when the module is loaded with the
Z3ColorControlLight example application or using color-temperature tuned LEDs D2, D3, D4 and D5 when the module is loa-ded with Z3ColorTempLight example application. The reference designs are pre-programmed with the Z3ColorControlLight ex-ample application.
silabs.com | Building a more connected world. Rev. 0.4 | 4
3. Recommended Next Steps
3.1 Evaluate the Demo Board
The Zigbee Lighting Reference Design has been designed to support common Zigbee lighting application requirements. Typical areasfor evaluation include the following:• PWM frequency and duty cycles.• RF performance such as channel power and range.• Zigbee network behavior such as network join and leave The remainder of this document covers these topics in detail.
3.2 Evaluate the Firmware
If firmware modification is necessary:
Visit the Zigbee getting started page and order a Wireless Starter Kit SLWSTK6000B: https://www.silabs.com/products/development-tools/wireless/mesh-networking/mighty-gecko-starter-kit.
The Silicon Labs Lighting Reference Design demo board facilitates the evaluation of the Zigbee Lighting Reference Design module andthe customization of lighting application firmware. In addition to programming and debug access, the demo board has a number of fea-tures specifically useful for lighting applications such as RGB and Color-Temperature LEDs, a power-interrupt button to mimic switchingof the mains supply, and PWM test points that can be wired directly into a light engine.
4.1 Part Numbers
The part numbers convention is RD-XXXX-YYYY, where:
RD Reference Design
XXXX Reference Design Number
YYYY Reference Design Component
This document will call out the reference design number (i.e., RD-XXXX) when describing the complete design and the reference de-sign component (i.e., RD-XXXX-YYYY) when describing a specific component.
The table below provides a description and PCB marking for each part number. Note that in some cases there is not sufficient space onthe PCB and an internal "IST" marking appears on the PCB instead of the "RD" part number.
silabs.com | Building a more connected world. Rev. 0.4 | 6
4.2.2 Adapter Board
Each reference design module is mounted on an adapter board to provide connectivity to the Zigbee lighting demo board as well as theSilicon Labs Wireless STK. The adapter board and lighting demo board also have mounted EEPROMs with board-specific informationstored. This allows Silicon Labs software to easily detect the connected hardware and configure themselves to show relevant informa-tion.
4.2.3 Lighting Demo Board
The Zigbee lighting demo board provides for the evaluation of the Zigbee lighting reference design module. Features are listed in thetable below.
Demo Board Feature Benefit
Low and high temperature white LEDs, tri-color RGB LED Simulate LED lighting scenarios
Network status LED LED ON means on a Zigbee network. LED OFF means not on aZigbee network.
Micro-USB connector Provides power
10-pin mini-Simplicity compatible connector Facilitates programming, debug, and packet trace
Power down button Mimics momentary mains switch
Green power indicator LED Demo board power indication
SW1 brightness switch Selects between High and Low LED brightness
SW2 network status LED switch Selects between routing PWM output to Network Status LED orTP9. Can be used to turn off the LED or select GPIO for differentpurpose.
SW3 power switch Mimics mains power switch
LiPo battery connector Provides additional power options
Note: The single-cell LiPo battery begins charging with power supplied through the micro-USB connector.
4.3 Features and Benefits of the RD-0035-0601 Demo Board Kit
4.3.1 Board Lighting Reference Design Module
The reference design kits include an RD-0035-0101 lighting module. These modules are pre-programmed with the Z3ColorControlLightZigbee lighting application.
Application firmware is available both as precompiled binaries and as source via the EmberZNet PRO stack. Firmware can be updatedeither via a hardwired debugger connection or other-the-air (OTA) using an OTA-enabled gateway.
The following clusters are used in the reference design application.
silabs.com | Building a more connected world. Rev. 0.4 | 9
5. Operation Details for the Lighting Reference Designs
5.1 Zigbee Network Behavior
This section will describe the various operational states a powered lighting reference design is able to occupy as it joins and leaves aZigbee network. The input mechanisms for operation utilize a physical power-cycling methodology which can either be employed byexternally disabling and enabling the demo board's power supply or by utilizing button S1 where a button assertion equates to poweringoff and releasing equates to power up. The white and tri-color LEDs operate as output signaling information as the demo board traver-ses or occupies a functional state. Refer to the figure below for a pictorial representation of this process.
Figure 5.1. Device Operation State Diagram
5.1.1 First Time Demo Board Power-Up
After the hardware has been powered up for the first time, the device will be in a factory default mode and be placed in the ACTIVENTWK SEARCH state.
5.1.2 OFF NETWORK State
This state is a condition where the demo board is not connected to a network and is not aggressively searching for a network. To leavethis state and to enter the ACTIVE NTWK SEARCH state, the power to the board needs to be cycled at least one time (most easilyaccomplished by pressing button S1). The device does continue to perform infrequent searches for networks while in the OFF NET-WORK state.
The white/tri-color LEDs on the board will operate like a conventional non-connected light when in this state.
5.1.3 ACTIVE NTWK SEARCH State
This state is a condition where the demo board is actively searching for a network but has not joined a network. This is an operation foractively searching for open network and if a suitable one is found it will attempts to join. The process of searching will repeat for threedifferent security keys, install code derived preconfigured link key, default global trust center link key and distributed security global linkkey. If no open network is found, the whole process will start again. It will repeat for up to 20 times. The demo board will then enter intothe OFF NETWORK state. If a network is found it will enter the NETWORK JOIN state and attempt to join the network with the securitykey it is currently used for searching and joining. If the joining is successful it will enter the ON NETWORK state. If the joining is notsuccessful it will fall back to the previous state of ACTIVE NTWK SEARCH. Power-cycling while in ACTIVE NETWORK SEARCH statewill reset the timer.
UG252: Lighting Reference Design Demo Board Kit User's Guide (RD-0035-0601, RD-0085-0401, RD-0098-0401)Operation Details for the Lighting Reference Designs
silabs.com | Building a more connected world. Rev. 0.4 | 10
5.1.4 NETWORK JOIN State
After a demo board leaves the ACTIVE NTWK SEARCH state and enters this state, the white/tri-color LEDs will flash 10 times to indi-cate successfully finding and joining a network. This state is transitory as the light moves immediately to the ON NETWORK state oncethe LEDS complete their flash sequence. Power-cycling at this time will only impair the 10 LED flashes, but not prevent entry into theON NETWORK STATE once the power is reapplied.
5.1.5 ON-NETWORK State
This state is a condition where the demo board is connected to a Zigbee 3.0 network and is not searching for a network. While in thisstate, the white/tri-color LEDs illumination on the demo board will correspond to commands the demo boards receive from the Zigbeenetwork. This state contains multiple entry and exit paths depending on various factors such as number power-cycles received within ashort time period of a few consecutive seconds.
If the power to the demo board is removed for long periods of time, the demo board will immediately rejoin its original joined networkwhen power becomes available and will not seek other networks, unless the user forces it to leave its joined network as will be descri-bed within this section.
If the demo board is power-cycled four times, the demo board will temporarily enter the IDENTIFY state while remaining on its joinednetwork.
If the demo board is power-cycled from five to nine times, the demo board will temporarily enter the NETWORK STATUS state whileremaining on its joined network.
If the demo board is power-cycled ten times OR if the demo board receives a leave network command, the demo board will enter theLEAVE NETWORK state.
5.1.6 IDENTIFY State
The purpose of this state is to help an installer (or user) identify which bulb is being communicated to by visually flashing in a specifiedpattern so this person can locate the targeted light. After a demo board leaves the ON-NETWORK state and enters this state, the white/tri-color LEDs will flash at a 0.5 Hz rate. This state is temporary and will return the demo board into the ON NETWORK state once thestate's timer reaches its time limit or if power is cycled at least once to the demo board. There are two ways to enter this mode depend-ing on the intended application.
The first method is done locally to the bulb by power cycling it 4 times. The main purpose of this method is to support EZ Mode commis-sioning, whereby the light becomes discoverable by other devices as a candidate for pairing. The bulb will blink at 0.5 Hz until the Iden-tify Mode times out after 3 minutes.
The second method is done remotely by sending an Identify command from a gateway. The main purpose of this method is to allow aninstaller to visually locate the bulb in question. The bulb will blink at 0.5 Hz until the Identify Mode for the duration is requested by thegateway.
5.1.7 NETWORK STATUS State
The purpose of this state is to help an installer (or user) identify if the light is successfully connected to a network. After a demo boardleaves the ON-NETWORK state and enters this state, the white/tri-color LEDS will flash at a 2 Hz rate. This state is temporary and willreturn the demo board into the ON NETWORK state once the state's timer reaches its time limit or if power is cycled at least once to thedemo board.
5.1.8 LEAVE NETWORK State
After a demo board leaves the ON NETWORK state and enters this state, the demo board will leave the joined network and will indicatethis process is in action by slow flashing the white/tri-color LEDS three times at a 0.5 Hz rate. This state is termporary and will place thedemo board into the ACTIVE NTWK SEARCH state once the LEDs complete their flash sequence. Power-cycling will only impair theslow LED flashes but not prevent entry into the ACTIVE NTWK SEARCH state once the power is reapplied.
UG252: Lighting Reference Design Demo Board Kit User's Guide (RD-0035-0601, RD-0085-0401, RD-0098-0401)Operation Details for the Lighting Reference Designs
silabs.com | Building a more connected world. Rev. 0.4 | 11
6. Hardware Details for the Lighting Reference Design
This section describes the key aspects of the reference design.
6.1 Lighting Reference Design RD-0085-0101 and RD-0098-0101
This section describes the key hardware specifics of the RD-0085-0101 and RD-0098-0101 modules.
UG252: Lighting Reference Design Demo Board Kit User's Guide (RD-0035-0601, RD-0085-0401, RD-0098-0401)Hardware Details for the Lighting Reference Design
silabs.com | Building a more connected world. Rev. 0.4 | 12
6.1.1 Key Highlights
• EFR32MG Zigbee PRO radio with stacked flash (RD-0085-0101) or internal flash (RD-0098-0101)• Two-layer 0.062" printed circuit board with all components on primary side• 8-pin 0.050" application header with VDD, GND, and six PWM output pins• 10-pin debug header with packet trace functionality
Figure 6.1. Module Block Diagram
Figure 6.2. Module Photo, Pin Numbering, and Dimensions
Note: Additional pin functions require custom firmware. Refer to the data sheet for available functions.
UG252: Lighting Reference Design Demo Board Kit User's Guide (RD-0035-0601, RD-0085-0401, RD-0098-0401)Hardware Details for the Lighting Reference Design
silabs.com | Building a more connected world. Rev. 0.4 | 13
Table 6.2. Debug Port
Pin # Pin Name Pin Functions Description
D1 VDD VDD 3.3V Supply Voltage
D2 GND GND Ground
D3 RESETn RESETn MCU Reset
D4 PA1 USART_RX USART RX
D5 PA0 USART_TX USART TX
D6 PF2 SW_O/TDO Serial Wire Viewer Output
D7 PF1 SW_DIO Serial Wire Data Input/Output
D8 PF0 SW_CLK Serial Wire Clock
D9 PB13 PTI_SYNC Packet Trace Enable
D10 PB12 PTI_DATA Packet Trace Data
Note: The debug connector is compatible with the mini-simplicity packet trace port connector, connected from the top side.
6.1.2 Conducted RF Connector
The RF connector on the secondary side of the RD-0098-0101 board provides an easy way to access the RF output signal from thechip. This can be useful in setting up conducted RF setups for testing and demos. Note that the signal coming to the connector is notoptimized for performance and FCC emission requirements. Only the radiated signal is guaranteed to perform within FCC specifica-tions.
In order to use the connector, depopulate resistor R1, close solder bridge J4, and populate connector J3.
Connector Manufacturer: Murata Electronics
Connector Part Number: MM5829-2700RJ4
Please check manufacturers site for compatible mating connectors and cable assemblies.
6.2 Zigbee Lighting Reference Design RD-0035-0101
This section describes the key hardware specifics of the RD-0035-0101 module.
UG252: Lighting Reference Design Demo Board Kit User's Guide (RD-0035-0601, RD-0085-0401, RD-0098-0401)Hardware Details for the Lighting Reference Design
silabs.com | Building a more connected world. Rev. 0.4 | 14
6.2.1 Key Highlights
• EM3585 Zigbee Pro radio with embedded flash• SKY66019 power amplifier (PA)• Four-layer 0.062" printed circuit board with all components on primary side• 6-pin 0.050" application header with VDD, GND, and four PWM output pins• 10-pin debug header with packet trace functionality
Figure 6.3. Module Block Diagram
Figure 6.4. Module Photo, Pin Numbering, and Dimensions
UG252: Lighting Reference Design Demo Board Kit User's Guide (RD-0035-0601, RD-0085-0401, RD-0098-0401)Hardware Details for the Lighting Reference Design
silabs.com | Building a more connected world. Rev. 0.4 | 15
D7 PC4 JTMS/SWDIO JTAG Mode Select, Serial WireData In/Out
UG252: Lighting Reference Design Demo Board Kit User's Guide (RD-0035-0601, RD-0085-0401, RD-0098-0401)Hardware Details for the Lighting Reference Design
silabs.com | Building a more connected world. Rev. 0.4 | 16
Pin # Pin Name Pin Functions Description
D8 nRESET EM3xxx Reset
D9 PA4 PTF Packet Trace Enable
D10 PAS PTD Packet Trace Data
Note: The debug connector is compatible with the ISA3 packet trace port connector when placed on the bottom side of the PCB.
6.3 Module Hardware Integration Guidelines
This section contains guidelines on how to integrate the lighting module in a custom application. Schematically, the integration isstraightforward: the user only needs to provide power and ground hookups and ensure that the PWM signals are wired to the appropri-ate locations in the light engine. Layout and mechanical design can be more involved, so tips are provided below.
The Power, Ground and PWM signals are not intended to carry high-frequency information and can therefore be handled using stand-ard best practices of PCB design.
Placing any type of material near the RF section and antenna, particularly metals and strong dielectrics, will have a big effect on anten-na performance and on spurious emissions. The region nearest the antenna within 1 wavelength, which at 2.4 GHz is approximately
12.5 cm or 5 inches, is known as the near-field region. Ideally no foreign materials should be introduced in this region.
In practice, lightbulbs are not large enough to allow for that keep-out. However, we have observed that keeping metals at least 2.5 cmaway from the antenna tends to produce good results. Metal that is part of a radiating ground plane is not harmful and may often beextended without issue, although it does have an effect on antenna matching. This generally includes ground planes under the module(but not under the antenna).
The following images show the most common layouts as an example of which layout practices are suggested
6.3.1 Horizontal Mounting Guidelines
Either hang the antenna off the PCB edge (right figure) or remove the PCB ground plane beneath the antenna and extending beyondthe module along the edge (left figure). Both RD-0098, RD-0085 and RD-0035 can be mounted using a through-hole header. In addi-tion, RD-0085 and RD-0098 have has castellation pins around the perimeter that allow it to be used in a standard SMT flow without theneed for an intervening header.
The following connectors are recommended for horizontal mounting applications.
Through-hold mount Surface mount
RD-0098-0101 FTS-108-01-F-S (Samtec) Solder directly to castellation pins
RD-0085-0101 FTS-108-01-F-S (Samtec) Solder directly to castellation pins
RD-0035-0101 TMM-106-01-G-S (Samtec) N/A
UG252: Lighting Reference Design Demo Board Kit User's Guide (RD-0035-0601, RD-0085-0401, RD-0098-0401)Hardware Details for the Lighting Reference Design
silabs.com | Building a more connected world. Rev. 0.4 | 17
6.3.2 Vertical Mounting Guidelines
The lighting reference design modules can also be mounted vertically using a right angle connector. There is no inherent advantage inthis arrangement other than to provide additional flexibility in the mechanical design of the host application.
The following right-angle connectors are recommended for vertical mounting applications.
Through-hold mount Surface mount
RD-0098-0101 TM-108-01-F-S-RA (Samtec) N/A
RD-0085-0101 TM-108-01-F-S-RA (Samtec) N/A
RD-0035-0101 TMM-106-01-G-S (Samtec) N/A
6.3.3 Connector Information
The following links provide further information about recommended connectors:• http://suddendocs.samtec.com/prints/fts-1xx-xx-x-sx-mkt.pdf• http://suddendocs.samtec.com/prints/tms-1xx-xx-xx-x-xx-xxx-mkt.pdf• http://cloud.samtec.com/Prints/TMM-1XX-XX-XX-X-XX-XXX-MKT1.pdf• http://cloud.samtec.com/Prints/TMM-STH.PDF• http://cloud.samtec.com/Prints/TMM-1XX-XX-XX-X-RA-XXX-MKT.pdf
6.4 Module Hardware Modification Guidelines
Modification of the reference design module is discouraged, however we recognize that some users may require slight changes in orderto satisfy mechanical requirements in specific installations.
6.4.1 Modify With Care
While any modification is discouraged, those listed here should have less effect on RF performance.• Changing the type of connector• Pitch, spacing, rows, size• Changing from castellation to through hole, and vice versa• Selecting different GPIO pins• Pins close to the RF Frontend should not be modified
UG252: Lighting Reference Design Demo Board Kit User's Guide (RD-0035-0601, RD-0085-0401, RD-0098-0401)Hardware Details for the Lighting Reference Design
silabs.com | Building a more connected world. Rev. 0.4 | 18
All changes listed here may have serious impacts on module performance.• Modifying the spacing near any IC, especially near the RF ports• Modifying the layout of RF bypass capacitors• Changing the PCB Antenna Length• Altering any part of the Ground Pour Area• Changing the number of metal layers
UG252: Lighting Reference Design Demo Board Kit User's Guide (RD-0035-0601, RD-0085-0401, RD-0098-0401)Hardware Details for the Lighting Reference Design
silabs.com | Building a more connected world. Rev. 0.4 | 19
7. Firmware Details for the Lighting Reference Design
The purpose of this section is to describe the lighting reference design application firmware.
7.1 Obtaining the Firmware Application
The firmware application is loaded into the flash of the EM3585, ERF32MG1P232F256 or ERF32MG12P432F1024 during the manufac-turing process. The firmware application source code is delivered as part of EmberZNet PRO, which is available to registered users of awireless starter kit such as the SLWSTK6000B.
For more information, visit the Zigbee Getting Started page.
7.2 Building the Firmware Application
The instructions below describe how to build the device firmware.1. Install EmberZNet PRO.2. Create a new Application Framework Configuration in AppBuilder and select the SoC stack release.3. Create a project using Z3ColorControlLight sample application.4. During Project Setup, verify that the proper board and chip is selected.5. In AppBuilder, under the “hal configuration tab”, verify the architecture and header files:
a. EM3585b. EFR32MG1P732F256GM32 and Board header ist_a0085c. EFR32MG12P432F1024GM32 and Board header ist_a0098
6. Generate and note the directory in which the project files were created.7. Save the project file into the directory you just created.8. Compile with IAR (for version compatibility information see the EmberZNet PRO release notes and QSG106: Getting Started with
EmberZNet PRO).At this point you can load the image onto the Smart Outlet reference design using the Board Header Reprogram-ming method described above.
7.3 Programming the RD-0085-0101 and RD-0098-0101 Lighting Reference Design
The reference design provides two methods to re-program the demo board:• Using a WSTK debugger and mini-simplicity adapter board to upload an .s37, .bin or .hex image• Using the over-the-air (OTA) upgrade feature with an .ota image file.
7.3.1 Board Header Reprogramming
The demo board can be reprogrammed with an available .s37 or .hex file and a WSTK programmer. Please refer to Application NoteAN958 for more information on how to successfully program the demo board with the WSTK programmer and mini-simplicity adapterboard. The debug connector on the demo board is the J2 header. Note the orientation of the connector where the keyed side of theconnector corresponds to the key marking found with the silkscreen drawing surrounding the J2 header.
7.3.2 Over-the-Air Programming
The demo board can be reprogrammed with an available .ota file and a device that can perform OTA upgrades such as theRD-0002-0101 Zigbee USB Gateway Kit supported by Silicon Labs. Refer to the gateway documentation for more information on howto reprogram via OTA upgrade.
7.4 Programming the RD-0035-0101 Lighting Reference Design
The reference design provides two methods to reprogram the demo board:• Using the ISA3 debugger with an .s37 or .hex image file• Using the over-the-air (OTA) upgrade feature with an .ota image file
UG252: Lighting Reference Design Demo Board Kit User's Guide (RD-0035-0601, RD-0085-0401, RD-0098-0401)Firmware Details for the Lighting Reference Design
silabs.com | Building a more connected world. Rev. 0.4 | 20
The demo board can be reprogrammed with an available .s37 or .hex file and an ISA3 programmer. Please refer to the Silicon LabsUG110 User's Guide on ISA3 for more information on how to successfully program the demo board with the ISA3 programmer. TheISA3 connector on the demo board is the J3 header.
Note: The orientation of the connector where the keyed side of the connector corresponds to the ISA3 key marking is found with thesilkscreen drawing surrounding the J3 header.
Figure 7.1. Demo Board's ISA3 Header
7.4.2 Over-the-Air Reprogramming
The demo board can be reprogrammed with an available .ota file and a device that can perform OTA upgrades such as theRD-0002-0101 Zigbee USB Gateway Kit supported by Silicon Labs. Refer to the gateway documentation for more information on howto reprogram via OTA upgrade.
Several plugins were developed or altered as part of the lighting reference design work. This section documents these new clusters.Here are some highlights of the new functionality:• Ability to configure radio transmit power and specific bulb-related attributes (such as PWM frequency) using OTA commands• Ability to execute RF test commands using a radio command• Ability to directly configure the PWM pulse width for individual PWMs using a CLI command• An example on setting up and using an LED calibration table in the chip's memory
7.5.1 Bulb-UI
The purpose of this plugin is to drive the user interface for the bulb. The user interface is primarily concerned with deciding when to joinor leave a network. It does this by counting the number of rapid power cycles. By default, power cycling the bulb 10 times in quicksuccession (< 8 seconds of on time) will cause a joined bulb to leave the network and begin to search for a new network.
UG252: Lighting Reference Design Demo Board Kit User's Guide (RD-0035-0601, RD-0085-0401, RD-0098-0401)Firmware Details for the Lighting Reference Design
silabs.com | Building a more connected world. Rev. 0.4 | 21
7.5.1.1 Theory of Operation
The primary task of the bulb-ui plugin is to manage the network connectivity state. When the bulb is not on the network, it will kick offthe joining procedure. It begins by scanning on the Zigbee preferred channels. If it does not find a joinable network, it will continue on toscanning on all legal 802.15.4 channels. It proceeds to scan for up to 20 times or until it finds a joinable network, at which point it willstop scanning. If the bulb-ui plugin has not found a network, it will assume there are no legal networks at this time, operate as a normalnon-connected LED bulb, and kick off a new join procedure after a power cycle.
Once on the network, the bulb-ui plugin will proceed to user interface mode. A user can input commands to the bulb by means of aseries of rapid on/off power cycles. The bulb will count these power cycles and take actions as indicated by the number of power cy-cles. If the bulb is power cycled 4 times, it will enter identify mode. The bulb will begin to blink at the identify rate of 0.5 Hz (as definedby the bulb project’s callbacks.c file) for 3 minutes, as specified by the EZ Mode commissioning behavior in the Zigbee HomeAutomation profile.
Power cycling the bulb between 5 and 9 times will initiate rejoin behavior. The bulb is designed to be a non-sleepy end device. As such,it relies on a connection through a parent device for network connectivity. If this connection becomes unstable, the user can initiate therejoin behavior to coerce the bulb into finding a new, perhaps better parent through which to communicate with the network.
Power cycling the bulb for 10 or more times will force the bulb to leave the network and attempt to find a new network. A side effect ofthis behavior is that all of the bulb parameters (on/off, level, color control if available) will be reset to the factory defaults.
Lastly, to facilitate manufacturing tests, the lighting reference designs include our manufacturing library CLI plugin for driving the radioin test modes so that technicians may make various RF parameter measurements. This can be tricky because the manufacturing librarycannot be called if the bulb is in the middle of scanning for a network. To facilitate this behavior, the manufacturing library CLI pluginhas a command to enable the manufacturing library token. If this token has been enabled, the bulb ui will pause 10 seconds beforekicking off the network scan in order to allow the test equipment time to invoke the manufacturing library behavior. There are moredetails on this behavior in the manufacturing library CLI plugin section.
7.5.1.2 Configurable Parameters
The bulb user interface has no parameters that are configurable through application builder. It does, however, have some parametersthat are configurable through the configuration cluster server. These are the minimum and maximum on time for counting power uppulses, as well as the default bulb power up behavior.
The minimum on time parameter is used to tell the bulb-ui to ignore really short pulses. By default, the plugin will ignore pulses that areshorter than 100 mS. However, setting this parameter, the user can configure the bulb to ignore longer on time pulses so they will notbe counted as part of the bulb user interface.
The maximum on time parameter is the amount of time that the bulb will wait before it declares a final value for the number of pulses.This is 2 seconds by default.
Finally, the user can configure the default power up behavior for the bulb. There are three options: turn the bulb on to full brightness onpower up, turn the bulb off on power up, and return the bulb to the previous state on power up. By default, the bulb will return to the lastknown state on power up.
7.5.1.3 CLI Commands
The bulb-ui plugin has no CLI commands.
7.5.2 Mfg-lib-cli
To assist with the manufacturing process, the lighting reference designs include the manufacturing library as well as the manufacturinglibrary CLI commands. On the factory floor, a lighting module that has been programmed with these images may be used to also makeradio measurements.
7.5.2.1 Theory of Operation
The purpose of the manufacturing library CLI plugin (or mfg-lib CLI plugin for short) is to allow access to commands that will put theradio into test mode so that the radio modules can be tested at manufacturing time with the final bulb firmware images.
7.5.2.2 Configurable Parameters
There are no configurable parameters for the manufacturing library CLI plugin.
UG252: Lighting Reference Design Demo Board Kit User's Guide (RD-0035-0601, RD-0085-0401, RD-0098-0401)Firmware Details for the Lighting Reference Design
silabs.com | Building a more connected world. Rev. 0.4 | 22
7.5.2.3 CLI Commands
Table 7.1. Commands for the Manufacturing Library Command Line Interface (CLI)
CLI Command Notes
plugin mfglib mfgenable <0|1> Set the token to pause bulb-ui plugin from scanning for channelsto allow for starting the manufacturing library before the stack op-eration begins. 0 clears the token, 1 sets the token.
plugin mfglib start <0|1> Starts the manufacturing library, which will prevent network activi-ty as well as enable the rest of the manufacturing library com-mands. The argument dictates whether or not to track incomingmessages and provide receiver statistics on the incoming pack-ets.
plugin mfglib stop Stops the manufacturing library.
plugin mfglib set-channel <channel> Set the radio to the specified channel. Note: channel must be be-teween 11 and 26 inclusive.
plugin mfglib set-power <power> <mode> Sets the radio power to be used for manufacturing library transmitcommands. The mode, enables or disables boost mode for theEM35x series of chips.
plugin mfglib stream <start|stop>
plugin mfglib tone <start|stop>
Note: There are additional CLI commands for use with the manufacturing library plugin. They can be explored by typing the command"plugin mfglib <enter>" and seeing a list of valid commands. Above we are detailing the commands that are most commonly useful to alighting reference design during the manufacturing process.
Here is the procedure for starting the manufacturing library:1. Connect to the lighting reference design and issue the mfgenable command: “plugin mfglib mfgenable 1”2. Power cycle the reference design.3. Within 10 seconds of power cycle, issue the start command “plugin mfglib start 0”
At this point, any of the manufacturing library commands can be safely executed without interference from the networking stack.
For example to take measurements on a modulated tone on channel 15 at a power of 20, issue the following commands:1. plugin mfglib set-channel 152. plugin mfglib set-power 20 03. plugin mfglib stream start4. At this time, take your measurements.5. plugin mfglib stream stop
Note: Transmit power of 20 is only valid for certain flavors of the EFR32 radio chip at this time.
When the manufacturing tests are completed, it is important that you disable the manufacturing library delay at bootup with the followingcommand:
plugin mfglib mfgenable 0
It is not necessary to issue the manufacturing library stop command unless you wish to initiate normal networking activity without apower cycle as the manufacturing library operation will be reset at the next power cycle.
UG252: Lighting Reference Design Demo Board Kit User's Guide (RD-0035-0601, RD-0085-0401, RD-0098-0401)Firmware Details for the Lighting Reference Design
silabs.com | Building a more connected world. Rev. 0.4 | 23
7.5.3 Configuration Cluster Server
The configuration cluster server plugin allows a user to change certain parameters of the light bulb at the time of manufacture. Thisprevents the need for recompiling the images for small changes to the design. For example, different models of bulb may require thatthe PWMs be driven at different frequencies or that the transmit power be adjusted to meet FCC requirements. The configuration clus-ter server allows manufacture time configuration of these parameters so that the same binary image may be used across multiplemodel numbers.
7.5.3.1 Theory of Operation
This feature uses a Silicon Labs custom cluster to define special Zigbee cluster library commands that contain configuration informationfor pre-selected parameters of the lighting reference designs. Any Zigbee coordinator (including the Z3Gateway Reference Design) thatis set up with the Silicon Labs custom clusters for OTA configuration can send these commands to the lighting reference design toconfigure these parameters. It is important to note that these parameters are stored in non-volatile memory and will be a new, perma-nent configuration for the device after it has been configured. Also, one of the parameters is a lock down feature that prevents furtherconfiguration of these parameters once the device has been shipped into the field.
The first step in the process is to connect the lighting device to a gateway that has this cluster enabled. Once the lighting design joinsthe network, the gateway can send it a command to configure any of the configurable parameters. Upon receiving the configurationmessage from the gateway, the lighting reference design will update its non-volatile memory storage of the configuration parameters. Itis important to note that configuration parameters are utilized at bootup, and the changes do not take effect until the next power cycle.
UG252: Lighting Reference Design Demo Board Kit User's Guide (RD-0035-0601, RD-0085-0401, RD-0098-0401)Firmware Details for the Lighting Reference Design
silabs.com | Building a more connected world. Rev. 0.4 | 24
7.5.3.2 Configurable Parameters
Table 7.2. Configurable Parameters
Name Creator Description
OTA_CONFIG_LOCK 0x7000 Token to prevent OTA configuration andOTA RF test commands from working
TX_POWER 0x7001 Sets the TX power for channels 11-24
TX_POWER25 0x7002 Sets the TX power for channel 25
TX_POWER26 0x7003 Sets the TX power for channel 26
MODEL_NAME 0x7004 Configures the model identifier attribute inthe basic cluster
MANUFACTURER_NAME 0x7005 Configures the manufacturer name attrib-ute in the basic cluster
HW_VERSION 0x7006 Configures the hardware version attributein the basic cluster
BULB_PWM_FREQUENCY_HZ 0x7007 Sets the frequency of the PWM signals
BULB_PWM_MIN_ON_US 0x7008 When the bulb is on and the level is set to1, this is the amount of time per cycle thatthe PWM will be in the active state
BULB_PWM_MAX_ON_US 0x7009 When the bulb is on and the level is set tothe maximum, this is the amount of timeper cycle that the PWM will be in the activestate
BULB_UI_MIN_ON_TIME 0x700A When power cycling the bulb, this sets theminimum time the bulb must be on to regis-ter as a single power cycle event
BULB_UI_TIMEOUT 0x700B When power cycling the bulb, this sets theamount of time the bulb must be on to resetthe boot counter and take the appropriateaction (if any)
BULB_UI_POWER_UP_BEHAVIOR 0x700C This sets the on/off state of the bulb after apower cycle. It can either be always on (0),always off (1) or last known state (2)
UG252: Lighting Reference Design Demo Board Kit User's Guide (RD-0035-0601, RD-0085-0401, RD-0098-0401)Firmware Details for the Lighting Reference Design
silabs.com | Building a more connected world. Rev. 0.4 | 25
7.5.3.3 CLI Commands—Device
The parameters may be configured at manufacture time through direction connection to the lighting design by means of the standardcommand line interface. Here are a list of these commands:
Table 7.3. Commands for the Configuration Cluster Server Plugin
CLI Command Notes
plugin configuration-server lock <true|false> Will enable/disable the custom OTA commands from the server.
Note: It is important that the bulb firmware be locked before finalshipment to end customers.
plugin configuration-server set <creator> {<data>} Sets the configuration token specified by the creator to the valuein data. Note: the data is little endian (i.e. least significant bytefirst) in the format of {XX XX … }, where XX is 2 hexadecimal dig-its specifying a single byte of data.
plugin configuration-server read Print out the complete list of the configuration tokens as well astheir current values.
For example, to configure the device for a PWM frequency of 700 Hz (which is 0x02BC), issue the following command:• plugin configuration-server set 0x7007 {BC 02}
UG252: Lighting Reference Design Demo Board Kit User's Guide (RD-0035-0601, RD-0085-0401, RD-0098-0401)Firmware Details for the Lighting Reference Design
silabs.com | Building a more connected world. Rev. 0.4 | 26
7.5.3.4 CLI Commands—Gateway
The parameters may be configured at manufacture time using over the air commands from a gateway that supports the ota configura-tion client cluster. This is particularly convenient if the lighting module resides inside a finished light bulb product, and provides flexibilityfor the user to set up the manufacturing flow.
Table 7.4. Commands for the Configuration Cluster Client (Gateway) Device
CLI Command Notes
zcl mfg-code 0x1002 Sets the manufacturing code to 0x1002, which is the Silicon Labscode used for these custom clusters.
Note: The manufacturing code will remain set until it is explicitlyunset, and normal CL commands will not work when in this mode.
zcl mfg-code 0 Unsets the manufacturing code.
zcl ota-config lock Explicit command to lock the OTA configuration functionality ofthe reference designs
zcl ota-config read <creator> Command to read the data from the token specified by the creatorvalue
zcl ota-config setToken <creator> {<data>} Sets the configuration token specified by the creator to the valuein data. Note: the data is little endian (i.e. least significant bytefirst) in the format of {XX XX … }, where XX is 2 hexadecimal dig-its specifying a single byte of data.
zcl ota-config unlock {<unlock key>} Unlocks the OTA configuration functionality of the reference de-sign. See an FAE for support.
custom send <device entry> Send the command to the reference design from the Zigbee Gate-way Reference Design.
Here is an example of the commands used to set the PWM frequency of a light bulb that exists at location 0 in the device table to 700Hz.
Note: It is assumed the gateway already created a network and that the lighting reference design has joined this network:1. zcl mfg-code 0x10022. zcl ota-config setToken 0x7007 {BC 02}3. custom send 04. zcl mfg-code 0
Note: If you are setting multiple configuration parameters using OTA commands, the final "zcl mfg-code 0" is only required after thefinal message has been sent to the device being configured.
7.5.4 Manufacturing Library OTA
This plugin implements the manufacturing library custom cluster from Silicon Labs. It provides a means, through radio messages, to putthe device into RF testing mode. In the past, enabling such features on a device required the user to physically alter the device (bycutting the case, adding a connector, and connecting to a ribbon cable). For some tests, this is practically impossible. For others, it willalter the results of the test (such as for FCC tests). To overcome these issues, Silicon Labs developed a way to invoke the manufactur-ing library commands using radio commands.
UG252: Lighting Reference Design Demo Board Kit User's Guide (RD-0035-0601, RD-0085-0401, RD-0098-0401)Firmware Details for the Lighting Reference Design
silabs.com | Building a more connected world. Rev. 0.4 | 27
7.5.4.1 Theory of Operation
Silicon Laboratories has created a custom Zigbee cluster that details RF commands for the purpose of putting the device receiving thecommands into manufacturing test mode. Specifically, it can force the device to transmit an unmodulated tone, transmit a modulatedtone, or receive packets for a short time to check the RX path of the device in the field.
First, the user must obtain a gateway that supports this functionality. The Z3Gateway application supports the MFGLIB Cluster, al-though it is possible to use our development environment to create such a gateway.
After the gateway creates the network and the lighting reference design joins the network, the gateway can send commands to thelighting reference design to tell it which RF test to perform and which parameters to use, such as channel and TX power. Each of theRF commands also includes a timeout parameter, which sets the amount of time (in milliseconds) to enable the command. Using atimeout parameter of 0 means that the device will remain in the specified RF test until the next device power cycle.
7.5.4.2 Configurable Parameters
There are no configurable parameters for these plugins.
7.5.4.3 CLI Commands—Device
There are no device side CLI commands for this plugin.
7.5.4.4 CLI Commands—Gateway
The following table details the commands for sending the manufacturing test commands over the air from a gateway that supports thisfunctionality.
Table 7.5. Commands for the Configuration Cluster Client (Gateway) Device
CLI Command Notes
zcl mfg-code 0x1002 Sets the manufacturing code to 0x1002, which is the Silicon Labscode used for these custom clusters.
Note: The manufacturing code will remain set until it is explicitlyunset, and normal CL commands will not work when in this mode.
zcl mfg-code 0 Unsets the manufacturing code.
zcl mfglib rx-mode <channel> <power> <time> Put the device into RX mode. Note: when in RX mode, the deviceunder test will keep track of the number of packets received, theRSSI and the LQI of the first packet received. It is recommendedto use a non-zero timeout as these parameters are stored in vola-tile memory and will be reset at power cycle.
zcl mfglib stream <channel> <power> <time> Set the radio to transmit a modulated carrier. Note: the carrier willbe modulated with a random stream of characters.
zcl mfglib tone <channel> <power> <time> Set the radio to transmit a modulated carrier.
Note: The carrier will be modulated with a random stream of char-acters.
custom send <device entry> Send the command to the reference design from the Zigbee Gate-way Reference Design.
Here is an example of the commands used to command the lighting design to transmit a modulated carrier at channel 15 with a powerof 20 dBm until the next device power cycle.
Note: It is assumed the gateway already created a network and that the lighting reference design has joined this network:1. zcl mfg-code 0x10022. zcl mfglib-stream 15 20 03. custom send 0
UG252: Lighting Reference Design Demo Board Kit User's Guide (RD-0035-0601, RD-0085-0401, RD-0098-0401)Firmware Details for the Lighting Reference Design
silabs.com | Building a more connected world. Rev. 0.4 | 28
7.5.5 LED-RGB-pwm
This plugin takes commands from the on/off, level control, and color control plugins. It will then compute the correct PWM drive valuesto implement the current color mode output based on the on/off and level parameters for three separate strings of red, green, and blueLEDs.
7.5.6 LED-Temp-PWM
This plugin takes commands from the on/off, level control, and color temperature server plugins. It then computes the correct PWMdrive values to implement the current temperature and level. It assumes that it is driving two independent strings of LEDs, where oneLED string is a warm LED string and one LED string is a cool LED string.
Note: The RD-0085 and RD-0098 hardware have color temperature LEDs at 2200LK and at 5000K. The PWM signals are used toblend these two colors to create intermediate color temperatures. The RD-0035 hardware does not have color temperature LEDs andcannot demonstrate this feature.
7.5.7 LED-Dim-PWM
This plugin takes commands from the on/off cluster and the level control cluster and translates them into the PWM drive values for asingle PWM. It is intended for use by the dimmable LED light bulb reference design. Because it controls a single LED string, it does notsupport any of the color modes.
7.5.8 Diagnostic Server
This plugin has been extended to record the RSSI, LQI, and number of retransmissions per APS packet sent. The plugin will populatethe appropriate attributes of the diagnostic server so that they may be read by other devices or reported by the bulb.
7.5.9 Bulb-pwm-cli
The lighting reference designs include pwm drivers designed to drive most standard LED bulb architectures. The bulb pwm CLI pluginfacilitates the testing of this hardware. It includes commands for setting the PWMs to different output values. Note: these values arehardware specific, so this plugin will require knowledge of your specific device’s chip architecture and output frequency.
UG252: Lighting Reference Design Demo Board Kit User's Guide (RD-0035-0601, RD-0085-0401, RD-0098-0401)Firmware Details for the Lighting Reference Design
silabs.com | Building a more connected world. Rev. 0.4 | 29
7.5.9.1 Theory of Operation
The purpose of this plugin is to allow the user, through the CLI, to dial in specific pulse widths in the PWM hardware. This is done bymeans of a direct serial connection either through the WSTK or over the serial lines in the 10-pin connector.
You can look to the hal bulb pwm driver section below for more details on the PWM operation, but here are a few details you need toknow to use this CLI.
By default, the PWMs are set to operate at 1 kHz. The EM35x series of chips will drive the peripheral clock at 6 MHz, which means thatit will take 6,000 ticks for the PWM to count through an entire cycle. This means that setting a PWM value of 0 will drive the signal tolow the entire time, and setting the PWM value of 6000 will drive it to full high through the entire PWM cycle.
For the EFR32 series of chips, the peripheral clock is running much faster. It will take 38,400 ticks for the PWM to count through anentire cycle at 1 kHz. Therefore, you need to set the PWM to 38,400 to drive the PWM to full on.
Finally, the PWM drive has the concept of a channel handler, or channel for short. Because the lighting design uses multiple PWMchannels across multiple PWM peripherals, it was convenient to have a single, monotonic number set for all of the channels. Here is atable for the EFR:
Channel Function GPIO Port VPIO Pin Timer Timer Channel
1 White B 1 Timer 2 1
2 Red B 2 Timer 2 2
3 Green B 3 Timer 2 3
4 Blue B 4 Timer 2 4
7.5.9.2 Configurable Parameters
There are no configurable parameters for this plugin.
UG252: Lighting Reference Design Demo Board Kit User's Guide (RD-0035-0601, RD-0085-0401, RD-0098-0401)Firmware Details for the Lighting Reference Design
silabs.com | Building a more connected world. Rev. 0.4 | 30
7.5.9.3 CLI Commands
Table 7.8. CLI Commands for Driving the PWM Outputs
CLI Command Notes
plugin bulb-pwm set <channel> <value> This will set the PWM of the specified channel to the specified val-ue.
If you wish to set the blue PWM to maximum value for the EFR32, use the following command:• plugin bulb-pwm set 6 38400
And if you wish to set the blue PWM to maximum value for the EM35x, use the following command:• plugin bulb-pwm set 4 6000
7.5.10 Hal-Bulb-PWM-Driver
The hal bulb PWM driver configures the PWM hardware to drive external LEDs. These PWM signals can be connected directly to bulbpower supplies to drive the LED strings to the levels required by the Zigbee communication.
7.5.10.1 Theory of Operation
The pinouts and hardware is specified by a board header file. After creating a new lighting reference design project in Simplicity Studio,there will be a file of the form <project>_board.h, also known as the board header file. It will contain a section in which you may recon-figure the PWM definitions depending on your final hardware. The default settings are designed to work with the lighting reference de-sign hardware, and any changes will make this project incompatible with the lighting reference design.
Upon boot up, the hal bulb PWM driver will use the settings in the board header file and use those settings to set up the hardware:which GPIO drives which PWM channel, and how are these tied to the functionality required of the lighting reference design (such asthe white LED).
Also as part of the startup configuration, the hal bulb PWM driver will make calls into the protocol to obtain the PWM drive frequency,which for the lighting reference designs is one of the configurable parameters.
Finally, the hal bulb PWM driver implements a generic blinking function. It provides the ability to turn the LEDs on for a fixed amount oftime, turn the LEDs off for a fixed amount of time, blink at a specific rate for a specific number of times, and finally to blink a genericpattern for a specific number of times. Note that at the end of these blinking patterns, the hal bulb PMW driver will make a call into theprotocol stack to indicate the blinking finished, and will expect calls from the protocol stack to set the new, non-blinking PWM valuesappropriate for the on/off, level, and color parameters.
7.5.10.2 Configurable Parameters
There is one configurable parameter for this plugin. The blink pattern is stored in a statically allocated array. The size of this array isconfigurable through the plugin UI in Simplicity Studio.
7.5.10.3 CLI Commands
See the above plugin for instructions on driving this plugin through CLI interaction.
UG252: Lighting Reference Design Demo Board Kit User's Guide (RD-0035-0601, RD-0085-0401, RD-0098-0401)Firmware Details for the Lighting Reference Design
silabs.com | Building a more connected world. Rev. 0.4 | 31
8. Ecosystem Considerations
The lighting reference design firmware examples have been made to be Zigbee 3.0 certifiable. As such, they should work with any ofthe Zigbee certified Home Automation gateways in the market. However, each gateway may have some individual requirements be-yond the Zigbee 3.0 requirements. It is therefore recommended that you contact the individual gateway manufacturers for support ingetting your device onto their gateway. Several gateway manufacturers have developer websites for such tasks.
In our testing, we have discovered that virtually all gateway manufacturers require a device to support two optional attributes in theBasic cluster: manufacturer name and model identifier. While our reference designs have values for these attributes that are reflectiveof the Silicon Laboratories reference design work, it is expected that each individual customer would customize these attributes for theirown product.
In our testing, we have also discovered that a few of the gateway manufacturers use the manufacturer name and model identifier(among other things) to implement a white list. A white list is a list of approved devices that the gateway will allow onto its network. Ifyour device is not on the white list, it will not be allowed to join the network. For these gateways, you will need to contact the gatewaymanufacturer directly to add your manufacturer name and model identifier to their gateway's white list.
silabs.com | Building a more connected world. Rev. 0.4 | 32
9. Engineering Tests
This reference design has undergone the following product testing for pre-certification purposes:• Zigbee 3.0• FCC Emissions• Antenna Radiation Patterns
9.1 Zigbee 3.0
All modules have gone through a preliminary Zigbee 3.0 testing to verify their compliance with the Zigbee standard.
9.2 FCC Emissions Testing
All modules have gone through a preliminary FCC pre-scan testing to verify their compliance with FCC Part 15 restrictions. Such testingis done to ensure that customers are given a design that can pass FCC, but it does not transfer FCC compliance to modules built ac-cording to this reference design, even if the design is copied exactly.
silabs.com | Building a more connected world. Rev. 0.4 | 33
10. Manufacturing Tests for RD-0085-0101 and RD-0098-0101
This section describes how a user can develop a low cost manufacturing test methodology in order to test products that utilize this ref-erence design. It will outline recommended test equipment and test procedure.
10.1 Test Coverage
By following these guidelines, the following items will be tested and verified for functionality.• RF TX/RX Performance• Current consumption• PWM functionality• Common Zigbee operations• Crystal frequency offset measurement
10.2 Test Equipment List
The test system is composed of the following components:• Desktop PC• RF Shielded Box• Power Supply (Agilent E3646A)• 2x WSTK programming/packet trace adapters (Silicon Labs)• Golden Node to act as a Zigbee coordinator• Frequency counter accurate to 1 ppm• Device under test (DUT)
10.3 Test System Diagram
UG252: Lighting Reference Design Demo Board Kit User's Guide (RD-0035-0601, RD-0085-0401, RD-0098-0401)Manufacturing Tests for RD-0085-0101 and RD-0098-0101
silabs.com | Building a more connected world. Rev. 0.4 | 34
10.4 Test System Connection Procedure
Wire the system as indicated above. All WSTK adapters will be connected to the PC through USB. One adapter will connect to the DUTto both reprogram and interact with the DUT, and the second one will connect to the Golden Node for testing network functionality. TheWSTK adapters may need to be powered off during some tests. This can be done by adding a power switch to the test jig, or by usingthe power selection switch already on the WSTK.
Indicators as simple as LEDs may be used to verify PWM functionality. The only thing in the shielded box should be connectors linkedto the DUT, and connectors for 50 ohm antennas.
10.5 Configuring the WSTK Adapters
For this setup, the PC will communicate to the WSTK Adapter over USB. Each adapter has a unique J-Link Serial Number that is dis-played on the LCD screen. This number will be used to reference to the specific WSTK and communicate with it.
10.6 Communicating with Targets
Communication to the WSTK needs to be established through the Simplicity Commander tool. This includes commands to program theDUT or shut off programming capabilities of the WSTK itself, if that is required.
Communcation to the DUT can be established through serial connection with the Virtual COM port of the WSTK. All device behaviortests are performed by sending specific commands which the device interprets and acts upon.
10.7 Additional Details
For a more thorough checklist, please refer to Application Note AN700 or contact Silicon Labs (http://www.silabs.com) for more informa-tion.
UG252: Lighting Reference Design Demo Board Kit User's Guide (RD-0035-0601, RD-0085-0401, RD-0098-0401)Manufacturing Tests for RD-0085-0101 and RD-0098-0101
silabs.com | Building a more connected world. Rev. 0.4 | 35
This section describes how a user can develop a low cost manufacturing test methodology in order to test products that utilize this ref-erence design. It will outline recommended test equipment and test procedure.
11.1 Test Coverage
By following these guidelines, the following items will be tested and verified for functionality:• RF TX/RX performance• Current consumption• PWM functionality• Common Zigbee operations• Frequency offset
11.2 Test Equipment List
The test system is composed of the following components:• Desktop PC• RF Shielded Box• Power Supply (Agilent E3646A)• PoE Hub (Netgear Prosafe 108P)• 2 x ISA3 programming/packet trace adapters (Silicon Labs ISA3)• Golden Node• Spectrum Analyzer or frequency counter accurate to 1 ppm• Device under test (DUT)
silabs.com | Building a more connected world. Rev. 0.4 | 36
11.4 Test System Connection Procedure
Wire the system as indicated above. Both ISA3 adapters and the PC will be connected to the PoE hub. One ISA3 adapter will connectto the DUT to both reprogram and interact with the DUT, whereas the second ISA3 adapter will connect to the Golden Node for testingnetwork functionality. The ISA3 Adapters connected to the DUT should never be turned off. Instead, power for the DUT will be providedby the Power Supply for live current measurements.
Indicators as simple as LEDs may be used to verify PWM functionality. The only thing in the shielded box should be connectors linkedto the DUT, and connectors for 50 ohm antennas.
11.5 Configuring the ISA3 Adapters
For this setup, the PC will communicate to the ISA3 Adapter with an Ethernet connection over Telnet. To do this, first the ISA3 adaptersneed to be configured to use a static IP address. For instructions on how to set up static IPs, reference sections 6.3 and 6.4 in SiliconLabs' UG110 User's Guide. Use the Admin interface over USB to set up the ISA3 adapters.
11.6 Communicating with Targets
Through the Telnet interface, both the ISA3 adapters and their respective connected targets can be communicated with simultaneously.To communicate with the ISA3 adapters, a Telnet session should be opened to its static IP at port 4902. To communicate with a targetconnected to the ISA3 adapter through virtual UART, connect to the ISA3's static IP at port 4900.
Once connected, press Enter, or send a '\r\n' sequence which will result in a prompt ending with a '>' character.
11.7 Additional Details
For a more thorough checklist, please refer to Application Note AN700 or contact Silicon Labs (http://www.silabs.com) for more informa-tion.
Silicon Laboratories Inc.400 West Cesar ChavezAustin, TX 78701USA
Smart. Connected. Energy-Friendly.
Productswww.silabs.com/products
Qualitywww.silabs.com/quality
Support and Communitycommunity.silabs.com
DisclaimerSilicon Labs intends to provide customers with the latest, accurate, and in-depth documentation of all peripherals and modules available for system and software implementers using or intending to use the Silicon Labs products. Characterization data, available modules and peripherals, memory sizes and memory addresses refer to each specific device, and "Typical" parameters provided can and do vary in different applications. Application examples described herein are for illustrative purposes only. Silicon Labs reserves the right to make changes without further notice and limitation to product information, specifications, and descriptions herein, and does not give warranties as to the accuracy or completeness of the included information. Silicon Labs shall have no liability for the consequences of use of the information supplied herein. This document does not imply or express copyright licenses granted hereunder to design or fabricate any integrated circuits. The products are not designed or authorized to be used within any Life Support System without the specific written consent of Silicon Labs. A "Life Support System" is any product or system intended to support or sustain life and/or health, which, if it fails, can be reasonably expected to result in significant personal injury or death. Silicon Labs products are not designed or authorized for military applications. Silicon Labs products shall under no circumstances be used in weapons of mass destruction including (but not limited to) nuclear, biological or chemical weapons, or missiles capable of delivering such weapons.
Trademark InformationSilicon Laboratories Inc.® , Silicon Laboratories®, Silicon Labs®, SiLabs® and the Silicon Labs logo®, Bluegiga®, Bluegiga Logo®, Clockbuilder®, CMEMS®, DSPLL®, EFM®, EFM32®, EFR, Ember®, Energy Micro, Energy Micro logo and combinations thereof, "the world’s most energy friendly microcontrollers", Ember®, EZLink®, EZRadio®, EZRadioPRO®, Gecko®, ISOmodem®, Micrium, Precision32®, ProSLIC®, Simplicity Studio®, SiPHY®, Telegesis, the Telegesis Logo®, USBXpress®, Zentri and others are trademarks or registered trademarks of Silicon Labs. ARM, CORTEX, Cortex-M3 and THUMB are trademarks or registered trademarks of ARM Holdings. Keil is a registered trademark of ARM Limited. All other products or brand names mentioned herein are trademarks of their respective holders.
