Digi XBee Manual
  1. Manuals
  2. Brands
  3. Digi Manuals
  4. Control Unit
  5. XBee
  6. Manual

Digi XBee Manual

Digimesh 2.4 rf modules
Hide thumbs Also See for XBee:
Table of Contents

Advertisement

Quick Links

Download this manual
XBee®/XBee-PRO® DigiMesh™ 2.4 RF Modules
XBee® DigiMesh 2.4 RF Modules
RF Module Operation
RF Module Configuration
RF Modules by Digi International
Firmware version:
8x4x XBee/XBee-PRO DigiMesh 2.4
28x4x XBee/XBee-PRO DigiMesh 2.4 (International variant)
90000991_B
3/23/2010

Advertisement

Table of Contents
loading
Need help?

Need help?

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

Questions and answers

Related Manuals for Digi XBee

Summary of Contents for Digi XBee

  • Page 1 XBee®/XBee-PRO® DigiMesh™ 2.4 RF Modules XBee® DigiMesh 2.4 RF Modules RF Module Operation RF Module Configuration RF Modules by Digi International Firmware version: 8x4x XBee/XBee-PRO DigiMesh 2.4 28x4x XBee/XBee-PRO DigiMesh 2.4 (International variant) 90000991_B 3/23/2010...
  • Page 2 © 2010 Digi International, Inc. All rights reserved No part of the contents of this manual may be transmitted or reproduced in any  form or by any means without the written permission of Digi International, Inc. XBee®/XBee‐PRO® and DigiMesh are trademarks or registered trademarks of  Digi International, Inc. Technical Support:  Phone: (801) 765‐9885 Live Chat: www.digi.com Online support: http://www.digi.com/support/eservice/eservicelogin.jsp   ...

  • Page 3: Table Of Contents

    XBee/XBee‐PRO 2.4 RF Modules Table of Contents 1. XBee/XBee-PRO 2.4 RF Modules 4 4.4.2. Broadcast Addressing 23 4.4.3. Routing 23 1.1. Key Features 4 4.4.4. Route Discovery 23 1.1.1. Worldwide Acceptance 4 4.4.5. Throughput 23 1.2. Specifications 5 4.5. Transmission Timeouts 24 1.3. Mechanical Drawings 7 4.5.1.

  • Page 4: Key Features

    XBee/XBee‐PRO DigiMesh 2.4 RF Modules   1.XBee/XBee‐PRO DigiMesh 2.4 RF Modules The XBee/XBee-PRO DigiMesh 2.4 RF Modules were engineered to support the unique needs of low-cost, low-power wireless sensor networks. The modules require minimal power and provide reliable delivery of data between remote devices. Key Features Long-range Data Integrity...

  • Page 5: Specifications

    PAN ID, Channel and Addresses PAN ID, Channel and Addresses Agency Approvals United States (FCC Part 15.247) OUR-XBEE OUR-XBEEPRO Industry Canada (IC) 4214A XBEE 4214A XBEEPRO Europe (CE) ETSI ETSI (Max. 10 dBm transmit power output)* R201WW08215111" (Max. 10 dBm transmit power Japan...

  • Page 6: Mechanical Drawings

    •Through-hole single-row receptacles - Samtec P/N: MMS-110-01-L-SV (or equivalent) •Surface-mount double-row receptacles - Century Interconnect P/N: CPRMSL20-D-0-1 (or equivalent) •Surface-mount single-row receptacles - Samtec P/N: SMM-110-02-SM-S Digi also recommends printing an outline of the module on the board to indicate the orientation the module should be mounted. © 2010 Digi International, Inc.

  • Page 7: Pin Signals

    Analog Input 0 or Digital I/O 0 * Function is not supported at the time of this release Design Notes: The XBee modules do not specifically require any external circuitry or specific connections for proper operation. However, there are some general design guidelines that are recommended to help with troubleshooting and building a robust design.

  • Page 8: Electrical Characteristics

    XBee™ & XBee‐Pro™ RF Modules Electrical Characteristics DC Characteristics (VCC = 2.8 ‐ 3.4 VDC) Symbol Characteristic Condition Typical Unit Input Low Voltage All Digital Inputs 0.35 * VCC Input High Voltage All Digital Inputs 0.7 * VCC = 2 mA, VCC >= 2.7 V Output Low Voltage = -2 mA, VCC >= 2.7 V Output High Voltage VCC - 0.5...
  • Page 9 XBee/XBee‐PRO DigiMesh 2.4 RF Modules   9. Input leakage error is error due to input leakage across the real portion of the impedance of the network driving the analog  pin. Reducing the impedance of the network reduces this error. 10. Total unadjusted error is the difference between the transition voltage to the current code and the ideal straight‐line trans‐ fer function. This measure of error includes inherent quantization error (1/2LSB) and circuit error (differential, integral, zero‐ scale, and full‐scale) error. The specified value of E  assumes zero E  (no leakage or zero real source impedance). © 2010 Digi International, Inc.      9...

  • Page 10: 2. Rf Module Operation

    Serial Communications The XBee/XBee-PRO 2.4 DigiMesh RF Modules interface to a host device through a logic-level asynchronous serial port. Through its serial port, the module can communicate with any logic and voltage compatible UART; or through a level translator to any serial device (For example: Through a Digi proprietary RS-232 or USB interface board).

  • Page 11: Serial Flow Control

    XBee/XBee‐PRO DigiMesh 2.4  RF Modules   Internal Data Flow Diagram Serial RF TX Receiver Transmitter Buffer Buffer RF Switch Antenna Processor Port RF RX Serial Transmit DOUT Receiver Buffer Buffer Serial Receive Buffer When serial data enters the RF module through the DIN Pin (pin 3), the data is stored in the serial receive buffer until it can be processed.

  • Page 12: Serial Interface Protocols

    XBee/XBee‐PRO DigiMesh 2.4  RF Modules   Serial Interface Protocols The XBee modules support both transparent and API (Application Programming Interface) serial interfaces. Transparent Operation When operating in transparent mode, the modules act as a serial line replacement. All UART data received through the DIN pin is queued up for RF transmission. When RF data is received, the data is sent out through the DOUT pin.

  • Page 13: Idle Mode

    XBee/XBee‐PRO DigiMesh 2.4  RF Modules   As a general rule of thumb, API firmware is recommended when a device: • sends RF data to multiple destinations • sends remote configuration commands to manage devices in the network • receives IO samples from remote devices • receives RF data packets from multiple devices, and the application needs to know which device sent which packet •...

  • Page 14: Receive Mode

    XBee/XBee‐PRO DigiMesh 2.4  RF Modules   Receive Mode If a valid RF packet is received, the data is transferred to the serial transmit buffer. Command Mode To modify or read RF Module parameters, the module must first enter into Command Mode - a state in which incoming serial characters are interpreted as commands.
  • Page 15 "Command Reference Tables" chapter. Sleep Mode Sleep mode allows the RF module to enter a low power state. The XBee DigiMesh 2.4 modules support a network synchronized sleep to conserve power. Sleep functionality is discussed in detail in Chapter 4.

  • Page 16: 3. Advanced Application Features

    API devices can send configuration commands to set or read the configuration settings of any device in the network. Device Placement For a mesh network installation to be successful, the installer must be able to determine where to place individual XBee devices to establish reliable links throughout the mesh network.

  • Page 17: Node Discovery

    Node Discovery The node discovery command can be used to discover all Digi modules that have joined a network. Issuing the ND com- mand sends a broadcast node discovery message throughout the network. All devices that receive the command will send a response that includes the device’s addressing information, node identifier string (see NI command), and other relevant...

  • Page 18: Pushbutton And Associate Led

    Causes a node which is configured with sleeping router nomination enabled (see description of the ATSO – sleep options Configured for sleep command in the XBee module’s Product Manual) to immediately nominate itself as the network sleep coordinator. Issues an ATRE to restore module parameters Either to default values.

  • Page 19: I/O Line Monitoring

    XBee/XBee‐PRO DigiMesh 2.4 RF Modules   Associate LED The Associate pin (pin 15) can provide indication of the device's sleep status and diagnostic information. To take advantage of these indications, an LED can be connected to the Associate pin as shown in the figure above. The Associate LED functionality is enabled by setting the D5 command to 1 (enabled by default).
  • Page 20 XBee/XBee‐PRO DigiMesh 2.4 RF Modules   Pin Configuration Commands Module Pin Names Module Pin Number Configuration Command CD / DIO12 PWM0 / RSSI / DIO10 PWM1 / DIO11 DTR / SLEEP_RQ / DIO8 AD4 / DIO4 CTS / DIO7 ON_SLEEP / DIO9 ASSOC / AD5 / DIO5...

  • Page 21: Periodic I/O Sampling

    IC command is a bitmask that can be used to set which digital IO lines should be monitored for a state change. If one or more bits in IC is set, an IO sample will be transmitted as soon as a state change is observed in one of the monitored digi- tal IO lines.

  • Page 22: 4.  Xbee/Xbee-Pro® Digimesh 2.4

    DigiMesh modules utilize direct-sequence spread spectrum modulation and operate on a fixed channel. There are 16 oper- ating channels defined in the 2.4 GHz frequency band. XBee modules support all 16 channels and XBee-PRO modules sup- port 12 of the 16 channels. The operating channel on a module is selected using the CH command.

  • Page 23: Broadcast Addressing

    XBee/XBee‐PRO DigiMesh 2.4 RF Modules   Broadcast Addressing Broadcast transmissions will be received and repeated by all routers in the network. Because ACKs are not used the origi- nating node will send the broadcast multiple times. By default a broadcast transmission is sent four times. Essentially the extra transmissions become automatic retries without acknowledgments.

  • Page 24: Transmission Timeouts

    XBee/XBee‐PRO DigiMesh 2.4 RF Modules   Transmission Timeouts When a node receives an API TX Request (API configured modules) or an RO timeout occurs (modules configured for Transparent Mode) the time required to route the data to its destination depends on a number of configured parameters, whether the trans- mission is a unicast or a broadcast, and if the route to the destination address is known.

  • Page 25: Sleeping Routers

    XBee/XBee‐PRO DigiMesh 2.4 RF Modules   Sleeping Routers The Sleeping Router feature of DigiMesh makes it possible for all nodes in the network to synchronize their sleep and wake times. All synchronized cyclic sleep nodes enter and exit a low power state at the same time. This forms a cyclic sleeping network. Nodes synchronize by receiving a special RF packet called a sync message which is sent by a node acting as a sleep coordinator.
  • Page 26 XBee/XBee‐PRO DigiMesh 2.4 RF Modules   network will not apply the new settings until the beginning of the next wake time. See the Changing Sleep Parameters section below for more information. A sleeping router network is robust enough that an individual node can go several cycles without receiving a sync message (due to RF interference, for example).
  • Page 27 XBee/XBee‐PRO DigiMesh 2.4 RF Modules   Becoming a Sleep Coordinator A node can become a sleep coordinator in one of four ways: Preferred Sleep Coordinator Option A node can be specified to always act as a sleep coordinator. This is done by setting the preferred sleep coordinator bit (bit 0) in the sleep options parameter (ATSO) to 1.

  • Page 28: Configuration

    XBee/XBee‐PRO DigiMesh 2.4 RF Modules   If a sleep compatible node has missed three or more sync messages (presumably because the sleep coordinator has been disabled) it may become a sleep coordinator. Depending on the platform and other configured options such a node will eventually nominate itself after a number of cycles without a sync. A nominated node will begin acting as the new network sleep coordinator.
  • Page 29 XBee/XBee‐PRO DigiMesh 2.4 RF Modules   Choose NN and NH. Based on the placement of the nodes in your network select appropriate values for the Network Hops (NH) and Network Delay Slots (NN) parameters. Note: The default values of NH and NN have been optimized to work for the majority of network deployments. In most cases it is suggested that these parameters are not modified from the default values.
  • Page 30 XBee/XBee‐PRO DigiMesh 2.4 RF Modules   If one of these methods are not used it is necessary to wait for the network to wake up before the new node can be added. The new node should be placed in range of the network with a sleep period which is shorter than the wake period of the network.

  • Page 31: Diagnostics

    XBee/XBee‐PRO DigiMesh 2.4 RF Modules   If a network has multiple subnets that have drifted out of phase with each other, then follow the following steps to get the subnets back in phase: Place a sleep support node in range of both subnets. Select a node in the subnet which you desire the other subnet to sync up with. Use this node to slightly change the sleep cycle settings of the network (increment ST for example).

  • Page 32: 5. Digimesh 2.4 Command Reference Tables

    Digi data endpoint Destination Endpoint. Set/read application layer destination ID value. This value will be used as the 0-0xFF 0xE8 destination endpoint for all data transmissions. The default value (0xE8) is the Digi data endpoint. Cluster Identifier. 0-0xFFFF 0x11 Set/read application layer cluster ID value.
  • Page 33 XBee/XBee‐PRO DigiMesh 2.4 RF Modules   Serial Interfacing Commands AT Name and Description Parameter Range Default Command Baud rate. Set or read serial interface rate (speed for data transfer between radio modem and host). Values from 0-8 select preset standard rates. Values at 0x7A and above select the actual baud rate. Baud rates above 250,00 bps are not supported.The...
  • Page 34 XBee/XBee‐PRO DigiMesh 2.4 RF Modules   I/O Commands I/O Commands AT Name and Description Parameter Range Default Command 0 - Disabled 1 - RSSI PWM 2 - PWM Output PWM0/DIO10 Configuration. 3 - Digital input, monitored Select/Read function for the DIO10 line of the RF module...
  • Page 35 XBee/XBee‐PRO DigiMesh 2.4 RF Modules   I/O Commands AT Name and Description Parameter Range Default Command 0 - Disabled 1 - Associated indication 2 - Analog input, single ended AD5/DIO5 Configuration. 3 - Digital input, monitored Select/Read function 4 - Digital output, default 5 - Digital output, default high 0 –...
  • Page 36 Forces a read of all enabled digital and analog input lines. XBee Sensor Sample. Forces a sample to be taken on an XBee Sensor device. This command can only be issued to an XBee sensor device using an API remote command.
  • Page 37 XBee/XBee‐PRO DigiMesh 2.4 RF Modules   Diagnostics Diagnostics Commands AT Name and Description Parameter Range Default Command Firmware Version. Read firmware version of the module. 0 - 0xFFFF [read-only] Firmware-set Hardware Version. Read hardware version of the module. 0 - 0xFFFF [read-only] Factory-set RF Errors Read the number of times the RF receiver detected a CRC or length error.
  • Page 38 XBee/XBee‐PRO DigiMesh 2.4 RF Modules   Node Identification Node Identification Commands  AT Name and Description Parameter Range Default Command PAN ID. Set or read the user network address. Nodes must have the same network address to communicate. Changes to ID should be written to non-volatile memory using...
  • Page 39 XBee/XBee‐PRO DigiMesh 2.4 RF Modules   Sleep Commands AT Name and Description Parameter Range Default Command Wake Time. Units of msec, represented in hex. Note 1: the minimum value for ST is a function of SP, SS, MT, NN, and NH. If the user 0x45-0x36EE80 0x7D0 (2 seconds) attempts to set the value of ST too low it will automatically be increased to a minimum effective value.
  • Page 40 AT Name and Description Parameter Range Default Command Channel. 0x0B - 0x1A (XBee) 0x0C Set/Read the channel number used for transmitting and receiving data between RF 0x0C - 0x17 (XBee-PRO) modules (uses 802.15.4 protocol channel numbers). Network Identifier. 0 - 0xFFFF 0x7FFF Set/Read the network identifier for the network.
  • Page 41 XBee/XBee‐PRO DigiMesh 2.4 RF Modules   DigiMesh Mesh Commands: Network Level Commands  AT Name and Description Parameter Range Default Command Network Hops Set or read the maximum number of hops expected to be seen in a network route. This value doesn't limit the number of hops allowed, but it is used to 1 to 0xFF calculate timeouts waiting for network acknowledgements.

  • Page 42: 6. Api Operation

    UART Data Frame. Please note that Digi may add new frame types to future versions of firmware, so please build into your software interface the ability to filter out additional API frames with unknown Frame Types.

  • Page 43: Frame Data

    XBee/XBee‐PRO DigiMesh 2.4 RF Modules   Note: In the above example, the length of the raw data (excluding the checksum) is 0x0002 and the checksum of the non-escaped data (excluding frame delimiter and length) is calculated as: 0xFF - (0x23 + 0x11) = (0xFF - 0x34) = 0xCB.
  • Page 44 XBee/XBee‐PRO DigiMesh 2.4 RF Modules   Modem Status API Identifier Value: (0x8A) RF module status messages are sent from the module in response to specific conditions.  Modem Status Frames Frame Fields Offset Example Description Start Delimiter 0 0x7E MSB 1 0x00 Length Number of bytes between the length and the checksum...
  • Page 45 XBee/XBee‐PRO DigiMesh 2.4 RF Modules   AT Command Response API Identifier Value: (0x88) Response to previous command. In response to an AT Command message, the module will send an AT Command Response message. Some com- mands will send back multiple frames (for example, the ND (Node Discover) command).
  • Page 46 XBee/XBee‐PRO DigiMesh 2.4 RF Modules   Remote AT Command Request API Identifier Value: (0x17) Allows for module parameter registers on a remote device to be queried or set Remote AT Command Request Frame Fields Offset Example Description Start Delimiter 0 0x7E MSB 1 0x00 Length Number of bytes between the length and the checksum...
  • Page 47 XBee/XBee‐PRO DigiMesh 2.4 RF Modules   Remote Command Response API Identifier Value: (0x97) If a module receives a remote command response RF data frame in response to a Remote AT Command Request, the module will send a Remote AT Command Response message out the UART. Some commands may send back multiple frames--for example, Node Discover (ND) command.
  • Page 48 XBee/XBee‐PRO DigiMesh 2.4 RF Modules   Transmit Request API Identifier Value: (0x10) A TX Request message will cause the module to send RF Data as an RF Packet. Transmit Request Frame Fields Offset Example Description Start Delimiter 0 0x7E MSB 1 0x00 Length Number of bytes between the length and the checksum...
  • Page 49 XBee/XBee‐PRO DigiMesh 2.4 RF Modules   Explicit Addressing Command Frame API Identifier Value: (0x11) Allows application layer fields (endpoint and cluster ID) to be specified for a data transmission. Explicit Addressing Command Frame Frame Fields Offset Example Description Start Delimiter 0 0x7E MSB 1 0x00 Length Number of bytes between the length and the checksum...
  • Page 50 XBee/XBee‐PRO DigiMesh 2.4 RF Modules   Transmit Status API Identifier Value: 0x8B When a TX Request is completed, the module sends a TX Status message. This message will indicate if the packet was transmitted successfully or if there was a failure. TX Status Frames Frame Fields Offset Example...
  • Page 51 XBee/XBee‐PRO DigiMesh 2.4 RF Modules   Receive Packet API Identifier Value: (0x90) When the module receives an RF packet, it is sent out the UART using this message type. RX Packet Frames Frame Fields Offset Example Description Start Delimiter 0 0x7E MSB 1 0x00 Length Number of bytes between the length and the checksum...
  • Page 52 XBee/XBee‐PRO DigiMesh 2.4 RF Modules   Explicit Rx Indicator API Identifier Value:(0x91) When the modem receives a RF packet it is sent out the UART using this message type (when AO=1).  Explicit RX Indicators Frame Fields Offset Example Description Start Delimiter 0 0x7E MSB 1 0x00 Length...

  • Page 53: Definitions

    XBee/XBee‐PRO DigiMesh 2.4 RF Modules   Appendix A: Definitions Definitions Terms and Definitions Personal Area Network - A data communication network with a defined set of characteristics that isolates it from other like devices Network Address The 16-bit address is used for compatibility and has an address of 0xFFFE DigiMesh Definitions...

  • Page 54: Agency Certifications

    Appendix B:  Agency Certifications United States (FCC) XBee/XBee-PRO DigiMesh 2.4 RF Modules comply with Part 15 of the FCC rules and regulations. Compliance with the labeling requirements, FCC notices and antenna usage guidelines is required. To fulfill FCC Certification requirements, the OEM must comply with the following regulations: The system integrator must ensure that the text on the external label provided with this device is placed on the outside of the final product [Figure A-01].
  • Page 55 The modules are FCC-approved for fixed base station and mobile applications on channels 0x0B - 0x1A (XBee) and 0x0C - 0x17 (XBee-PRO). If the antenna is mounted at least 20cm (8 in.) from nearby persons, the application is considered a mobile application. Antennas not listed in the table must be tested to comply with FCC Section 15.203 (Unique Antenna Connectors) and Section...
  • Page 56 XBee/XBee‐PRO DigiMesh 2.4 RF Modules   XBee RF Module: High Gain Antenna Summary The following antenna types have been tested and approved for use with the XBee Module: Antenna Type: Yagi RF Module was tested and approved with 15 dBi antenna gain with 7.9 dB cable loss. Any Yagi type antenna with 7.1 dBi gain or less can be used with no cable loss.

  • Page 57: Europe (Etsi)

    EMC and safety. Important Note Digi does not list the entire set of standards that must be met for each country. Digi customers assume full responsibility for learning and meeting the required guidelines for each country in their distribution market.

  • Page 58: Approved Antennas

    14.2 dBm). Any Flat Panel type antenna with 14.2 dBi gain or less can be used with no cable-loss. XBee-PRO RF Module (@ 10 dBm Transmit Power, PL parameter value must equal 0, or use Inter- national variant)

  • Page 59: Japan (Telec)

    XBee/XBee‐PRO DigiMesh 2.4 RF Modules   Japan (Telec) In order to use the XBee-PRO in Japan, you must order the International version. The Interna- tional XBee-PRO RF Modules are limited to a transmit power output of 10 dBm. Labeling Requirements A clearly visible label on the outside of the final product enclosure must display the following text:...

This manual is also suitable for:

Xbee-pro

Table of Contents