Digi XBee SX 868 User Manual
  1. Manuals
  2. Brands
  3. Digi Manuals
  4. Control Unit
  5. XBee SX 868
  6. User manual

Digi XBee SX 868 User Manual

Radio frequency (rf) module
Hide thumbs Also See for XBee SX 868:
Table of Contents

Advertisement

Quick Links

XBee® SX 868
Radio Frequency (RF) Module
User Guide

Advertisement

Table of Contents
loading

Related Manuals for Digi XBee SX 868

Summary of Contents for Digi XBee SX 868

  • Page 1 XBee® SX 868 Radio Frequency (RF) Module 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® SX 868 RF Module User Guide Applicable firmware and hardware Technical specifications Regulatory conformity summary Power requirements Networking and security specifications Performance specifications General specifications GPIO specifications LBT and AFA specifications Get started Verify kit contents Connect the hardware Configure the device using XCTU Configure the devices for a range test Configure remote devices...
  • Page 4 Data format SPI parameters Serial buffers Serial receive buffer Serial transmit buffer UART flow control CTS flow control RTS flow control Serial interface protocols Transparent operating mode API operating mode Advanced application features Remote configuration commands Send a remote command Apply changes on remote devices Remote command responses Network commissioning and diagnostics...
  • Page 5 Broadcast addressing Routing Route discovery DigiMesh throughput Transmission timeouts Modes Transmit mode Receive mode Command mode Enter Command mode Send AT commands Apply command changes Exit Command mode Sleep mode Force UART operation Condition Solution Sleep modes About sleep modes Asynchronous modes Synchronous modes Normal mode...
  • Page 6 MAC/PHY commands CM (Channel Mask) HP (Preamble ID) ID (Network ID) MT (Broadcast Multi-Transmits) BR (RF Data Rate) PL (TX Power Level) RR (Unicast Mac Retries) ED (Energy Detect) LB (LNA Bypass) Diagnostic commands BC (Bytes Transmitted) DB (Last Packet RSSI) ER (Received Error Count) GD (Good Packets Received) EA (MAC ACK Timeouts)
  • Page 7 AO command I/O settings commands CB command D0 (DIO0/AD0) D1 (DIO1/AD1) D2 (DIO2/AD2) D3 (DIO3/AD3) D4 (DIO4) D5 (DIO5/ASSOCIATED_INDICATOR) D6 (DIO6/RTS) D7 (DIO7/CTS) D8 (DIO8/DTR/SLEEP_REQUEST) D9 (DIO9/ON_SLEEP) P0 (DIO10/RSSI/PWM0 Configuration) P1 (DIO11/PWM1 Configuration) P2 (DIO12 Configuration) P3 (DOUT) P4 (DIN/CONFIG) P5 (DIO15/SPI_MISO Configuration) P6 (SPI_MOSI Configuration) P7 (DIO17/SPI_SSEL )
  • Page 8 PT (PWM Output Timeout) Sleep commands SM command SO command SN command SP (Sleep Period) ST (Wake Time) WH (Wake Host) Diagnostic - sleep status/timing commands SS (Sleep Status) OS (Operating Sleep Time) OW (Operating Wake Time) MS (Missed Sync Messages) SQ (Missed Sleep Sync Count) Command mode options CC (Command Sequence Character)
  • Page 9 Regulatory information Europe (CE) OEM labeling requirements Declarations of conformity Antennas PCB design and manufacturing Recommended footprint and keepout Design notes Host board design Improve antenna performance RF pad version Recommended solder reflow cycle Flux and cleaning Rework XBee® SX 868 RF Module User Guide...

  • Page 10: Xbee® Sx 868 Rf Module User Guide

    The XBee SX 868 RF Module is an embedded radio frequency (RF) device that provides wireless connectivity to end-point devices in mesh networks. The XBee SX 868 RF Module delivers up to 32 mW of Effective Isotropically Radiated Power (EIRP) and has excellent receive sensitivity, low operating current, and exceptional performance in low power modes.

  • Page 11: Applicable Firmware And Hardware

    XBee® SX 868 RF Module User Guide Applicable firmware and hardware Applicable firmware and hardware This manual supports the following firmware: 0xA00x, Europe v.10xx zigbee It supports the following hardware: XBee SX 868 RF Module XBee® SX 868 RF Module User Guide...
  • Page 12 Technical specifications Regulatory conformity summary Power requirements Networking and security specifications Performance specifications General specifications GPIO specifications LBT and AFA specifications XBee® SX 868 RF Module User Guide...

  • Page 13: Technical Specifications

    Technical specifications Regulatory conformity summary Regulatory conformity summary This table describes the agency approvals for the devices. Regulatory information for details. Country Approval Europe (CE) The following table shows the channel frequencies. Operational frequency band Channel # Frequency 863.15 MHz 863.35 MHz 863.55 MHz 863.75 MHz...

  • Page 14: Power Requirements

    Band R applies when polite spectrum access is being used, i.e. more than one channel is enabled. Band Q applies when polite spectrum access is not used, i.e. when channel 29 is the only enabled channel. Power requirements The following table describes the power requirements for the XBee SX 868 RF Module. Specification Condition Value Supply voltage range 2.4 to 3.6 VDC...

  • Page 15: Networking And Security Specifications

    Technical specifications Networking and security specifications Specification Condition Value Receive current VCC = 3.3 V 40 mA VCC = 3.3 V, LNA bypass enabled 34 mA Transmit current VCC = 3.3 V 55 mA @ 32 mW EIRP VCC = 3.3 V 45 mA @ 16 mW EIRP VCC = 3.3 V 40 mA @ 10 mW EIRP...

  • Page 16: General Specifications

    Technical specifications General specifications Specification Condition Value Available channel frequencies All data rates Rural range line of sight Low data rate Up to 14.5 km (9 mi) Urban range line of sight Low data rate Up to 2.5 km (1.5 mi) Receiver sensitivity Low data rate -113 dBm...

  • Page 17: Gpio Specifications

    Technical specifications GPIO specifications Specification Value Digital I/O 13 I/O lines, 5 output lines Analog-to-digital converter (ADC) 4 10-bit analog inputs Pulse width modulator (PWM) 2 outputs GPIO specifications The following table provides the electrical specifications for the GPIO pads. GPIO electrical specification Value Voltage - supply...

  • Page 18: Get Started

    Get started Verify kit contents Connect the hardware Configure the device using XCTU Configure the devices for a range test Configure remote devices Perform a range test XBee® SX 868 RF Module User Guide...

  • Page 19: Verify Kit Contents

    Get started Verify kit contents Verify kit contents The XBee SX 868 RF Module development kit contains the following components: XBee U.FL module (3) XBee development board (3) USB cable (2) Power supply Set of power supply adapters Antenna U.FL (3)

  • Page 20: Connect The Hardware

    The following illustration shows you how to assemble the hardware components of the development kit. 1. Attach the XBee SX 868 RF Modules to the development boards. 2. Attach the antennas to the devices. 3. Connect the USB cables to the development boards.

  • Page 21: Configure The Device Using Xctu

    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 22 Get started Configure remote devices 3. Configure the second device in either API or Transparent mode, and name it XBEE_B. 4. Disconnect XBEE_B from your computer and remove it from XCTU. 5. Connect XBEE_B to a power supply (or laptop or portable battery). The Radio Modules area should look something like this.

  • Page 23: Perform A Range Test

    Get started Perform a range test Perform a range test 1. Go to the XCTU display for LOCAL_DEVICE. 2. Click to discover remote devices within the same network. The Discover remote devices dialog appears. 3. Click Add selected devices. 4. Click and select Range test.
  • Page 24 Get started Perform a range test 6. Click Start Range Test to begin the range test. If the test is running properly, the packets sent should match the packets received. You will also see the received signal strength indicator (RSSI) update for each radio after each reception.

  • Page 25: Hardware

    Hardware Mechanical drawings Pin signals XBee® SX 868 RF Module User Guide...

  • Page 26: Mechanical Drawings

    Mechanical drawings Mechanical drawings The following figures show the XBee SX 868 RF Module mechanical drawings. All dimensions are in centimeters. The XBee SX 868 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 27: 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 Pin Name state Function Ground Power supply DOUT I/O Output UART data out DIN/CONFIG I/O Input UART data in DIO12 I/O Disabled GPIO...
  • Page 28 Hardware Pin signals Default Pin 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 DIO10/RSSI/PWM0 I/O Output GPIO / RX Signal Strength Indicator DIO11/PWM1 I/O Disabled GPIO / Pulse Width Modulator [Reserved]...

  • Page 29: Pin Connection Recommendations

    Hardware Pin signals Default Pin Name state Function DIO9/ON/SLEEP I/O Output GPIO / Module Sleep Status Indicator Feature not supported on this device. Used on other XBee devices for analog voltage reference. DIO5/ASSOC I/O Output GPIO / Associate Indicator DIO6/RTS I/O Disabled GPIO / UART Request to Send Flow Control DIO3/AD3 I/O Disabled GPIO / Analog Input...

  • Page 30: Operation

    Operation Operation Listen Before Talk and Automatic Frequency Agility Single frequency mode band mode Serial communications Configuration considerations Serial buffers UART flow control Serial interface protocols XBee® SX 868 RF Module User Guide...

  • Page 31: Operation

    Operation Operation The XBee SX 868 RF Module uses a multi-layered firmware base to order the flow of data, dependent on the hardware and software configuration you choose. The following configuration block diagram shows the host serial interface as the physical starting point and the antenna as the physical endpoint for the transferred data.

  • Page 32: Single Frequency Mode Band Mode

    For example, if you enabled two channels you would have an effective duty cycle of 5.6%. The XBee SX 868 RF Module uses a sliding bucket algorithm to calculate usage over the period of 1 hour for each channel. Each bucket accumulates for 6 minutes.

  • Page 33: Spi Communications

    Serial communications For serial communication to occur, you must configure the UART of both devices (the microcontroller and the XBee SX 868 RF Module) with compatible settings for the baud rate, parity, start bits, stop bits, and data bits. Each data byte consists of a start bit (low), 8 data bits (least significant bit first) and a stop bit (high).

  • Page 34: Spi Operation

    SPI implementation The XBee SX 868 RF Module operates as a SPI slave only. This means an external master provides the clock and decides when to send data. The XBee SX 868 RF Module supports an external clock rate of up to 6 Mhz (6 Mb/s).
  • Page 35 Full duplex operation SPI on the XBee SX 868 RF Module requires that you use API mode (without escaping) to packetize data. By design, SPI is a full duplex protocol even when data is only available in one direction. This means that when a device receives data, it also transmits and that data is normally invalid.

  • Page 36: Configuration Considerations

    Clock polarity (CPOL): first (leading) edge rises All XBee SX 868 RF Modules use SPI mode 0 and MSB first. Mode 0 means that data is sampled on the leading edge and that the leading edge rises. MSB first means that bit 7 is the first bit of a byte sent over the interface.

  • Page 37: Serial Buffers

    Operation Serial buffers Serial buffers To enable the UART port, DIN and DOUT must be configured as peripherals. To enable the SPI port, SPI_MISO, SPI_MOSI, SPI_SSEL, and SPI_CLK must be enabled as peripherals. If both ports are enabled, output goes to the UART until the first input on SPI. This is the default configuration. When input occurs on either port, that port is selected as the active port and no input or output is allowed on the other port until the next reset of the module.

  • Page 38: Serial Interface Protocols

    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. Serial interface protocols The XBee SX 868 RF Module supports both Transparent and Application Programming Interface (API) serial interfaces. Transparent operating mode When operating in Transparent mode, the devices act as a serial line replacement.
  • Page 39 Advanced application features Remote configuration commands Network commissioning and diagnostics I/O line monitoring I/O line passing General Purpose Flash Memory Over-the-air firmware updates XBee® SX 868 RF Module User Guide...

  • Page 40: Advanced Application Features

    Advanced application features Remote configuration commands Remote configuration commands The API firmware has provisions to send configuration commands to remote devices using the Remote Command Request API frame (see Operate in API mode). Use the API frame to send commands to a remote device to read or set command parameters. Send a remote command To send a remote command, populate the Remote Command Request frame with: 64-bit address of the remote device...

  • Page 41: Network Link Establishment And Maintenance

    Advanced application features Network commissioning and diagnostics settings of any device in the network. Network link establishment and maintenance Build aggregate routes In many applications it is necessary for many or all of the nodes in the network to transmit data to a central aggregator node.

  • Page 42: Place Devices

    Advanced application features Network commissioning and diagnostics To update only the routing table information without affecting the DH/DL registers, use Example 2. To update the DH/DL registers of the network, use the method in the following example. Example: Use the device with serial number 0x0013a2004052c507 as a network aggregator and replace it with a device with serial number 0x0013a200f5e4d3b2.

  • Page 43: Device Discovery

    Advanced application features Network commissioning and diagnostics The configuration steps for sending data to the loopback cluster ID depend on what mode the device is in. For details on setting the mode, see Mode. The following sections list the steps based on the device's mode.

  • Page 44: Link Reliability

    Advanced application features Network commissioning and diagnostics You can use this command for generating a list of all module addresses in a network. When a device receives the network discovery command, it waits a random time before sending a response. The device sets the maximum time delay on the ND sender with the NT command. The ND originator includes its NT setting in the transmission to provide a delay window for all devices in the network.
  • Page 45 Advanced application features Network commissioning and diagnostics to the address of the remote. After exiting command mode, the source device transmits any received serial characters to the remote device, and returned to the sender. API configuration (AP=1 or AP=2) Send an Explicit Addressing Command API frame (0x11) using 0x12 as the cluster ID and 0xE8 as the source and destination endpoint.
  • Page 46 Advanced application features Network commissioning and diagnostics Number of bytes Field name Description minRSSI The weakest RSSI reading observed during the test. avgRSSI The average RSSI reading observed during the test. Example: Suppose that the link between device A (SH/SL = 0x0013a20040521234) and device B (SH/SL=0x0013a2004052abcd) is being tested by transmitting 1,000 40 byte packets.

  • Page 47: Commissioning Pushbutton And Associate Led

    Advanced application features Network commissioning and diagnostics Because of the large number of Route Information packets that can be generated by a unicast with Trace Route enabled, we suggest that the Trace Route option only be used for occasional diagnostic purposes and not for normal operations.
  • Page 48 Advanced application features Network commissioning and diagnostics A pushbutton and an LED can be connected to XBee SX 868 RF Module pins 33 and 28 (SMT), or pins 20 and 15 (TH) respectively to support the commissioning pushbutton and associate LED functionalities.
  • Page 49 Advanced application features Network commissioning and diagnostics Sleep Button configuration and sync Presses status Action Configured for synchronous Wakes the module for 30 seconds (or until the sleep synchronized network goes to sleep). Queues a Node Identification broadcast transmission sent at the beginning of the next network wake cycle.

  • Page 50: I/O Line Monitoring

    Associate pin rapidly for one second. I/O line monitoring I/O samples The XBee SX 868 RF Module supports both analog input and digital I/O line modes on several configurable pins. Pin configurations The following table provides typical parameters for the pin configuration commands (D0 - D9, P0 - P2).
  • Page 51 Advanced application features I/O line monitoring The following table provides the pin configurations when you set the configuration command for a particular pin. Device pin name Device pin number Configuration command DIO12 PWM0 / RSSI / DIO10 PWM1 / DIO11 DTR / SLEEP_RQ / DIO8 DIO4 CTS / DIO7...
  • Page 52 Advanced application features I/O line monitoring 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 53: Periodic I/O Sampling

    Advanced application features I/O line monitoring Example Sample AT response 0x03D0 [Analog input: ADIO 0 = 0x3D0] 0x0124 [Analog input: ADIO 1 =0x120] 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.

  • Page 54: I/O Line Passing

    I/O line passing I/O line passing You can configure XBee SX 868 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 55: General Purpose Flash Memory

    You can use the PD command to change the direction of the internal pull- up/down resistors. The XBee SX 868 RF Module uses an internal reference voltage of 2.5 V for ADC lines, but you can use the AV command to set it to 1.25 VDC.

  • Page 56: General Purpose Flash Memory Commands

    Advanced application features General Purpose Flash Memory Byte offset Number of in payload bytes Field name General field description GPM_CMD_ID Specific GPM commands are described in detail in the topics that follow. GPM_OPTIONS Command-specific options. GPM_BLOCK_NUM The block number addressed in the GPM.
  • Page 57 Advanced application features General Purpose Flash Memory PLATFORM_INFO_REQUEST (0x00) A PLATFORM_INFO_REQUEST frame can be sent to query details of the GPM structure. Field name Command-specific description GPM_CMD_ID Should be set to PLATFORM_INFO_REQUEST (0x00). GPM_OPTIONS This field is unused for this command. Set to 0. GPM_BLOCK_NUM This field is unused for this command.
  • Page 58 Advanced application features General Purpose Flash Memory Field name Command-specific description GPM_CMD_ID Should be set to ERASE (0x01). GPM_OPTIONS There are currently no options defined for the ERASE command. Set this field to 0. GPM_BLOCK_NUM Set to the index of the GPM block that should be erased. When erasing all GPM blocks, this field is ignored (set to 0).
  • Page 59 Advanced application features General Purpose Flash Memory command performs an ERASE of the entire GPM block specified with the GPM_BLOCK_NUM field prior to doing a WRITE. Field name Command-specific description GPM_CMD_ID Should be set to WRITE (0x02) or ERASE_THEN_WRITE (0x03). GPM_OPTIONS There are currently no options defined for this command.
  • Page 60 Advanced application features General Purpose Flash Memory 7E 0007 8B 01 FFFE 00 00 00 76 7E 001A 91 0013A200407402AC FFFE E6 E6 0023 C105 C1 82 00 0016 0000 0000 4C READ (0x04) You can use the READ command to read the specified number of bytes from the GPM location specified.
  • Page 61 Advanced application features General Purpose Flash Memory Assuming all transmissions were successful and that flash block 22 was previously written with incrementing data, the following API packets would be output the source node's serial interface: 7E 0007 8B 01 FFFE 00 00 00 76 7E 0029 91 0013A200407402AC FFFE E6 E6 0023 C105 C1 84 00 0016 0000 000F 0102030405060708090A0B0C0D0E0F C3 FIRMWARE_VERIFY (0x05) and FIRMWARE_VERIFY_AND_INSTALL(0x06)

  • Page 62: Work With Flash Memory

    Flash memory has a limited lifetime. The flash memory on which the GPM is based is rated at 20,000 erase cycles before failure. Take care to ensure that the frequency of erase/write operations allows for the desired product lifetime. Digi's warranty does not cover products that have exceeded the allowed number of erase cycles.

  • Page 63: Distribute The New Application

    SX 868 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 64: Verify The New Application

    Advanced application features Over-the-air firmware updates 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. To guarantee that this is the case, GPM VERIFY functions exist to ensure that all bytes are properly in place.

  • Page 65: Networking Methods

    Networking methods This section explains the basic layers and the three networking methods available on the XBee SX 868 RF Modules, building from the simplest to the most complex. Directed Broadcast/Repeater mode Point to Point/Multipoint mode DigiMesh networking Networking concepts Data transmission and routing XBee®...

  • Page 66: Directed Broadcast/Repeater Mode

    Networking methods Directed Broadcast/Repeater mode Directed Broadcast/Repeater mode In this broadcast mode, the exact transmission method is determined by the data rate of your device. In the 10k version, set the network in a repeater mode, where there is no route discovery. The transmission is sent out to the network and each device repeats the message to its neighboring devices.

  • Page 67: Digimesh Feature Set

    Networking methods DigiMesh networking Selective acknowledgments. Only the destination node will reply to route requests. Reliable delivery. Reliable delivery of data is accomplished by means of acknowledgments. Sleep modes. Low power sleep modes with synchronized wake are supported with variable sleep and wake times.

  • Page 68: Networking Concepts

    Networking methods Networking concepts Sleep modes Low power sleep modes with synchronized wake are supported with variable sleep and wake times. Networking concepts This section provides information on configuring DigiMesh devices and network identifiers. Device Configuration You can configure DigiMesh devices to act as routers or end devices with the CE command. By default, all devices in a DigiMesh network act as routers.

  • Page 69: Routing

    Networking methods Data transmission and routing Sending frequent broadcast transmissions can quickly reduce the available network bandwidth. Use broadcast transmissions sparingly. The broadcast address is a 64 bit address with the lowest 16 bits set to 1. The upper bits are set to 0. To send a broadcast transmission: Set DH to 0.

  • Page 70: Transmission Timeouts

    Networking methods Data transmission and routing Configuration Data throughput Point to Point, encryption disabled 34.63 kb/s Point to Point, encryption enabled 34.48 kb/s Mesh unicast, one hop, encryption disabled 27.54 kb/s Mesh unicast, one hop, encryption enabled 27.3 kb/s Mesh unicast, three hops, encryption disabled 9.55 kb/s Mesh unicast, three hops, encryption enabled 9.38 kb/s...
  • Page 71 Networking methods Data transmission and routing Unicast one hop time unicastOneHopTime is a building block of many of the following calculations. It represents the amount of time it takes to send a unicast transmission between two adjacent nodes. The amount of time depends on the parameter.
  • Page 72 Modes The XBee SX 868 RF Module is in Receive Mode when it is not transmitting data. The device shifts into the other modes of operation under the following conditions: Transmit Mode (Serial data in the serial receive buffer is ready to be packetized)

  • Page 73: Transmit Mode

    Receive mode This is the default mode for the XBee SX 868 RF Module. The device is in Receive mode when it is not transmitting data. If a destination node receives a valid RF packet, the destination node transfers the data to its serial transmit buffer.

  • Page 74: Apply Command Changes

    Modes Sleep mode The preceding example changes the device's destination address (Low) to 0x1F. Multiple AT commands You can send multiple AT commands at a time when they are separated by a comma in Command mode; for example, ATSH,SL. Parameter format Refer to the list of AT commands for the format of individual AT command parameters.

  • Page 75: Force Uart Operation

    Modes Force UART operation Force UART operation Condition You configure a device with only the SPI enabled and no SPI master is available to access the SPI slave port Solution Use the following steps to recover the device to UART operation: 1.
  • Page 76 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 Wake timer Indirect messaging and polling Sleeping routers Sleep coordinator sleep modes in the DigiMesh network XBee®...

  • Page 77: 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 78: Asynchronous Cyclic Sleep Mode

    Sleep modes Asynchronous cyclic sleep mode Pin sleep allows the device to sleep and wake according to the state of the SLEEP_RQ pin (pin 9). When you assert SLEEP_RQ (high), the device finishes any transmit or receive operations and enters a low-power state.

  • Page 79: Wake Timer

    Sleep modes Wake timer Generally, the network’s sleep coordinator specifies the sleep and wake times based on its SP and ST settings. The device only uses these parameters at startup until the device synchronizes with the network. When a device has synchronized with the network, you can query its sleep and wake times with the OS and OW commands respectively.

  • Page 80: Polling

    Sleep modes Sleeping routers Indirect messaging has no effect on broadcasts. These messages are sent immediately when received over the serial port and are not put on the indirect messaging queue. Polling Polling is the automatic process by which a node can request data from an indirect messaging coordinator.
  • Page 81 Sleep modes Sleep coordinator sleep modes in the DigiMesh network Sleep compatible nodes use Deployment mode when they first power up and the sync message has not been relayed. A sleep coordinator in Deployment mode rapidly sends sync messages until it receives a relay of one of those messages.
  • Page 82 Sleep modes Sleep coordinator sleep modes in the DigiMesh network XBee® SX 868 RF Module User Guide...

  • Page 83: Become A Sleep Coordinator

    Sleep modes Sleep coordinator sleep modes in the DigiMesh network 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 84 Sleep modes Sleep coordinator sleep modes in the DigiMesh network 1. Newer sleep parameters: the network considers a node using newer sleep parameters (SP and ST) as higher priority to a node using older sleep parameters. See Change sleep parameters. 2.

  • Page 85: Select Sleep Parameters

    Sleep modes Sleep coordinator sleep modes in the DigiMesh network Auto-early wake-up sleep option Similar to the sleep guard time, the auto early wake-up option decreases the sleep period based on the number of sync messages a node misses. This option comes at the expense of battery life. Use the SO command to disable auto-early wake-up sleep.

  • Page 86: Add A New Node To An Existing Network

    Sleep modes Sleep coordinator sleep modes in the DigiMesh network 4. Configure the new nodes to the sleep mode you want, either cyclic sleeping modes or sleep support modes. 5. Set the SP and ST values on the sleep coordinator to the values you want for the network. 6.

  • Page 87: Change Sleep Parameters

    Sleep modes Sleep coordinator sleep modes in the DigiMesh network The new node periodically sends sync requests until the network wakes up and it receives a sync message. Change sleep parameters To change the sleep and wake cycle of the network, select any sleep coordinator capable node in the network and change the SP and/or ST of the node to values different than those the network currently uses.

  • Page 88: Diagnostics

    Sleep modes Sleep coordinator sleep modes in the DigiMesh network If you disable the non-sleep coordinator bit in the SO command on multiple devices in the network, they are eligible for the network to nominate them as a sleep coordinator. For more details, see command.
  • Page 89 Sleep modes Sleep coordinator sleep modes in the DigiMesh network Sleep status API messages When you use the SO command to enable this option, a device that is in API operating mode outputs modem status frames immediately after it wakes up and prior to going to sleep. XBee®...

  • Page 90: At Commands

    AT commands Special commands MAC/PHY commands Diagnostic commands Network commands Addressing commands Addressing discovery/configuration commands Diagnostic - addressing 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 commands XBee®...

  • Page 91: Special Commands

    AT commands Special commands Special commands The following commands are special commands. AC (Apply Changes) Immediately applies new settings without exiting Command mode. Immediately applies new settings without exiting Command Mode. Parameter range Default 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.

  • Page 92: Mac/Phy Commands

    AT commands MAC/PHY commands MAC/PHY commands The following AT commands are MAC/PHY commands. CM (Channel Mask) 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.

  • Page 93: Mt (Broadcast Multi-Transmits)

    AT commands MAC/PHY commands Parameter range 0 - 0x7FFF Default 0x7FFF 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 - 5 Default BR (RF Data Rate) Sets and reads the device's RF data rate (the rate at which the device transmits and receives RF data...

  • Page 94: Rr (Unicast Mac Retries)

    AT commands MAC/PHY commands Setting Power level* 10 mW EIRP 16 mW EIRP 32 mW EIRP * EIRP stands for Effective Isotropically Radiated Power, which is the device's output power plus 2.1 dBi (dipole antenna gain). Default RR (Unicast Mac Retries) Set or read the maximum number of MAC level packet delivery attempts for unicasts.

  • Page 95: Diagnostic Commands

    AT commands Diagnostic commands Parameter Mode LNA Bypass Disabled LNA Bypass Enabled Default Diagnostic commands The following AT commands are diagnostic commands. Diagnostic commands are typically volatile and will not persist across a power cycle. BC (Bytes Transmitted) The number of RF bytes transmitted. The firmware counts every byte of every packet, including MAC/PHY headers and trailers.

  • Page 96: Gd (Good Packets Received)

    AT commands Diagnostic commands Parameter range 0 - 0xFFFF Default GD (Good Packets Received) This count increments when a device receives a good frame with a valid MAC header on the RF interface. Once the number reaches 0xFFFF, it does not count further events. To reset the counter to any 16-bit unsigned value, append a hexadecimal parameter to the command.

  • Page 97: H (Mac Unicast One Hop Time)

    AT commands Network commands Parameter range 0 - 0xFFFF Default %H (MAC Unicast One Hop Time) The MAC unicast one hop time timeout in milliseconds. If you change the MAC parameters it can change this value. Parameter range [read-only] Default 0xF3 %8 (MAC Broadcast One Hop Time) The MAC broadcast one hop time timeout in milliseconds.

  • Page 98: Bh Command

    AT commands Network commands Note Bit 0 and Bit 2 cannot be set at the same time. Parameter range 0 - 6 Default BH command The number of hops for broadcast data transmissions. Set the value to 0 for the maximum number of hops. If you set BH greater than NH, the device uses the value of NH.

  • Page 99: Addressing Commands

    AT commands Addressing commands If you set this parameter to 0, it disables network ACKs. Initially, the device can find routes, but a route will never be repaired if it fails. Parameter range 0 - 7 Default Addressing commands The following AT commands are addressing commands. SH command Displays the upper 32 bits of the unique IEEE 64-bit extended address assigned to the XBee in the factory.

  • Page 100: To (Transmit Options)

    AT commands Addressing commands Reserved zigbee network addresses: 0x000000000000FFFF is a broadcast address. 0x0000000000000000 addresses the network coordinator. Parameter range 0 - 0xFFFFFFFF Default 0x0000FFFF TO (Transmit Options) The bitfield that configures the transmit options for Transparent mode. The device's transmit options. The device uses these options for all transmissions. You can override these options using the TxOptions field in the API TxRequest frames.

  • Page 101: Ni Command

    Parameter range 0x0 - 0x7 (bit field) Option Description Append the DD (Digi Device Identifier) value to ND or FN responses or API node 0x01 identification frames. Local device returns own ND response frame when a ND or FN is issued.

  • Page 102: Ci (Cluster Id)

    Default 0x11 DE command Sets or displays the application layer destination ID value. The value is used as the destination endpoint for all data transmissions. The default value (0xE8) is the Digi data endpoint. Parameter range 0 - 0xFF Default...

  • Page 103: Dn (Discover Node)

    AT commands Addressing discovery/configuration commands The receiving node establishes a DigiMesh route back to the originating node, if there is space in the routing table. The DH and DL of the receiving node update to the address of the originating node if the AG parameter matches the current DH/DL of the receiving node.

  • Page 104: 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 105: Security Commands

    AT commands Security commands Parameter range [read-only] Default Security commands The following AT commands are security commands. EE (Security Enable) Enables or disables 128-bit Advanced Encryption Standard (AES) encryption. Set this command parameter the same on all devices in a network. Parameter range 0 - 1 Parameter...
  • Page 106 AT commands Serial interfacing commands The BD parameter does not affect the RF data rate. If you set the interface data rate higher than the RF data rate, you may need to implement a flow control configuration. Non-standard interface data rates The firmware interprets any value within 0x4B0 - 0x2580 and 0x4B00 - 0x1C9468 as an actual baud rate.

  • Page 107: Nb (Parity)

    AT commands Serial interfacing commands NB (Parity) Set or read the serial parity settings for UART communications. Parameter range 0x00 - 0x02 Parameter Description 0x00 No parity 0x01 Even parity 0x02 Odd parity Parameter Description No parity Even parity Odd parity Default 0x00 SB command...

  • Page 108: Ft (Flow Control Threshold)

    AT commands Serial interfacing commands Default FT (Flow Control Threshold) Set or display the flow control threshold. De-assert CTS and/or send XOFF when FT bytes are in the UART receive buffer. Re-assert CTS when less than FT-16 bytes are in the UART receive buffer. Parameter range 0x1A - 0x166 bytes Default...

  • Page 109: I/O Settings Commands

    AT commands I/O settings commands Default I/O settings commands The following AT commands are I/O settings commands. CB command Use CB to simulate commissioning pushbutton presses in software. Set the parameter value to the number of button presses that you want to simulate. For example, send CB1 to perform the action of pressing the Commissioning Pushbutton once.

  • Page 110: D2 (Dio2/Ad2)

    AT commands I/O settings commands Parameter Description Disabled Digital input Digital output, low Digital output, high Default D2 (DIO2/AD2) Sets or displays the DIO2/AD2 configuration (pin 31). Parameter range 0, 2 - 5 Parameter Description Disabled Digital input Digital output, low Digital output, high Default D3 (DIO3/AD3)

  • Page 111: D4 (Dio4)

    AT commands I/O settings commands Parameter Description Digital input Digital output, low Digital output, high Default D4 (DIO4) Sets or displays the DIO4 configuration (pin 24). Parameter range 0, 3 - 5 Parameter Description Disabled Digital input Digital output, low Digital output, high Default D5 (DIO5/ASSOCIATED_INDICATOR)

  • Page 112: D6 (Dio6/Rts)

    AT commands I/O settings commands Default D6 (DIO6/RTS) Sets or displays the DIO6/RTS configuration (pin 29). Parameter range 0, 1, 3 - 5 Parameter Description Disabled RTS flow control Digital input Digital output, low Digital output, high Default D7 (DIO7/CTS) Sets or displays the DIO7/CTS configuration (pin 25).

  • Page 113: D8 (Dio8/Dtr/Sleep_Request)

    AT commands I/O settings commands D8 (DIO8/DTR/SLEEP_REQUEST) Sets or displays the DIO8/SLEEP_REQUEST configuration (pin 10). Parameter range 0, 1, 3 - 5 Parameter Description Disabled Sleep request Digital input Digital output, low Digital output, high Default D9 (DIO9/ON_SLEEP) Sets or displays the DIO9/ON_SLEEP configuration (pin 26). Parameter range 0, 1, 3 - 5 Parameter...

  • Page 114: P1 (Dio11/Pwm1 Configuration)

    AT commands I/O settings commands Parameter range 0 - 5 Parameter Description Disabled RSSI PWM0 output PWM0 output Digital input Digital output, low Digital output, high Default P1 (DIO11/PWM1 Configuration) Sets or displays the DIO11/PWM1 configuration (pin 8). Parameter range 0 - 5 Parameter Description...

  • Page 115: P3 (Dout)

    AT commands I/O settings commands Parameter Description Disabled Digital input Digital output, low Digital output, high Default P3 (DOUT) Sets or displays the DOUT configuration (pin 3). Parameter range 0, 1 Parameter Description Disabled UART DOUT enabled Default P4 (DIN/CONFIG) Sets or displays the DIN/CONFIG configuration (pin 4).

  • Page 116: P6 (Spi_Mosi Configuration)

    AT commands I/O settings commands Parameter range 0, 1, 4, 5 Parameter Description Disabled SPI_MISO Digital output low Digital output high Default P6 (SPI_MOSI Configuration) Sets or displays the DIO16/SPI_MOSI configuration (pin 16). Parameter range 0, 1, 4, 5 Parameter Description Disabled SPI_MOSI...

  • Page 117: P9 (Dio19/Spi_Attn)

    AT commands I/O settings commands Parameter Description Disabled SPI_SSEL Digital output low Digital output, high Default P8 (DIO18/SPI_SCLK) Sets or displays the DIO18/SPI_SCLK configuration (pin 14). Parameter range 0, 1, 4, 5 Parameter Description Disabled SPI_SCLK Digital output low Digital output high Default P9 (DIO19/SPI_ATTN) Sets or displays the DIO19/SPI_ATTN configuration (pin 12).

  • Page 118: Pd (Pull Up/Down Direction)

    AT commands I/O settings commands Parameter Description Digital output low Digital output high UART data present indicator Default PD (Pull Up/Down Direction) The resistor pull direction bit field (1 = pull-up, 0 = pull-down) for corresponding I/O lines that are set by the PR command.

  • Page 119: M1 (Pwm1 Duty Cycle)

    AT commands I/O sampling commands M1 (PWM1 Duty Cycle) 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 LT command Set or read the Associate LED blink time. If you use the D5 command to enable the Associate LED functionality (DIO5/Associate pin), this value determines the on and off blink times for the LED when the device has joined the network.

  • Page 120: Ic (Dio Change Detection)

    AT commands I/O sampling commands Parameter Description 1.25 V reference 2.5 V reference Default IC (DIO Change Detection) 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) . If you enable a pin as a digital I/O, you can use the IC command to force an immediate I/O sample transmission when the DIO state changes.

  • Page 121: If (Sleep Sample Rate)

    AT commands I/O sampling 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 122: Voltage Supply Monitoring)

    AT commands I/O line passing commands Default %V (Voltage Supply Monitoring) Displays the supply voltage of the device in mV units. Parameter range This is a read-only parameter Default I/O line passing commands The following AT commands are I/O line passing commands. I/O Line Passing allows the digital and analog inputs of a remote device to affect the corresponding outputs of the local device.

  • Page 123: T0 (D0 Timeout)

    AT commands I/O line passing commands Default 0xFFFFFFFFFFFFFFFF (I/O line passing disabled) T0 (D0 Timeout) Specifies how long pin D0 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 T1 (D1 Output Timeout)

  • Page 124: 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 before it reverts to configured value. If set to 0, there is no timeout.

  • Page 125: T9 (D9 Timeout)

    AT commands I/O line passing commands T9 (D9 Timeout) 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 Q0 (P0 Timeout) Specifies how long pin P0 holds a given value before it reverts to configured value.

  • Page 126: Q4 (P4 Timeout)

    AT commands Sleep commands Default Q4 (P4 Timeout) Specifies how long pin P4 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 PT (PWM Output Timeout) Specifies how long both PWM outputs (P0, P1) output a given PWM signal before it reverts to zero.

  • Page 127: So Command

    AT commands Sleep commands Parameter Description Sleep Support Synchronized Cyclic Sleep Default SO command Set or read the sleep options bit field of a device. This command is a bitmask. You cannot set bit 0 and bit 1 at the same time. Parameter range 0 - 0x13E For synchronous sleep devices, the following sleep bit field options are defined:...

  • Page 128: Sp (Sleep Period)

    AT commands Sleep commands Default SP (Sleep Period) Sets or displays the device's sleep time. This command defines the amount of time the device sleeps per cycle. For a node operating as an Indirect Messaging Coordinator, this command defines the amount of time that it will hold an indirect message for an end device.

  • Page 129: Diagnostic - Sleep Status/Timing Commands

    AT commands Diagnostic - sleep status/timing commands Diagnostic - sleep status/timing commands The following AT commands are Diagnostic sleep status/timing commands. SS (Sleep Status) Queries a number of Boolean values that describe the device's status. 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.

  • Page 130: Ms (Missed Sync Messages)

    AT commands Command mode options Parameter range [read-only] Default 0x1F40 MS (Missed Sync Messages) Reads the number of sleep or wake cycles since the device received a sync message. Parameter range [read-only] Default SQ (Missed Sleep Sync Count) Counts the number of sleep cycles in which the device does not receive a sleep sync. Set the value to 0 to reset this value.

  • Page 131: Cn Command

    AT commands Firmware commands Parameter range 2 - 0x1770 (x 100 ms) Default 0x64 (10 seconds) CN command Immediately exits Command Mode and applies pending changes. Parameter range Default GT command Set the required period of silence before and after the command sequence characters of the Command mode sequence (GT + CC + GT).

  • Page 132: Hv Command

    Read the device's hardware series number. Parameter range 0 - 0xFFFF [read-only] Default Set in the firmware DD command Stores the Digi device type identifier value. Use this value to differentiate between multiple XBee devices. Parameter range 0 - 0xFFFFFFFF [read-only] Default 0x110000 NP (Maximum Packet Payload Bytes) Reads the maximum number of RF payload bytes that you can send in a transmission.
  • Page 133 AT commands Firmware commands Parameter range Default XBee® SX 868 RF Module User Guide...

  • Page 134: Operate In Api Mode

    Operate in API mode API mode overview Use the AP command to set the operation mode API frame format API serial exchanges Frame descriptions XBee® SX 868 RF Module User Guide...

  • Page 135: 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 136: 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 137 Operate in API mode API frame format Frame Data Start delimiter Length Frame type Checksum Data 00 0F 17 01 00 13 A2 00 40 AD 14 2E FF FE 02 4E 49 6D You must escape the 0x13 byte: 1.

  • Page 138: Api Serial Exchanges

    Subtract 0x47 from 0xFF and you get 0xB8 (0xFF - 0x47 = 0xB8). 0xB8 is the checksum for this data packet. If an API data packet is composed with an incorrect checksum, the XBee SX 868 RF Module will consider the packet invalid and will ignore the data.

  • Page 139: Transmit And Receive Rf Data

    Operate in API mode API serial exchanges Transmit and receive RF data The following image shows the API exchanges that take place at the serial interface when sending RF data to another device. The transmit status frame is always sent at the end of a data transmission unless the frame ID is set to 0 in the TX request.

  • Page 140: Frame Descriptions

    Operate in API mode Frame descriptions Frame descriptions The following sections describe the API frames. 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 141 Operate in API mode Frame descriptions Frame data fields Offset Example AT command 0x4E (N) 0x48 (H) Parameter value (optional) Checksum 0x0F XBee® SX 868 RF Module User Guide...

  • Page 142: 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 Format...

  • Page 143: 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 144 Operate in API mode Frame descriptions Example The example shows how to send a transmission to a device if you disable escaping (AP = 1), with destination address 0x0013A200 400A0127, and payload “TxData0A”. Frame data fields Offset Example Start delimiter 0x7E Length MSB 1...
  • Page 145 Operate in API mode Frame descriptions 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 146: 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.
  • Page 147 Operate in API mode Frame descriptions Frame data fields Offset Description Bitfield: bits 6,7: Transmission options 22 b’01 - Point-to-Multipoint b’10 - Repeater mode (directed broadcast) b’11 - DigiMesh (not available on 10k product) All other bits must be set to 0. Data payload 23-n Example...
  • Page 148 Operate in API mode Frame descriptions Frame data fields Offset Example Cluster ID 0x15 0x54 Profile ID 0xC1 0x05 Broadcast radius 0x00 Transmit options 0x00 Data payload 0x54 0x78 0x44 0x61 0x74 0x61 Checksum 0xDD XBee® SX 868 RF Module User Guide...

  • Page 149: 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 150 Operate in API mode Frame descriptions Frame data fields Offset Example 64-bit destination address MSB 5 0x00 0x13 0xA2 0x00 0x40 0x40 0x11 LSB 12 0x22 Reserved 0xFF 0xFE Remote command options 0x02 (apply changes) AT command 0x42 (B) 0x48 (H) Command parameter 0x01 Checksum...

  • Page 151: 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 Frame type...
  • Page 152 Operate in API mode Frame descriptions Frame data fields Offset Example Command data Checksum 0xF0 XBee® SX 868 RF Module User Guide...

  • Page 153: 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 format.

  • Page 154: 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. Format The following table provides the contents of the frame.
  • Page 155 Operate in API mode Frame descriptions Frame Fields Offset Example Frame type 0x8B Frame ID 0x47 Reserved 0xFF 0xFE Transmit retry count 0x00 Delivery status 0x00 Discovery status 0x02 Checksum 0x2E XBee® SX 868 RF Module User Guide...

  • Page 156: 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 Frame data fields Offset Description Frame type 0x8D...
  • Page 157 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 Timestamp MSB 6 0x9C 0x93 0x81 LSB 9 0x7F ACK timeout count 0x00 TX blocked count 0x00...
  • Page 158 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 0xCE XBee®...

  • Page 159: 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 160 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 0x2E XBee® SX 868 RF Module User Guide...

  • Page 161: 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 162 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®...

  • Page 163: 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. Format The following table provides the contents of the frame.
  • Page 164 Operate in API mode Frame descriptions Frame data fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x18 Frame type 0x91 64-bit source address MSB 4 0x00 0x13 0xA2 0x00 0x40 0x52 0x2B LSB 11 0xAA Reserved 0xFF 0xFE Source endpoint...

  • Page 165: Data Sample Rx Indicator Frame - 0X92

    Operate in API mode Frame descriptions 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 Frame data fields Offset Description...
  • Page 166 Operate in API mode Frame descriptions Frame fields Offset Example Start delimiter 0x7E Length MSB 1 0x00 LSB 2 0x14 Frame-specific data 64-bit source address MSB 4 0x00 0x13 0xA2 0x00 0x40 0x52 0x2B LSB 11 0xAA Reserved MSB 12 0xfffe LSB 13 0x84...

  • Page 167: 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 168 Frame data fields Offset Description Source event 1 = Frame sent by node identification pushbutton event. 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 169 0x74 0x02 0xAC LSB 24 NI string 0x20 0x00 Reserved 0xFF 0xFE Device type 0x01 Source event 0x01 Digi Profile ID 0xC1 0x05 Digi Manufacturer ID 0x10 0x1E Digi DD value 0x00 (optional) 0x0C 0x00 0x00 RSSI (optional) 0x2E Checksum 0x33 XBee®...

  • Page 170: 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 171 Operate in API mode Frame descriptions Frame data fields Offset Example Frame ID 0x55 64-bit source (remote) address MSB 5 0x00 0x13 0xA2 0x00 0x40 0x52 0x2B LSB 12 0xAA Reserved 0xFF 0xFE AT commands 0x53 0x4C Command status 0x00 Command data 0x40 0x52...

  • Page 172: Regulatory Information

    Regulatory information Europe (CE) Antennas XBee® SX 868 RF Module User Guide...

  • Page 173: Europe (Ce)

    Europe (CE) Europe (CE) The XBee SX 868 RF Modules have been tested for use in several European countries. For a complete list, refer to www.digi.com/resources/certifications. If the XBee SX 868 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 Directive.

  • Page 174: Declarations Of Conformity

    For more information, see www.digi.com/resources/certifications. Antennas The following antennas have been tested and approved for use with the XBee SX 868 RF Module: Dipole (2.1 dBi), Digi PN A08-HABUF-P5I* All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option.
  • Page 175 PCB design and manufacturing The XBee SX 868 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 176: Recommended Footprint And Keepout

    Recommended footprint and keepout Recommended footprint and keepout We designed the XBee SX 868 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 177 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 178: 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 179: 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.

  • Page 180: Recommended Solder Reflow Cycle

    PCB design and manufacturing Recommended solder reflow cycle the module. All of the grounds on the jack and the module are connected to the ground planes directly or through closely placed vias. Space any ground fill on the top layer at least twice the distance d (in this case, at least 0.050 in) from the microstrip to minimize their interaction.

  • Page 181: 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 182 PCB design and manufacturing Rework CAUTION! Any modification to the device voids the warranty coverage and certifications. XBee® SX 868 RF Module User Guide...

Table of Contents