Digi XBee User Manual

Digi XBee User Manual

S1 802.15.4 (legacy) rf modules
Hide thumbs Also See for XBee:
Table of Contents

Advertisement

Quick Links

XBee/XBee-PRO S1 802.15.4 (Legacy)
RF Modules
User Guide

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

Summary of Contents for Digi XBee

  • Page 1 XBee/XBee-PRO S1 802.15.4 (Legacy) RF Modules User Guide...
  • Page 2 Information in this document is subject to change without notice and does not represent a commitment on the part of Digi International. Digi provides this document “as is,” without warranty of any kind, expressed or implied, including, but not limited to, the implied warranties of fitness or merchantability for a particular purpose.
  • Page 3 Digi Technical Support: Digi offers multiple technical support plans and service packages to help our customers get the most out of their Digi product. For information on Technical Support plans and pricing, contact us at +1 952.912.3444 or visit us at www.digi.com/support.
  • Page 4: Table Of Contents

    Contents About the XBee/XBee-PRO S1 802.15.4 (Legacy) RF Modules Technical specifications Electrical characteristics DC Characteristics (VCC = 2.8 - 3.4 VDC) ADC timing/performance characteristics1 Performance specifications Power requirements General specifications Networking and security specifications Regulatory conformity summary Hardware XBee/XBee-PRO S1 802.15.4 (Legacy) Antenna options XBee/XBee-PRO S1 802.15.4 (Legacy) Mechanical drawings...
  • Page 5 NT (Node Discover Time) NO (Node Discovery Options) CE (Coordinator Enable) SC (Scan Channels) SD (Scan Duration) A1 (End Device Association) A2 (Coordinator Association) AI (Association Indication) DA (Force Disassociation) FP (Force Poll) AS (Active Scan) XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 6 M0 (PWM0 Output Level) M1 (PWM1 Output Level) PT (PWM Output Timeout) RP (RSSI PWM Timer) Diagnostic commands VR (Firmware Version) VL (Version Long) HV (Hardware Version) DB (Last Packet RSSI) EC (CCA Failures) EA (ACK Failures) XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 7 OEM labeling requirements FCC notices FCC-approved antennas (2.4 GHz) RF exposure Europe (CE) Maximum power and frequency specifications OEM labeling requirements Declarations of conformity Antennas Canada (IC) Labeling requirements Japan Labeling requirements Brazil ANATEL XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 8 About the XBee/XBee-PRO S1 802.15.4 (Legacy) RF Modules The XBee and XBee-PRO RF Modules were engineered to meet IEEE 802.15.4 standards and support the unique needs of low-cost, low-power wireless sensor networks. The devices require minimal power and provide reliable delivery of data between devices.
  • Page 9 Technical specifications Electrical characteristics Performance specifications Power requirements General specifications Networking and security specifications Regulatory conformity summary XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 10: Technical Specifications

    Technical specifications Electrical characteristics Electrical characteristics The following tables list the electrical characteristics of the XBee/XBee-PRO XBee/XBee-PRO S1 802.15.4 (Legacy) RF Modules. DC Characteristics (VCC = 2.8 - 3.4 VDC) Symbol Characteristic Condition Typical Unit Input low voltage All Digital Inputs 0.35 *...
  • Page 11: Adc Timing/Performance Characteristics1

    (Current Code–1/2)*(1/((VREFH+EFS)–(VREFL+EZS))). 7. Zero-scale error is the difference between the transition to the first valid code and the ideal transition to that code. The Ideal transition voltage to a given code is (Code–1/2)*(1/(VREFH– VREFL)). XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 12: Performance Specifications

    -92 dBm 100 dBm Receiver sensitivity (typical) (1% packet error rate) (1% packet error rate) Power requirements The following table describes the power requirements for the XBee/XBee-PRO S1 802.15.4 (Legacy). XBee XBee-PRO Specification Supply voltage 2.8 - 3.4 V 2.8 - 3.4 V...
  • Page 13: General Specifications

    PAN ID, channel and addresses PAN ID, channel and addresses Regulatory conformity summary This table describes the agency approvals for the devices. Specification XBee XBee-PRO United States (FCC OUR-XBEE OUR-XBEEPRO Part 15.247) Industry Canada (IC) 4214A-XBEE 4214A-XBEEPRO XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 14 (Maximum 10 dBm transmit power output)* Wire, chip, RPMSA, and U.FL versions are certified for Japan. PCB antenna version is not. Australia/New RCM/R-NZ RCM/R-NZ Zealand Brazil ANATEL 0369-15- ANATEL 0378-15-1209 1209 Regulatory information or region-specific certification requirements. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 15: Hardware

    Hardware XBee/XBee-PRO S1 802.15.4 (Legacy) Antenna options XBee/XBee-PRO S1 802.15.4 (Legacy) Mechanical drawings Mounting considerations Pin signals Design notes XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 16: Xbee/Xbee-Pro S1 802.15.4 (Legacy) Antenna Options

    XBee and XBee-PRO OEM RF Module Antenna Considerations Application Note. XBee/XBee-PRO S1 802.15.4 (Legacy) Mechanical drawings The following graphics show the mechanical drawings of the XBee / XBee-PRO OEM RF Modules. The XBee and XBee-PRO RF Modules are pin-for-pin compatible. Note The antenna options not shown.
  • Page 17: Pin Signals

    Hardware Pin signals Century Interconnect manufactures the receptacles used on Digi development boards. Several other manufacturers provide comparable mounting solutions; however, Digi currently uses the following receptacles: Through-hole single-row receptacles: Samtec part number: MMS-110-01-L-SV (or equivalent) Surface-mount double-row receptacles: Century Interconnect part number: CPRMSL20-D-0-1 (or equivalent) Surface-mount single-row receptacles: Samtec part number: SMM-110-02-SM-S ...
  • Page 18 The module includes a 50 kΩ pull-up resistor attached to RESET You can configure several of the input pull-ups using the PR command Leave any unused pins disconnected Function is not supported at the time of this release. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 19: Design Notes

    Do not place XBee devices with the chip or integrated PCB antenna inside a metal enclosure. Do not place any ground planes or metal objects above or below the antenna. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 20: Pin Connection Recommendations

    LED pin (pin 15). The Associate LED flashes differently depending on the state of the device. If analog sampling is desired, attach the VRef (pin 14) to a voltage reference. Keepout area We recommend that you allow a “keepout” area, as shown in the following drawing. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 21 3. Maximize the distance between the antenna and metal objects that might be mounted in the keepout area. 4. These keepout area guidelines do not apply for wire whip antennas or external RF connectors. Wire whip antennas radiate best over the center of a ground plane. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 22: Operation

    Operation Serial communications ADC and Digital I/O line support Networks Addressing Modes of operation XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 23: Serial Communications

    The UART baud rate and parity settings on the XBee module can be configured with the BD and NB commands, respectively. For more information, see commands.
  • Page 24: Transparent Operating Mode

    The API operation option facilitates many operations such as the following examples: Transmitting data to multiple destinations without entering Command Mode Receiving success/failure status of each transmitted RF packet Identifying the source address of each received packet XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 25: Flow Control

    Flow control The XBee/XBee-PRO S1 802.15.4 (Legacy) maintains buffers to collect serial and RF data that it receives. The serial receive buffer collects incoming serial characters and holds them until the device can process them. The serial transmit buffer collects the data it receives via the RF link until it transmits that data out the serial port.
  • Page 26: Adc And Digital I/O Line Support

    D6 (DIO6 Configuration) command description for more information. ADC and Digital I/O line support The XBee/XBee-PRO RF Modules support ADC (analog-to-digital conversion) and digital I/O line passing. The following pins support multiple functions: Pin functions and their associated pin numbers and commands...
  • Page 27: I/O Data Format

    For Cyclic Sleep modes: If the IR parameter is set, the device stays awake until the IT (Samples before parameter is met. The device stays awake for ST (Time before Sleep). XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 28: Dio Pin Change Detect

    20 ms. I/O line passing You can set up virtual wires between XBee/XBee-PRO Modules. When a device receives an RF data packet that contains I/O data, it can be setup to update any enabled outputs (PWM and DIO) based on the data it receives.
  • Page 29: Configuration Example

    When in the same network as a coordinator. Devices that rely on a coordinator for synchronization and can be put into states of sleep for low-power applications. Personal Area Network. A data communication network that includes one or more end devices and optionally a coordinator. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 30: Peer-To-Peer Networks

    Networks Peer-to-peer networks By default, XBee/XBee-PRO S1 802.15.4 (Legacy) modules are configured to operate within a peer-to- peer network topology and therefore are not dependent upon master/slave relationships. This means that devices remain synchronized without the use of master/server configurations and each device in the network shares both roles of master and slave.
  • Page 31 The Coordinator retains its CH setting, and an Energy Scan is not performed. 3. Start Coordinator The Coordinator starts on the specified channel (CH parameter) and PAN ID (ID parameter). Note These may be selected in steps 1 or 2. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 32 Reassign_Channel bit set (bit 1 = 1) - End device can associate with a PAN with any CH value. Reassign_Channel bit not set (bit 1 = 0) - End device will only associate with a PAN whose CH setting matches the CH setting of the end device. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 33: Addressing

    (Destination Address High) parameter to '0.' Unicast mode By default, the XBee/XBee-PRO S1 802.15.4 (Legacy) operates in Unicast mode. Unicast Mode is the only mode that supports retries. While in this mode, receiving devices send an ACK (acknowledgment) of RF packet reception to the transmitter. If the transmitting device does not receive the ACK, it re- sends the packet up to three times or until it receives the ACK.
  • Page 34: Broadcast Mode

    When you are programming the device, enter the parameters in hexadecimal notation (without the “0x” prefix). Leading zeros may be omitted. Modes of operation This section describes the different operating modes for the device. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 35: Idle Mode

    Direct transmission: data is transmitted immediately to the Destination Address Indirect transmission: a packet is retained for a period of time and is only transmitted after the destination device (source address = destination address) requests the data. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 36 When in Unicast packets with RR (Retries) = 0, the device executes two CCA retries. Broadcast packets always get two CCA retries. Note Customers in Europe who have the XBee 802.15.4 module must manage their CCA settings. See CA (CCA Threshold) for CA values.
  • Page 37: Sleep Modes

    RF data is sleep time SM (Sleep present/When SM = 5 interval Mode) and ST elapses. The (Time before time interval Sleep) is defined by parameters the SP (Cyclic Sleep Period) parameter. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 38 To wake a sleeping device operating in Pin Doze Mode, de-assert Sleep_RQ (pin 9). The device wakes when Sleep_RQ is de-asserted and is ready to transmit or receive when the CTS line is low. When XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 39 The Cyclic Sleep modes allow devices to periodically check for RF data. When the SM parameter is set to 4, the XBee/XBee-PRO S1 802.15.4 (Legacy) is configured to sleep, then wakes once per cycle to check for data from a from a device configured as a Cyclic Sleep Coordinator (SM = 0, CE = 1). The Cyclic Sleep Remote sends a poll request to the coordinator at a specific interval set by the SP (Cyclic Sleep Period) parameter.
  • Page 40: Multiple At Commands

    Operation Modes of operation Command mode Command mode is a state in which the firmware interprets incoming characters as commands. The XBee/XBee-PRO S1 802.15.4 (Legacy) supports two Command mode options: AT commands operation. AT Command Mode This section provides information about entering, sending, and exiting Command Mode.
  • Page 41 2. If the device does not receive any valid AT commands within the time specified by CT (Command Mode Timeout), it returns to Idle Mode. For an example of programming the device using AT Commands and descriptions of each configurable parameter, see commands. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 42: Configuration

    Configuration Programming the RF module Remote configuration commands XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 43: Programming The Rf Module

    3. Change the value of the parameter to, for example, 1A0D. If you have not saved the parameter, a green triangle appears in the lower right corner of the parameter. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 44: Remote Configuration Commands

    For example, changing the BD parameter does not change the serial interface on the remote until the changes are applied. To apply changes, do one of the following: XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 45: Remote Command Responses

    The device that sends a remote command will not receive a remote command response frame if either of the following conditions exist: The destination device could not be reached. The frame ID in the remote command request is set to 0. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 46: At Commands

    AT commands XBee/XBee-PRO RF Modules expect numerical values in hexadecimal. Hexadecimal values are designated by a “0x” prefix, and decimal equivalents are designated by a “d” suffix. Commands are contained within the following command categories: Note All modules within a PAN should operate using the same firmware version.
  • Page 47: Special Commands

    Forces a software reset on the device. The reset simulates powering off and then on again the device. The device responds immediately with an OK and performs a reset 100 ms later. Parameter range Default Note Minimum firmware version required: 1.x80. Firmware versions are numbered in hexadecimal notation. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 48: Networking And Security Commands

    To transmit using a 16-bit address, set DH parameter to zero and DL less than 0xFFFF. The broadcast address for the PAN is 0x000000000000FFFF. For more information, see Addressing. Parameter range 0 - 0xFFFFFFFF XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 49: Dl Command

    Set in the factory SL (Serial Number Low) Displays the lower 32 bits of the unique IEEE 64-bit RF extended address assigned to the XBee in the factory. The 64-bit source address is always enabled. This value is read-only and it never changes.
  • Page 50: Rr (Xbee Retries)

    This value does not need to be set on all devices for retries to work. If retries are enabled, the transmitting device sets a bit in the Digi RF Packet header that requests the receiving device to send an ACK. If the transmitting device does not receive an ACK within 200 ms, it re-sends the packet within a random period up to 48 ms.
  • Page 51: Mm (Mac Mode)

    The MM command is used to set and read the MAC Mode value. The MM command disables/enables the use of a Digi header contained in the 802.15.4 RF packet. By default (MM = 0), Digi Mode is enabled and the module adds an extra header to the data portion of the 802.15.4 packet. This enables the...
  • Page 52: Nd Command

    1 byte for DB (Received Signal Strength) value NULL-terminated string for NI (Node Identifier) value (max 20 bytes without NULL terminator) Note Minimum firmware version required: 1.x80. Firmware versions are numbered in hexadecimal notation. Parameter range Optional 20-character NI value Default XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 53: Nt (Node Discover Time)

    If there is no response from a module within 200 milliseconds or you do not specify a parameter (by leaving it blank), the command terminates and returns an ERROR message. Note Minimum firmware version required: 1.x80. Firmware versions are numbered in hexadecimal notation. Parameter range 20-byte ASCII string Default XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 54: Ce (Coordinator Enable)

    Minimum firmware version required: 1.x80. Firmware versions are numbered in hexadecimal notation. Parameter range 0 - 0xFFFF (bit field) Bit field mask: Parameter 0x0B (not available on XBee-PRO) 0x0C 0x0D 0x0E 0x0F 0x10 0x11 0x12 0x13 XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 55: Sd (Scan Duration)

    ([# of channels to scan] * (2 ^SD) * 15.36 ms) + (38 ms * [# of channels to scan]) + 20 ms Use the SC (Scan Channels) command to set the number of channels to scan. The XBee can scan up to 16 channels (SC = 0xFFFF).
  • Page 56: A1 (End Device Association)

    Beacon-enabled system must always associate to a Coordinator. PollCoordOnPinWake 0 Pin Wake does not poll the Coordinator for indirect (pending) data. Pin Wake sends Poll Request to Coordinator to extract any pending data. 4 - Reserved  7 XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 57: A2 (Coordinator Association)

    The binary equivalent of the default value (0x06) is 00000110. ‘Bit 0’ is the last digit of the sequence. Default AI (Association Indication) Reads errors with the last association request. Note Minimum firmware version required: 1.x80. Firmware versions are numbered in hexadecimal notation. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 58: Da (Force Disassociation)

    Disassociated - No longer associated to Coordinator. 0xFF RF Module is attempting to associate. Parameter range 0 - 0x13 [read-only] Default DA (Force Disassociation) Causes the End Device to immediately disassociate from a Coordinator (if associated) and re-attempt to associate. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 59: Fp (Force Poll)

    15 - Association Permitted (MSB) bit 14 - PAN Coordinator bit 13 - Reserved bit 12 - Battery Life Extension bits 8-11 - Final CAP Slot bits 4-7 - Superframe Order bits 0-3 - Beacon Order GtsPermit<CR> XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 60: Ee (Aes Encryption Enable)

    Time = [(2 ^ (SD Parameter)) * 15.36] ms. Total scan time is this time multiplied by the number of channels to be scanned (16 for the XBee and 13 for the XBee-PRO). Refer to the scan table in SD (Scan Duration) to determine scan times.
  • Page 61: Ky (Aes Encryption Key)

    When queried, the system returns an OK message and no value is returned. Note Minimum firmware version required: 1.xA0. Firmware versions are numbered in hexadecimal notation. Parameter range 0 - (any 16-byte value) Default RF interfacing commands The following AT commands are RF interfacing commands. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 62: Pl (Power Level)

    Sets or displays the power level at which the device transmits conducted power. When operating in Europe, XBee-PRO 802.15.4 modules must operate at or below a transmit power output level of 10 dBm. Order the international variant of the XBee-PRO module, which has a maximum transmit output power of 10 dBm.
  • Page 63: Sleep Commands (Low Power)

    Set or read the sleep mode options. Parameter range 0 - 4 The Sleep Coordinator option (SM=6) exists for backwards compatibility with firmware version 1.x06 only. In all other cases, use the CE command to enable a Coordinator. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 64: St (Time Before Sleep)

    Coordinator and End Device SP values should always be equal. To send direct messages on a coordinator, set SP = 0. NonBeacon firmware End Device: SP determines the sleep period for cyclic sleeping remotes. The maximum sleep period is 268 seconds (0x68B0). XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 65: Dp (Disassociated Cyclic Sleep Period)

    BD register. The RF data rate is not affected by the BD parameter. If you set the interface data rate higher than the RF data rate, you may need to implement a flow control configuration. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 66 Non-standard baud rates: 0x80 - 0x3D090 (up to 250 kb/s) Parameter Description 1200 b/s 2400 b/s 4800 b/s 9600 b/s 19200 b/s 38400 b/s 57600 b/s 115200 b/s 0x80 - 0x3D090 non-standard baud rates up to 250 kb/s Default 0x03 (9600 b/s) XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 67: Ro (Packetization Timeout)

    Default 0x00 PR (Pull-up/Down Resistor Enable) The bit field that configures the internal pull-up resistor status for the I/O lines. PR and PD only affect lines that are configured as digital inputs or disabled. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 68: I/O Settings Commands

    Sets or displays the DIO0/AD0 configuration (pin 20). The options include analog-to-digital converter, digital input, and digital output. Note Minimum firmware version required: 1.xA0. Firmware versions are numbered in hexadecimal notation. Parameter range 0 - 1 XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 69: D1 (Dio1 Configuration)

    Digital output, low Digital output, high PTI_EN Default D2 (AD2/DIO2 Configuration) Sets or displays the DIO2/AD2 configuration (pin 18). The options include analog-to-digital converter, digital input, and digital output. Parameter range 0 - 1 XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 70: D3 (Dio3 Configuration)

    Digital output, low Digital output, high Default D4 (DIO4 Configuration) Sets or displays the DIO4 configuration (pin 11). Note Minimum firmware version required: 1.xA0. Firmware versions are numbered in hexadecimal notation. Parameter range 0 - 1 XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 71: D5 (Dio5 Configuration)

    Digital output, default low Digital output, default high Default D6 (DIO6 Configuration) Sets or displays the DIO6/RTS configuration (pin 16). Note Minimum firmware version required: 1.x80. Firmware versions are numbered in hexadecimal notation. Parameter range 0 - 1 XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 72: D7 (Dio7 Configuration)

    Default D8 (DIO8 Configuration) Sets or displays the DIO8 configuration (pin 4). This command enables you to configure the pin to function as a digital input. This line is also used with Pin Sleep. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 73: Iu (I/O Output Enable)

    One ADC sample is considered complete when all enabled ADC channels have been read. The device can buffer up to 88 bytes of sample data. Since the module uses a 10-bit A/D converter, each sample uses two bytes. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 74: Is (Force Sample)

    Sets digital output levels. This allows DIO lines setup as outputs to be changed through Command mode. Note Minimum firmware version required: 1.xA0. Firmware versions are numbered in hexadecimal notation. Parameter range 8-bit bit map; each bit represents the level of an I/O line set up as an output Default XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 75: Ic (Dio Change Detect)

    I/O packet to change outputs. Setting the address to 0xFFFF allows any received I/O packet to change outputs. You can use the IA command to set or read both 16 and 64-bit addresses. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 76: T0 (D0 Output Timeout)

    The timer resets when a valid I/O packet is received. The Tn parameter defines the permissible amount of time to stay in a non-default (active) state. If Tn = 0, Output Timeout is disabled (output levels are held indefinitely). XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 77: T3 (D3 Output Timeout)

    The timer resets when a valid I/O packet is received. The Tn parameter defines the permissible amount of time to stay in a non-default (active) state. If Tn = 0, Output Timeout is disabled (output levels are held indefinitely). XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 78: T6 (D6 Output Timeout)

    0xFF P0 (PWM0 Configuration) Sets or displays the PWM0 configuration (). This command enables the option of translating incoming data to a PWM so that the output can be translated back into analog form. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 79: P1 (Pwm1 Configuration)

    M0 (PWM0 Output Level) Sets or displays output level of the PWM0 line (pin 6). Before setting the line as an output: 1. Enable PWM0 output (P0 = 2). 2. Apply settings (use CN or AC). XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 80: M1 (Pwm1 Output Level)

    PWM output is 8.32 ms. PWM output consists of 40 steps, so the minimum step size is 0.208 ms. Enables a pulse-width modulated (PWM) output on the RF device. We calibrate the pin to show the difference between received signal strength and the sensitivity level of the device. PWM pulses vary XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 81: Diagnostic Commands

    VL (Version Long) Shows detailed version information including the application build date, MAC, PHY, and bootloader versions. The VL command has been deprecated in version 10C9. It is not supported in firmware versions after 10C8. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 82: Hv (Hardware Version)

    It reports the absolute value. For example, if DB returns 0x58 (-88 dBm), the reported value is accurate between -40 dBm and RX sensitivity. If the XBee/XBee-PRO S1 802.15.4 (Legacy) has been reset and has not yet received a packet, DB reports 0.
  • Page 83: Ea (Ack Failures)

    Sets or displays the Command mode timeout parameter. If a device does not receive any valid commands within this time period, it returns to Idle mode from Command mode. Use the CN (Exit Command Mode) command to exit Command Mode manually. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 84: Cn (Exit Command Mode)

    Command mode sequence (GT + CC + GT). The period of silence prevents inadvertently entering Command mode. Command mode options for more information about AT Command mode. Parameter range 0x2 - 0xCE4 (x 1 ms) Default 0x3E8 (one second) XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 85: Cc (Command Sequence Character)

    For more information about Command mode sequence, see Command mode options. Parameter range 0 - 0xFF Default 0x2B (the ASCII plus character: +) XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 86: Api Operation

    API operation By default, XBee/XBee-PRO RF Modules act as a serial line replacement (Transparent Operation). All UART data received through the DI pin is queued up for RF transmission. When the module receives an RF packet, it sends the data out the DO pin with no additional information.
  • Page 87: Api Frame Specifications

    For more information on using this API mode, refer to the following knowledge base article: http://knowledge.digi.com/articles/Knowledge_Base_Article/Escaped-Characters-and-API-Mode-2 The following table shows the structure of an API frame with escaped characters: Frame fields Byte Description Start delimiter 1 0x7E XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 88: Calculate And Verify Checksums

    2. If the checksum is correct, the last two digits on the far right of the sum equal 0xFF. Example Consider the following sample data packet: 7E 00 0A 01 01 50 01 00 48 65 6C 6C 6F B8 Byte(s) Description Start delimeter 00 0A Length bytes XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 89: Api Types

    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/XBee-PRO S1 802.15.4 (Legacy) will consider the packet invalid and will ignore the data.
  • Page 90: At Command Frame - 0X08

    If present, indicates the requested parameter value to set the given register. value If no characters are present, it queries the register. Example The following example illustrates an AT Command frame when you modify the device's DL parameter value. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 91: At Command - Queue Parameter Value Frame - 0X09

    API frame specifications. Frame data fields Offset Description Frame type 0x88 Identifies the data frame being reported. If set to 0, the device does not Frame ID send a response. M was arbitrarily selected. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 92: Remote At Command Request Frame - 0X17

    Remote Command Response frame - 0x97 Description If a device receives this frame in response to a Remote Command Request (0x17) frame, the device sends an AT Command Response (0x97) frame out the serial interface. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 93: Tx Request: 64-Bit Address Frame - 0X00

    Broadcast = 0x000000000000FFFF address Options 0x01 = Disable ACK 0x04 = Send packet with Broadcast PAN ID All other bits must be set to 0. RF data 15-n Up to 100 bytes per packet. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 94: Tx Request: 16-Bit Address - 0X01

    Frame data fields Offset Description Frame type 0x89 Identifies the UART data frame being reported. Frame ID Status 0 = success 1 = no ACK received 2 = CCA failure 3 = purged Notes: XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 95: Rx (Receive) Packet: 64-Bit Address Frame - 0X80

    When a device receives an RF data packet, it sends this frame out the UART. Format The following table provides the contents of the frame. For details on frame structure, see API frame specifications. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 96: Rx (Receive) Packet: 64-Bit Address Io Frame- 0X82

    0: Reserved bit 1: Address broadcast bit 2: PAN broadcast bits 3-7: Reserved RF data 15-n Up to 100 bytes per packet. The following table shows the Channel Indicator and Digital Samples bit fields. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 97: Rx Packet: 16-Bit Address I/O Frame - 0X83

    For example if RX signal strength is -40 dBm, then 0x28 (40 decimal) is returned. Options Bit field: bit 0: Reserved bit 1: Address broadcast bit 2: PAN broadcast bits 3-7: Reserved RF data Up to 100 bytes per packet. XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 98: Regulatory Information

    Regulatory information United States (FCC) Europe (CE) Canada (IC) Japan Brazil ANATEL XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 99: United States (Fcc)

    Note The FCC ID for the XBee is “OUR-XBEE”. The FCC ID for the XBee-PRO is “OUR-XBEEPRO”. FCC notices IMPORTANT: The XBee/XBee-PRO S1 802.15.4 (Legacy)s have been certified by the FCC for use with other products without any further certification (as per FCC section 2.1091).
  • Page 100: Fcc-Approved Antennas (2.4 Ghz)

    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 15.247...
  • Page 101 XBee/XBee-PRO RF Module common antennas The following table shows the antennas approved for use with the XBee/XBee-PRO RF Modules. Cable loss is not required as shown in the table. All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option.
  • Page 102 XBee/XBee-PRO S1 802.15.4 (Legacy) antennas The following table shows the antennas approved for use with the XBee/XBee-PRO S1 802.15.4 (Legacy). Cable loss is required as shown in the table. Part number Type (description) Gain Min. separation Required cable-loss Application Yagi class antennas...
  • Page 103 Part number Type (description) Gain Min. separation Required cable-loss Application A24-F10NF Omni-directional (Fiberglass base station) 10.0 dBi Fixed 0.7 dB A24-F12NF Omni-directional (Fiberglass base station) 12.0 dBi Fixed 2.7 dB A24-F15NF Omni-directional (Fiberglass base station) 15.0 dBi Fixed 5.7 dB A24-W7NF Omni-directional (base station) 7.2 dBi...
  • Page 104 XBee-PRO RF Module antennas The following table shows the antennas approved for use with the XBee-PRO RF Module. Cable loss is required as shown in the table. Part number Type Gain Min. separation Required cable-loss Application Yagi class antennas A24-Y4NF Yagi (4-element) 6.0 dBi...
  • Page 105 Part number Type Gain Min. separation Required cable-loss Application A24-F10NF Omni-directional (fiberglass base station) 10.0 dBi Fixed 12.1 dB A24-F12NF Omni-directional (fiberglass base station) 12.0 dBi Fixed 14.1 dB A24-F15NF Omni-directional (fiberglass base station) 15.0 dBi Fixed 17.1 dB A24-W7NF Omni-directional (base station) 7.2 dBi Fixed...
  • Page 106: Rf Exposure

    Europe (CE) RF exposure If you are an integrating the XBee into another product, you must include the following Caution statement in OEM product manuals to alert users of FCC RF exposure compliance: CAUTION! To satisfy FCC RF exposure requirements for mobile transmitting devices, a separation distance of 25 cm or more should be maintained between the antenna of this device and persons during device operation.
  • Page 107: Declarations Of Conformity

    The following antennas have been tested and approved for use with the XBee/XBee-PRO S1 802.15.4 (Legacy): All antenna part numbers followed by an asterisk (*) are not available from Digi. Consult with an antenna manufacturer for an equivalent option. Dipole (2.1 dBi, Omni-directional, Articulated RPSMA, Digi part number A24-HABSM) PCB Antenna (0.0 dBi)
  • Page 108: Canada (Ic)

    Industry Canada RSS-247 or CISPR 22 test report for compliance with ICES-003. Japan In order to use the XBee-PRO in Japan, you must order the International version. The International XBee-PRO RF Modules are limited to a transmit power output of 10 dBm (10 mW).
  • Page 109 Regulatory information Brazil ANATEL The XBee-PRO RF modules with 802.15.4 or DigiMesh firmware (models noted in conformity information below) comply with Brazil ANATEL standards in Resolution No. 506. The following information is required in the user manual for the product containing the radio and on the product containing the radio (in Portuguese): XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...
  • Page 110 Regulatory information Brazil ANATEL XBee/XBee-PRO S1 802.15.4 (Legacy) User Guide...

This manual is also suitable for:

Xbee-pro

Table of Contents