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

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

Advertisement

Table of Contents
loading
Need help?

Need help?

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

Questions and answers

Subscribe to Our Youtube Channel

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 Added translated safety instructions. Trademarks and copyright Digi, Digi International, and the Digi logo are trademarks or registered trademarks in the United States and other countries worldwide. All other trademarks mentioned in this document are the property of their respective owners.
  • Page 3    Description of issue    Steps to reproduce Contact Digi technical support: Digi offers multiple technical support plans and service packages. Contact us at +1 952.912.3444 or visit us at www.digi.com/support. Feedback To provide feedback on this document, email your comments to techcomm@digi.com...

  • Page 4: Table Of Contents

    Contents XBee® SX 868 RF Module User Guide Applicable firmware and hardware Safety instructions Safety instructions XBee modules Инструкции за безопасност XBee модули Sigurnosne upute XBee moduli Bezpečnostní instrukce moduly XBee Sikkerhedsinstruktioner XBee moduler Veiligheidsinstructies XBee-modules Ohutusjuhised XBee moodulid Turvallisuusohjeet XBee moduulit Consignes de sécurité...
  • Page 5 Bezpečnostné inštrukcie moduly XBee Varnostna navodila XBee moduli Módulos XBee Säkerhets instruktioner XBee-moduler 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 6 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 Configure devices Network link establishment and maintenance Place devices Device discovery Link reliability...
  • Page 7 Modes Transmit mode Receive mode Command mode Enter Command mode Troubleshooting Send AT commands Response to AT commands Apply command changes Make command changes permanent Exit Command mode Sleep mode Force UART operation Condition Solution Sleep modes About sleep modes Asynchronous modes Synchronous modes Normal mode...
  • Page 8 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) TR (Transmission Errors) UA (MAC Unicast Transmission Count)
  • Page 9 AO (API Options) I/O settings commands CB (Commissioning Pushbutton) 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)
  • Page 10 PT (PWM Output Timeout) Sleep commands SM (Sleep Mode) SO (Sleep Options) SN (Number of Sleep Periods) 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...
  • Page 11 Description 64-bit addressing Reserved endpoints Reserved cluster IDs Reserved profile IDs Transmit options bit field Examples Remote AT Command Request - 0x17 Description Format Examples Local AT Command Response - 0x88 Description Examples Modem Status - 0x8A Description Modem status codes Examples Extended Transmit Status - 0x8B Description...
  • Page 12 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 13: 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 14: 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 It supports the following hardware: XBee SX 868 RF Module XBee® SX 868 RF Module User Guide...

  • Page 15: Safety Instructions

    Safety instructions Safety instructions Инструкции за безопасност Sigurnosne upute Bezpečnostní instrukce Sikkerhedsinstruktioner Veiligheidsinstructies Ohutusjuhised Turvallisuusohjeet Consignes de sécurité Sicherheitshinweise Οδηγίες ασφαλείας Biztonsági utasítások Istruzioni di sicurezza Drošības instrukcijas Saugos instrukcijos Sikkerhetsinstruksjoner Instrukcje bezpieczeństwa Instruções de segurança Instructiuni de siguranta Bezpečnostné inštrukcie Varnostna navodila Módulos XBee Säkerhets instruktioner...

  • Page 16: Safety Instructions

    Safety instructions Safety instructions Safety instructions XBee modules The XBee radio module cannot be guaranteed operation due to the radio link and so should not be used for interlocks in safety critical devices such as machines or automotive applications. The XBee radio module have not been approved for use in (this list is not exhaustive): medical devices nuclear applications explosive or flammable atmospheres...

  • Page 17: Sigurnosne Upute

    Safety instructions Sigurnosne upute Използвайте този продукт с антените, посочени в ръководствата за потребителя на модула XBee. Крайният потребител трябва да бъде казано как да премахне захранването от радиомодула XBee или да разположи антените на 20 см от хора или животни. Sigurnosne upute XBee moduli Radio modulu XBee ne može se jamčiti rad zbog radio veze i stoga se ne smije koristiti za...

  • Page 18: Sikkerhedsinstruktioner

    Safety instructions Sikkerhedsinstruktioner Při manipulaci buďte opatrní, aby nedošlo k elektrickému poškození desky plošných spojů a součástí. Nevystavujte rádiové moduly XBee vodě nebo vlhkosti. Používejte tento produkt s anténami uvedenými v uživatelských příručkách modulu XBee. Koncový uživatel musí být informován, jak odpojit napájení rádiového modulu XBee nebo jak umístit antény 20 cm od lidí...

  • Page 19: Ohutusjuhised

    Safety instructions Ohutusjuhised Er zijn geen door de gebruiker te onderhouden componenten in de XBee-radiomodule. Verwijder het schild niet en wijzig de XBee op geen enkele manier. Modificaties kunnen de module uitsluiten van enige garantie en kunnen ertoe leiden dat de XBee-radio werkt buiten de regelgeving voor een bepaald land, wat kan leiden tot de mogelijke illegale werking van de radio.

  • Page 20: Consignes De Sécurité

    Safety instructions Consignes de sécurité lukitsemiseen. XBee-radiomoduulia ei ole hyväksytty käytettäväksi (tämä luettelo ei ole tyhjentävä): lääketieteelliset laitteet ydinvoimasovellukset räjähdysvaarallisiin tai syttyviin tiloihin XBee-radiomoduulin sisällä ei ole käyttäjän huollettavia osia. Älä poista suojusta tai muokkaa XBeetä millään tavalla. Muutokset voivat sulkea moduulin takuun ulkopuolelle ja aiheuttaa sen, että...

  • Page 21: Sicherheitshinweise

    Safety instructions Sicherheitshinweise Sicherheitshinweise XBee-Module Der Betrieb des XBee-Funkmoduls kann aufgrund der Funkverbindung nicht garantiert werden und sollte daher nicht für Verriegelungen in sicherheitskritischen Geräten wie Maschinen oder Automobilanwendungen verwendet werden. Das XBee-Funkmodul ist nicht zugelassen für den Einsatz in (diese Liste ist nicht vollständig): Medizinprodukte nukleare Anwendungen explosive oder brennbare Atmosphären...

  • Page 22: Biztonsági Utasítások

    Safety instructions Biztonsági utasítások Προσέχετε κατά το χειρισμό για να αποφύγετε ηλεκτρική βλάβη στο PCB και στα εξαρτήματα. Μην εκθέτετε τις μονάδες ραδιοφώνου XBee σε νερό ή υγρασία. Χρησιμοποιήστε αυτό το προϊόν με τις κεραίες που καθορίζονται στους οδηγούς χρήσης της μονάδας...

  • Page 23: Drošības Instrukcijas

    Safety instructions Drošības instrukcijas illegale della radio. Utilizzare la protezione ESD standard del settore durante la manipolazione del modulo XBee. Prestare attenzione durante la manipolazione per evitare danni elettrici al PCB e ai componenti. Non esporre i moduli radio XBee all'acqua o all'umidità. Utilizzare questo prodotto con le antenne specificate nelle guide per l'utente del modulo XBee.

  • Page 24: Sikkerhetsinstruksjoner

    Safety instructions Sikkerhetsinstruksjoner XBee radijo modulio viduje nėra komponentų, kuriuos vartotojas galėtų prižiūrėti. Jokiu būdu nenuimkite skydo ir nekeiskite XBee. Dėl modifikacijų moduliui gali būti netaikoma jokia garantija, o „XBee“ radijas gali veikti ne pagal tam tikros šalies norminius reikalavimus, o tai gali sukelti neteisėtą...

  • Page 25: Instruções De Segurança

    Safety instructions Instruções de segurança wyroby medyczne zastosowania nuklearne atmosferach wybuchowych lub łatwopalnych Wewnątrz modułu radiowego XBee nie ma żadnych elementów, które mogłyby być serwisowane przez użytkownika. Nie zdejmuj osłony ani nie modyfikuj XBee w żaden sposób. Modyfikacje mogą wykluczyć moduł z jakiejkolwiek gwarancji i spowodować, że radio XBee będzie działać...

  • Page 26: Instructiuni De Siguranta

    Safety instructions Instructiuni de siguranta Instructiuni de siguranta module XBee Nu se poate garanta funcționarea modulului radio XBee din cauza conexiunii radio și, prin urmare, nu trebuie utilizat pentru interblocări în dispozitive critice pentru siguranță, cum ar fi mașini sau aplicații auto. Modulul radio XBee nu a fost aprobat pentru utilizare în (această...

  • Page 27: Varnostna Navodila

    Safety instructions Varnostna navodila Tento produkt používajte s anténami špecifikovanými v používateľských príručkách modulu XBee. Koncový používateľ musí byť informovaný o tom, ako odpojiť napájanie rádiového modulu XBee alebo ako umiestniť antény 20 cm od ľudí alebo zvierat. Varnostna navodila XBee moduli Radijskega modula XBee ni mogoče zagotoviti delovanja zaradi radijske povezave in ga zato ne smete uporabljati za zaklepanje v varnostno kritičnih napravah, kot so stroji ali avtomobilske...

  • Page 28: Säkerhets Instruktioner

    Safety instructions Säkerhets instruktioner No exponga los módulos de radio XBee al agua ni a la humedad. Utilice este producto con las antenas especificadas en las guías de usuario del módulo XBee. Se debe indicar al usuario final cómo desconectar la alimentación del módulo de radio XBee o ubicar las antenas a 20 cm de personas o animales.
  • Page 29 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 30: Regulatory Conformity Summary

    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 31: 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 32: 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 33: General Specifications

    Technical specifications General specifications Specification Condition Value RF data rate (software selectable) Low data rate 10 kb/s High data rate 80 kb/s Up to 15 dBm (32 mW) Transmit power (software selectable) EIRP Up to 13 dBm (20 mW) Maximum data throughput High data rate 38.4 kb/s Available channel frequencies...

  • Page 34: Gpio Specifications

    Technical specifications GPIO specifications Specification Value Restriction of Hazardous Substances (RoHS) Compliant Manufacturing ISO 9001:2008 registered standards Host interface connector 37 castellated SMT pads Antenna connector options U.FL or RF pad Antenna impedance 50 Ω unbalanced Maximum input RF level at antenna port 6 dBm Operating temperature -40°C to 85°C...
  • Page 35 Technical specifications LBT and AFA specifications Specification Condition Value Channel spacing 200 kHz Receiver bandwidth 150 kHz Modulation bandwidth < 300 kHz LBT threshold Low data rate < -95 dBm High data rate < -90 dBm TX on time < 1 second XBee®...

  • Page 36: 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 Network Assistant XBee Multi Programmer XBee® SX 868 RF Module User Guide...

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

  • Page 38: 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 39: Configure The Device Using Xctu

    XCTU User Guide. Click Discover devices and follow the instructions. XCTU should discover the connected XBee SX 868 RF Modules using the provided settings. Click Add selected devices. The devices appear in the Radio Modules list. You can click a module to view and configure its individual settings.
  • Page 40 Get started Configure remote devices These instructions show you how to configure the LT (Associated LED Blink Time) parameter on a remote device. 1. Add two XBee devices to XCTU. 2. Configure the first device in API mode and name it XBEE_A. 3.

  • Page 41: 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 42: Xbee Network Assistant

    The XBee Multi Programmer is a combination of hardware and software that enables partners and distributors to program multiple Digi Radio frequency (RF) devices simultaneously. It provides a fast and easy way to prepare devices for distribution or large networks deployment.
  • Page 43 Each XBee Multi Programmer board allows you to program up to six devices simultaneously. Connect more boards to increase the programming concurrency. Different board variants cover all the XBee form factors to program almost any Digi RF device. Download the XBee Multi Programmer application from: Digi XBee Multi Programmer...

  • Page 44: Hardware

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

  • Page 45: 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 46: Pin Signals

    Hardware Pin signals Pin signals The following table describes the pin signals. Low-asserted signals are distinguished with a horizontal line over the signal name. Default Name state Function Ground Power supply DOUT Output UART data out DIN/CONFIG Input UART data in DIO12 Disabled GPIO...
  • Page 47 Hardware Pin signals Default Name state Function RESET Drive low to reset device. Do not drive pin high; pin may only be driven open drain or low. Pin has an internal 20k pullup resistor. The minimum reset pulse time is 100 ns. DIO10/RSSI/PWM0 Output GPIO / RX Signal Strength Indicator...

  • Page 48: Pin Connection Recommendations

    Hardware Pin signals Default Name state Function other XBee devices for analog voltage reference. DIO5/ASSOC Output GPIO / Associate Indicator DIO6/RTS Disabled GPIO / UART Request to Send Flow Control DIO3/AD3 Disabled GPIO / Analog Input DIO2/AD2 Disabled GPIO / Analog Input DIO1/AD1 Disabled GPIO / Analog Input...

  • Page 49: 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 50: 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 51: 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 52: Spi Communications

    Serial communications Serial data A device sends data to the XBee SX 868 RF Module's UART through pin 4 DIN as an asynchronous serial signal. When the device is not transmitting data, the signals should idle high. 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.

  • Page 53: 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 54 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 55: Configuration Considerations

    By default, Digi configures DIO8 (SLEEP_REQUEST) as a peripheral and during pin sleep it wakes the device and puts it to sleep. This applies to both the UART and SPI serial interfaces.

  • Page 56: Data Format

    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 57: Serial Transmit Buffer

    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 58: Api Operating Mode

    Operation Serial interface protocols The device buffers data in the serial receive buffer and packetizes and transmits the data when it receives the following: No serial characters for the amount of time determined by the RO (Packetization Timeout) parameter. If RO = 0, packetization begins when the device received a character. Command Mode Sequence (GT + CC + GT).
  • Page 59 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 Software libraries XBee® SX 868 RF Module User Guide...

  • Page 60: Remote Configuration Commands

    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.

  • Page 61: Configure Devices

    Advanced application features Network commissioning and diagnostics Configure devices You can configure XBee devices locally through serial commands (AT or API) or remotely through remote API commands. API devices can send configuration commands to set or read the configuration 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...

  • Page 62: Place Devices

    Advanced application features Network commissioning and diagnostics Node replacement You can also use the AG command to update the routing table and DH/DL registers in the network after a device is replaced, and you can update the DH/DL registers of nodes in the network. To update only the routing table information without affecting the DH/DL registers, use Example 2.

  • Page 63: 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 AP (API Mode). The following sections list the steps based on the device's mode.

  • Page 64: 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 65 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 66 Advanced application features Network commissioning and diagnostics 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. Send the following API packet to the serial interface of the device outputting the results, device C. Note that device C can be the same device as device A or B (Whitespace delineates fields and bold text is the payload portion of the packet): 7E 0020 11 01 0013A20040521234 FFFE E6 E6 0014 C105 00 00 0013A2004052ABCD 0028 03E8 EB...

  • Page 67: Commissioning Pushbutton And Associate Led

    LED behaviors. The following features can be supported in hardware: TH RF Module A pushbutton and an LED can be connected to the 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 68 Advanced application features Network commissioning and diagnostics Button Sleep Presses configuration and sync status Action 0x95). Configured for synchronous Wakes the module for 30 seconds. Immediately sleep sends a Node Identification broadcast transmission. All devices that receive this transmission blink their Associate LED rapidly for 1 second.

  • Page 69: 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 70 Advanced application features I/O line monitoring Pin command parameter Description Digital input, monitored Digital output, low Digital output, high Alternate functionality, where applicable 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...
  • Page 71 Advanced application features I/O line monitoring Field Name Description bit 0 = AD0/DIO0 bit 1 = AD1/DIO1 bit 2 = AD2/DIO2 bit 3 = AD3/DIO3 bit 4 = DIO4 bit 5 = ASSOC/DIO5 bit 6 = RTS/DIO6 bit 7 = CTS/GPIO7 bit 8 = DTR / SLEEP_RQ / DIO8 bit 9 = ON_SLEEP / DIO9 bit 10 = RSSI/DIO10...

  • Page 72: Periodic I/O Sampling

    Advanced application features I/O line monitoring 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.

  • Page 73: 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 74 Advanced application features I/O line passing Command Description Device A Device B DIO2/AD2 3: Digital input 5: Digital output, HIGH DIO3/AD3 5: Digital output, HIGH 3: Digital input DIO3 Timeout 0x64 (10 seconds) Command Description Device A Device B Serial Number High 0x0013A200 0x0013A200 Serial Number Low...

  • Page 75: General Purpose Flash Memory

    This causes inputs to float high. 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 76: General Purpose Flash Memory Commands

    Advanced application features General Purpose Flash Memory The format of the response is similar to the request packet: Byte offset in Number of payload bytes Field name General field description GPM_CMD_ID This field is the same as the request field. GPM_STATUS Status indicating whether the command was successful.
  • Page 77 Advanced application features General Purpose Flash Memory Field name Command-specific description bits are reserved at this time. GPM_BLOCK_NUM Indicates the number of GPM blocks available. GPM_START_INDEX Indicates the size, in bytes, of a GPM block. GPM_NUM_BYTES The number of bytes in the GPM_DATA field. For this command, this field will be set to 0.
  • Page 78 Advanced application features General Purpose Flash Memory Field name Command-specific description GPM_CMD_ID Should be set to ERASE_RESPONSE (0x81). GPM_STATUS A 1 in the least significant bit indicates an error occurred. All other bits are reserved at this time. GPM_BLOCK_NUM Matches the parameter passed in the request frame. GPM_START_INDEX Matches the parameter passed in the request frame.
  • Page 79 Advanced application features General Purpose Flash Memory WRITE _RESPONSE (0x82) and ERASE_THEN_WRITE_RESPONSE (0x83) When a WRITE or ERASE_THEN_WRITE command request has been unicast to a node, that node sends a response in the following format to the source endpoint specified in the requesting frame. Field name Command-specific description GPM_CMD_ID...
  • Page 80 Advanced application features General Purpose Flash Memory Field name Command-specific description command fields) cannot exceed the maximum payload size of the device. You can query the maximum payload size with the NP AT command. GPM_DATA No data bytes should be specified for this command. READ_RESPONSE (0x84) When a READ command request has been unicast to a node, that node sends a response in the following format to the source endpoint specified in the requesting frame.
  • Page 81 Advanced application features General Purpose Flash Memory Field name Command-specific description GPM_BLOCK_NUM This field is unused for this command. Set to 0. GPM_START_INDEX This field is unused for this command. Set to 0. GPM_NUM_BYTES This field is unused for this command. Set to 0. GPM_DATA This field is unused for this command FIRMWARE_VERIFY_RESPONSE (0x85)

  • Page 82: 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 83: Verify The New Application

    Advanced application features Over-the-air firmware updates Send the contents of the .ebin file to the target device using general purpose memory WRITE commands. Erase the entire GPM prior to beginning an upload of an .ebin file. The contents of the .ebin file should be stored in order in the appropriate GPM memory blocks.

  • Page 84: Software Libraries

    (accessible over the RF port) the same process can be used to update firmware on a device in either case. Software libraries One way to communicate with the XBee SX 868 RF Module is by using a software library. The libraries available for use with the XBee SX 868 RF Module include: XBee Java library XBee Python library The XBee Java Library is a Java API.

  • Page 85: 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 86: Directed Broadcast/Repeater Mode

    Networking methods Directed Broadcast/Repeater mode Directed Broadcast/Repeater mode In this delivery method, the device sends all outgoing transmissions as broadcasts. Unicast messages are sent as broadcasts, but are addressed to a specific receiver. Only the specified device will emit the received frame out of the serial port.

  • Page 87: Digimesh Feature Set

    Networking methods DigiMesh networking Route discovery. Rather than maintaining a network map, routes will be discovered and created only when needed. 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.

  • Page 88: Networking Concepts

    Networking methods Networking concepts 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 89: Routing

    Networking methods Data transmission and routing In order to avoid RF packet collisions, the network inserts a random delay before each router relays the broadcast message. You can change this random delay time with the NN parameter. Sending frequent broadcast transmissions can quickly reduce the available network bandwidth. Use broadcast transmissions sparingly.

  • Page 90: Transmission Timeouts

    Networking methods Data transmission and routing The following table shows the results of this test with various configurations. All measurements were acquired by streaming 10,000 bytes of data in Transparent mode from the transmitter to the receiver at a baud rate of 115,200 b/s. Configuration Data throughput Point to Point, encryption disabled...
  • Page 91 Networking methods Data transmission and routing Note The timeouts in this documentation are theoretical timeouts and are not precisely accurate. Your application should pad the calculated maximum timeouts by a few hundred milliseconds. When you use API operating mode, use Extended Transmit Status - 0x8B as the primary method to determine if a transmission is complete.
  • Page 92 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 93: 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 94: Troubleshooting

    Modes Command mode command character (CC) and the silence before and after the sequence (GT) are configurable. When the entrance criteria are met the device responds with OK\r on UART signifying that it has entered Command mode successfully and is ready to start processing AT commands. If configured to operate in Transparent operating mode, when entering Command mode the XBee SX...

  • Page 95: Response To At Commands

    AT command parameters. Valid formats for hexidecimal values include with or without a leading 0x for example FFFF or 0xFFFF. Response to AT commands When using AT commands to set parameters the XBee SX 868 RF Module responds with OK<cr> if successful and ERROR<cr> if not. Apply command changes Any changes you make to the configuration command registers using AT commands do not take effect until you apply the changes.

  • Page 96: 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 97 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 98: 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 99: Asynchronous Cyclic Sleep Mode

    Sleep modes Asynchronous cyclic sleep mode When you assert SLEEP_RQ (high), the device finishes any transmit or receive operations and enters a low-power state. When you de-assert SLEEP_RQ (low), the device wakes from pin sleep. Asynchronous cyclic sleep mode Set SM to 4 to enter asynchronous cyclic sleep mode. Cyclic sleep allows the device to sleep for a specific time and wake for a short time to poll.

  • Page 100: 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 101: Polling

    Sleep modes Sleeping routers Indirect messaging only functions with P2MP unicast messages. Indirect messaging has no effect on P2MP broadcasts, directed broadcasts, repeater packets, or DigiMesh packets. 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 102 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 103 Sleep modes Sleep coordinator sleep modes in the DigiMesh network XBee® SX 868 RF Module User Guide...

  • Page 104: 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 105 Sleep modes Sleep coordinator sleep modes in the DigiMesh network sent. 2. Otherwise, the node with the preferred sleep coordinator bit set takes precedence. 3. Otherwise, a sleep support node—SM 7—takes priority over a node that is not a sleep support node—SM 8.

  • Page 106: 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 107: Synchronous Pulse

    Sleep modes Sleep coordinator sleep modes in the DigiMesh network Synchronous pulse The Synchronous pulse feature supports user applications that desire synchronizing operations across multiple devices in a network. This is done by pulsing the DIO9—ON_SLEEP—pin simultaneously on all devices in the network. Typically, this feature is used with a mains-powered application and transmissions are not inhibited except during the small window of time allocated for sending synchronization messages throughout the network.

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

    Sleep modes Sleep coordinator sleep modes in the DigiMesh network 3. Power on the new nodes within range of the sleep coordinator. The nodes quickly receive a sync message and synchronize themselves to the short cycle SP and ST set on the sleep coordinator.

  • Page 109: Change Sleep Parameters

    Sleep modes Sleep coordinator sleep modes in the DigiMesh network If you do not use one of these two methods, you must wait for the network to wake up before adding the new node. Place the new node in range of the network with a sleep/wake cycle that is shorter than the wake period of the network.

  • Page 110: Diagnostics

    Sleep modes Sleep coordinator sleep modes in the DigiMesh network When you use the default DigiMesh sleep parameters, separated subnets do not drift out of phase with each other. Subnets can drift out of phase with each other if you configure the network in one of the following ways: 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.
  • Page 111 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 112 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 113: Special Commands

    AT commands Special commands Special commands The following commands are special commands. AC (Apply Changes) This command applies to the XBee SX 868 RF Module. Immediately applies new settings without exiting Command mode. Parameter range Default FR (Software Reset) This command applies to the XBee SX 868 RF Module.

  • Page 114: Mac/Phy Commands

    The following AT commands are MAC/PHY commands. CM (Channel Mask) This command applies to the XBee SX 868 RF Module. 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 115: Id (Network Id)

    AT commands MAC/PHY commands ID (Network ID) This command applies to the XBee SX 868 RF Module. Set or read the user network identifier. Devices must have the same network identifier to communicate with each other. When receiving a packet, the device check this after the preamble ID. If you are using Original equipment manufacturer (OEM) network IDs, 0xFFFF uses the factory value.

  • Page 116: Rr (Unicast Mac Retries)

    Default RR (Unicast Mac Retries) This command applies to the XBee SX 868 RF Module. Set or read the maximum number of MAC level packet delivery attempts for unicasts. If RR is non- zero, the sent unicast packets request an acknowledgment from the recipient. Unicast packets can be retransmitted up to RR times if the transmitting device does not receive a successful acknowledgment.

  • Page 117: Lb (Lna Bypass)

    Diagnostic commands LB (LNA Bypass) This command applies to the XBee SX 868 RF Module. Sets or reads the LNA bypass enable of the device. If the LNA bypass is enabled, the RX current draw improves by 6 mA while the RX sensitivity degrades by approximately 12 dB.

  • Page 118: Er (Received Error Count)

    Default ER (Received Error Count) This command applies to the XBee SX 868 RF Module. This count increments when a device receives a packet that contains integrity errors of some sort. When the number reaches 0xFFFF, the firmware does not count further events.

  • Page 119: Ua (Mac Unicast Transmission Count)

    Default UA (MAC Unicast Transmission Count) This command applies to the XBee SX 868 RF Module. This count increments whenever a MAC unicast transmission occurs that requests an ACK. Once the number reaches 0xFFFF, it does not count further events.

  • Page 120: Ce (Node Messaging Options)

    AT commands Network commands CE (Node Messaging Options) This command applies to the XBee SX 868 RF Module. The routing and messaging mode bit field of the device. A routing device repeats broadcasts. Indirect Messaging Coordinators do not transmit point-to- multipoint unicasts until an end device requests them.

  • Page 121: Bh (Broadcast Hops)

    Default 0x04 BH (Broadcast Hops) This command applies to the XBee SX 868 RF Module. 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 122: Addressing Commands

    The following AT commands are addressing commands. SH (Serial Number High) This command applies to the XBee SX 868 RF Module. Displays the upper 32 bits of the unique IEEE 64-bit extended address assigned to the XBee in the factory.

  • Page 123: To (Transmit Options)

    Default 0x0000FFFF TO (Transmit Options) This command applies to the XBee SX 868 RF Module. 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 124: Nt (Node Discover Timeout)

    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. 0x02 Append the RSSI of the last hop to ND, FN responses or API node identification frames.

  • Page 125: Ci (Cluster Id)

    AT commands Addressing commands Option Description Option Description Append the DD (Digi Device Identifier) value to ND responses or API node identification 0x01 frames. Local device sends ND response frame when the ND is issued. 0x02 Default CI (Cluster ID) This command applies to the XBee SX 868 RF Module.

  • Page 126: Addressing Discovery/Configuration Commands

    Addressing discovery/configuration commands Addressing discovery/configuration commands AG (Aggregator Support) This command applies to the XBee SX 868 RF Module. The AG command sends a broadcast through the network that has the following effects on nodes that receive the broadcast: The receiving node establishes a DigiMesh route back to the originating node, if there is space in the routing table.

  • Page 127: Fn (Find Neighbors)

    PROFILE_ID<CR> (2 bytes) MANUFACTURER_ID<CR> (2 bytes) DIGI DEVICE TYPE<CR> (4 bytes. Optionally included based on NO settings.) RSSI OF LAST HOP<CR> (1 byte. Optionally included based on NO settings.) After (NT * 100) milliseconds, the command ends by returning a <CR>.

  • Page 128: Diagnostic - Addressing Commands

    The following AT command is a Diagnostic - addressing command. N? (Network Discovery Timeout) This command applies to the XBee SX 868 RF Module. The maximum response time, in milliseconds, for ND (Network Discovery) responses and DN (Discover Node) responses. The timeout is the sum of NT (Network Discovery Back-off Time) and the network propagation time.

  • Page 129: Ky (Aes Encryption Key)

    Default KY (AES Encryption Key) This command applies to the XBee SX 868 RF Module. Sets the network security key value that the device uses for encryption and decryption. When using ECB (compatibility) mode, the LS 128 bits of the specified KY value are used. Otherwise, all 256 bits are used.

  • Page 130: Nb (Parity)

    9600 19200 38400 57600 115200 230400 Default NB (Parity) This command applies to the XBee SX 868 RF Module. Set or read the serial parity settings for UART communications. Parameter range 0x00 - 0x02 Parameter Description 0x00 No parity XBee® SX 868 RF Module User Guide...

  • Page 131: Sb (Stop Bits)

    No parity Even parity Odd parity Default 0x00 SB (Stop Bits) This command applies to the XBee SX 868 RF Module. Sets or displays the number of stop bits for UART communications. Parameter range 0 - 1 Parameter Configuration One stop bit...

  • Page 132: Ap (Api Mode)

    CTS when less than FT-16 bytes are in the UART receive buffer. Parameter range 0x1A - 0x166 bytes Default 0x11D AP (API Mode) This command applies to the XBee SX 868 RF Module. Sets or reads the UART API mode. Parameter range 0 - 2 The following settings are allowed: Parameter Description Transparent mode, API mode is off.

  • Page 133: I/O Settings Commands

    The following AT commands are I/O settings commands. CB (Commissioning Pushbutton) This command applies to the XBee SX 868 RF Module. 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 134: D2 (Dio2/Ad2)

    Description Disabled Digital input Digital output, low Digital output, high Default D2 (DIO2/AD2) This command applies to the XBee SX 868 RF Module. Sets or displays the DIO2/AD2 configuration (pin 31). Parameter range 0, 2 - 5 Parameter Description Disabled...

  • Page 135: D4 (Dio4)

    Description Disabled Digital input Digital output, low Digital output, high Default D4 (DIO4) This command applies to the XBee SX 868 RF Module. Sets or displays the DIO4 configuration (pin 24). Parameter range 0, 3 - 5 Parameter Description Disabled...

  • Page 136: D6 (Dio6/Rts)

    Digital input Digital output, default low Digital output, default high Default D6 (DIO6/RTS) This command applies to the XBee SX 868 RF Module. Sets or displays the DIO6/RTS configuration (pin 29). Parameter range 0, 1, 3 - 5 Parameter Description...

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

    RS-485 Tx enable high, high Tx (high on transmit, 0 V when idle) Default D8 (DIO8/DTR/SLEEP_REQUEST) This command applies to the XBee SX 868 RF Module. Sets or displays the DIO8/SLEEP_REQUEST configuration (pin 10). Parameter range 0, 1, 3 - 5...

  • Page 138: P0 (Dio10/Rssi/Pwm0 Configuration)

    Digital input Digital output, low Digital output, high Synchronous pulse output Default P0 (DIO10/RSSI/PWM0 Configuration) This command applies to the XBee SX 868 RF Module. Sets or displays the PWM0/RSSI/DIO10 configuration (pin 7). Parameter range 0 - 5 Parameter Description...

  • Page 139: P2 (Dio12 Configuration)

    PWM1 output Digital input Digital output, low Digital output, high Default P2 (DIO12 Configuration) This command applies to the XBee SX 868 RF Module. Sets or displays the DIO12 configuration (pin 5). Parameter range 0, 3 - 5 Parameter Description...

  • Page 140: P4 (Din/Config)

    AT commands I/O settings commands Parameter Description Disabled UART DOUT enabled Default P4 (DIN/CONFIG) This command applies to the XBee SX 868 RF Module. Sets or displays the DIN/CONFIG configuration (pin 4). Parameter range Parameter Description Disabled UART DIN/CONFIG enabled Default P5 (DIO15/SPI_MISO Configuration) This command applies to the XBee SX 868 RF Module.

  • Page 141: P6 (Spi_Mosi Configuration)

    AT commands I/O settings commands P6 (SPI_MOSI Configuration) This command applies to the XBee SX 868 RF Module. Sets or displays the DIO16/SPI_MOSI configuration (pin 16). Parameter range 0, 1, 4, 5 Parameter Description Disabled SPI_MOSI Digital output low Digital output, high...

  • Page 142: P9 (Dio19/Spi_Attn)

    Description Disabled SPI_SCLK Digital output low Digital output high Default P9 (DIO19/SPI_ATTN) This command applies to the XBee SX 868 RF Module. Sets or displays the DIO19/SPI_ATTN configuration (pin 12). Parameter range 0, 1, 4 - 6 Parameter Description Disabled...

  • Page 143: Pr (Pull-Up/Down Resistor Enable)

    0xFFFFF PR (Pull-up/Down Resistor Enable) This command applies to the XBee SX 868 RF Module. The bit field that configures the internal pull-up resistor status for the I/O lines. If you set a PR bit to 1, it enables the pull-up/down resistor If you set a PR bit to 0, it specifies no internal pull-up/down resistor.

  • Page 144: Rp (Rssi Pwm Timer)

    0x14 - 0xFF (x 10 ms) Default RP (RSSI PWM Timer) This command applies to the XBee SX 868 RF Module. The PWM timer expiration in 0.1 seconds. RP sets the duration of pulse width modulation (PWM) signal output on the RSSI pin.

  • Page 145: If (Sleep Sample Rate)

    Default IF (Sleep Sample Rate) This command applies to the XBee SX 868 RF Module. Set or read the number of sleep cycles that must elapse between periodic I/O samples. This allows the firmware to take I/O samples only during some wake cycles. During those cycles, the firmware takes I/O samples at the rate specified by IR.

  • Page 146: Ir (I/O Sample Rate)

    Default IR (I/O Sample Rate) This command applies to the XBee SX 868 RF Module. Set or read the I/O sample rate to enable periodic sampling. If you set the I/O sample rate to greater than 0, the device samples all enabled digital I/O and analog inputs at a specified interval.

  • Page 147: Voltage Supply Monitoring)

    AT commands I/O line passing commands %V (Voltage Supply Monitoring) This command applies to the XBee SX 868 RF Module. 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.

  • Page 148: T0 (D0 Timeout)

    0xFFFFFFFFFFFFFFFF (I/O line passing disabled) T0 (D0 Timeout) This command applies to the XBee SX 868 RF Module. Specifies how long pin D0 holds a given value before it reverts to configured value. If set to 0, there is no timeout.

  • Page 149: T4 (D4 Output Timeout)

    0 - 0x1770 (x 100 ms) Default T4 (D4 Output Timeout) This command applies to the XBee SX 868 RF Module. Specifies how long pin D4 holds a given value before it reverts to configured value. If set to 0, there is no timeout.

  • Page 150: T8 (D8 Timeout)

    0 - 0x1770 (x 100 ms) Default T8 (D8 Timeout) This command applies to the XBee SX 868 RF Module. Specifies how long pin D8 holds a given value before it reverts to configured value. If set to 0, there is no timeout.

  • Page 151: Q2 (P2 Timeout)

    0 - 0x1770 (x 100 ms) Default Q2 (P2 Timeout) This command applies to the XBee SX 868 RF Module. Specifies how long pin P2 holds a given value before it reverts to configured value. If set to 0, there is no timeout.

  • Page 152: Sleep Commands

    0xFF Sleep commands The following AT commands are sleep commands. SM (Sleep Mode) This command applies to the XBee SX 868 RF Module. Sets or displays the sleep mode of the device. Parameter range 0, 1, 4, 5, 7, 8...

  • Page 153: Sn (Number Of Sleep Periods)

    0x2 (non-sleep coordinator) SN (Number of Sleep Periods) This command applies to the XBee SX 868 RF Module. Set or read the number of sleep periods value. This command controls the number of sleep periods that must elapse between assertions of the ON_SLEEP line during the wake time of Asynchronous Cyclic Sleep.

  • Page 154: St (Wake Time)

    0x190 (4 seconds) ST (Wake Time) This command applies to the XBee SX 868 RF Module. Sets or displays the wake time of the device. For devices in asynchronous sleep, ST defines the amount of time that a device stays awake after it receives RF or serial data.

  • Page 155: Os (Operating Sleep Time)

    0x40 OS (Operating Sleep Time) This command applies to the XBee SX 868 RF Module. Reads the current network sleep time that the device is synchronized to, in units of 10 milliseconds. If the device has not been synchronized, then OS returns the value of SP.

  • Page 156: Ms (Missed Sync Messages)

    AT commands Command mode options MS (Missed Sync Messages) This command applies to the XBee SX 868 RF Module. 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) This command applies to the XBee SX 868 RF Module.

  • Page 157: Cn (Exit Command Mode)

    AT commands Firmware commands Default 0x64 (10 seconds) CN (Exit Command Mode) This command applies to the XBee SX 868 RF Module. Immediately exits Command Mode and applies pending changes. Parameter range Default GT (Guard Times) This command applies to the XBee SX 868 RF Module.

  • Page 158: Hv (Hardware Version)

    Default Set in the firmware DD (Device Type Identifier) This command applies to the XBee SX 868 RF Module. Stores the Digi device type identifier value. Use this value to differentiate between multiple XBee devices. Parameter range 0 - 0xFFFFFFFF...

  • Page 159: Ck (Configuration Crc)

    AT commands Firmware commands CK (Configuration CRC) This command applies to the XBee SX 868 RF Module. Displays the cyclic redundancy check (CRC) of the current AT command configuration settings. Parameter range Default XBee® SX 868 RF Module User Guide...
  • Page 160 Operate in API mode API mode overview Use the AP command to set the operation mode API frame format API serial exchanges XBee® SX 868 RF Module User Guide...

  • Page 161: Operate In Api Mode

    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 162: 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 163 Operate in API mode API frame format Example: escape an API frame To express the following API non-escaped frame in API operating mode with escaped characters: Frame Data Start delimiter Length Frame type Checksum 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 164: 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 165: 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 166 Frame descriptions The following sections describe the API frames. Local AT Command Request - 0x08 Queue Local AT Command Request - 0x09 Transmit Request - 0x10 Explicit Addressing Command Request - 0x11 Remote AT Command Request - 0x17 Local AT Command Response - 0x88 Modem Status - 0x8A Modem status codes Extended Transmit Status - 0x8B...

  • Page 167: Local At Command Request - 0X08

    Frame descriptions Local AT Command Request - 0x08 Local AT Command Request - 0x08 Response frame: Local AT Command Response - 0x88 Description This frame type is used to query or set command parameters on the local device. Any parameter that is set with this frame type will apply the change immediately.
  • Page 168 Frame descriptions Local AT Command Request - 0x08 Frame type Frame ID AT command Parameter value 0x08 0xA1 0x4E49 0x456E6420446576696365 Request Matches response "NI" "End Device" Query local command parameter Query the temperature of the module—TP command. The corresponding Local AT Command Response - 0x88 with a matching Frame ID will return the temperature value.

  • Page 169: Queue Local At Command Request - 0X09

    Frame descriptions Queue Local AT Command Request - 0x09 Queue Local AT Command Request - 0x09 Response frame: Local AT Command Response - 0x88 Description This frame type is used to query or set queued command parameters on the local device. In contrast Local AT Command Request - 0x08, this frame queues new parameter values and does not apply them until you either:...
  • Page 170 Frame descriptions Queue Local AT Command Request - 0x09 Queue setting local command parameter Set the UART baud rate to 115200, but do not apply changes immediately. The device will continue to operate at the current baud rate until the change is applied with a subsequent AC command.

  • Page 171: Transmit Request - 0X10

    Frame descriptions Transmit Request - 0x10 Transmit Request - 0x10 Response frame: Extended Transmit Status - 0x8B Description This frame type is used to send payload data as an RF packet to a specific destination. This frame type is typically used for transmitting serial data to one or more remote devices. The endpoints used for these data transmissions are defined by the SE and EP commands and the cluster ID defined by the CI command—excluding 802.15.4.

  • Page 172: Transmit Options Bit Field

    Frame descriptions Transmit Request - 0x10 Offset Size Frame Field Description options options. If set to 0, the value of TO specifies the transmit options. Payload Data to be sent to the destination device. Up to NP bytes per 17-n variable data packet. 8-bit Checksum 0xFF minus the 8-bit sum of bytes from offset 3 to this byte (between length and checksum).
  • Page 173 Frame descriptions Transmit Request - 0x10 Bcast Frame radius type Frame ID 64-bit dest Reserved Options RF data 0x10 0x52 0x0013A200 0xFFFE 0x00 0x00 0x547844617461  12345678 Request Matches Destination Unused Will use "TxData" response 64-bit broadcast Sending a broadcast transmission of the serial data "Broadcast" to neighboring devices and suppressing the corresponding response by setting Frame ID to 0.

  • Page 174: Explicit Addressing Command Request - 0X11

    Cannot be used on XBee 802.15.4 firmware. Reserved profile IDs The Digi profile ID of 0xC105 should be used when sending serial data between XBee devices. Format The following table provides the contents of the frame. For details on the frame structure, see frame format.

  • Page 175: Transmit Options Bit Field

    Frame descriptions Explicit Addressing Command Request - 0x11 Offset Size Frame Field Description 8-bit Start Delimiter Indicates the start of an API frame. 16-bit Length Number of bytes between the length and checksum. Frame type Explicit Addressing Command Request - 0x11 8-bit Frame ID Identifies the data frame for the host to correlate with a...

  • Page 176: Examples

    0x001 0xC10 0x00 0x00 0x547844617 461  12345678 Explici Matche Destinati Unused Digi Digi Data Digi "TxData" data profile reque respon Loopback Packet Sending a loopback transmission to an device with the 64-bit address of 0013A20012345678 using Cluster ID 0x0012. To better understand the raw performance, retries and acknowledgements are disabled.
  • Page 177 EP t EP data 0x0013A2 0x11 0xF8 0xFFFE 0xE8 0x001 0xC10 0x00 0x01 0x547844617 461  12345678 Explici Matche Destinati Unused Digi Digi Data Digi Disabl "TxData" data profile reque respon retries XBee® SX 868 RF Module User Guide...

  • Page 178: Remote At Command Request - 0X17

    Frame descriptions Remote AT Command Request - 0x17 Remote AT Command Request - 0x17 Response frame: Remote AT Command Response- 0x97 Description This frame type is used to query or set AT command parameters on a remote device. For parameter changes on the remote device to take effect, you must apply changes, either by setting the Apply Changes options bit, or by sending an AC command to the remote.

  • Page 179: Examples

    Frame descriptions Remote AT Command Request - 0x17 Offset Size Frame Field Description command change is received with this bit set Bit 2: Reserved (set to 0) Bit 3: Reserved (set to 0) Bit 4: Send the remote command securely [0x10] Note Option values may be combined. Set all unused bits to 0.
  • Page 180 Frame descriptions Remote AT Command Request - 0x17 Frame Command Parameter type Frame ID 64-bit dest Reserved options command value 0x17 0x68 0x0013A200 0xFFFE 0x00 0x4944 0x0451 12345678 Unused Request Matches Queue Change "ID" response Query remote command parameter Query the temperature of a remote device—TP command. corresponding Remote AT Command Response- 0x97 with a matching Frame ID will return the temperature value.

  • Page 181: Local At Command Response - 0X88

    Frame descriptions Local AT Command Response - 0x88 Local AT Command Response - 0x88 Request frames: Local AT Command Request - 0x08 Queue Local AT Command Request - 0x09 Description This frame type is emitted in response to a local AT Command request. Some commands send back multiple response frames;...
  • Page 182 Frame descriptions Local AT Command Response - 0x88 Set local command parameter Host set the NI string of the local device to "End Device" using a 0x08 request frame. The corresponding Local AT Command Response - 0x88 with a matching Frame ID is emitted as a response: 7E 00 05 88 01 4E 49 00 DF Frame...

  • Page 183: Modem Status - 0X8A

    0x0B = Network woke up 0x0C = Network went to sleep 0x0D = Voltage supply limit exceeded 0x0E = Digi Remote Manager connected 0x0F = Digi Remote Manager disconnected 0x11 = Modem configuration changed while join in progress 0x12 = Access fault...

  • Page 184: Modem Status Codes

    Frame descriptions Modem status codes Frame Offset Size Field Description 0x42 = Network Watchdog timeout expired 0x80 through 0xFF = Stack error Refer to the tables below for a filtered list of status codes that are appropriate for specific devices. 8-bit Checksum 0xFF minus the 8-bit sum of bytes from offset 3 to this byte (between length and checksum).

  • Page 185: Extended Transmit Status - 0X8B

    Frame descriptions Extended Transmit Status - 0x8B Extended Transmit Status - 0x8B Request frames: Transmit Request - 0x10 Explicit Addressing Command Request - 0x11 Description This frame type is emitted when a network transmission request completes. The status field of this frame indicates whether the request succeeded or failed and the reason.
  • Page 186 Frame descriptions Extended Transmit Status - 0x8B Offset Size Frame Field Description 0x00 = No discovery overhead status 0x02 = Route discovery 8-bit Checksum 0xFF minus the 8-bit sum of bytes from offset 3 to this byte (between length and checksum). XBee®...

  • Page 187: Route Information - 0X8D

    Frame descriptions Route Information - 0x8D Route Information - 0x8D Request frames: Transmit Request - 0x10 Explicit Addressing Command Request - 0x11 Description This frame type contains the DigiMesh routing information for a remote device on the network. This route information can be used to diagnose marginal links between devices across multiple hops. This frame type is emitted in response to a DigiMesh unicast transmission request which has Trace Routing or NACK enabled.

  • Page 188: Examples

    Frame descriptions Route Information - 0x8D Offset Size Frame Field Description address Information packet after it sends (or attempts to send) the data packet to the next hop (the Receiver node). 64-bit Receiver The 64-bit IEEE address of the node that the device sends (or address attempts to send) the data packet.

  • Page 189: Aggregate Addressing Update - 0X8E

    Frame descriptions Aggregate Addressing Update - 0x8E Aggregate Addressing Update - 0x8E Description This frame type is emitted on devices that update it addressing information in response to a network aggregator issuing an addressing update. A network aggregator is defined by a device on the network who has had the AG (Aggregator Support) command issued.

  • Page 190: Receive Packet - 0X90

    Frame descriptions Receive Packet - 0x90 Receive Packet - 0x90 Request frames: Transmit Request - 0x10 Explicit Addressing Command Request - 0x11 Description This frame type is emitted when a device configured with standard API output—AO (API Options) = 0— receives an RF data packet.

  • Page 191: Examples

    Frame descriptions Receive Packet - 0x90 Offset Size Frame Field Description Note Option values may be combined. 15-n variable Received The RF payload data that the device receives. data 8-bit Checksum 0xFF minus the 8-bit sum of bytes from offset 3 to this byte (between length and checksum).

  • Page 192: Explicit Receive Indicator - 0X91

    The Profile ID that the fame is addressed to. Bit field of options that apply to the received message for 8-bit Receive packets sent using Digi endpoints (0xDC-0xEE): options Bit 0: Packet was Acknowledged [0x01] Bit 1: Packet was sent as a broadcast [0x02]...

  • Page 193: Examples

    Received data 0x0013A200 0x91 0x87BD 0xE8 0xE8 0x0011 0xC105 0xC1 0x54784461746 41AEB54E 1  Unused Explicit Digi Digi Data Digi ACK was "TxData" output data data profile sent in DigiMesh network I/O Sample Indicator - 0x92 Description This frame type is emitted when a device configured with standard API output—AO (API Options)
  • Page 194 Frame descriptions I/O Sample Indicator - 0x92 Format Frame Offset Size Field Description 8-bit Start Indicates the start of an API frame. Delimiter 16-bit Length Number of bytes between the length and checksum. Frame type I/O Sample Indicator - 0x92 8-bit The sender's 64-bit IEEE address.

  • Page 195: Examples

    Frame descriptions I/O Sample Indicator - 0x92 Frame Offset Size Field Description bit 3: AD3 bit 7: Supply Voltage (enabled with V+ command) If the sample set includes any digital I/O lines (Digital channel 16-bit Digital mask > 0), this field contain samples for all enabled digital I/O samples (if lines.

  • Page 196: Node Identification Indicator - 0X95

    Frame descriptions Node Identification Indicator - 0x95 Node Identification Indicator - 0x95 Description This frame type is emitted when a node identification broadcast is received. The node identification indicator contains information about the identifying device, such as address, identifier string (NI), and other relevant data.

  • Page 197: Examples

    30+NI 8-bit Source event to be sent. 0 = Reserved 1 = Frame sent by node identification pushbutton event—see (DIO0/AD0). The Digi application Profile ID— 0xC105 . 31+NI 16-bit Digi Profile ID The Digi Manufacturer ID— 0x101E . 33+NI 16-bit Digi...
  • Page 198 NI String type le ID 0x0013A 0x0013A 0x95 0xFFFE 0xC2 0x4C48373 0xFFFE 0x01 0x01 0xC1 0x10 5 00 1234567 1234567 Identifica Unuse Unuse DigiMe "LH75" + Rout Butt Digi Digi tion null broadc press XBee® SX 868 RF Module User Guide...

  • Page 199: Remote At Command Response- 0X97

    Frame descriptions Remote AT Command Response- 0x97 Remote AT Command Response- 0x97 Request frame: Remote AT Command Request - 0x17 Description This frame type is emitted in response to a Remote AT Command Request - 0x17. Some commands send back multiple response frames; for example, the ND command. Refer to individual AT command descriptions for details on API response behavior.

  • Page 200: Examples

    Frame descriptions Remote AT Command Response- 0x97 Examples Each example is written without escapes (AP = 1) and all bytes are represented in hex format. For brevity, the start delimiter, length, and checksum fields have been excluded. Set remote command parameter Host set the NI string of a remote device to "Remote"...
  • Page 201 Frame descriptions Remote AT Command Response- 0x97 Frame 64-bit Command Command type Frame ID source Reserved command Status data 0x97 0x27 0x0013A200 0x0013A200 0x4944 0x00 0x002F 12345678 12345678 Unused Response Matches "TP" Success +47 °C request XBee® SX 868 RF Module User Guide...

  • Page 202: Regulatory Information

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

  • Page 203: Europe (Ce)

    Europe (CE) Europe (CE) The XBee SX 868 RF Module has been tested for use in several European countries. For a complete list, refer to www.digi.com/resources/certifications. If 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 204: 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 205: Pcb Design And Manufacturing

    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 206: 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 207 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 208: 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 209: Improve Antenna Performance

    PCB design and manufacturing Design notes Improve antenna performance The choice of antenna and antenna location is important for optimal performance. In general, antenna elements radiate perpendicular to the direction they point. Thus a vertical antenna, such as a dipole, emit across the horizon. Metal objects near the antenna cause parasitic coupling and detuning, preventing the antenna from radiating efficiently.

  • Page 210: Recommended Solder Reflow Cycle

    PCB design and manufacturing Recommended solder reflow cycle Number Description XBee pin 36 50 Ω microstrip trace Back off ground fill at least twice the distance between layers 1 and 2 RF connector Stitch vias near the edges of the ground plane Pour a solid ground plane under the RF trace on the reference layer Implementing these design suggestions helps ensure that the RF pad device performs to specifications.

  • Page 211: 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 212 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