Digi XBee SX User Manual

Radio frequency (rf) module

Hide thumbs Also See for XBee SX:

User manual (42 pages)

User manual (206 pages)

Table Of Contents

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

page of 236

/ 236
Contents
Table of Contents
Bookmarks

Table of Contents

Quick Links

Download this manual

XBee®/XBee-PRO SX

Radio Frequency (RF) Module

User Guide

Table of Contents

Need help?

Do you have a question about the XBee SX and is the answer not in the manual?

Questions and answers

Summary of Contents for Digi XBee SX

Page 1 XBee®/XBee-PRO SX Radio Frequency (RF) Module User Guide...
Page 2 Updated Mexican certifications. 2021 Trademarks and copyright Digi, Digi International, and the Digi logo are trademarks or registered trademarks in the United States and other countries worldwide. All other trademarks mentioned in this document are the property of their respective owners.
Page 3 Trace (if possible) Description of issue Steps to reproduce Contact Digi technical support: Digi offers multiple technical support plans and service packages. Contact us at +1 952.912.3444 or visit us at www.digi.com/support. Feedback To provide feedback on this document, email your comments to techcomm@digi.com...
Page 4: Table Of Contents
Mechanical drawings Pin signals Pin connection recommendations Getting started with the XBee/XBee-PRO SX RF Module Development XBee SX Development Board Connect XBee-PRO SX development boards to a PC Connect the XBIB-U-SS development board to a PC Configure the device using XCTU...
Page 5 API operating mode Comparing Transparent and API modes Modes of operation Receive mode Transmit mode Sleep mode Command mode Sleep modes About sleep modes Asynchronous modes Synchronous modes Normal mode Asynchronous pin sleep mode Asynchronous cyclic sleep mode Asynchronous cyclic sleep with pin wake up mode Synchronous sleep support mode Synchronous cyclic sleep mode The sleep timer...
Page 6 Repeater/directed broadcast DigiMesh networking Serial communication UART data flow Serial data SPI signals Signal description Slave mode characteristics Full duplex operation Low power operation Configuration considerations SPI and API mode SPI parameters Serial port selection Serial receive buffer Serial transmit buffer UART flow control CTS flow control RTS flow control...
Page 7 NH (Network Hops) MR (Mesh Unicast Retries) NN (Network Delay Slots) Addressing commands SH (Serial Number High) SL (Serial Number Low) DH (Destination Address High) DL (Destination Address Low) TO (Transmit Options) NI (Node Identifier) NT (Network Discovery Back-off) NO (Network Discovery Options) CI (Cluster ID) Diagnostic - addressing commands N? (Network Discovery Timeout)
Page 8 PR (Pull-up/Down Resistor Enable) M0 (PWM0 Duty Cycle) M1 (PWM1 Duty Cycle) LT (Associated LED Blink Time) RP (RSSI PWM Timer) I/O sampling commands AV (Analog Voltage Reference) IC (DIO Change Detect) IF (Sleep Sample Rate) IR (Sample Rate) IS (Immediate Sample) TP (Board Temperature) %V (Voltage Supply Monitoring) I/O line passing commands...
Page 9 NP (Maximum Packet Payload Bytes) CK (Configuration CRC) Operate in API mode API mode overview Use the AP command to set the operation mode API frame format API operation (AP parameter = 1) API operation with escaped characters (AP parameter = 2) Length field Frame data Calculate and verify checksums...
Page 10 Description Route Information - 0x8D Description Format Examples Aggregate Addressing Update - 0x8E Description Examples 64-bit Receive Packet - 0x80 Description Format Examples Local AT Command Response - 0x88 Description Examples Transmit Status - 0x89 Description Delivery status codes Examples Receive Packet - 0x90 Description Examples Explicit Receive Indicator - 0x91...
Page 11 RSSI indicators Discover all the devices on a network Trace route option NACK messages The Commissioning Pushbutton Associate LED Monitor I/O lines Pin configurations Queried sampling Periodic I/O sampling Detect digital I/O changes I/O line passing Configuration example General Purpose Flash Memory General Purpose Flash Memory Access General Purpose Flash Memory General Purpose Flash Memory commands...
Page 12 RSM (New Zealand) Power requirements Brazil (Anatel) ANATEL Brazil for XBee-PRO SX radio products (XBPSX) SX ANATEL Brazil for XK9X-DMS-1 XBee SX RF Module Dev Kit (XK9X-DMS-1) ANATEL Brazil for XBee SX radio products (XBSX) IFETEL (Mexico) OEM labeling requirements...
Page 13: Xbee®/Xbee-Pro Sx Rf Module User Guide
XBee®/XBee-PRO SX RF Module User Guide The XBee/XBee-PRO SX RF Module is an embedded radio frequency (RF) device that provides wireless connectivity to end-point devices in mesh networks. The XBee/XBee-PRO SX RF Module delivers up to 1 Watt of RF power and has excellent receive sensitivity, low operating current, and exceptional performance in low power modes.
Page 14: Applicable Firmware And Hardware
This manual supports the following firmware: 0x900X USA and Canada, XBee/XBee-PRO SX 0x920x Australia, XBee/XBee-PRO SX 0x930X Brazil XBee/XBee-PRO SX 0x960X New Zealand, XBee SX only Note The New Zealand firmware only works with non-PRO hardware. It supports the following hardware:...
Page 15 Technical specifications Regulatory conformity summary Power requirements Networking specifications Performance specifications General specifications GPIO specifications XBee®/XBee-PRO SX RF Module User Guide...
Page 16: Technical Specifications
RCPDIXB19-2288 RCPDIXB19-1819 Power requirements The following table describes the power requirements for the XBee/XBee-PRO SX RF Module. Specification Condition XBee SX value XBee-PRO SX value Supply voltage range 2.4 to 3.6 VDC 2.6 to 3.6 VDC Typical supply voltage 3.3 V Receive current VCC = 3.3 V...
Page 17: Performance Specifications
Technical specifications Performance specifications Specification Value topologies (software selectable) Optional 256-bit Advanced Encryption Standard (AES) encryption which may be Encryption operated in either cipher block chaining (CBC) mode or counter (CTR) mode. Use the EE command to enable encryption. Use the KY command to set the encryption key.
Page 18: General Specifications
Technical specifications General specifications XBee-PRO Specification Condition XBee value value Rural range line of Low data rate Up to 14.5 km (9 mi) Up to 105 sight km (65 mi) Urban range line of Low data rate Up to 2.5 km (1.5 mi) Up to 18 km sight (11 mi)
Page 19: Gpio Specifications
Technical specifications GPIO specifications Specification Value Restriction of Hazardous Substances (RoHS) Compliant Manufacturing ISO 9001:2008 registered standards Host interface connector 37 castellated SMT pads Antenna connector options U.FL or RF pad Antenna impedance 50 Ω unbalanced Maximum input RF level at antenna port 6 dBm Operating temperature -40 °C to 85 °C...
Page 20: Hardware
Hardware Mechanical drawings Pin signals XBee®/XBee-PRO SX RF Module User Guide...
Page 21: Mechanical Drawings
Hardware Mechanical drawings Mechanical drawings The following figures show the XBee/XBee-PRO SX RF Module mechanical drawings. All dimensions are in centimeters. The XBee/XBee-PRO SX RF Module differs from other surface-mount XBee modules. It has an additional ground pad on the underside of the module used for heat dissipation. For more details, see PCB design and manufacturing.
Page 22: Pin Signals
Hardware Pin signals Pin signals The following table describes the pin signals. Low-asserted signals are distinguished with a horizontal line over the signal name. Default Name state Function Ground Power supply DIO13/DOUT Output GPIO / UART data out DIN/DIO14/CONFIG Input GPIO / UART data in DIO12 Disabled...
Page 23 Hardware Pin signals Default Name state Function RESET Drive low to reset device. Do not drive pin high; pin may only be driven open drain or low. Pin has an internal 20k pullup resistor. The minimum reset pulse time is 100 ns. DIO10/RSSI/PWM0 Output GPIO / RX Signal Strength Indicator...
Page 24: Pin Connection Recommendations
Hardware Pin signals Default Name state Function other XBee devices for analog voltage reference. DIO5/ASSOC Output GPIO / Associate Indicator DIO6/RTS Disabled GPIO / UART Request to Send Flow Control DIO3/AD3 Disabled GPIO / Analog Input DIO2/AD2 Disabled GPIO / Analog Input DIO1/AD1 Disabled GPIO / Analog Input...
Page 25 This section provides information on the Development Board for the XBee/XBee-PRO SX RF Module and getting started instructions if you have an XBee/XBee-PRO SX RF Module Development Kit. XBee SX Development Board Connect XBee-PRO SX development boards to a PC...
Page 26: Xbee Sx Development Board
Getting started with the XBee/XBee-PRO SX RF Module Development Kit XBee SX Development Board XBee SX Development Board The following figure shows the XBee SX development board with onboard XBee-PRO SX RF pad module and the table that follows explains the callouts in the picture. Number...
Page 27: Connect Xbee-Pro Sx Development Boards To A Pc
2. Connect the SX development boards to the USB port on a PC via the mini-USB cables. Separate the SX development boards by at least 2 m (6 ft). 3. Connect the antennas to the RPSMA connector on the SX development boards. The following table shows the XBee SX development kit contents. Description Quantity...
Page 28: Connect The Xbib-U-Ss Development Board To A Pc
Connect the XBIB-U-SS development board to a PC This step is optional. It shows how to set up the standalone XBee SX module on the XBIB-U-SS development board, which you can substitute as one of the range test devices or use with the other two devices to create a DigiMesh network.
Page 29: Perform A Range Test
Getting started with the XBee/XBee-PRO SX RF Module Development Kit Perform a range test 5. Select the other module and click the Default firmware settings button. 6. Configure the following parameters: ID: 2015 NI: REMOTE_DEVICE AP: Transparent Mode [0] 7. Click the Write radio settings button. After you write the radio settings for each device, their names appear in the Radio Modules area.
Page 30: Mesh Network Demonstration
8. Click Stop Range Test to stop the process at any time. Mesh network demonstration 1. Connect the two XBee PRO SX development boards and the XBIB-U-SS (with the XBee SX installed) to your computer. Open XCTU and find the three XBee devices.
Page 31 Getting started with the XBee/XBee-PRO SX RF Module Development Kit Mesh network demonstration You can now start sending messages. Use the following steps to simulate a simple DigiMesh network by configuring SENDER and RECEIVER to communicate, moving the two devices out of range of each other, and adding the BRIDGE node to relay the messages between SENDER and RECEIVER.
Page 32: Software Libraries
XBee Network Assistant The XBee Network Assistant is an application designed to inspect and manage RF networks created by Digi XBee devices. Features include: Join and inspect any nearby XBee network to get detailed information about all the nodes it contains.
Page 33: Xbee Multi Programmer
Each XBee Multi Programmer board allows you to program up to six devices simultaneously. Connect more boards to increase the programming concurrency. Different board variants cover all the XBee form factors to program almost any Digi RF device. Download the XBee Multi Programmer application from: Digi XBee Multi Programmer...
Page 34: Modes
Modes Transparent and API operating modes Modes of operation XBee®/XBee-PRO SX RF Module User Guide...
Page 35: Transparent And Api Operating Modes
Modes Transparent and API operating modes Transparent and API operating modes The firmware operates in several different modes. Two top-level modes establish how the device communicates with other devices through its serial interface: Transparent operating mode and API operating mode. Transparent operating mode Devices operate in this mode by default.
Page 36: Modes Of Operation
Modes Modes of operation Feature Description application to change the address in the API frame. This process is much multiple destinations faster than in Transparent mode where the application must enter Command mode, change the address, exit Command mode, and then transmit data.
Page 37: Transmit Mode
Modes Modes of operation Transmit mode When DigiMesh data is transmitted from one node to another, the destination node transmits a network-level acknowledgment back across the established route to the source node. This acknowledgment packet indicates to the source node that the destination node received the data packet.
Page 38 Modes Modes of operation Enter Command mode To get a device to switch into Command mode, you must issue the following sequence: +++ within one second. There must be at least one second preceding and following the +++ sequence. Both the command character (CC) and the silence before and after the sequence (GT) are configurable. When the entrance criteria are met the device responds with OK\r on UART signifying that it has entered Command mode successfully and is ready to start processing AT commands.
Page 39 Modes Modes of operation Multiple AT commands You can send multiple AT commands at a time when they are separated by a comma in Command mode; for example, ATNIMy XBee,AC<cr>. The preceding example changes the NI (Node Identifier) to My XBee and makes the setting active through AC (Apply Changes).
Page 40 Sleep modes About sleep modes Normal mode Asynchronous pin sleep mode Asynchronous cyclic sleep mode Asynchronous cyclic sleep with pin wake up mode Synchronous sleep support mode Synchronous cyclic sleep mode The sleep timer Indirect messaging and polling Sleeping routers Sleep coordinator sleep modes in the DigiMesh network Synchronization messages Become a sleep coordinator...
Page 41: Sleep Modes
Sleep modes About sleep modes About sleep modes A number of low-power modes exist to enable devices to operate for extended periods of time on battery power. Use the SM command to enable these sleep modes. The sleep modes are characterized as either: Asynchronous (SM = 1, 4, 5).
Page 42: Asynchronous Pin Sleep Mode
Sleep modes Asynchronous pin sleep mode Use mains-power for devices in Normal mode. A device in Normal mode synchronizes to a sleeping network, but does not observe synchronization data routing rules; it routes data at any time, regardless of the network's wake state. When synchronized, a device in Normal mode relays sync messages that sleep-compatible nodes generate, but does not generate sync messages itself.
Page 43: Synchronous Cyclic Sleep Mode
Sleep modes Synchronous cyclic sleep mode Synchronous cyclic sleep mode Set SM to 8 to enter synchronous cyclic sleep mode. A device in synchronous cyclic sleep mode sleeps for a programmed time, wakes in unison with other nodes, exchanges data and sync messages, and then returns to sleep. While asleep, it cannot receive RF messages or receive data (including commands) from the UART port.
Page 44: Polling
Sleep modes Sleeping routers the coordinator is in API mode, a TxStatus message is generated for a purged data packet with a status of 0x75 (INDIRECT_MESSAGE_UNREQUESTED). An indirect messaging coordinator queues up as many data packets as it has buffers available. After the coordinator uses all of its available buffers, it holds transmission requests unprocessed on the serial input queue.
Page 45: Synchronization Messages
Sleep modes Synchronization messages Synchronization messages A sleep coordinator regularly sends sync messages to keep the network in sync. Unsynchronized nodes also send messages requesting sync information. Sleep compatible nodes use Deployment mode when they first power up and the sync message has not been relayed.
Page 46 Sleep modes Synchronization messages XBee®/XBee-PRO SX RF Module User Guide...
Page 47: Become A Sleep Coordinator
Sleep modes Become a sleep coordinator Become a sleep coordinator In DigiMesh networks, a device can become a sleep coordinator in one of four ways: Define a preferred sleep coordinator A potential sleep coordinator misses three or more sync messages Press the Commissioning Pushbutton twice on a potential sleep coordinator Change the sleep timing values on a potential sleep coordinator Preferred sleep coordinator option...
Page 48: Commissioning Pushbutton Option
Sleep modes Become a sleep coordinator 1. Newer sleep parameters always take priority over older sleep parameters. The age of the sleep parameters is determined by a sequence number that increments when an overriding sync is sent. 2. Otherwise, the node with the preferred sleep coordinator bit set takes precedence. 3.
Page 49 Sleep modes Become a sleep coordinator more and more consecutive sync messages, the sleep guard time increases in duration and decreases the available transmission time. XBee®/XBee-PRO SX RF Module User Guide...
Page 50: Auto-Early Wake-Up Sleep Option
Sleep modes Select sleep parameters Auto-early wake-up sleep option If you have nodes that are missing sync messages and could be going out of sync with the rest of the network, enabling an early wake gives the device a better chance to hear the sync messages that are being broadcast.
Page 51: Synchronous Pulse
Sleep modes Synchronous pulse In the event that one or more nodes fail to receive the sleep immediate broadcast, they will not get the power savings, but they will still remain synchronized to the network because the sleep cycle would not have changed. Synchronous pulse The Synchronous pulse feature supports user applications that desire synchronizing operations across multiple devices in a network.
Page 52: Add A New Node To An Existing Network
Sleep modes Add a new node to an existing network 1. Set SO to 1 to enable the preferred sleep coordinator option on one of the nodes. 2. Set its SM to a synchronous sleep compatible mode (7 or 8) with its SP and ST set to a quick cycle time.
Page 53: Change Sleep Parameters
Sleep modes Change sleep parameters 2. You can wake a sleeping cyclic sleep node in the network using the Commissioning Pushbutton. Place the new node in range of the existing cyclic sleep node. Wake the existing node by holding down the Commissioning Pushbutton for two seconds, or until the node wakes.
Page 54: Rejoin Nodes That Lose Sync
Sleep modes Rejoin nodes that lose sync Rejoin nodes that lose sync DigiMesh networks get their robustness from routing redundancies which may be available. We recommend architecting the network with redundant mesh nodes to increase robustness. If a scenario exists where the only route connecting a subnet to the rest of the network depends on a single node, and that node fails or the wireless link fails due to changing environmental conditions (a catastrophic failure condition), then multiple subnets may arise using the same wake and sleep intervals.
Page 55: Sleep Status
Sleep modes Diagnostics Sleep status Use the SS command to query useful information regarding the sleep status of the device. Use this command to query if the node is currently acting as a network sleep coordinator. Missed sync messages command Use the MS command to query the number of cycles that elapsed since the device received a sync message.
Page 56: Networking Methods
Networking methods The MAC and PHY layers 64-bit addresses Make a unicast transmission Make a broadcast transmission Delivery methods XBee®/XBee-PRO SX RF Module User Guide...
Page 57: The Mac And Phy Layers
Networking methods The MAC and PHY layers The MAC and PHY layers Most network protocols use the concept of layers to separate different components and functions into independent modules that developers can assemble in different ways. The PHY layer defines the physical and electrical characteristics of the network. It is responsible for managing the hardware that modulates and demodulates the RF bits.
Page 58: Make A Unicast Transmission
Make a unicast transmission Use the SH and SL commands to read this address. The form of the address is: 0x0013A2XXXXXXXXXX. The first six digits are the Digi Organizationally Unique Identifier (OUI). The broadcast address is 0x000000000000FFFF. Make a unicast transmission To transmit to a specific device in Transparent operating mode: Set DH:DL to the SH:SL of the destination device.
Page 59: Repeater/Directed Broadcast
Networking methods Delivery methods Repeater/directed broadcast This mode of operation allows messages to traverse a network and arrive at the destination node without requiring the overhead of route discovery. This is done in the network layer which does one of two things when it receives a message: 1.
Page 60 Networking methods Delivery methods With mesh networking, the distance between two nodes does not matter as long as there are enough nodes in between to pass the message along. When one node wants to communicate with another, the network automatically calculates the best path. A mesh network is also reliable and offers redundancy.
Page 61 Networking methods Delivery methods Packet tracking prevents a node from resending a broadcast message more than MT+1 times. This means that a node that relays a broadcast will only relay it after it receives it the first time and it will discard repeated instances of the same packet.
Page 62 Networking methods Delivery methods The maximum delay occurs when the sender and receiver are on the opposite ends of the network. The NH and %H parameters define the maximum broadcast delay as follows: BroadcastTxTime = NH * NN * %8 Unless BH <...
Page 63: Serial Communication
Serial communication UART data flow SPI signals Slave mode characteristics Full duplex operation Low power operation Configuration considerations SPI and API mode SPI parameters Serial port selection UART flow control XBee®/XBee-PRO SX RF Module User Guide...
Page 64: Uart Data Flow
Serial communication UART data flow UART data flow Devices that have a UART interface connect directly to the pins of the XBee/XBee-PRO SX RF Module as shown in the following figure. The figure shows system data flow in a UART-interfaced environment. Low-asserted signals have a horizontal line over the signal name.
Page 65: Signal Description
Serial communication Slave mode characteristics Signal Pin number Applicable AT command SPI_SSEL (Slave select) SPI_MOSI (Master out, Slave in) SPI_MISO (Master in, Slave out) By default, the inputs have pull-up resistors enabled. Use the PR command to disable the pull-up resistors.
Page 66: Full Duplex Operation
By default, Digi configures DIO8 (SLEEP_REQUEST) as a peripheral and during pin sleep it wakes the device and puts it to sleep. This applies to both the UART and SPI serial interfaces.
Page 67: Configuration Considerations
Serial communication Configuration considerations Using SPI_SSEL to control sleep and to indicate that the SPI master has selected a particular slave device has the advantage of requiring one less physical pin connection to implement pin sleep on SPI. It has the disadvantage of putting the device to sleep whenever the SPI master negates SPI_SSEL (meaning time is lost waiting for the device to wake), even if that was not the intent.
Page 68: Serial Receive Buffer
Serial communication UART flow control If you change the configuration so that only one port is configured, then that port is the only one enabled or used. If the parameters are written with only one port enabled, then the port that is not enabled is not used even temporarily after the next reset.
Page 69 Serial communication UART flow control If the device sends data out the UART when RTS is de-asserted (set high) the device could send up to five characters out the UART port after RTS is de-asserted. XBee®/XBee-PRO SX RF Module User Guide...
Page 70 AT commands Special commands MAC/PHY commands Diagnostic commands - MAC statistics and timeouts Network commands Addressing commands Diagnostic - addressing commands Addressing discovery/configuration commands Security commands Serial interfacing commands I/O settings commands I/O sampling commands I/O line passing commands Sleep commands Diagnostic - sleep status/timing commands Command mode options Firmware version/information commands...
Page 71: At Commands
AT commands Special commands Special commands The following commands are special commands. AC (Apply Changes) This command applies to the XBee/XBee-PRO SX RF Module. Immediately applies new settings without exiting Command mode. Parameter range Default FR (Software Reset) This command applies to the XBee/XBee-PRO SX RF Module. Resets the device.
Page 72: Mac/Phy Commands
AT commands MAC/PHY commands Default MAC/PHY commands The following AT commands are MAC/PHY commands. AF (Available Frequencies) This command applies to the XBee/XBee-PRO SX RF Module. You can query this read-only command to return a bitfield of the frequencies that are available in the device’s region of operation.
Page 73: Mf (Minimum Frequencies)
AT commands MAC/PHY commands CM allows you to selectively enable or disable channels used for RF communication. This is useful to avoid using frequencies that experience unacceptable levels of RF interference, or to operate two networks of radios on separate frequencies. When CM is queried, it returns the operating channel mask based on what value BR is set to.
Page 74: Hp (Preamble Id)
AT commands MAC/PHY commands The Default value of MF for the Australia/New Zealand firmware varies depending on the value you set BR to: BR value Australia default New Zealand default Brazil default 0x31 (49 channels) 0x29 (41 channels) 0 - 0x32 (50 channels) 0x31 (49 channels) 0x29 (41 channels) 1 - 0x32 (50 channels)
Page 75: Br (Rf Data Rate)
AT commands MAC/PHY commands Default BR (RF Data Rate) This command applies to the XBee/XBee-PRO SX RF Module. Sets and reads the device's RF data rate (the rate at which the device transmits and receives RF data over-the-air). Synchronous sleep is not supported when BR = 0. All devices on the network must have the same BR value set in order to communicate.
Page 76: Rr (Unicast Mac Retries)
AT commands MAC/PHY commands The XBee-PRO SX requires the power supply to be above 3.3 V to ensure 30 dBm output power. The following table shows the typical values over supply voltage. If using a USB interface board with an XBee-PRO SX module, you must supply external DC power.
Page 77: Ed (Energy Detect)
AT commands Diagnostic commands - MAC statistics and timeouts Default 0xA (10 retries) ED (Energy Detect) This command applies to the XBee/XBee-PRO SX RF Module. Starts an energy detect scan. This command accepts an argument to specify the time in milliseconds to scan all channels.
Page 78: Er (Receive Count Error)
AT commands Diagnostic commands - MAC statistics and timeouts Parameter range 0x28 - 0x6E (-40 dBm to -110 dBm) [read-only] Default ER (Receive Count Error) This command applies to the XBee/XBee-PRO SX RF Module. This count increments when a device receives a packet that contains integrity errors of some sort. When the number reaches 0xFFFF, the firmware does not count further events.
Page 79: Tr (Transmission Failure Count)
AT commands Network commands TR (Transmission Failure Count) This command applies to the XBee/XBee-PRO SX RF Module. This value is volatile—the value does not persist in the device's memory after a power-up sequence. Parameter range 0 - 0xFFFF Default UA (Unicasts Attempted Count) This command applies to the XBee/XBee-PRO SX RF Module.
Page 80: Ce (Routing / Messaging Mode)
AT commands Network commands CE (Routing / Messaging Mode) This command applies to the XBee/XBee-PRO SX RF Module. The routing and messaging mode of the device. A routing device repeats broadcasts. Indirect Messaging Coordinators do not transmit point-to- multipoint unicasts until an end device requests them. Setting a device as a poller causes it to regularly send polls to its Indirect Messaging Coordinator.
Page 81: Bh (Broadcast Hops)
AT commands Network commands All other bits should be 0 for future compatibility. Default 0x04 BH (Broadcast Hops) This command applies to the XBee/XBee-PRO SX RF Module. The maximum transmission hops for broadcast data transmissions. This will not affect Point-to- Multipoint transmissions (TO = 40).
Page 82: Addressing Commands
AT commands Addressing commands Set or read the maximum random number of network delay slots before rebroadcasting a network packet. Parameter range 1 - 0x5 network delay slots Default Addressing commands The following AT commands are addressing commands. SH (Serial Number High) This command applies to the XBee/XBee-PRO SX RF Module.
Page 83: Dl (Destination Address Low)
AT commands Addressing commands Parameter range 0 - 0xFFFFFFFF Default DL (Destination Address Low) This command applies to the XBee/XBee-PRO SX RF Module. Set or display the lower 32 bits of the 64-bit destination address. When you combine DH with DL, it defines the destination address that the device uses for transmissions in Transparent mode.
Page 84: Nt (Network Discovery Back-Off)
0x0 - 0x7 (bit field) Bit field Option Description Append the DD (Digi Device Identifier) value to ND responses or API node identification 0x01 frames. Local device sends ND response frame out the serial interface when ND is issued. 0x02...
Page 85: Ci (Cluster Id)
AT commands Diagnostic - addressing commands Default CI (Cluster ID) This command applies to the XBee/XBee-PRO SX RF Module. The application layer cluster ID value. The device uses this value as the cluster ID for all data transmissions. If you set this value to 0x12 (loopback Cluster ID), the destination node echoes any transmitted packet back to the source device.
Page 86: Addressing Discovery/Configuration Commands
AT commands Addressing discovery/configuration commands Brazil = 3 New Zealand = 6 Parameter range 1, 2, 3, 6 [read-only] Default Addressing discovery/configuration commands AG (Aggregator Support) This command applies to the XBee/XBee-PRO SX RF Module. The AG command sends a broadcast through the network that has the following effects on nodes that receive the broadcast: The receiving node establishes a DigiMesh route back to the originating node, if there is space in the routing table.
Page 87: Nd (Network Discover)
PROFILE_ID<CR> (2 bytes) MANUFACTURER_ID<CR> (2 bytes) DIGI DEVICE TYPE<CR> (4 bytes. Optionally included based on NO settings.) RSSI OF LAST HOP<CR> (1 byte. Optionally included based on NO settings.) After (NT * 100) milliseconds, the command ends by returning a <CR>.
Page 88: Fn (Find Neighbors)
DEVICE_TYPE<CR> (1 byte: 0 = Coordinator, 1 = Router, 2 = End Device) STATUS<CR> (1 byte: reserved) PROFILE_ID<CR> (2 bytes) MANUFACTURER_ID<CR> (2 bytes) DIGI DEVICE TYPE<CR> (4 bytes. Optionally included based on NO (Network Discovery Options) settings.) RSSI OF LAST HOP<CR> (1 byte. Optionally included based on NO (Network Discovery Options) settings.)
Page 89: Ky (Aes Encryption Key)
AT commands Security commands C8 (Compatibility Options) that affects whether to use CBC mode or CTR mode encryption. A 256- bit AES key is used in both instances. Parameter range 0 - 1 Parameter Description Encryption Disabled Encryption Enabled Default KY (AES Encryption Key) This command applies to the XBee/XBee-PRO SX RF Module.
Page 90: Serial Interfacing Commands
AT commands Serial interfacing commands Parameter range 3 to 33 ASCII characters (a minimum of three characters are required to enter two passwords separated by a space) Default 0 in ASCII. Note When KZ is set to any value other than the default, it cannot be read. However, when KZ is set to the default value it reads 0.
Page 91: Nb (Parity)
AT commands Serial interfacing commands Parameter ranges 0 - xA (standard rates) 0x4B0 - 0x1C9468 (non-standard rates; 0x2581 to 0x4AFF not supported) Parameter Configuration (b/s) 1200 2400 4800 9600 19200 38400 57600 115200 230400 460800 921600 Default NB (Parity) This command applies to the XBee/XBee-PRO SX RF Module. Set or read the serial parity settings for UART communications.
Page 92: Sb (Stop Bits)
AT commands Serial interfacing commands Default 0x00 SB (Stop Bits) This command applies to the XBee/XBee-PRO SX RF Module. Sets or displays the number of stop bits in the data packet. Parameter range 0 - 1 Parameter Configuration One stop bit Two stop bits Default RO (Packetization Timeout)
Page 93: Ao (Api Options)
AT commands I/O settings commands Set or read the API mode setting. The device can format the RF packets it receives into API frames and send them out the serial port. When you enable API, you must format the serial data as API frames because Transparent operating mode is disabled.
Page 94: D1 (Dio1/Ad1)
AT commands I/O settings commands Sets or displays the DIO0/AD0 configuration (pin 33). Parameter range 0 - 5 Parameter Description Disabled Unmonitored digital input Commissioning Pushbutton Digital input Digital output, low Digital output, high Default D1 (DIO1/AD1) This command applies to the XBee/XBee-PRO SX RF Module. Sets or displays the DIO1/AD1 configuration (pin 32).
Page 95: D3 (Dio3/Ad3)
AT commands I/O settings commands Parameter range 0, 2 - 5 Parameter Description Disabled Digital input Digital output, low Digital output, high Default D3 (DIO3/AD3) This command applies to the XBee/XBee-PRO SX RF Module. Sets or displays the DIO3/AD3 configuration (pin 30). Parameter range 0, 2 - 5 Parameter...
Page 96: D5 (Dio5/Associated_Indicator)
AT commands I/O settings commands Parameter Description Disabled Unmonitored digital input Digital input Digital output, low Digital output, high Default D5 (DIO5/ASSOCIATED_INDICATOR) This command applies to the XBee/XBee-PRO SX RF Module. Sets or displays the DIO5/ASSOCIATED_INDICATOR configuration (pin 28). Parameter range 0, 1, 3 - 5 Parameter Description...
Page 97: D7 (Dio7/Cts)
AT commands I/O settings commands Parameter Description Disabled RTS flow control Digital input Digital output, low Digital output, high Default D7 (DIO7/CTS) This command applies to the XBee/XBee-PRO SX RF Module. Sets or displays the DIO7/CTS configuration (pin 25). Parameter range 0, 1, 3 - 7 Parameter Description...
Page 98: D9 (Dio9/On_Sleep)
AT commands I/O settings commands Parameter Description Disabled Digital input Digital output, low Digital output, high Default D9 (DIO9/ON_SLEEP) This command applies to the XBee/XBee-PRO SX RF Module. Sets or displays the DIO9/ON_SLEEP configuration (pin 26). Parameter range 0, 1, 3 - 6 Parameter Description Disabled...
Page 99: P1 (Dio11/Pwm1 Configuration)
AT commands I/O settings commands Parameter Description Disabled RSSI PWM0 output PWM0 output Digital input Digital output, low Digital output, high Default P1 (DIO11/PWM1 Configuration) This command applies to the XBee/XBee-PRO SX RF Module. Sets or displays the DIO11/PWM1 configuration (pin 8). When configured as a PWM1 output, you can use M1 to set the PWM duty cycle.
Page 100: P3 (Dio13/Dout)
AT commands I/O settings commands Parameter Description Disabled Digital input Digital output, low Digital output, high RX LED Default P3 (DIO13/DOUT) This command applies to the XBee/XBee-PRO SX RF Module. Sets or displays the DIO13/DOUT configuration (pin 3). Parameter range 0, 1 Parameter Description...
Page 101 AT commands I/O settings commands Parameter Description Disabled UART DIN/CONFIG enabled Default P5 (DIO15/SPI_MISO) This command applies to the XBee/XBee-PRO SX RF Module. Sets or displays the DIO15/SPI_MISO configuration (pin 17). Parameter range 0, 1, 4, 5 Parameter Description Disabled SPI_MISO Digital output low Digital output high...
Page 102 AT commands I/O settings commands Parameter Description Digital output low Digital output, high Default P7 (DIO17/SPI_SSEL ) This command applies to the XBee/XBee-PRO SX RF Module. Sets or displays the DIO17/SPI_SSEL configuration (pin 15). Parameter range 0, 1, 4, 5 Parameter Description Disabled...
Page 103: P9 (Dio19/Spi_Attn)
AT commands I/O settings commands Parameter Description Digital output low Digital output high Default P9 (DIO19/SPI_ATTN) This command applies to the XBee/XBee-PRO SX RF Module. Sets or displays the DIO19/SPI_ATTN configuration (pin 12). Parameter range 0, 1, 4 - 6 Parameter Description Disabled...
Page 104: M0 (Pwm0 Duty Cycle)
AT commands I/O settings commands The following table defines the bit-field map for PR and PD commands. The bit field that configures internal pull-up/down resistors status for I/O lines. If you set a PR bit to 1, it enables the internal pull-up/down resistor, 0 specifies no internal pull-up/down. The following table defines the bit-field map for both the PR and PD commands.
Page 105: M1 (Pwm1 Duty Cycle)
AT commands I/O settings commands Parameter range 0 - 0x3FF Default M1 (PWM1 Duty Cycle) This command applies to the XBee/XBee-PRO SX RF Module. The duty cycle of the PWM1 line (pin 8). Use the P1 command to configure the line as a PWM output. Parameter range 0 - 0x3FF Default...
Page 106: I/O Sampling Commands
AT commands I/O sampling commands I/O sampling commands The following AT commands configure I/O sampling parameters. AV (Analog Voltage Reference) This command applies to the XBee/XBee-PRO SX RF Module. The analog voltage reference used for A/D sampling. Parameter range 0, 1 Parameter Description 1.25 V reference...
Page 107: If (Sleep Sample Rate)
AT commands I/O sampling commands I/O line Module pin DIO9 DIO10 DIO11 DIO12 Parameter range 0 - 0xFFFF (bit field) Default IF (Sleep Sample Rate) This command applies to the XBee/XBee-PRO SX RF Module. Set or read the number of sleep cycles that must elapse between periodic I/O samples. This allows the firmware to take I/O samples only during some wake cycles.
Page 108: Is (Immediate Sample)
AT commands I/O line passing commands Default IS (Immediate Sample) This command applies to the XBee/XBee-PRO SX RF Module. Immediately forces an I/O sample to be generated. If you issue the command to the local device, the sample data is sent out the local UART. If sent remotely, the sample data is returned as a Command Response - 0x88.
Page 109: Iu (I/O Output Enable)
AT commands I/O line passing commands ADC0 corresponds with PWM0 ADC1 corresponds with PWM1 IU (I/O Output Enable) This command applies to the XBee/XBee-PRO SX RF Module. Enable or disable I/O data received to be sent out UART/SPI using an API frame when AP = 1 or 2 and when I/O line passing is enabled.
Page 110: T1 (D1 Output Timeout)
AT commands I/O line passing commands Default T1 (D1 Output Timeout) This command applies to the XBee/XBee-PRO SX RF Module. Specifies how long pin D1 holds a given value before it reverts to configured value. If set to 0, there is no timeout.
Page 111: T5 (D5 Output Timeout)
AT commands I/O line passing commands Default T5 (D5 Output Timeout) This command applies to the XBee/XBee-PRO SX RF Module. Specifies how long pin D5 holds a given value before it reverts to configured value. If set to 0, there is no timeout.
Page 112: T9 (D9 Timeout)
AT commands I/O line passing commands T9 (D9 Timeout) This command applies to the XBee/XBee-PRO SX RF Module. Specifies how long pin D9 holds a given value before it reverts to configured value. If set to 0, there is no timeout. Parameter range 0 - 0x1770 (x 100 ms) Default...
Page 113: Q3 (P3 Timeout)
AT commands Sleep commands Q3 (P3 Timeout) This command applies to the XBee/XBee-PRO SX RF Module. Specifies how long pin P3 holds a given value before it reverts to configured value. If set to 0, there is no timeout. Parameter range 0 - 0x1770 (x 100 ms) Default Q4 (P4 Timeout)
Page 114: So (Sleep Options)
AT commands Sleep commands Parameter range 0, 1, 4, 5, 7, 8 Parameter Description Normal. Asynchronous Pin Sleep. In this mode, the SLEEP_RQ line controls the sleep/wake state of the device. Asynchronous Cyclic Sleep. In this mode, the device periodically sleeps and wakes based on the SP and ST commands.
Page 115: Sn (Number Of Cycles Between On_Sleep)
AT commands Sleep commands Option Disable coordinator rapid sync deployment mode Always wake for ST time. Enable sync sleep randomize I/O sampling For asynchronous sleep devices, the following sleep bit field options are defined: Option Always wake for ST time Enable sync sleep randomize I/O sampling Default 0x2 (non-sleep coordinator)
Page 116: St (Wake Time)
AT commands Diagnostic - sleep status/timing commands Default 0x12C (3 seconds) ST (Wake Time) This command applies to the XBee/XBee-PRO SX RF Module. Sets or displays the wake time of the device. For devices in asynchronous sleep, ST defines the amount of time that a device stays awake after it receives RF or serial data.
Page 117: Os (Operating Sleep Time)
AT commands Diagnostic - sleep status/timing commands Description This bit is true when the network is in its wake state. This bit is true if the node currently acts as a network sleep coordinator. This bit is true if the node ever receives a valid sync message after it powers on. This bit is true if the node receives a sync message in the current wake cycle.
Page 118: Ms (Missed Sync Messages)
AT commands Command mode options Default MS (Missed Sync Messages) This command applies to the XBee/XBee-PRO SX RF Module. Reads the number of sleep or wake cycles since the device received a sync message. Parameter range Default SQ (Missed Sleep Sync Count) This command applies to the XBee/XBee-PRO SX RF Module.
Page 119: Ct (Command Mode Timeout)
AT commands Firmware version/information commands CT (Command Mode Timeout) This command applies to the XBee/XBee-PRO SX RF Module. Sets or displays the Command mode timeout parameter. If a device does not receive any valid commands within this time period, it returns to Idle mode from Command mode. Parameter range 2 - 0x1770 (x 100 ms) Default...
Page 120: Hv (Hardware Version)
0x0A00 - set in the firmware DD (Device Type Identifier) This command applies to the XBee/XBee-PRO SX RF Module. Stores the Digi device type identifier value. Use this value to differentiate between multiple XBee devices. Parameter range 0 - 0xFFFFFFFF...
Page 121 AT commands Firmware version/information commands This command allows you to detect an unexpected configuration change on a device. Use the code that the device returns to determine if a node has the configuration you want. After a firmware update this command may return a different value. Parameter range Default XBee®/XBee-PRO SX RF Module User Guide...
Page 122: Operate In Api Mode
Operate in API mode API mode overview Use the AP command to set the operation mode API frame format XBee®/XBee-PRO SX RF Module User Guide...
Page 123: Api Mode Overview
Operate in API mode API mode overview API mode overview By default, the XBee/XBee-PRO SX RF Module acts as a serial line replacement (Transparent operation), it queues all UART data that it receive through the DI pin for RF transmission. When the device receives an RF packet, it sends the data out the DO pin with no additional information.
Page 124: Api Operation With Escaped Characters (Ap Parameter = 2)
API mode, see the Escaped Characters and API Mode 2 in the Digi Knowledge base. API escaped operating mode works similarly to API mode. The only difference is that when working in API escaped mode, the software must escape any payload bytes that match API frame specific data, such as the start-of-frame byte (0x7E).
Page 125: Length Field
Operate in API mode API frame format In API mode with escaped characters, the length field does not include any escape characters in the frame and the firmware calculates the checksum with non-escaped data. Example: escape an API frame To express the following API non-escaped frame in API operating mode with escaped characters: Frame Data Start delimiter Length Frame type Checksum...
Page 126 Operate in API mode API frame format 1. Add all bytes of the packet, except the start delimiter 0x7E and the length (the second and third bytes). 2. Keep only the lowest 8 bits from the result. 3. Subtract this quantity from 0xFF. To verify the checksum of an API frame: 1.
Page 127: Api Frames
API frames The following sections document API frame types. API frame exchanges Code to support future API frames 64-bit Transmit Request - 0x00 Local AT Command Request - 0x08 Queue Local AT Command Request - 0x09 Transmit Request - 0x10 Explicit Addressing Command Request - 0x11 Remote AT Command Request - 0x17 Secure Remote AT Command Request frame - 0x18...
Page 128: Api Frame Exchanges
API frames API frame exchanges API frame exchanges Every outgoing API frame has a corresponding response (or ACK) frame that indicates the success or failure of the outgoing API frame. This section details some of the common API exchanges that occur. You can use the Frame ID field to correlate between the outgoing frames and associated responses.
Page 129: Remote At Commands
API frames API frame exchanges Remote AT commands The following image shows the API frame exchanges that take place on the serial interface when you send a 0x17 Remote AT Command frame The 0x97 Remote AT Command Response is always generated and you can use it to identify if the remote device successfully received and applied the command.
Page 130: Code To Support Future Api Frames
API frames Code to support future API frames Code to support future API frames If your software application supports the API, you should make provisions that allow for new API frames in future firmware releases. For example, you can include the following section of code on a host microprocessor that handles serial API frames that are sent out the device's DOUT pin: void XBee_HandleRxAPIFrame(_apiFrameUnion *papiFrame){ switch(papiFrame->api_id){...
Page 131: 64-Bit Transmit Request - 0X00
This frame type is used to send serial payload data as an RF packet to a remote device with a corresponding 64-bit IEEE address. Note This frame format is deprecated and should only be used by customers who require compatibility with legacy Digi RF products. For new designs, we encourage you to use Transmit Request - 0x10 to initiate API transmissions.
Page 132: Examples
API frames 64-bit Transmit Request - 0x00 Examples Each example is written without escapes (AP = 1) and all bytes are represented in hex format. For brevity, the start delimiter, length, and checksum fields have been excluded. 64-bit unicast Sending a unicast transmission to a device with the 64-bit address of 0013A20012345678 with the serial data "TxData".
Page 133: Local At Command Request - 0X08
API frames Local AT Command Request - 0x08 Local AT Command Request - 0x08 Response frame: Local AT Command Response - 0x88 Description This frame type is used to query or set command parameters on the local device. Any parameter that is set with this frame type will apply the change immediately.
Page 134 API frames Local AT Command Request - 0x08 7E 00 0E 08 A1 4E 49 45 6E 64 20 44 65 76 69 63 65 38 Frame type Frame ID AT command Parameter value 0x08 0xA1 0x4E49 0x456E6420446576696365 Request Matches response "NI"...
Page 135: Queue Local At Command Request - 0X09
API frames Queue Local AT Command Request - 0x09 Queue Local AT Command Request - 0x09 Response frame: Local AT Command Response - 0x88 Description This frame type is used to query or set queued command parameters on the local device. In contrast Local AT Command Request - 0x08, this frame queues new parameter values and does not apply them until you either:...
Page 136 API frames Queue Local AT Command Request - 0x09 Queue setting local command parameter Set the UART baud rate to 115200, but do not apply changes immediately. The device will continue to operate at the current baud rate until the change is applied with a subsequent AC command.
Page 137: Transmit Request - 0X10
API frames Transmit Request - 0x10 Transmit Request - 0x10 Response frame: Extended Transmit Status - 0x8B Description This frame type is used to send payload data as an RF packet to a specific destination. This frame type is typically used for transmitting serial data to one or more remote devices. The endpoints used for these data transmissions are defined by the SE and EP commands and the cluster ID defined by the CI command—excluding 802.15.4.
Page 138: Transmit Options Bit Field
API frames Transmit Request - 0x10 Offset Size Frame Field Description options options. If set to 0, the value of TO specifies the transmit options. Payload Data to be sent to the destination device. Up to NP bytes per 17-n variable data packet. 8-bit Checksum 0xFF minus the 8-bit sum of bytes from offset 3 to this byte (between length and checksum).
Page 139 API frames Transmit Request - 0x10 Bcast Frame radius type Frame ID 64-bit dest Reserved Options RF data 0x10 0x52 0x0013A200 0xFFFE 0x00 0x00 0x547844617461 12345678 Request Matches Destination Unused Will use "TxData" response 64-bit broadcast Sending a broadcast transmission of the serial data "Broadcast" to neighboring devices and suppressing the corresponding response by setting Frame ID to 0.
Page 140: Explicit Addressing Command Request - 0X11
Cannot be used on XBee 802.15.4 firmware. Reserved profile IDs The Digi profile ID of 0xC105 should be used when sending serial data between XBee devices. Format The following table provides the contents of the frame. For details on the frame structure, see frame specifications.
Page 141: Transmit Options Bit Field
API frames Explicit Addressing Command Request - 0x11 Offset Size Frame Field Description 8-bit Start Delimiter Indicates the start of an API frame. 16-bit Length Number of bytes between the length and checksum. Frame type Explicit Addressing Command Request - 0x11 8-bit Frame ID Identifies the data frame for the host to correlate with a...
Page 142: Examples
0x001 0xC10 0x00 0x00 0x547844617 461 12345678 Explici Matche Destinati Unused Digi Digi Data Digi "TxData" data profile reque respon Loopback Packet Sending a loopback transmission to an device with the 64-bit address of 0013A20012345678 using Cluster ID 0x0012. To better understand the raw performance, retries and acknowledgements are disabled.
Page 143 EP t EP data 0x0013A2 0x11 0xF8 0xFFFE 0xE8 0x001 0xC10 0x00 0x01 0x547844617 461 12345678 Explici Matche Destinati Unused Digi Digi Data Digi Disabl "TxData" data profile reque respon retries XBee®/XBee-PRO SX RF Module User Guide...
Page 144: Remote At Command Request - 0X17
API frames Remote AT Command Request - 0x17 Remote AT Command Request - 0x17 Response frame: Remote AT Command Response- 0x97 Description This frame type is used to query or set AT command parameters on a remote device. For parameter changes on the remote device to take effect, you must apply changes, either by setting the Apply Changes options bit, or by sending an AC command to the remote.
Page 145: Examples
API frames Remote AT Command Request - 0x17 Offset Size Frame Field Description command change is received with this bit set Bit 2: Reserved (set to 0) Bit 3: Reserved (set to 0) Bit 4: Send the remote command securely [0x10] Note Option values may be combined. Set all unused bits to 0.
Page 146 API frames Remote AT Command Request - 0x17 Frame Command Parameter type Frame ID 64-bit dest Reserved options command value 0x17 0x68 0x0013A200 0xFFFE 0x00 0x4944 0x0451 12345678 Unused Request Matches Queue Change "ID" response Query remote command parameter Query the temperature of a remote device—TP command. corresponding Remote AT Command Response- 0x97 with a matching Frame ID will return the temperature value.
Page 147: Secure Remote At Command Request Frame - 0X18
API frames Secure Remote AT Command Request frame - 0x18 Secure Remote AT Command Request frame - 0x18 Description The 0x18 frame is like the 0x17 frame except that it requires a password to function; See KZ (Remote AT Command Password).
Page 148 API frames Secure Remote AT Command Request frame - 0x18 Frame data fields Offset Description Command 20+password If present, indicates the parameter value you request for a given Parameter length register. If no characters are present, it queries the register. Numeric parameter values are given in binary format.
Page 149 API frames Secure Remote AT Command Request frame - 0x18 Frame data fields Offset Example Reserved 0xFF 0xFE Command Options 0x02 (apply changes) AT Command 0x42 (B) 0x44 (D) Command Parameter 0x07 Checksum 0x21 XBee®/XBee-PRO SX RF Module User Guide...
Page 150: Modem Status - 0X8A
0x0B = Network woke up 0x0C = Network went to sleep 0x0D = Voltage supply limit exceeded 0x0E = Digi Remote Manager connected 0x0F = Digi Remote Manager disconnected 0x11 = Modem configuration changed while join in progress 0x12 = Access fault...
Page 151: Examples
API frames Modem Status - 0x8A Frame Offset Size Field Description Refer to the tables below for a filtered list of status codes that are appropriate for specific devices. 8-bit Checksum 0xFF minus the 8-bit sum of bytes from offset 3 to this byte (between length and checksum).
Page 152: Extended Transmit Status - 0X8B
API frames Extended Transmit Status - 0x8B Extended Transmit Status - 0x8B Request frames: Transmit Request - 0x10 Explicit Addressing Command Request - 0x11 Description This frame type is emitted when a network transmission request completes. The status field of this frame indicates whether the request succeeded or failed and the reason.
Page 153 API frames Extended Transmit Status - 0x8B Offset Size Frame Field Description 0x00 = No discovery overhead status 0x02 = Route discovery 8-bit Checksum 0xFF minus the 8-bit sum of bytes from offset 3 to this byte (between length and checksum). XBee®/XBee-PRO SX RF Module User Guide...
Page 154: Route Information - 0X8D
API frames Route Information - 0x8D Route Information - 0x8D Request frames: Transmit Request - 0x10 Explicit Addressing Command Request - 0x11 Description This frame type contains the DigiMesh routing information for a remote device on the network. This route information can be used to diagnose marginal links between devices across multiple hops. This frame type is emitted in response to a DigiMesh unicast transmission request which has Trace Routing or NACK enabled.
Page 155: Examples
API frames Route Information - 0x8D Offset Size Frame Field Description address transmission. 64-bit Responder The 64-bit IEEE address of the node that generates this Route address Information packet after it sends (or attempts to send) the data packet to the next hop (the Receiver node). 64-bit Receiver The 64-bit IEEE address of the node that the device sends (or address...
Page 156: Aggregate Addressing Update - 0X8E
API frames Aggregate Addressing Update - 0x8E Aggregate Addressing Update - 0x8E Description This frame type is emitted on devices that update it addressing information in response to a network aggregator issuing an addressing update. A network aggregator is defined by a device on the network who has had the AG (Aggregator Support) command issued.
Page 157 API frames Aggregate Addressing Update - 0x8E Frame type Reserved New address Old address 0x0013A200 0x8E 0x00 0x0013A200 4052BBBB 4052AAAA What DH/DL is now set to What DH/DL was set to Update XBee®/XBee-PRO SX RF Module User Guide...
Page 158: 64-Bit Receive Packet - 0X80
RF data packet from a device configured to use 64-bit source addressing—MY = 0xFFFE. Note This frame format is deprecated and should only be used by customers who require compatibility with legacy Digi RF products. For new designs, we encourage you to use Receive Packet - 0x90 for reception of API transmissions.
Page 159: Examples
API frames 64-bit Receive Packet - 0x80 Frame Offset Size Field Description 8-bit Checksum 0xFF minus the 8-bit sum of bytes from offset 3 to this byte (between length and checksum). Examples Each example is written without escapes (AP = 1) and all bytes are represented in hex format. For brevity, the start delimiter, length, and checksum fields have been excluded.
Page 160: Local At Command Response - 0X88
API frames Local AT Command Response - 0x88 Local AT Command Response - 0x88 Request frames: Local AT Command Request - 0x08 Queue Local AT Command Request - 0x09 Description This frame type is emitted in response to a local AT Command request. Some commands send back multiple response frames;...
Page 161 API frames Local AT Command Response - 0x88 Set local command parameter Host set the NI string of the local device to "End Device" using a 0x08 request frame. The corresponding Local AT Command Response - 0x88 with a matching Frame ID is emitted as a response: 7E 00 05 88 01 4E 49 00 DF Frame...
Page 162: Transmit Status - 0X89
API frames Transmit Status - 0x89 Transmit Status - 0x89 Request frames: 64-bit Transmit Request - 0x00 16-bit Transmit Request - 0x01 Description This frame type is emitted when a transmit request completes. The status field of this frame indicates whether the request succeeded or failed and the reason. This frame is only emitted if the Frame ID in the request is non-zero.
Page 163: Delivery Status Codes
API frames Transmit Status - 0x89 Frame Offset Size Field Description 0x7A = Invalid host address 0x7B = Invalid data mode 0x7C = Invalid interface. 0x7D = Interface not accepting frames. 0x7E = A modem update is in progress. Try again after the update is complete.
Page 164: Receive Packet - 0X90
API frames Receive Packet - 0x90 Receive Packet - 0x90 Request frames: Transmit Request - 0x10 Explicit Addressing Command Request - 0x11 Description This frame type is emitted when a device configured with standard API output—AO (API Options) = 0— receives an RF data packet.
Page 165: Examples
API frames Receive Packet - 0x90 Offset Size Frame Field Description Note Option values may be combined. 15-n variable Received The RF payload data that the device receives. data 8-bit Checksum 0xFF minus the 8-bit sum of bytes from offset 3 to this byte (between length and checksum).
Page 166: Explicit Receive Indicator - 0X91
The Profile ID that the fame is addressed to. Bit field of options that apply to the received message for 8-bit Receive packets sent using Digi endpoints (0xDC-0xEE): options Bit 0: Packet was Acknowledged [0x01] Bit 1: Packet was sent as a broadcast [0x02]...
Page 167: Examples
Reserved Cluster Profile options Received data 0x0013A200 0x91 0x87BD 0xE8 0xE8 0x0011 0xC105 0xC1 0x54784461746 41AEB54E 1 Unused Explicit Digi Digi Data Digi ACK was "TxData" output data data profile sent in DigiMesh network XBee®/XBee-PRO SX RF Module User Guide...
Page 168: Node Identification Indicator - 0X95
API frames Node Identification Indicator - 0x95 Node Identification Indicator - 0x95 Description This frame type is emitted when a node identification broadcast is received. The node identification indicator contains information about the identifying device, such as address, identifier string (NI), and other relevant data.
Page 169: Examples
30+NI 8-bit Source event to be sent. 0 = Reserved 1 = Frame sent by node identification pushbutton event—see (DIO0/AD0). The Digi application Profile ID— 0xC105 . 31+NI 16-bit Digi Profile ID The Digi Manufacturer ID— 0x101E . 33+NI 16-bit Digi...
Page 170 NI String type le ID 0x0013A 0x0013A 0x95 0xFFFE 0xC2 0x4C48373 0xFFFE 0x01 0x01 0xC1 0x10 5 00 1234567 1234567 Identifica Unuse Unuse DigiMe "LH75" + Rout Butt Digi Digi tion null broadc press XBee®/XBee-PRO SX RF Module User Guide...
Page 171: Remote At Command Response- 0X97
API frames Remote AT Command Response- 0x97 Remote AT Command Response- 0x97 Request frame: Remote AT Command Request - 0x17 Description This frame type is emitted in response to a Remote AT Command Request - 0x17. Some commands send back multiple response frames; for example, the ND command. Refer to individual AT command descriptions for details on API response behavior.
Page 172: Examples
API frames Remote AT Command Response- 0x97 Examples Each example is written without escapes (AP = 1) and all bytes are represented in hex format. For brevity, the start delimiter, length, and checksum fields have been excluded. Set remote command parameter Host set the NI string of a remote device to "Remote"...
Page 173 API frames Remote AT Command Response- 0x97 Frame 64-bit Command Command type Frame ID source Reserved command Status data 0x97 0x27 0x0013A200 0x0013A200 0x4944 0x00 0x002F 12345678 12345678 Unused Response Matches "TP" Success +47 °C request XBee®/XBee-PRO SX RF Module User Guide...
Page 174 Work with networked devices Network commissioning and diagnostics Local configuration Remote configuration Secure remote AT commands Establish and maintain network links Test links in a network - loopback cluster Test links between adjacent devices XBee®/XBee-PRO SX RF Module User Guide...
Page 175: Work With Networked Devices
Work with networked devices Network commissioning and diagnostics Network commissioning and diagnostics We call the process of discovering and configuring devices in a network for operation, "network commissioning." Devices include several device discovery and configuration features. In addition to configuring devices, you must develop a strategy to place devices to ensure reliable routes. To accommodate these requirements, modules include features to aid in placing devices, configuring devices, and network diagnostics.
Page 176: Secure Remote At Commands
Work with networked devices Secure remote AT commands 1. The status of the command, which is either success or the reason for failure. 2. In the case of a command query, it includes the register value. The device that sends a remote command does not receive a remote command response frame if: 1.
Page 177: Secure Remote Command Control
Work with networked devices Secure remote AT commands Secure remote command control Assuming the password is known, you can use the Secure Remote AT Command Request frame - 0x18 to send secure remote commands and include the known password in that frame. Such frames are free to be effective on any node in the network whether or not that node has a password set to a non- default value.
Page 178: Software Downgrades
Work with networked devices Establish and maintain network links observe the password as it is communicated from the controller to the XBee/XBee-PRO SX RF Module. For the same reason, we recommend using at least two different passwords on a network—one for gateway devices, and one for standalone devices.
Page 179: Digimesh Routing Examples
Work with networked devices Establish and maintain network links receiving the AG broadcast you can use the invalid address of 0xFFFE. The receiving nodes that are configured in API mode output an Aggregator Update API frame (0x8E) if they update their DH/DL address;...
Page 180: Test Links In A Network - Loopback Cluster
Work with networked devices Test links in a network - loopback cluster Test links in a network - loopback cluster To measure the performance of a network, you can send unicast data through the network from one device to another to determine the success rate of several transmissions. To simplify link testing, the devices support a Loopback cluster ID (0x12) on the data endpoint (0xE8).
Page 181: Example
Work with networked devices Test links between adjacent devices 3. Include a 12-byte payload in the Explicit Addressing Command frame with the following format: Number of bytes Field name Description Destination The address the device uses to test its link. For this example, use the address device A address.
Page 182: Rssi Indicators
Work with networked devices Test links between adjacent devices When the test is finished, the following API frame may be received: 7E 0027 91 0013A20040521234 FFFE E6 E6 0094 C105 00 0013A2004052ABCD 0028 03E8 03E7 0064 00 0A 50 53 52 9F This means: 999 out of 1000 packets were successful.
Page 183: Trace Route Option
Work with networked devices Test links between adjacent devices When a device receives the network discovery command, it waits a random time before sending its own response. You can use the NT command to set the maximum time delay on the device that you use to send the ND command.
Page 184: Nack Messages
Work with networked devices Test links between adjacent devices After the data packet makes a successful MAC transmission from device A to device B, device A outputs a Route Information Packet frame indicating that the transmission of the data packet from device A to device E was successful in forwarding one hop from device A to device B.
Page 185 Work with networked devices Test links between adjacent devices To support the Commissioning Pushbutton and its associated LED functions, connect a pushbutton and an LED to device pins 33 and 28 respectively. Definitions To enable the Commissioning Pushbutton functionality on pin 33, set the D0 command to 1. The functionality is enabled by default.
Page 186: Associate Led
Work with networked devices Test links between adjacent devices Sleep configuration Button and sync presses status Action All devices that receive this transmission blink their Associate LED rapidly for one second. All devices in API operating mode that receive this transmission send a Node Identification Indicator frame (0x95) out their UART.
Page 187 Work with networked devices Test links between adjacent devices Sleep mode LED status Meaning 1, 4, 5 The device is in a low power mode 1, 4, 5 On, blinking The device has power, is awake and is operating properly On, solid The network is asleep, or the device has not synchronized with the network, or has lost synchronization with the network...
Page 188: Pin Configurations
Monitor I/O lines Pin configurations Devices support both analog input and digital I/O line modes on several configurable pins. The following table provides typical parameters for the pin configuration commands (D0 - D9, P0 - P2). Pin command parameter Description Unmonitored digital input (disabled) Reserved for pin-specific alternate functionality Analog input (A/D pins) or PWM output (PWM pins)
Page 189: Queried Sampling
Monitor I/O lines Pin configurations Device pin name Device pin number Configuration command RTS / DIO6 AD3 / DIO3 AD2 / DIO2 AD1 / DIO1 AD0 / DIO0 / Commissioning Pushbutton Use the PR command to enable internal pull up/down resistors for each digital input. Use the PD command to determine the direction of the internal pull up/down resistor.
Page 190: Periodic I/O Sampling
Monitor I/O lines Periodic I/O sampling Field Name Description bit 5 = ASSOC/AD5/DIO5 If you enable any digital I/O lines, the first two bytes of the data set indicate Variable Sampled the state of all enabled digital I/O. data set Only digital channels that you enable in the Digital channel mask bytes have any meaning in the sample set.
Page 191 Monitor I/O lines Detect digital I/O changes the IR interval sending x samples or x samples - 1. If the IR interval is greater than the ST time period then ST time will be used to randomize the I/O sample. You can configure devices to transmit a data sample immediately whenever a monitored digital I/O pin changes state.
Page 192: I/O Line Passing
I/O line passing You can configure XBee/XBee-PRO SX RF Modules to perform analog and digital line passing. When a device receives an RF I/O sample data packet, you can set up the receiving device to update any enabled outputs (PWM and DIO) based on the data it receives. Digital I/O lines are mapped in pairs;...
Page 193 I/O line passing Configuration example Command Description Device A Device B Destination Low 0xABCDABCD 0x0000FFFF (broadcast) I/O Input Address 0x0013A200ABCDABCD 0x0013A20012345678 Sample Rate 0x7D0 (2 seconds) 0 (disabled) DIO Change Detect 0 (disabled) 0x1000 (DIO3 only) DIO1/AD1 2 : ADC input DIO11/PWM1 2: PWM1 output PWM Output Timeout...
Page 194 I/O line passing Configuration example DIO2 on Device B outputs the state of DIO2 from Device A. PWM1 outputs a duty cycle equivalent to the analog voltage read on AD1 of Device A. A PWM timeout has been set to three seconds; if no sample is received, PWM1 returns to 0 V after this period.
Page 195: General Purpose Flash Memory
General Purpose Flash Memory General Purpose Flash Memory Access General Purpose Flash Memory General Purpose Flash Memory commands XBee®/XBee-PRO SX RF Module User Guide...
Page 196: General Purpose Flash Memory
General Purpose Flash Memory General Purpose Flash Memory General Purpose Flash Memory XBee/XBee-PRO SX RF Modules provides 119 512-byte blocks of flash memory that an application can read and write to. This memory provides a non-volatile data storage area that an application uses for many purposes.
Page 197: General Purpose Flash Memory Commands
General Purpose Flash Memory General Purpose Flash Memory commands Byte offset in Number of payload bytes Field name General field description GPM_CMD_ID This field is the same as the request field. GPM_STATUS Status indicating whether the command was successful. GPM_BLOCK_NUM The block number addressed in the GPM.
Page 198: Erase (0X01)
General Purpose Flash Memory General Purpose Flash Memory commands Field name Command-specific description GPM_BLOCK_NUM Indicates the number of GPM blocks available. GPM_START_INDEX Indicates the size, in bytes, of a GPM block. GPM_NUM_BYTES The number of bytes in the GPM_DATA field. For this command, this field will be set to 0.
Page 199: Write (0X02) And Erase_Then_Write (0X03)
General Purpose Flash Memory General Purpose Flash Memory commands Field name Command-specific description GPM_CMD_ID Should be set to ERASE_RESPONSE (0x81). GPM_STATUS A 1 in the least significant bit indicates an error occurred. All other bits are reserved at this time. GPM_BLOCK_NUM Matches the parameter passed in the request frame.
Page 200: Write _Response (0X82) And Erase_Then_Write_Response (0X83)
General Purpose Flash Memory General Purpose Flash Memory commands WRITE _RESPONSE (0x82) and ERASE_THEN_WRITE_RESPONSE (0x83) When a WRITE or ERASE_THEN_WRITE command request has been unicast to a node, that node sends a response in the following format to the source endpoint specified in the requesting frame. Field name Command-specific description GPM_CMD_ID...
Page 201: Read_Response (0X84)
General Purpose Flash Memory General Purpose Flash Memory commands Field name Command-specific description be operated on per command. For this reason, GPM_START_INDEX + GPM_NUM_BYTES cannot be greater than the GPM block size. The number of bytes sent in an explicit API frame (including the GPM command fields) cannot exceed the maximum payload size of the device.
Page 202: Firmware_Verify_Response (0X85)
General Purpose Flash Memory General Purpose Flash Memory commands Field name Command-specific description GPM_CMD_ID Should be set to FIRMWARE_VERIFY (0x05) or FIRMWARE_VERIFY_ AND_INSTALL (0x06) GPM_OPTIONS There are currently no options defined for this command. Set this field to 0. GPM_BLOCK_NUM This field is unused for this command.
Page 203 General Purpose Flash Memory General Purpose Flash Memory commands Field name Command-specific description GPM_START_INDEX This field is unused for this command. Set to 0. GPM_NUM_BYTES This field is unused for this command. Set to 0. GPM_DATA This field is unused for this command. Example To verify a firmware image previously loaded into the GPM on a target device with serial number 0x0013a200407402ac, format a FIRMWARE_VERIFY packet as follows (spaces added to delineate...
Page 204: Update The Firmware Over-The-Air
Update the firmware over-the-air This section provides instruction on how to update your firmware using wired updates and over-the- air updates. Over-the-air firmware updates Distribute the new application Verify the new application Install the application XBee®/XBee-PRO SX RF Module User Guide...
Page 205: Over-The-Air Firmware Updates
XBee/XBee-PRO SX RF Modules use an encrypted binary (.ebin) file for both serial and over-the-air firmware updates. These firmware files are available on the Digi Support website and via XCTU. Send the contents of the .ebin file to the target device using general purpose memory WRITE commands.
Page 206: Verify The New Application
Update the firmware over-the-air Verify the new application GPM_BLOCK_NUM GPM_START_INDEX GPM_NUM_BYTES .ebin bytes 54784 to 54911 54912 to 55039 55040 to 55140 Verify the new application For an uploaded application to function correctly, every single byte from the .ebin file must be properly transferred to the GPM.
Page 207: Regulatory Information
Regulatory information FCC (United States) ISED (Innovation, Science and Economic Development Canada) ACMA (Australia) RSM (New Zealand) Brazil (Anatel) IFETEL (Mexico) XBee®/XBee-PRO SX RF Module User Guide...
Page 208: Fcc (United States)
(i.) this device may not cause harmful interference and (ii.) this device must accept any interference received, including interference that may cause undesired operation. The following text is the required FCC label for OEM products containing the XBee SX RF Module: Contains FCC ID: MCQ-XBSX The enclosed device complies with Part 15 of the FCC Rules.
Page 209 Regulatory information FCC (United States) Increase the separation between the equipment and receiver, Connect equipment and receiver to outlets on different circuits, or Consult the dealer or an experienced radio/TV technician for help. XBee®/XBee-PRO SX RF Module User Guide...
Page 210: Rf Exposure Statement
Section 15.247 (emissions). Fixed base station and mobile applications Digi devices are pre-FCC approved for use in fixed base station and mobile applications. When the antenna is mounted at least 34 cm from nearby persons, the application is considered a mobile application.
Page 211: Xbee-Pro Sx Antenna Options (30 Dbm Maximum Rf Power)
Digi does not carry all of these antenna variants. Contact Digi Sales for available antennas. Dipole antennas All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option. Part number...
Page 212 9.0 dB Fixed/mobile A09-Y14TM* 14 element Yagi 14.0 dBi RPTNC 9.9 dB Fixed/mobile Omni-directional base station antennas All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option.
Page 213 Part number Type Gain Connector Required antenna cable loss Application A09-F0NF* Fiberglass base station 0 dBi Fixed A09-F1NF* Fiberglass base station 1.0 dBi Fixed A09-F2NF-M Fiberglass base station 2.1 dBi Fixed A09-F3NF* Fiberglass base station 3.1 dBi Fixed A09-F4NF* Fiberglass base station 4.1 dBi Fixed A09-F5NF-M...
Page 214 7.1 dBi RPTNC 1.9 dB Fixed Dome antennas All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option. Part number Type Gain Connector Required antenna cable loss...
Page 215 Part number Type Gain Connector Required antenna cable loss Application A09-QRAMM 3" Quarter wave wire 2.1 dBi MMCX Fixed/mobile A09-QRSM-2.1* Quarter wave 2.1" right angle 3.3 dBi RPSMA 0.4 dB Fixed/mobile A09-QW* Quarter wave wire 1.9 dBi Permanent Fixed/mobile A09-QSM-3* Quarter wave straight 1.9 dBi RPSMA...
Page 216: Xbee Sx Antenna Options (13 Dbm Maximum Rf Power)
XBee SX antenna options (13 dBm maximum RF power) The following tables cover the antennas that are approved for use with the XBee SX RF Module. If applicable, the tables show the required cable loss between the device and the antenna.
Page 217 Part number Type Gain Connector Required antenna cable loss Application A09-Y6NF* 2 element Yagi 6.1 dBi Fixed/mobile A09-Y7NF* 3 element Yagi 7.1 dBi Fixed/mobile A09-Y8NF 4 element Yagi 8.1 dBi Fixed/mobile A09-Y9NF* 4 element Yagi 9.1 dBi Fixed/mobile A09-Y10NF* 5 element Yagi 10.1 dBi Fixed/mobile A09-Y11NF...
Page 218 15.1 dBi RPTNC 0.7 dB Fixed/mobile Omni-directional base station antennas All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option. Part number Type Gain Connector Required antenna cable loss...
Page 219 Wire Base Station 7.1 dBi RPTNC Fixed Dome antennas All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option. Part number Type Gain Connector Required antenna cable loss...
Page 220 3.0 dBi RPSMA 0.4 dB Fixed/mobile Monopole antennas All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option. Part number Type Gain Connector Required antenna cable loss...
Page 221: Fcc Publication 996369 Related Information
Host product manufacturers need to follow the sticker guidelines outlined in OEM labeling requirements. 2.9 Information on test modes and additional testing requirements Contact a Digi sales representative for information on how to configure test modes for the XBee SX and XBee-PRO SX modules. XBee®/XBee-PRO SX RF Module User Guide...
Page 222 FCC Part 15 Subpart B compliance testing is still required for the final host product. This testing is required for all end products, and XBee SX/XBee-PRO SX Part 15 Subpart B compliance does not affirm the end product’s compliance.
Page 223: Ised (Innovation, Science And Economic Development Canada)
Labeling requirements XBee SX Labeling requirements for Industry Canada are similar to those of the FCC. A clearly visible label on the outside of the final product must display the following text: Contains Model XBSX Radio, IC: 1846A-XBSX The integrator is responsible for its product to comply with IC ICES-003 and FCC Part 15, Sub.
Page 224: Acma (Australia)
RCM mark on an end product, a company must comply with a or b below: a. have a company presence in Australia. b. have a company/distributor/agent in Australia that will sponsor the import of the end product. Contact Digi for questions related to locating a contact in Australia. RSM (New Zealand) Power requirements No antenna with gain greater that 2.1 dBi (dipole) can be used with this radio in New Zealand.
Page 225: Brazil (Anatel)
Brazil (Anatel) ANATEL Brazil for XBee-PRO SX radio products (XBPSX) The XBee SX-PRO RF modules (models noted below) comply with Brazil ANATEL standards in Resolution No. 506. The following information is required in the user manual for the product containing the radio and on the product containing the radio (in Portuguese): Digi Model: XBPSX Este equipamento não tem direito à...
Page 226: Sx Anatel Brazil For Xk9X-Dms-1 Xbee Sx Rf Module Dev Kit (Xk9X-Dms-1)
SX ANATEL Brazil for XK9X-DMS-1 XBee SX RF Module Dev Kit (XK9X- DMS-1) The XBee SX RF modules (models noted below) comply with Brazil ANATEL standards in Resolution No.506. The following information is required in the user manual for the product containing the radio and on the product containing the radio (in Portuguese): Digi Model: XK9X-DMS-1 Este equipamento não tem direito à...
Page 227: Anatel Brazil For Xbee Sx Radio Products (Xbsx)
ANATEL Brazil for XBee SX radio products (XBSX) The XBee SX RF modules (models noted below) comply with Brazil ANATEL standards in Resolution No. 506. The following information is required in the user manual for the product containing the radio and on the product containing the radio (in Portuguese): Digi Model: XBSX Este equipamento não tem direito à...
Page 228: Ifetel (Mexico)
“Este equipo contiene el módulo XBP9X con IFT #: RCPDIXB19-2288” The IFETEL number for the XBee SX product must be listed either on the end product, on the packaging, in the manual, or in the software with the following phrase: “Este equipo contiene el módulo XB9X con Número IFETEL: RCPDIXB19-1819”...
Page 229 PCB design and manufacturing The XBee/XBee-PRO SX RF Module is designed for surface-mount on the OEM PCB. It has castellated pads to allow for easy solder attach inspection. The pads are all located on the edge of the module, so there are no hidden solder joints on these modules.
Page 230: Pcb Design And Manufacturing
PCB design and manufacturing Recommended footprint and keepout Recommended footprint and keepout We designed the XBee/XBee-PRO SX RF Module for surface-mounting on the OEM printed circuit board (PCB). It has castellated pads around the edges and one ground pad on the bottom. Mechanical drawings includes a detailed mechanical drawing.
Page 231 PCB design and manufacturing Recommended footprint and keepout The recommended footprint includes an additional ground pad that you must solder to the corresponding pad on the device. This ground pad transfers heat generated during transmit mode away from the device’s power amplifier. The pad must connect through vias to a ground plane on the host PCB.
Page 232: Design Notes
PCB design and manufacturing Design notes Design notes The following guidelines help to ensure a robust design. Host board design A good power supply design is critical for proper device operation. If the supply voltage is not kept within tolerance, or is excessively noisy, it may degrade device performance and reliability. To help reduce noise, we recommend placing both a 1 uF and 100 pF capacitor as near to VCC as possible.
Page 233: Improve Antenna Performance
PCB design and manufacturing Design notes Improve antenna performance The choice of antenna and antenna location is important for optimal performance. In general, antenna elements radiate perpendicular to the direction they point. Thus a vertical antenna, such as a dipole, emit across the horizon. Metal objects near the antenna cause parasitic coupling and detuning, preventing the antenna from radiating efficiently.
Page 234: Recommended Solder Reflow Cycle
PCB design and manufacturing Recommended solder reflow cycle Number Description XBee pin 36 50 Ω microstrip trace Back off ground fill at least twice the distance between layers 1 and 2 RF connector Stitch vias near the edges of the ground plane Pour a solid ground plane under the RF trace on the reference layer Implementing these design suggestions helps ensure that the RF pad device performs to specifications.
Page 235: Flux And Cleaning
PCB design and manufacturing Flux and cleaning Time (seconds) Temperature (degrees C) The maximum temperature should not exceed 260 °C. The SX device will reflow during this cycle, and therefore must not be reflowed upside down. Take care not to jar the device while the solder is molten, as this can remove components under the shield from their required locations.
Page 236 PCB design and manufacturing Rework CAUTION! Any modification to the device voids the warranty coverage and certifications. XBee®/XBee-PRO SX RF Module User Guide...

This manual is also suitable for:

Xbee-pro sx

Digi XBee SX User Manual

Xbee®/Xbee-PRO SX RF Module User Guide

Technical Specifications

Hardware

Kit

Gettingstarted with the Xbee/Xbee-Prosxrfmoduledevelopment

Modes

Sleep Modes

Networking Methods

Serial Communication

AT Commands

Operate in API Mode

API Frames

Quick Links

Need help?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for Digi XBee SX

Summary of Contents for Digi XBee SX