Texas Instruments CC2530 ZigBee Development Kit User manual

SWRU214 1
CC2530 Software Examples
User’s Guide

SWRU214 2
Table of contents
1 Introduction................................................................................................................................................... 3
2 Abbreviations ................................................................................................................................................ 3
3 Using the software......................................................................................................................................... 4
3.1 Prerequisites ........................................................................................................................................... 4
3.2 Getting started......................................................................................................................................... 5
3.2.1 Set up Hardware and Software........................................................................................................ 5
3.2.2 Program the board with IAR........................................................................................................... 5
3.2.3 Alternative: Download hex files with the Flash Programmer ......................................................... 6
4 Application Examples................................................................................................................................... 7
4.1 Light/Switch application ......................................................................................................................... 7
4.2 Packet Error Rate tester application....................................................................................................... 9
4.3 Spectrum Analyzer application ............................................................................................................. 10
5 Software Library Reference....................................................................................................................... 11
5.1 Software architecture............................................................................................................................ 11
5.1.1 Software folder structure............................................................................................................... 11
5.2 Basic RF................................................................................................................................................ 12
5.2.1 Basic RF frame format.................................................................................................................. 12
5.2.2 Basic RF usage instructions .......................................................................................................... 13
5.2.3 Basic RF API reference................................................................................................................. 14
5.2.4 Basic RF operation........................................................................................................................ 16
5.2.5 Limitations of Basic RF ................................................................................................................ 19
5.3 Hardware Abstraction Layer ................................................................................................................ 19
5.3.1 HAL RF API reference ................................................................................................................. 19
References............................................................................................................................................................ 22
Document History............................................................................................................................................... 22

SWRU214 3
1 Introduction
This document describes software examples for the CC2530 System-on-Chip solution for IEEE
802.15.4/ZigBee. It also describes the necessary hardware and software to run the examples, and
how to get started. The software examples are designed to run on the CC2530EM mounted on
SmartRF05EB.
Section 3 of this document describes necessary prerequisites and how to get started with the code
examples. Section 4 describes how to run each of the application examples. The software library that
the code examples are built upon is described in section 5. The latter section also gives an API
reference and describes the functionality of the software library. Hex files for each of the example
applications are provided. IAR EW8051 Full version is needed for building the source code.
2 Abbreviations
API - Application Programming Interface
CBC-MAC - Cipher Block Chaining Message Authentication Code
CCM - Counter with CBC-MAC (mode of operation)
CCM* - Extension of CCM
FCS - Frame Check Sequence
HAL - Hardware Abstraction Layer
IO - Input/Output
MIC - Message Integrity Code
MPDU - MAC Protocol Data Unit
PAN - Personal Area Network
PER - Packet Error Rate
RF - Radio Frequency
RSSI - Received Signal Strength Indicator
SFD - Start of Frame Delimiter

SWRU214 4
3 Using the software
This section describes the necessary hardware and software, and how to get started with the
application examples for CC2530.
3.1 Prerequisites
To successfully download and run the software described in this document, the following material is
needed:
•2 x SmartRF05 EB rev. 1.7
•2 x CC2530EM boards with appropriate antennas
•IAR Embedded Workbench for 8051 versions 7.51* (Full version)
•4 AA batteries
*The software is tested with version 7.51, but later versions might also work.
Figure 1 SmartRF05EB with CC2530EM

SWRU214 5
3.2 Getting started
The following sections describe hardware and software setup, how to program the board and how to
run example code from the IAR debugger. A description of how to operate each software example is
found in section 4 of this guide.
3.2.1 Set up Hardware and Software
Follow these steps to configure the hardware and software needed:
1. Install IAR Embedded Workbench for 8051 and the patch to enable support for CC2530.
2. Save the CC2530 Software Examples zip file and unzip this file.
3. Attach the CC2530EM board to the SmartRF05EB.
4. Connect the SmartRF05EB to the PC with a USB cable.
5. Make sure the EM selection switch (P19 on SmartRF05EB) is placed in position SoC/TRX.
3.2.2 Program the board with IAR
6. Open IAR Embedded Workbench
7. Open the workspace file CC2530_SW_examples.eww with IAR. This file is found in the folder
ide under the folder where the CC2530 Software Examples was unzipped. Figure 2 shows the
IAR EW with the workspace opened.
8. Each application has its own project tab in the IAR workspace viewer. Select the project to be
compiled in the workspace viewer of IAR. See section 4 for a description of each application
example.
9. Select Project->Rebuild All. This will perform a full rebuild on the selected project.
10. Select Project->Debug. IAR will now establish a connection with the CC2530 and program
the application. The debugger will be started, halting the target at main().
11. Start the application by selecting Debug -> Go.
12. The board can be reset by selecting Debug -> Reset.
13. The debugger can be stopped by selecting Debug -> Stop Debugging.
14. The unit can now be operated independently from the debugger by disconnecting the USB
cable and using the AA batteries as power source. Cycle power with the power switch on the
SmartRF05EB.
15. Repeat the steps 9 to 12 to program additional boards.
Figure 2 IAR EW

SWRU214 6
3.2.3 Alternative: Download hex files with the Flash Programmer
It is also possible to program the boards with the Texas Instruments Flash Programmer as an
alternative to IAR. Follow these steps after connecting the USB cable in section 3.2.1.
5. Install the Texas Instruments Flash Programmer. The TI Flash programmer tool is found under
the ‘Tools and software’ section on the CC2530 web site.
6. Open the Texas Instruments Flash Programmer, and choose the System-on-Chip tab. The
connected device is shown in the list as in Figure 3.
7. In the Flash image field browse to the correct hex file.
8. Make sure the ‘Erase, program and verify’ action is checked.
9. Push the ‘Perform actions’ button to program the device.
Figure 3 Flash programmer

SWRU214 7
4 Application Examples
The following application examples are included in this software package:
“light_switch” Wireless light/switch application. One node is configured as a light controller,
and the other node as a wireless light switch.
“PER_test” Packet Error Rate test application.
“spectrum_analyzer” This application use the LCD on the SmartRF05EB to display the RSSI
values of all IEEE 802.15.4 defined channels.
Details about how to run the different application examples can be found in the following sections.
Section 3.2 describes how to program the applications on the target.
4.1 Light/Switch application
This application example requires 2 nodes programmed with the ‘light_switch’ project.
The example implements a wireless light switch application. One of the nodes is configured as a light
controller, while the other node is configured as a light switch.
The following steps must be done to use the light/switch application:
1. Reset both boards by cycling power.
2. Press Button 1 to enter the application menu
3. Choose device mode. The menu is navigated by moving the joystick right or left. Choose
device mode ‘Switch’ on one of the nodes, and ‘Light’ on the other node. Confirm the choices
by pressing Button 1.
4. The light switch application example is now ready. LED1 on the ‘Light’ node can now be
toggled by pushing joystick down on the ‘Switch’.
The data sent out from the switch device can be observed with a Texas Instruments packet sniffer*
configured on channel 25 – 2475 Mhz.
*The Texas Instruments packet sniffer application can be downloaded from:
http://focus.ti.com/docs/toolsw/folders/print/packet-sniffer.html. The following hardware can be used for
the packet sniffer: SmartRF05EB/CC2530EM, CC2531 USB dongle, CC2430DB,
SmartRF04EB/CC2430EM or SmartRF05EB/CC2520EM.
It is also possible to build the Light/Switch application with the CCM security feature included. This will
enable CCM authentication and encryption on each packet. In order to use the CCM security feature
the compile option SECURITY_CCM must be set in the project file. This can be done in IAR EW by
selecting Project and Options. Navigate to the C/C++ Compiler and Preprocessor tab and set
SECURITY_CCM as one of the defined symbols (i.e. change xSECURITY_CCM to
SECURITY_CCM). See also Figure 4. The CCM security feature is also described in section 5.2 in this
guide.

SWRU214 8
Figure 4 Compile option for CCM security

SWRU214 9
4.2 Packet Error Rate tester application
This application example requires 2 nodes for operation. Select the project ‘per_test’* in the IAR
workspace viewer and program both nodes.
*The PER test application is also preprogrammed on both of the CC2530EM boards found in the
CC2530DK. The CC2530DK Quick Start Guide describes how to run the preprogrammed PER test out
of the box.
The packet error rate test application sets up a one-way RF link between two nodes. One board will
operate as a transmitter and the other board will operate as a receiver. The transmitter node must be
configured with the output power to use and the number of packets to transmit as part of the PER test
(burst size). During a PER test the receiver node will display the number of received packets, the RSSI
level (signal strength) and PER.
The user configurable parameters for the test can be seen in Table 1. These parameters are set using
a menu on the LCD during initialization. The menu is navigated with the joystick (see arrows in the
display) and the settings are confirmed by pressing Button 1.
Parameter Settings
Channel 11 – 26 (2405 – 2480 MHz)
Operating Mode Receiver, Transmitter
TX Output Power -3 dBm, 0 dBm, 4 dBm
Burst Size 1K, 10K, 100K, 1M
Packet rate 100, 50, 20 or 10 packets per second
Table 1 User configurable parameters
Configure one node as receiver and the other node as transmitter by following the steps below:
PER Test Receiver configuration:
Perform the following steps to configure the receiver node:
1. Reset the board by cycling power.
2. Press Button 1 to enter the application menu.
3. Select a channel between 11 and 26. Navigate the menu by pressing joystick left or right, and
confirm the selection by pressing Button 1. Note the channel, since it will also be used for the
Transmitter node.
4. Select operating mode ‘Receiver’ and confirm with Button 1.
5. The Receiver node is now ready for operation, displaying ‘Receiver Ready’.
PER Test Transmitter configuration
Perform the following steps to configure the transmitter node:
1. Reset the board by cycling power.
2. Press Button 1 to enter the application menu.
3. Select the same channel as for the Receiver node. Navigate the menu by pressing joystick left
or right, and confirm the selection by pressing Button 1.
4. Select operating mode ‘Transmitter’ and confirm with Button 1.
5. Select TX output power by navigating the joystick. Confirm with Button 1.
6. Select the number of packets, either 1000, 10K, 100K or 1M. Press Button 1 to confirm.
7. Select packet rate; 100, 50, 20 or 10 packet per second. Press Button 1 to confirm.
8. Push the joystick down to start a PER test. The number of packets specified by burst size will
be sent to the Receiver node. Packet Error Rate, RSSI, and number of packets received are
displayed on the Receiver’s LCD panel.
9. The PER test can be stopped by pressing joystick down again.

SWRU214 10
Calculation of PER and RSSI
In order to obtain the statistics during the PER test, the receiver maintains the following variables. The
variable rxStats is of type perRxStats_t as defined in per_test.h.
rxStats.expectedSeqNum The expected sequence number for the next packet that should
arrive. This is equivalent to the number of received packets+lost
packets +1.
rxStats.rssiSum This is the sum of the RSSI level of the last 32 packets.
rxStats.rcvdPkts The number of correctly received packets as part of the PER test.
rxStats.lostPkts The number of packets that have been lost.
Lost packets are detected through a jump in the sequence number. If the received packet has a higher
sequence number than rxStats.expectedSeqNum the packets in between are calculated as lost. This
implies that a series of lost packets will not be detected until a subsequent packet has been received
correctly. Packets with errors are considered as lost.
The PER value per thousand packets is calculated by the formula:
PER = 1000* rxStats.lostPkts/ (rxStats. lostPkts+ rxStats. rcvdPkts)
(for rxStats. rcvdPkts>=1)
The RSSI value is fetched from the first byte following the payload in the received packet. This value is
in signed 2’s complement and must be corrected with an RSSI offset to get the absolute RSSI value
(in dBm). This offset is specified in the CC2530 datasheet. The converted RSSI values of the last 32
(defined by RSSI_AVG_WINDOW_SIZE in per_test.h) received packets are stored in a ring buffer,
implementing a moving average filter.
The average RSSI of the 32 last received packets is presented on the LCD of the receiver node during
a PER test.
Reset statistics in display
The values of PER, RSSI and number of received packets in the receiver’s display can be reset during
a PER test by pressing button 1.
4.3 Spectrum Analyzer application
This application example requires one SmartRF05EB/CC2530EM as it merely measures and presents
the RSSI values of all IEEE 802.15.4 defined channels in the 2.4 GHz frequency band. The application
displays the RSSI values of all channels from 11 (2405 MHz) to 26 (2480 MHz).
The application starts up in bar graph mode. In this mode only the bar graphs of the 16 channels are
shown. The application displays values in the range -120 dBm to -10 dBm. Text mode adds a textual
display of the channel number and the measured value for one specific channel whilst still displaying
the bar graphs of all channels, albeit with reduced resolution. The user may toggle between the
display modes by moving the joystick up. In text mode the channel is selected by moving the joystick
left or right.