Digi DigiMesh XBee S2C User Manual

Digi DigiMesh XBee S2C User Manual

Radio frequency (rf) modules
Hide thumbs Also See for DigiMesh XBee S2C:
Table of Contents

Advertisement

Quick Links

XBee®/XBee-PRO S2C DigiMesh® 2.4
Radio Frequency (RF) Modules
User Guide

Advertisement

Table of Contents
loading

Summary of Contents for Digi DigiMesh XBee S2C

  • Page 1 XBee®/XBee-PRO S2C DigiMesh® 2.4 Radio Frequency (RF) Modules User Guide...
  • Page 2 Information in this document is subject to change without notice and does not represent a commitment on the part of Digi International. Digi provides this document “as is,” without warranty of any kind, expressed or implied, including, but not limited to, the implied warranties of fitness or merchantability for a particular purpose.
  • Page 3: Table Of Contents

    Contents XBee S2C DigiMesh 2.4 User Guide Applicable firmware and hardware Firmware release notes Technical specifications Performance specifications Power requirements General specifications Networking and security specifications Regulatory conformity summary Serial communication specifications UART pin assignments SPI pin assignments GPIO specifications Hardware Antenna options Mechanical drawings...
  • Page 4 Modes Serial modes Transparent operating mode API operating mode Command mode Transceiver modes Idle mode Transmit mode Receive mode Serial communication Select a serial port Serial receive buffer Serial transmit buffer UART port UART data flow Serial data Flow control SPI port SPI signals SPI parameters...
  • Page 5 Network commissioning and diagnostics Local configuration Remote configuration Send a remote command Apply changes on remote devices Remote command response Establish and maintain network links Build aggregate routes DigiMesh routing examples Replace nodes Test links between adjacent devices Trace route option NACK messages RSSI indicators Associate LED...
  • Page 6 CA (CCA Threshold) ED (Energy Detect) TP (Board Temperature) %V (Voltage Supply Monitoring) %H (MAC Unicast One Hop Time) %8 (MAC Broadcast One Hop Time) DB (Last Packet RSSI) UA (Unicasts Attempted Count) GD (Good Packets Received) BC (Bytes Transmitted) EA (MAC ACK Failure Count) EC (CCA Failures) TR (Transmission Failure Count)
  • Page 7 D7 (DIO7/CTS) D8 (DIO8/DTR/SLEEP_REQUEST) D9 (ON_SLEEP) P0 (DIO10/RSSI/PWM0 Configuration) P1 (DIO11/PWM1 Configuration) P2 (DIO12/SPI_MISO Configuration) P5 (SPI_MISO) P6 (SPI_MOSI Configuration) P7 (SPI_SSEL ) P8 (SPI_SCLK )P8 (SPI_SCLK ) P9 (SPI_ATTN) PD (Pull Up/Down Direction) PR (Pull-up/Down Resistor Enable) M0 (PWM0 Duty Cycle) M1 (PWM1 Duty Cycle) LT command RP command...
  • Page 8 DD command NP (Maximum Packet Payload Bytes) CK (Configuration CRC) Operate in API mode API mode overview API frame specifications Calculate and verify checksums Escaped characters in API frames Frame descriptions API frame exchanges AT Command frame - 0x08 AT Command - Queue Parameter Value frame - 0x09 Transmit Request frame - 0x10 Explicit Addressing Command frame - 0x11 Remote AT Command Request frame - 0x17...
  • Page 9 Load DigiMesh 2.4 firmware on ZB devices Background Load firmware Migrate from XBee through-hole to surface-mount devices Pin mapping Mount the devices PCB design and manufacturing Recommended solder reflow cycle Recommended footprint and keepout Flux and cleaning Rework XBee S2C DigiMesh 2.4 User Guide...
  • Page 10: Xbee S2C Digimesh 2.4 User Guide

    You can build networks of up to 32 nodes using these devices. For larger networks of up to 1,000 or more nodes, we offer technical support to assist with proper network configuration. For information on Technical Support plans and pricing, contact us at 877.912.3444 or visit us at www.digi.com/support. Applicable firmware and hardware Firmware release notes...
  • Page 11: Applicable Firmware And Hardware

    900x It supports the following hardware: Firmware release notes You can view the current release notes in the Firmware Explorer section of XCTU. For instructions on downloading and using XCTU, go to: https://www.digi.com/products/xbee-rf-solutions/xctu- software/xctu. XBee S2C DigiMesh 2.4 User Guide...
  • Page 12 Technical specifications The following tables provide the device's technical specifications. Performance specifications Power requirements General specifications Networking and security specifications Regulatory conformity summary Serial communication specifications GPIO specifications XBee S2C DigiMesh 2.4 User Guide...
  • Page 13: Technical Specifications

    Technical specifications Performance specifications Performance specifications The following table describes the performance specifications for the devices. Specification XBee value XBee-PRO value Indoor / urban range Up to 200 ft (60 m) Up to 300 ft. (90 m) Outdoor RF line-of-sight range Up to 4000 ft (1200 m) Up to 2 miles (3200 6.3 mW (8 dBm), Boost mode...
  • Page 14: General Specifications

    Technical specifications General specifications General specifications The following table describes the general specifications for the devices. Specification XBee XBee-PRO Operating ISM 2.4 GHz frequency Supported 11 - 26 12 - 23 channels TH: 2.438 x 2.761 cm (0.960 x 1.087 in) TH: 2.438 x 3.294 cm (0.960 x 1.297 in) Form factor SMT: 2.199 x 3.4 x 0.305 cm (0.866 x...
  • Page 15: Serial Communication Specifications

    Technical specifications Serial communication specifications XBee-PRO (surface- XBee XBee XBee-PRO mount) (through-hole) Country (surface-mount) (through-hole) IC:  Industry Canada (IC) 1846A-XBS2C 1846A- 1846A-S2CTH 1846A-PS2CTH PS2CSM FCC/IC test transmit -26 to +8 dBm -0.7 to -26 to +8 dBm +1 to +19 dBm power output range +19.4 dBm Europe (CE)
  • Page 16 Technical specifications Serial communication specifications Specifications Module pin number SPI pins XBee (surface-mount) XBee (through-hole) SPI_SSEL SPI_MOSI SPI_MISO XBee S2C DigiMesh 2.4 User Guide...
  • Page 17: Gpio Specifications

    Technical specifications GPIO specifications GPIO specifications XBee/XBee-PRO S2C DigiMesh 2.4 RF Modules have 15 General Purpose Input / Output (GPIO) ports available. The exact list depends on the device configuration, as some GPIO pads are used for purposes such as serial communication. GPIO Electrical Specification Value Low Schmitt switching threshold...
  • Page 18: Hardware

    Hardware Antenna options Mechanical drawings Mounting considerations Pin signals Design notes ADC characteristics XBee S2C DigiMesh 2.4 User Guide...
  • Page 19: Antenna Options

    Hardware Antenna options Antenna options The ranges specified are typical for the integrated whip (1.5 dBi) and dipole (2.1 dBi) antennas. The printed circuit board (PCB) antenna option provides advantages in its form factor; however, it typically yields shorter range than the whip and dipole antenna options when transmitting outdoors. For more information, see XBee and XBee-PRO OEM RF Module Antenna Considerations Application Note.
  • Page 20: Mounting Considerations

    Hardware Mounting considerations The following drawings show the XBee-PRO through-hole device. Mounting considerations We design the through-hole module to mount into a receptacle so that you do not have to solder the module when you mount it to a board. The development kits may contain RS-232 and USB interface boards that use two 20-pin receptacles to receive modules.
  • Page 21: Pin Signals

    Hardware Pin signals The following illustration shows the module mounting into the receptacle on the RS-232 interface board. Through-hole single-row receptacles: Samtec part number: MMS-110-01-L-SV (or equivalent) Surface-mount double-row receptacles: Century Interconnect part number: CPRMSL20-D-0-1 (or equivalent) Surface-mount single-row receptacles: Samtec part number: SMM-110-02-SM-S  Note We recommend that you print an outline of the module on the board to indicate the correct orientation for mounting the module.
  • Page 22 Hardware Pin signals Name Direction Description DIN/CONFIG Input UART data In DIO12/SPI_MISO Both Digital I/O 12 / Serial Peripheral Interface (SPI) Data Out RESET Input Module reset (reset pulse must be at least 200 ns). This must be driven as an open drain/collector. The device drives this line low when a reset occurs.
  • Page 23 Hardware Pin signals Name Direction Function DIO12 Both Digital I/O 12 RESET Input Module reset (reset pulse must be at least 200 ns). This must be driven as an open drain/collector. The device drives this line low when a reset occurs. Never drive this line high.
  • Page 24: Notes

    Hardware Design notes Name Direction Function DIO3/AD3 Both Digital I/O 3 / Analog input 3 DIO2/AD2 Both Digital I/O 2 / Analog input 2 DIO1/AD1 Both Digital I/O 1 / Analog input 1 DIO0/AD0 Both Digital I/O 0 / Analog input 0 [Reserved] Do not connect Ground...
  • Page 25: Keepout Area

    Hardware Design notes the best signal perpendicular to the direction they point, so a vertical antenna's omnidirectional radiation pattern is strongest across the horizon. Position the antennas away from metal objects whenever possible. Metal objects between the transmitter and receiver can block the radiation path or reduce the transmission distance. Objects that are often overlooked include: metal poles metal studs...
  • Page 26 Hardware Design notes Through-hole keepout Notes 1. We recommend non-metal enclosures. For metal enclosures, use an external antenna. 2. Keep metal chassis or mounting structures in the keepout area at least 2.54 cm (1 in) from the antenna. 3. Maximize the distance between the antenna and metal objects that might be mounted in the keepout area.
  • Page 27: Rf Pad Version

    Hardware Design notes Surface-mount keepout Notes 1. We recommend non-metal enclosures. For metal enclosures, use an external antenna. 2. Keep metal chassis or mounting structures in the keepout area at least 2.54 cm (1 in) from the antenna. 3. Maximize the distance between the antenna and metal objects that might be mounted in the keepout area.
  • Page 28 Hardware Design notes For the transmission line, we recommend either a microstrip or coplanar waveguide trace on the PCB. We provide a microstrip example below, because it is simpler to design and generally requires less area on the host PCB than coplanar waveguide. We do not recommend using a stripline RF trace because that requires routing the RF trace to an inner PCB layer, and via transitions can introduce matching and performance problems.
  • Page 29: Adc Characteristics

    Hardware ADC characteristics Number Description XBee surface-mount 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 30 Hardware ADC characteristics Parameter Condition Typical Units Internal voltage reference 1.17 1.23 Analog input voltage range Input impedance MΩ Number of bits Codes peak 0.044 Differential non-linearity Codes RMS 0.014 Codes peak 0.306 Integral non-linearity Codes RMS 0.176 Analog input must be within range for valid conversion. Values greater than 1.2 V convert to $3FF. XBee S2C DigiMesh 2.4 User Guide...
  • Page 31: Configure The Xbee/Xbee-Pro S2C Digimesh 2.4 Rf Module

    Configure the XBee/XBee-PRO S2C DigiMesh 2.4 RF Module Software libraries Configure the device using XCTU Over-the-air (OTA) firmware update XBee S2C DigiMesh 2.4 User Guide...
  • Page 32: Software Libraries

    XBee Configuration and Test Utility (XCTU) is a multi-platform program that enables users to interact with Digi radio frequency (RF) devices through a graphical interface. The application includes built-in tools that make it easy to set up, configure, and test Digi RF devices.
  • Page 33 Modes Serial modes Transceiver modes XBee S2C DigiMesh 2.4 User Guide...
  • Page 34: Modes

    Modes Serial modes Serial 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. Use the AP command to choose Serial mode. XBee/XBee-PRO S2C DigiMesh 2.4 RF Modules use Transparent operation as the default serial mode.
  • Page 35 Modes Serial modes command character (CC) and the silence before and after the sequence (GT) are configurable. When the device sees a full second of silence in the data stream (the guard time, GT) followed by the string +++ (without Enter or Return) and another full second of silence (the default time, which you can change in the GT command), it knows to stop sending data and start accepting commands locally.
  • Page 36: Transceiver Modes

    Modes Transceiver modes 1. Send the AC (Apply Changes) command. 2. Exit Command mode. Exit Command mode 1. Send the CN (Exit Command Mode) command followed by a carriage return. 2. If the device does not receive any valid AT commands within the time specified by CT (Command Mode Timeout), it returns to Transparent or API mode.
  • Page 37 Serial communication Select a serial port UART port SPI port XBee S2C DigiMesh 2.4 User Guide...
  • Page 38: Select A Serial Port

    Serial communication Select a serial port Select a serial port The device has two serial ports and only one is active at a time. To be active, a port must be enabled and in use. The UART is always enabled. The SPI is enabled if it is configured. To be configured, SPI_MISO, SPI_ MOSI, SPI_SSEL , and SPI_CLK must all be configured as peripherals.
  • Page 39: Serial Data

    Serial communication UART port Serial data A device sends data to the XBee/XBee-PRO S2C DigiMesh 2.4 RF Module's UART through TH pin 3/SMT pin 4 DIN as an asynchronous serial signal. When the device is not transmitting data, the signals should idle high.
  • Page 40: Spi Port

    Serial communication SPI port CTS flow control If you enable CTS flow control (by setting D7 to 1), when the serial receive buffer is 7 bytes away from being full, the device de-asserts CTS(sets it high) to signal to the host device to stop sending serial data.
  • Page 41: Spi Parameters

    Serial communication SPI port SMT pin SMT applicable AT TH Pin TH applicable AT Signal command command SPI_MOSI (Master out, Slave in) SPI_MISO (Master in, Slave out) SPI_SCLK (Serial clock) SPI_SSEL (Slave select) SPI_ATTN (Attention) By default, the inputs have pull-up resistors enabled. On through-hole devices, you can use the PR command to disable the pull-up resistors.
  • Page 42: Spi And Api Mode

    Serial communication SPI port SPI and API mode The SPI only operates in API mode 1. The SPI does not support Transparent mode or API mode 2 (with escaped characters). This means that the AP configuration only applies to the UART interface and is ignored while using the SPI.
  • Page 43 Serial communication SPI port XBee S2C DigiMesh 2.4 User Guide...
  • Page 44: I/O Support

    I/O support Digital I/O line support Analog input Monitor I/O lines I/O line passing XBee S2C DigiMesh 2.4 User Guide...
  • Page 45: Digital I/O Line Support

    I/O support Digital I/O line support Digital I/O line support Digital I/O is available on lines DIO0 through DIO12 (D0 - D9 and P0 - P2). Each of these pins may be configured as 3, 4, or 5 with the following meanings: 3 is digital input 4 is digital output low 5 is digital output high...
  • Page 46 I/O support Monitor I/O lines Field Name Description Indicates which digital I/O lines have sampling enabled. Each bit corresponds to Digital one digital I/O line on the device. channel mask bit 0 = AD0/DIO0 bit 1 = AD1/DIO1 bit 2 = AD2/DIO2 bit 3 = AD3/DIO3 bit 4 = DIO4 bit 5 = ASSOC/DIO5...
  • Page 47: On Demand I/O Sampling

    I/O support Monitor I/O lines On demand I/O sampling You can use the IS (Force Sample) command to sample pins configured as digital I/O and analog input. If no pins are configured in this manner (with the DO - D8 commands set to 2, 3, 4, or 5), then the IS command returns an error.
  • Page 48: Periodic I/O Sampling

    I/O support Monitor I/O lines Periodic I/O sampling Periodic sampling allows a device to take an I/O sample and transmit it to a remote device at a periodic rate. Use the IR command to set the periodic sample rate. To disable periodic sampling, set IR to 0. For all other IR values, the firmware samples data when IR milliseconds elapse and the sample data transmits to a remote device.
  • Page 49: I/O Line Passing

    I/O support I/O line passing I/O line passing You can configure XBee/XBee-PRO S2C DigiMesh 2.4 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.
  • Page 50: Networking

    Networking Network identifiers Operating channels Delivery methods Encryption Maximum payload DigiMesh throughput XBee S2C DigiMesh 2.4 User Guide...
  • Page 51: Network Identifiers

    Networking Network identifiers Network identifiers You define DigiMesh networks with a unique network identifier. Use the ID command to set this identifier. For devices to communicate, you must configure them with the same network identifier and the same operating channel. For devices to communicate, the CH and ID commands must be equal on all devices in the network.
  • Page 52 Networking Delivery methods Self-healing. This process automatically figures out if one or more nodes on the network is missing and reconfigures the network to repair any broken routes. Peer-to-peer architecture. No hierarchy and no parent-child relationships are needed. Quiet protocol. Routing overhead will be reduced by using a reactive protocol similar to AODV. Route discovery.
  • Page 53 Networking Delivery methods Set DH to 0. Set DL to 0xFFFF. In API operating mode, this sets the destination address to 0x000000000000FFFF. Unicast addressing When devices transmit using DigiMesh unicast, the network uses retries and acknowledgments (ACKs) for reliable data delivery. In a retry and acknowledgment scheme, for every data packet that a device sends, the receiving device must send an acknowledgment back to the transmitting device to let the sender know that the data packet arrived at the receiver.
  • Page 54: Repeater/Directed Broadcast

    Networking Delivery methods If a message has a broadcast address, it is broadcast to all neighbors, then all routers that receive the message rebroadcast the message MT+1 times. Eventually, the message reaches the entire network. 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 55: Encryption

    Networking Encryption Point-to-multipoint transmissions occur between two adjacent nodes within RF range. No route discovery and no routing occur for these types of transmissions. The networking layer is entirely skipped. Point-to-multipoint has an advantage over DigiMesh for two adjacent devices due to less overhead. However, it cannot work over multiple hops.
  • Page 56 Networking DigiMesh throughput Sleeping end devices. Failures and route discoveries. Our empirical testing shows the following throughput performance in a robust operating environment with low interference. Configuration Data throughput 1 hop, encryption disabled 27.0 kb/s 3 hop, encryption disabled 10.9 kb/s 6 hop, encryption disabled 5.78 kb/s 1 hop, encryption enabled...
  • Page 57 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 58: Network Commissioning And Diagnostics

    Network commissioning and diagnostics Local configuration Local configuration You can configure devices locally using serial commands in Transparent or API mode, or remotely using remote API commands. Devices that are in API mode can send configuration commands to set or read the configuration settings of any device in the network. Remote configuration When you do not have access to the device's serial port, you can use a separate device in API mode to remotely configure it.
  • Page 59: Establish And Maintain Network Links

    Network commissioning and diagnostics Establish and maintain network links Establish and maintain network links Build aggregate routes In many applications, many or all of the nodes in the network must transmit data to a central aggregator node. In a new DigiMesh network, the overhead of these nodes discovering routes to the aggregator node can be extensive and taxing on the network.
  • Page 60: Replace Nodes

    Network commissioning and diagnostics Establish and maintain network links 2. All of the nodes internally update only their routing table information to contain a route to the aggregator node. 3. None of the nodes update their DH and DL registers because none of the registers are set to the 0xFFFE address.
  • Page 61 Network commissioning and diagnostics Establish and maintain network links Number of bytes Field name Description Destination The address the device used to test its link. address Payload size The size of the test packet device A sent to test the link. Iterations The number of packets that device A sent.
  • Page 62: Trace Route Option

    Network commissioning and diagnostics Establish and maintain network links frames can be sent by either device A, device B or device C and in all cases the test is the same: device A sends data to device B and reports the results. Trace route option In many networks, it is useful to determine the route that a DigiMesh unicast takes to its destination;...
  • Page 63: Nack Messages

    Network commissioning and diagnostics RSSI indicators NACK messages Transmit Request (0x10 and 0x11) frames contain a negative-acknowledge character (NACK) API option (Bit 2 of the Transmit Options field). If you use this option when transmitting data, when a MAC acknowledgment failure occurs on one of the hops to the destination device, the device generates a Route Information Packet (0x8D) frame and sends it to the originator of the unicast.
  • Page 64: The Commissioning Pushbutton

    Network commissioning and diagnostics The Commissioning Pushbutton the device transmits a broadcast Node Identification Indicator (0x95) frame at the beginning of the next wake cycle if the device is sleep compatible, or immediately if the device is not sleep compatible. If you enable the Associate LED functionality using the D5 command, a device that receives this transmission blinks its Associate pin rapidly for one second.
  • Page 65: Use The Commissioning Pushbutton

    Network commissioning and diagnostics Node discovery Use the Commissioning Pushbutton Use the CB command to simulate button presses in software. Send CB with a parameter set to the number of button presses to perform. For example, if you send ATCB1, the device performs the action (s) associated with a single button press.
  • Page 66: Directed Node Discovery

    Network commissioning and diagnostics Node discovery The device that sends the ND includes its NT setting in the transmission to provide a delay window for all devices in the network. The default NT value is 0x82 (13 seconds). Directed node discovery The directed node discovery command (ND with an NI string parameter) sends out a broadcast to find a node in the network with a matching NI string.
  • Page 67: The Fn (Find Neighbors) Command

    Network commissioning and diagnostics Node discovery You can send FN locally on a device in Command mode or you can use a local AT Command frame - 0x08. To use FN remotely, send the target node a Remote AT Command Request frame - 0x17 using FN as the name of the AT command.
  • Page 68: Sleep Support

    Sleep support Sleep modes Sleep parameters Sleep current Sleep pins Indirect messaging and polling XBee S2C DigiMesh 2.4 User Guide...
  • Page 69: Sleep Modes

    Sleep support Sleep modes Sleep modes Sleep modes enable the device to enter states of low-power consumption when not in use. In order to enter Sleep mode, one of the following conditions must be met (in addition to the device having a non- zero SM parameter value): SLEEP_RQ/DTR (pin 9 on through-hole devices, pin 10 on surface-mount devices) is asserted and the device is in a pin sleep mode (SM = 1, or 5)
  • Page 70: Cyclic Sleep With Pin Wake-Up Mode (Sm = 5)

    Sleep support Sleep parameters Cyclic Sleep with Pin Wake-up mode (SM = 5) Use this mode to wake a sleeping remote device through either the RF interface or by de-asserting SLEEP_RQ for event-driven communications. The cyclic sleep mode works as described previously with the addition of a pin-controlled wake-up at the remote device.
  • Page 71: Indirect Messaging And Polling

    Sleep support Indirect messaging and polling Pin name number Description SLEEP_ TH pin For SM = 1, high puts the device to sleep and low wakes it up. For SM = 5, a 9/SMT high to low transition wakes the device up for ST time. The device ignores a pin 10 low to high transition in SM = 5.
  • Page 72: At Commands

    AT commands Special commands MAC/PHY commands Network commands Addressing commands Diagnostic commands Security commands Serial interfacing commands I/O settings commands I/O line passing commands I/O sampling commands Sleep commands Command mode options Firmware version/information commands XBee S2C DigiMesh 2.4 User Guide...
  • Page 73: Special Commands

    AT commands Special commands Special commands The following commands are special commands. FR (Software Reset) Resets the device. The device responds immediately with an OK and performs a reset 100 ms later. If you issue FR while the device is in Command Mode, the reset effectively exits Command mode. Parameter range Default RE command...
  • Page 74: Mac/Phy Commands

    AT commands MAC/PHY commands MAC/PHY commands The following AT commands are MAC/PHY commands. CH (Operating Channel) Set or read the operating channel devices used to transmit and receive data. The channel is one of two addressing configurations available to the device. The other configuration is the Network ID (ID command).
  • Page 75: Mt (Broadcast Multi-Transmits)

    AT commands MAC/PHY commands MT (Broadcast Multi-Transmits) Set or read the number of additional MAC-level broadcast transmissions. All broadcast packets are transmitted MT+1 times to ensure they are received. Parameter range 0 - 0xF Default PL (TX Power Level) Sets or displays the power level at which the device transmits conducted power. For XBee, PL = 4, PM = 1 is tested at the time of manufacturing.
  • Page 76: Pm (Power Mode)

    AT commands MAC/PHY commands PL setting Channel(s) TX power* (dBm) 12 to 23 12 to 23 12 to 23 12 to 23 12 to 23 * Highest power level is tested during manufacturing. Other power levels are approximate. Default PM (Power Mode) Set or read the power mode of the device.
  • Page 77: Ed (Energy Detect)

    AT commands MAC/PHY commands ED (Energy Detect) Starts an energy detect scan. This command accepts an argument to specify the time in milliseconds to scan all channels. The device loops through all the available channels until the time elapses. It returns the maximal energy on each channel, a comma follows each value, and the list ends with a carriage return.
  • Page 78: Mac Broadcast One Hop Time)

    AT commands MAC/PHY commands %8 (MAC Broadcast One Hop Time) The MAC broadcast one hop time timeout in milliseconds. If you change MAC parameters, it can change this value. The time to send a broadcast between two nodes in the network should not exceed the product of the broadcast one hop time (%8) and the number of hops between those two nodes.
  • Page 79: Bc (Bytes Transmitted)

    AT commands MAC/PHY commands Parameter range 0 - 0xFFFF Default N/A (0 after reset) BC (Bytes Transmitted) The number of RF bytes transmitted. The firmware counts every byte of every packet, including MAC/PHY headers and trailers. You can reset the counter to any 32-bit value by appending a hexadecimal parameter to the command.
  • Page 80: Tr (Transmission Failure Count)

    AT commands Network commands TR (Transmission Failure Count) This count increments whenever a MAC transmission attempt exhausts all MAC retries without ever receiving a MAC acknowledgment message from the destination node. Once the number reaches 0xFFFF, it does not count further events. To reset the counter to any 16-bit value, append a hexadecimal parameter to the command.
  • Page 81: Bh Command

    AT commands Network commands Parameter range 0 - 0xFF Meaning Description b’00 = <invalid option> Delivery method b’01 = Point-multipoint (0x40) b'10 = Directed Broadcast (0x80) b’11 = DigiMesh (0xC0) Reserved <set this bit to 0> Reserved <set this bit to 0> Trace Route Enable a Trace Route on all DigiMesh API packets NACK...
  • Page 82: Nn (Network Delay Slots)

    AT commands Addressing commands Default NN (Network Delay Slots) Set or read the maximum random number of network delay slots before rebroadcasting a network packet. One network delay slot is approximately 13 ms. Parameter range 1 - 0xA network delay slots Default MR (Mesh Unicast Retries) Set or read the maximum number of network packet delivery attempts.
  • Page 83: Sl Command

    AT commands Addressing commands SL command Displays the lower 32 bits of the unique IEEE 64-bit RF extended address assigned to the product family in the factory. The 64-bit source address is always enabled. This value is read-only and it never changes. Parameter range 0 - 0xFFFFFFFF [read-only] Default...
  • Page 84: Diagnostic Commands

    AT commands Diagnostic commands Parameter range 0 - 0xFFFF Default 0x11 (Transparent data cluster ID) Diagnostic commands The following AT commands are diagnostic commands. Diagnostic commands are typically volatile and will not persist across a power cycle. AG (Aggregator Support) 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...
  • Page 85: Nd (Network Discover)

    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 settings.) RSSI OF LAST HOP<CR> (1 Byte. Optionally included based on NO settings.) <CR> If you send the FN command in Command mode, after (NT*100) ms + overhead time, the command ends by returning a carriage return, represented by <CR>.
  • Page 86: Fn (Find Neighbors)

    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 settings.) RSSI OF LAST HOP<CR> (1 Byte. Optionally included based on NO settings.) <CR> If you send the FN command in Command mode, after (NT*100) ms + overhead time, the command ends by returning a carriage return, represented by <CR>.
  • Page 87: Nt (Network Discovery Back-Off)

    AT commands Diagnostic commands XCTU prevents you from exceeding the string limit of 20 characters for this command. If you are using another software application to send the string, you can enter longer strings, but the software on the device returns an error. Use the ND (Network Discovery) command with this string as an argument to easily identify devices on the network.
  • Page 88: Security Commands

    AT commands Security commands 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 Append the RSSI of the last hop to ND, FN, and responses or API node identification 0x04 frames.
  • Page 89: Serial Interfacing Commands

    AT commands Serial interfacing commands Serial interfacing commands The following AT commands are serial interfacing commands. BD (Baud Rate) To request non-standard baud rates with values above 0x80, you can use the Serial Console toolbar in XCTU to configure the serial connection (if the console is connected), or click the Connect button (if the console is not yet connected).
  • Page 90: Ro Command

    AT commands Serial interfacing commands Parameter Description 0x01 Even parity 0x02 Odd parity Mark parity (forced high) 0x03 Default 0x00 RO command Set or read the number of character times of inter-character silence required before transmission begins when operating in Transparent mode. Set RO to 0 to transmit characters as they arrive instead of buffering them into one RF packet.
  • Page 91: Ao Command

    AT commands I/O settings commands Parameter Description API enabled API enabled (with escaped control characters) Default AO command The API data frame output format for RF packets received. Use AO to enable different API output frames. Parameter range 0 - 2 Parameter Description API Rx Indicator - 0x90, this is for standard data frames.
  • Page 92: D1 (Dio1/Ad1)

    AT commands I/O settings commands Parameter Description Disabled Commissioning Pushbutton Digital input Digital output, low Digital output, high Default D1 (DIO1/AD1) Sets or displays the DIO1/AD1 configuration (TH pin 19/SMT pin 32). Parameter range 0 - 5 Parameter Description Disabled SPI_ATTN for the through-hole device N/A for the surface-mount device Digital input...
  • Page 93: D3 (Dio3/Ad3)

    AT commands I/O settings commands Parameter Description SPI_CLK for through-hole devices N/A for surface-mount devices Digital input Digital output, low Digital output, high Default D3 (DIO3/AD3) Sets or displays the DIO3/AD3 configuration (TH pin 17/SMT pin 30). Parameter range 0 - 5 Parameter Description Disabled...
  • Page 94: D5 (Dio5/Associated_Indicator)

    AT commands I/O settings commands Parameter Description SPI_MOSI for the through-hole device N/A for the surface-mount device DI04 Digital input Digital output, low Digital output, high Default D5 (DIO5/ASSOCIATED_INDICATOR) Sets or displays the DIO5/ASSOCIATED_INDICATOR configuration (TH pin 15/SMT pin 28). Parameter range 0 - 5 Parameter...
  • Page 95: D7 (Dio7/Cts)

    AT commands I/O settings commands Parameter Description Digital input Digital output, low Digital output, high Default D7 (DIO7/CTS) Sets or displays the DIO7/CTS configuration (TH pin 12/SMT pin 25). Parameter range 0, 1, 3 - 7 Parameter Description Disabled CTS flow control Digital input Digital output, low Digital output, high...
  • Page 96: D9 (On_Sleep)

    AT commands I/O settings commands Parameter Description Digital input Digital output, low Digital output, high Default D9 (ON_SLEEP) Sets or displays the ON/SLEEP configuration (TH pin 13/SMT pin 26). Parameter range 0, 1, 3 - 5 Parameter Description Disabled ON/SLEEP output Digital input Digital output, low Digital output, high...
  • Page 97: P1 (Dio11/Pwm1 Configuration)

    AT commands I/O settings commands Parameter Description Digital input Digital output, low Digital output, high Default P1 (DIO11/PWM1 Configuration) Sets or displays the DIO11/PWM1 configuration (TH pin 7/SMT pin 8). Parameter range 0 - 5 Parameter Description Disabled PWM1 output. Value is controlled by M1 parameter or by I/O line passing Digital input Digital output, low Digital output, high...
  • Page 98: P5 (Spi_Miso)

    AT commands I/O settings commands Parameter Description Digital output, low Digital output, high Default P5 (SPI_MISO) Sets or displays the SPI_MISO configuration (TH pin 4/SMT pin 17). This only applies to surface-mount devices. Parameter range 0, 1 Parameter Description Disabled SPI_MISO Default P6 (SPI_MOSI Configuration)
  • Page 99: Pd (Pull Up/Down Direction)

    AT commands I/O settings commands Parameter Description Disabled SPI_SSEL Default P8 (SPI_SCLK )P8 (SPI_SCLK ) Sets or displays the SPI_SCLK configuration (TH pin 18/SMT pin 14). This only applies to surface-mount devices. Parameter range 1, 2 Parameter Description Disabled SPI_SCLK Default P9 (SPI_ATTN) Sets or displays the SPI_ATTN configuration (pin 12).
  • Page 100: Pr (Pull-Up/Down Resistor Enable)

    AT commands I/O settings commands Parameter range 0x0 - 0x7FFF Default 0x1FFF PR (Pull-up/Down Resistor Enable) PR and PD only affect lines that are configured as digital inputs or disabled. The following table defines the bit-field map for PR and PD commands. The bit field that configures the internal pull-up/down resistor status for the I/O lines.
  • Page 101: M1 (Pwm1 Duty Cycle)

    AT commands I/O settings commands If the IA (I/O Input Address) parameter is correctly set and P0 is configured as PWM0 output, incoming AD0 samples automatically modify the PWM0 value. PT (PWM Output Timeout). To configure the duty cycle of PWM0: 1.
  • Page 102: Rp Command

    AT commands I/O line passing commands RP command The PWM timer expiration in 0.1 seconds. RP sets the duration of pulse width modulation (PWM) signal output on the RSSI pin. The signal duty cycle updates with each received packet and shuts off when the timer expires.
  • Page 103: T0 (D0 Timeout)

    AT commands I/O line passing commands Default T0 (D0 Timeout) Specifies how long pin D0 holds a given value (due to I/O line passing) before it reverts to configured value. If set to 0, there is no timeout. Parameter range 0 - 0x1770 (x 100 ms) Default T1 (D1 Output Timeout)
  • Page 104: T5 (D5 Output Timeout)

    AT commands I/O line passing commands Parameter range 0 - 0x1770 (x 100 ms) Default T5 (D5 Output Timeout) Specifies how long pin D5 holds a given value (due to I/O line passing) before it reverts to configured value. If set to 0, there is no timeout. Parameter range 0 - 0x1770 (x 100 ms) Default...
  • Page 105: T9 (D9 Timeout)

    AT commands I/O line passing commands T9 (D9 Timeout) Specifies how long pin D9 holds a given value (due to I/O line passing) before it reverts to configured value. If set to 0, there is no timeout. Parameter range 0 - 0x1770 (x 100 ms) Default Q0 (P0 Timeout) Specifies how long pin P0 holds a given value (due to I/O line passing) before it reverts to configured...
  • Page 106: I/O Sampling Commands

    AT commands I/O sampling commands Parameter range 0 - 0x1770 (x 100 ms) Default 0xFF I/O sampling commands The following AT commands configure I/O sampling parameters. IC (DIO Change Detect) Set or read the digital I/O pins to monitor for changes in the I/O state. IC works with the individual pin configuration commands (D0 - D9, P0 - P2).
  • Page 107: If (Sleep Sample Rate)

    AT commands Sleep commands IF (Sleep Sample Rate) 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. During those cycles, the firmware takes I/O samples at the rate specified by IR.
  • Page 108: Sm Command

    AT commands Sleep commands SM command Sets or displays the sleep mode of the device. Normal mode is always awake. Pin sleep modes allow you to wake the device with the SLEEP_ REQUEST line. Asynchronous cyclic mode sleeps for SP time and briefly wakes, checking for activity. The device does not support synchronous sleep.
  • Page 109: Sp (Sleep Time)

    AT commands Sleep commands Default Example Set to 1 to set ON_SLEEP high after each SP time (default). If SN = 3, the ON_SLEEP line asserts only every third wakeup; SN = 9, every ninth wakeup; and so forth. SP (Sleep Time) Sets or displays the device's sleep time.
  • Page 110: Command Mode Options

    AT commands Command mode options Command mode options The following commands are Command mode option commands. CC (Command Character) The character value the device uses to enter Command mode. The default value (0x2B) is the ASCII code for the plus (+) character. You must enter it three times within the guard time to enter Command mode.
  • Page 111: Firmware Version/Information Commands

    0 - 0xFFFF [read-only] Default Set in firmware DD command Stores the Digi device type identifier value. Use this value to differentiate between multiple XBee devices. If you change DD, RE command will not restore defaults. The only way to get DD back to default values is to explicitly set it to defaults.
  • Page 112: Ck (Configuration Crc)

    AT commands Firmware version/information commands The XBee/XBee-PRO S2C DigiMesh 2.4 RF Module firmware returns a fixed number of bytes: 0x49 = 73 bytes. Parameter range 0 - 0xFFFF (bytes) [read-only] Default CK (Configuration CRC) Displays the cyclic redundancy check (CRC) of the current AT command configuration settings. This command allows you to detect an unexpected configuration change on a device.
  • Page 113: Operate In Api Mode

    Operate in API mode API mode overview Frame descriptions XBee S2C DigiMesh 2.4 User Guide...
  • Page 114: Api Mode Overview

    Operate in API mode API mode overview API mode overview As an alternative to Transparent operating mode, you can use API operating mode. API mode provides a structured interface where data is communicated through the serial interface in organized packets and in a determined order.
  • Page 115 Operate in API mode API mode overview http://knowledge.digi.com/articles/Knowledge_Base_Article/Escaped-Characters-and-API-Mode-2 The following table shows the structure of an API frame with escaped characters: Frame fields Byte Description Start delimiter 1 0x7E Length 2 - 3 Most Significant Byte, Least Significant Byte Characters escaped if needed...
  • Page 116: Calculate And Verify Checksums

    Operate in API mode API mode overview Frame type is the API frame type identifier. It determines the type of API frame and indicates how the Data field organizes the information. Data contains the data itself. This information and its order depend on the what type of frame that the Frame type field defines.
  • Page 117: Escaped Characters In Api Frames

    Operate in API mode API mode overview Now take the result of 0x247 and keep only the lowest 8 bits which in this example is 0xC4 (the two far right digits). Subtract 0x47 from 0xFF and you get 0x3B (0xFF - 0xC4 = 0x3B). 0x3B is the checksum for this data packet.
  • Page 118: Frame Descriptions

    Operate in API mode Frame descriptions Frame descriptions The following sections describe the API frames. 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 119 Operate in API mode Frame descriptions Use the AP command to choose the type of data frame you want to receive, either a (0x90) Receive Packet or a (0x91) Explicit Rx Indicator frame. 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 120: At Command Frame - 0X08

    Operate in API mode Frame descriptions AT Command frame - 0x08 Description Use this frame to query or set device parameters on the local device. This API command applies changes after running the command. You can query parameter values by sending the 0x08 AT Command frame with no parameter value field (the two-byte AT command is immediately followed by the frame checksum).
  • Page 121: At Command - Queue Parameter Value Frame - 0X09

    Operate in API mode Frame descriptions AT Command - Queue Parameter Value frame - 0x09 Description This frame allows you to query or set device parameters. In contrast to the AT Command (0x08) frame, this frame queues new parameter values and does not apply them until you issue either: The AT Command (0x08) frame (for API type) The AC command When querying parameter values, the 0x09 frame behaves identically to the 0x08 frame.
  • Page 122 Operate in API mode Frame descriptions Frame data fields Offset Example AT command 0x42 (B) 0x44 (D) Parameter value (BD7 = 115200 baud) 0x07 Checksum 0x68 XBee S2C DigiMesh 2.4 User Guide...
  • Page 123: Transmit Request Frame - 0X10

    Operate in API mode Frame descriptions Transmit Request frame - 0x10 Description This frame causes the device to send payload data as an RF packet to a specific destination. For broadcast transmissions, set the 64-bit destination address to 0x000000000000FFFF . For unicast transmissions, set the 64 bit address field to the address of the desired destination node.
  • Page 124 Operate in API mode Frame descriptions Meaning Description NACK Enable unicast NACK messages on all DigiMesh API packets Trace route Enable a unicast Trace Route on all DigiMesh API packets Reserved <set this bit to 0> Reserved <set this bit to 0> b’00 = <invalid option>...
  • Page 125 Operate in API mode Frame descriptions Frame data fields Offset Example RF data 0x54 0x78 0x44 0x61 0x74 0x61 0x30 0x41 Checksum 0x13 If you enable escaping (AP = 2), the frame should look like: 0x7E 0x00 0x16 0x10 0x01 0x00 0x7D 0x33 0xA2 0x00 0x40 0x0A 0x01 0x27 0xFF 0xFE 0x00 0x00 0x54 0x78 0x44 0x61 0x74 0x61 0x30 0x41 0x7D 0x33 The device calculates the checksum (on all non-escaped bytes) as [0xFF - (sum of all bytes from API frame type through data payload)].
  • Page 126: Explicit Addressing Command Frame - 0X11

    Operate in API mode Frame descriptions Explicit Addressing Command frame - 0x11 Description This frame is similar to Transmit Request (0x10), but it also requires you to specify the application- layer addressing fields: endpoints, cluster ID, and profile ID. This frame causes the device to send payload data as an RF packet to a specific destination, using specific source and destination endpoints, cluster ID, and profile ID.These fields ignore the ones specified by DE,SE and CI.
  • Page 127 Operate in API mode Frame descriptions Frame data fields Offset Description See the Transmit Options table below. Set all other bits to 0. Transmission Options Data Payload 23-n Data that is sent to the destination device. Transmit Options bit field Bit field: Meaning Description...
  • Page 128 Operate in API mode Frame descriptions Frame data fields Offset Example Frame ID 0x01 64-bit destination address MSB 5 0x00 0x13 0xA2 0x00 0x01 0x23 0x84 LSB12 0x00 Reserved 0xFF 0xFE Source endpoint 0xE8 Destination endpoint 0xE8 Cluster ID 0x00 0x11 Profile ID 0xC1...
  • Page 129: Remote At Command Request Frame - 0X17

    Operate in API mode Frame descriptions Remote AT Command Request frame - 0x17 Description Used to query or set device 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 130 Operate in API mode Frame descriptions Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x10 0x17 Frame type Frame ID 0x01 64-bit destination address MSB 5 0x00 0x13 0xA2 0x00 0x40 0x40 0x11 LSB 12 0x22 Reserved 0xFF...
  • Page 131: At Command Response Frame - 0X88

    Operate in API mode Frame descriptions AT Command Response frame - 0x88 Description A device sends this frame in response to an AT Command (0x08 or 0x09) frame. Some commands send back multiple frames; for example, the ND command. Format Frame data fields Offset Description...
  • Page 132 Operate in API mode Frame descriptions Frame data fields Offset Example Command data (No command data implies the parameter was set rather than queried) Checksum 0xF0 XBee S2C DigiMesh 2.4 User Guide...
  • Page 133: Modem Status Frame - 0X8A

    Operate in API mode Frame descriptions Modem Status frame - 0x8A Description Devices send the status messages in this frame in response to specific conditions. Format The following table provides the contents of the frame. For details on frame structure, see API frame specifications.
  • Page 134: Transmit Status Frame - 0X8B

    Operate in API mode Frame descriptions Transmit Status frame - 0x8B Description When a Transmit Request (0x10, 0x11) completes, the device sends a Transmit Status message out of the serial interface. This message indicates if the Transmit Request was successful or if it failed. Note Broadcast transmissions are not acknowledged and always return a status of 0x00, even if the delivery failed.
  • Page 135 Operate in API mode Frame descriptions Frame Fields Offset Example Length MSB 1 0x00 LSB 2 0x07 Frame type 0x8B Frame ID 0x47 Reserved 0xFF 0xFE Transmit retry count 0x00 Delivery status 0x00 Discovery status 0x02 Checksum 0x2E XBee S2C DigiMesh 2.4 User Guide...
  • Page 136: Route Information Packet Frame - 0X8D

    Operate in API mode Frame descriptions Route Information Packet frame - 0x8D Description If you enable NACK or the Trace Route option on a DigiMesh unicast transmission, a device can output this frame for the transmission. Format The following table provides the contents of the frame. For details on frame structure, see API frame specifications.
  • Page 137 Operate in API mode Frame descriptions Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x2A Frame type 0x8D Source event 0x12 Length 0x27 Timestamp MSB 6 0x9C 0x93 0x81 LSB 9 0x7F ACK timeout count 0x00 TX blocked count 0x00...
  • Page 138 Operate in API mode Frame descriptions Frame data fields Offset Example Responder address MSB 29 0x00 0x13 0xA2 0x00 0x40 0x52 0xBB LSB 36 0xBB Receiver address MSB 37 0x00 0x13 0xA2 0x00 0x40 0x52 0xCC LSB 44 0xCC Checksum 0xD2 XBee S2C DigiMesh 2.4 User Guide...
  • Page 139: Aggregate Addressing Update Frame - 0X8E

    Operate in API mode Frame descriptions Aggregate Addressing Update frame - 0x8E Description The device sends out an Aggregate Addressing Update frame on the serial interface of an API-enabled node when an address update frame (generated by the AG command being issued on a node in the network) causes the node to update its DH and DL registers.
  • Page 140 Operate in API mode Frame descriptions Frame data fields Offset Example New address MSB 5 0x00 0x13 0xA2 0x00 0x40 0x52 0xBB LSB 12 0xBB Old address 0x00 0x13 0xA2 0x00 0x40 0x52 0xAA 0xAA Checksum 0x19 XBee S2C DigiMesh 2.4 User Guide...
  • Page 141: Receive Packet Frame - 0X90

    Operate in API mode Frame descriptions Receive Packet frame - 0x90 Description When a device configured with a standard API Rx Indicator (AO = 0) receives an RF data packet, it sends it out the serial interface using this message type. Format The following table provides the contents of the frame.
  • Page 142 Operate in API mode Frame descriptions Frame data fields Offset Example MSB 4 0x00 64-bit source address 0x13 0xA2 0x00 0x40 0x52 0x2B LSB 11 0xAA Reserved 0xFF 0xFE Receive options 0x01 Received data 0x52 0x78 0x44 0x61 0x74 0x61 Checksum 0x11 XBee S2C DigiMesh 2.4 User Guide...
  • Page 143: Explicit Rx Indicator Frame - 0X91

    Operate in API mode Frame descriptions Explicit Rx Indicator frame - 0x91 Description When a device configured with explicit API Rx Indicator (AO = 1) receives an RF packet, it sends it out the serial interface using this message type. Note If a Transmit Request frame - 0x10...
  • Page 144 Operate in API mode Frame descriptions If AO = 1 on the receiving device, it sends the following frame out its serial interface. Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x18 Frame type 0x91 64-bit source address MSB 4...
  • Page 145: I/O Data Sample Rx Indicator Frame - 0X92

    Operate in API mode Frame descriptions I/O Data Sample Rx Indicator frame - 0x92 Description When you enable periodic I/O sampling or digital I/O change detection on a remote device, the UART of the device that receives the sample data sends this frame out. Format The following table provides the contents of the frame.
  • Page 146 Operate in API mode Frame descriptions Frame fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x14 64-bit source address MSB 4 0x00 0x13 0xA2 0x00 0x40 0x52 0x2B LSB 11 0xAA Reserved MSB 12 0xFF LSB 13 0xFE Receive options 0x01...
  • Page 147: Node Identification Indicator Frame - 0X95

    Operate in API mode Frame descriptions Node Identification Indicator frame - 0x95 Description A device receives this frame when: it transmits a node identification message to identify itself AO = 0 The data portion of this frame is similar to a network discovery response. For more information, see ND (Network Discover).
  • Page 148 Offset Description Source event 1=Frame sent by node identification pushbutton event - See (DIO0/AD0). Digi Profile ID 31-32 Set to the Digi application profile ID. Digi 33-34 Set to the Digi Manufacturer ID. Manufacturer Digi DD value Reports the DD value of the responding device. Use the NO command to...
  • Page 149 0xFE 64-bit remote address MSB 17 0x00 0x13 0xA2 0x00 0x40 0x74 0x02 0xAC LSB 24 NI string 0x20 0x00 Reserved 0xFF 0xFE Device type 0x01 Source event 0x01 Digi Profile ID 0xC1 0x05 XBee S2C DigiMesh 2.4 User Guide...
  • Page 150 Operate in API mode Frame descriptions Frame data fields Offset Example Digi Manufacturer ID 0x10 0x1E Digi DD value 0x00 (optional) 0x0C 0x00 0x00 RSSI (optional) 0x2E Checksum 0x33 XBee S2C DigiMesh 2.4 User Guide...
  • Page 151: Remote Command Response Frame - 0X97

    Operate in API mode Frame descriptions Remote Command Response frame - 0x97 Description If a device receives this frame in response to a Remote Command Request (0x17) frame, the device sends an AT Command Response (0x97) frame out the serial interface. Some commands, such as the ND command, may send back multiple frames.
  • Page 152 Operate in API mode Frame descriptions Frame data fields Offset Example 64-bit source (remote) address MSB 5 0x00 0x13 0xA2 0x00 0x40 0x52 0x2B LSB 12 0xAA Reserved 0xFF 0xFE 16-bit source (remote) address MSB 13 0x7D LSB 14 0x84 AT commands 0x53 (S) 0x4C (L)
  • Page 153: Over-The-Air Firmware Update Status - 0Xa0

    Operate in API mode Frame descriptions Over-the-Air Firmware Update Status - 0xA0 Description The Over-the-Air Firmware Update Status frame provides an indication of the status of a firmware update transmission attempt. A query command (0x01 0x51) sent to a target with a 64-bit address of 0x0013A200 40522BAA through an updater with 64-bit address 0x0013A200403E0750 and 16-bit address 0x0000, generates the following expected response.
  • Page 154 Operate in API mode Frame descriptions Frame data fields Offset Example Frame type 0xA0 64-bit source (remote) address MSB 4 0x00 0x13 0xA2 0x00 0x40 0x3E 0x07 0x50 16-bit destination address 0x00 0x00 Receive options 0x01 Bootloader message type 0x52 Block number 0x00 64-bit target address...
  • Page 155: Regulatory Information

    Regulatory information United States (FCC) Europe (CE) Canada (IC) Australia (RCM) South Korea ANATEL (Brazil) XBee S2C DigiMesh 2.4 User Guide...
  • Page 156: United States (Fcc)

    (as per FCC section 2.1091). Modifications not expressly approved by Digi could void the user's authority to operate the equipment. IMPORTANT: OEMs must test final product to comply with unintentional radiators (FCC section 15.107 &...
  • Page 157 Regulatory information United States (FCC) against harmful interference in a residential installation. This equipment generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communications. However, there is no guarantee that interference will not occur in a particular installation.
  • Page 158: Fcc-Approved Antennas (2.4 Ghz)

    Digi does not carry all of these antenna variants. Contact Digi Sales for available antennas. All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option. XBee S2C SMT RF module The following table shows the antennas approved for use with the XBee S2C SMT RF module.
  • Page 159 Required antenna cable loss (dB) Type Gain Min. Channels Channel Channel (description) Part number (dBi) Application* separation 11-24 A24-HASM- Dipole (Half-wave articulated RPSMA - 5.25") Fixed 25 cm Omni-directional antennas A24-F2NF Omni-directional (Fiberglass base station) Fixed/Mobile 25 cm A24-F3NF Omni-directional (Fiberglass base station) Fixed/Mobile 25 cm A24-F5NF...
  • Page 160 Required antenna cable loss (dB) Type Gain Min. Channels Channel Channel (description) Part number (dBi) Application* separation 11-24 A24-P19NF Flat Panel 19.0 Fixed 16.6 Yagi antennas A24-Y6NF Yagi (6-element) Fixed A24-Y7NF Yagi (7-element) Fixed A24-Y9NF Yagi (9-element) 10.0 Fixed A24-Y10NF Yagi (10-element) 11.0 Fixed A24-Y12NF...
  • Page 161 XBee S2C TH RF Module The following table shows the antennas approved for use with the XBee S2C TH RF Module. Required antenna cable loss (dB) Part Gain Min. Channels Channel Channel number Type (description) (dBi) Application* separation 11-24 Integral antennas 29000294 Integral PCB antenna -0.5...
  • Page 162 Required antenna cable loss (dB) Part Gain Min. Channels Channel Channel number Type (description) (dBi) Application* separation 11-24 A24-F9NF Omni-directional (Fiberglass base station) Fixed A24-F10NF Omni-directional (Fiberglass base station) 10.0 Fixed A24-F12NF Omni-directional (Fiberglass base station) 12.0 Fixed A24-W7NF Omni-directional (Fiberglass base station) Fixed A24-M7NF Omni-directional (Mag-mount base station)
  • Page 163 Required antenna cable loss (dB) Part Gain Min. Channels Channel Channel number Type (description) (dBi) Application* separation 11-24 A24-Y12NF Yagi (12-element) 12.0 Fixed A24-Y13NF Yagi (13-element) 12.0 Fixed A24-Y15NF Yagi (15-element) 12.5 Fixed A24-Y16NF Yagi (16-element) 13.5 Fixed A24-Y16RM Yagi (16-element, RPSMA connector) 13.5 Fixed A24-Y18NF...
  • Page 164 XBee-PRO S2C SMT RF Module The following table shows the antennas approved for use with the XBee-PRO S2C SMT RF Module. Required antenna cable loss (dB) Gain Channels 11- (dBi) Part Number Type (Description) Application* Separation 23† Channel 24† Internal antennas 29000313 Integral PCB antenna Fixed/Mobile...
  • Page 165 Required antenna cable loss (dB) Gain Channels 11- (dBi) Part Number Type (Description) Application* Separation 23† Channel 24† A24-F9NF Omni-directional (Fiberglass base station) Fixed A24-F10NF Omni-directional (Fiberglass base station) Fixed A24-F12NF Omni-directional (Fiberglass base station) Fixed A24-W7NF Omni-directional (Fiberglass base station) Fixed A24-M7NF Omni-directional (Mag-mount base station)
  • Page 166 Required antenna cable loss (dB) Gain Channels 11- (dBi) Part Number Type (Description) Application* Separation 23† Channel 24† A24-Y12NF Yagi (12-element) 12.0 Fixed A24-Y13NF Yagi (13-element) 12.0 Fixed A24-Y15NF Yagi (15-element) 12.5 Fixed A24-Y16NF Yagi (16-element) 13.5 Fixed A24-Y16RM Yagi (16-element, RPSMA connector) 13.5 Fixed A24-Y18NF...
  • Page 167 XBee-PRO S2C TH RF Module The following table shows the antennas approved for use with the XBee-PRO S2C TH RF Module. Required antenna cable loss (dB) Gain Min. Channels 11- Part number Type (description) (dBi) Application* separation 23† Channel 24† Integral antennas 29000294 Integral PCB antenna...
  • Page 168 Required antenna cable loss (dB) Gain Min. Channels 11- Part number Type (description) (dBi) Application* separation 23† Channel 24† A24-F9NF Omni-directional (Fiberglass base station) Fixed A24-F10NF Omni-directional (Fiberglass base station) 10.0 Fixed A24-F12NF Omni-directional (Fiberglass base station) 12.0 Fixed A24-W7NF Omni-directional (base station) Fixed A24-M7NF...
  • Page 169 Required antenna cable loss (dB) Gain Min. Channels 11- Part number Type (description) (dBi) Application* separation 23† Channel 24† A24-Y12NF Yagi (12-element) 12.0 Fixed A24-Y13NF Yagi (13-element) 12.0 Fixed A24-Y15NF Yagi (15-element) 12.5 Fixed A24-Y16NF Yagi (16-element) 13.5 Fixed A24-Y16RM Yagi (16-element, RPSMA connector) 13.5 Fixed...
  • Page 170: Rf Exposure

    Europe (CE) The XBee/XBee-PRO S2C DigiMesh 2.4 RF Modules (non-PRO variants) have been tested for use in several European countries. For a complete list, refer to www.digi.com/resources/certifications. If XBee/XBee-PRO S2C DigiMesh 2.4 RF Modules are incorporated into a product, the manufacturer must ensure compliance of the final product with articles 3.1a and 3.1b of the Radio Equipment...
  • Page 171: Listen Before Talk Requirement

    CA (CCA Threshold) to enable LBT at the required noise threshold level. Declarations of conformity Digi has issued Declarations of Conformity for the XBee RF Modules concerning emissions, EMC, and safety. For more information, see www.digi.com/resources/certifications. XBee S2C DigiMesh 2.4 User Guide...
  • Page 172: Antennas

    The following antennas have been tested and approved for use with the XBee/XBee-PRO S2C DigiMesh 2.4 RF Module: All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option.
  • Page 173: Transmitters For Detachable Antennas

    Have a company/distributor/agent in Australia or New Zealand that will sponsor the importing of the end product. Contact Digi for questions related to locating a contact in Australia and New Zealand. South Korea The low-power XBee S2C TH and XBee S2C devices have received South Korean approvals. To show conformity to the certificate, you must add a label with the South Korean product information to the XBee S2C DigiMesh RF Module.
  • Page 174 The text shown in the label is: : XBee S2C TH : MSIP-CRM-DIG-XBee-S2C-TH : DIGI INTERNATIONAL, INC. : DIGI INTERNATIONAL, INC. / If the label size does not accommodate the required content, you can use abbreviated information, as follows: XBee S2C DigiMesh 2.4 User Guide...
  • Page 175 Regulatory information South Korea The KCC logo must be at least 5 mm tall. The text shown on the label is: : MSIP-CRM-DIG-XBee-S2C-TH For the surface-mount version, the label will overlay the existing product label. CAUTION! By placing a label over the existing label, the certifications for Europe (CE), Australia, New Zealand (RCM), and Japan will no longer apply.
  • Page 176 The text shown in the label is: : XBee S2C : MSIP-CRM-DIG-XBee-S2C : DIGI INTERNATIONAL, INC. : DIGI INTERNATIONAL, INC. / If the label size does not accommodate the required content, you can use the abbreviated information, as follows: XBee S2C DigiMesh 2.4 User Guide...
  • Page 177: Anatel (Brazil)

    (in Portuguese): Digi Model: XBP24CZ7PIS-004, XBP24CZ7RIS-004, XBP24CZ7UIS-004, XBP24CAPIS-001, XBP24CARIS- 001, XBP24CAUIS-001, XBP24CDMPIS-001, XBP24CDMRIS-001, XBP24CDMUIS-001 XBee S2C DigiMesh 2.4 User Guide...
  • Page 178 Regulatory information ANATEL (Brazil) XBee S2C DigiMesh 2.4 User Guide...
  • Page 179: Load Digimesh 2.4 Firmware On Zb Devices

    Load DigiMesh 2.4 firmware on ZB devices Background Load firmware XBee S2C DigiMesh 2.4 User Guide...
  • Page 180: Background

    1. Verify that your device's part number (listed on the label) is included in the list shown in Background. 2. Install the device in a Digi development board and connect it to your PC. 3. The next steps involve loading firmware using XCTU. To download XCTU and read detailed instructions about it, go to: https://www.digi.com/products/xbee-rf-solutions/xctu-software/xctu...
  • Page 181 Load DigiMesh 2.4 firmware on ZB devices Load firmware 4. When you get to the Update firmware dialog box, in the Function set area, click the DigiMesh 2.4 option, and the newest firmware version. 5. Click Update and follow the instructions. 6.
  • Page 182: Migrate From Xbee Through-Hole To Surface-Mount Devices

    Migrate from XBee through-hole to surface-mount devices We design the XBee surface-mount and through-hole devices to be compatible with each other and offer the same basic feature set. The surface-mount form factor has more I/O pins. Because the XBee device was originally offered in only the through-hole form factor, we offer this section to help you migrate from the through-hole to the surface-mount form factor.
  • Page 183 Migrate from XBee through-hole to surface-mount devices Pin mapping Pin mapping The following table shows the pin mapping for the surface-mount (SMT) pins to the through-hole (TH) pins. The pin names are from the XBee S2C SMT device. SMT Pin # Name TH Pin # DOUT...
  • Page 184 Migrate from XBee through-hole to surface-mount devices Mount the devices SMT Pin # Name TH Pin # DIO5/ASSOC DIO6/RTS DIO3/AD3 DIO2/AD2 DIO1/AD1 DIO0/AD0 [Reserved] [Reserved] Mount the devices One important difference between the SMT and TH devices is the way they mount to a printed circuit board (PCB).
  • Page 185 Migrate from XBee through-hole to surface-mount devices Mount the devices The round holes in the diagram are for the TH design, and the semi-oval pads are for the SMT design. Pin 1 of the TH design is lined up with pad 1 of the SMT design, but the pins are actually offset by one pad;...
  • Page 186 PCB design and manufacturing The XBee/XBee-PRO S2C DigiMesh 2.4 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. Recommended solder reflow cycle Recommended footprint and keepout Flux and cleaning...
  • Page 187: Recommended Solder Reflow Cycle

    PCB design and manufacturing Recommended solder reflow cycle Recommended solder reflow cycle The following table provides the recommended solder reflow cycle. The table shows the temperature setting and the time to reach the temperature; it does not show the cooling cycle. Time (seconds) Temperature (degrees C) The maximum temperature should not exceed 260 °C.
  • Page 188 PCB design and manufacturing Recommended footprint and keepout Match the solder footprint to the copper pads, but you may need to adjust it depending on the specific needs of assembly and product standards. We recommend a stencil thickness of 0.15 mm (0.005 in). Place the component last and set the placement speed to the slowest setting.
  • Page 189: Flux And Cleaning

    PCB design and manufacturing Flux and cleaning Flux and cleaning We recommend that you use a “no clean” solder paste in assembling these devices. This eliminates the clean step and ensures that you do not leave unwanted residual flux under the device where it is difficult to remove.
  • Page 190 PCB design and manufacturing Rework Rework should never be performed on the module itself. The module has been optimized to give the best possible performance, and reworking the module itself will void warranty coverage and certifications. We recognize that some customers will choose to rework and void the warranty; the following information is given as a guideline in such cases to increase the chances of success during rework, though the warranty is still voided.

Table of Contents