Digi XBee Manual

Digi XBee Manual

Wi-fi rf module
Hide thumbs Also See for XBee:
Table of Contents

Advertisement

Quick Links

XBee® Wi-Fi RF Module
Wi-Fi RF Modules by Digi International
Firmware version: x201x
11001 Bren Road East
Minnetonka, MN 55343
877 912-3444 or 952 912-3444
http://www.digi.com
90002180_C

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® Wi-Fi Rf Module

    XBee® Wi-Fi RF Module Wi-Fi RF Modules by Digi International Firmware version: x201x 11001 Bren Road East Minnetonka, MN 55343 877 912-3444 or 952 912-3444 http://www.digi.com 90002180_C...
  • Page 2 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® is a registered trademark of Digi International, Inc. Technical Support Phone: (866) 765-9885 toll-free U.S.A. & Canada (801) 765-9885 Worldwide 8:00 am - 5:00 pm [U.S.
  • Page 3: Table Of Contents

    Board Layout ..........................19 Design Notes for PCB Antenna Modules ..................20 Design Notes for RF Pad ....................... 23 Mounting Considerations – Xbee Wi-Fi Through-hole ..............25 2. RF Module Operation ........................26 Serial Communications ........................26 UART Communications ......................... 26 SPI Communications ........................
  • Page 4 XBee Application Service ........................41 Local Host ............................. 41 Network Client ..........................42 Sending Configuration Commands ....................43 Sending Serial Data Command to XBee ..................44 Sending Over-the-Air Firmware Upgrades ..................45 Serial Communication Service ......................46 Transparent Mode ........................46 API Mode ............................
  • Page 5 XBee® Wi-Fi RF Modules I/O Sampling ............................. 53 Queried Sampling ......................... 54 Periodic I/O Sampling ........................55 Change Detection Sampling ......................55 I/O Examples ..........................56 General Purpose Flash Memory ....................... 56 Accessing General Purpose Flash Memory .................. 56 Working with Flash Memory ......................63 Over-the-Air Firmware Upgrades .....................
  • Page 6 RX (Receive) Packet: IPv4 ......................92 Put Response ..........................93 Device Request ..........................94 Device Response Status ........................ 95 Frame Error........................... 95 8. XBee Command Reference Tables....................96 Addressing ............................96 Networking Commands ........................97 Security Commands .......................... 97 RF Interfacing Commands ........................ 97 Serial Interfacing ..........................
  • Page 7 XBee® Wi-Fi RF Modules Transmitters with Detachable Antennas ..................115 Australia (C-Tick) ..........................115 11. Manufacturing Information for Surface Mount XBee ..............116 Recommended Solder Reflow Cycle ....................116 Recommended Footprint ....................... 117 Common Footprint for Through-hole and Surface Mount ............118 Flux and Cleaning ..........................
  • Page 8: Overview

    The XBee® Wi-Fi RF module provides wireless connectivity to end-point devices in 802.11 bgn networks. Using the 802.11 feature set, these modules are interoperable with other 802.11 bgn devices, including devices from other vendors. With XBee, users can have their 802.11 bgn network up and running in a matter of minutes.
  • Page 9 XBee® Wi-Fi RF Modules RF Data Rates RF Data Rates Standard Data rates (Mbps) 802.11b 1, 2, 5.5, 11 802.11g 6, 9, 12, 18, 24, 36, 48, 54 Data rates (Mbps) Standard MCS index 800 ns guard interval 400 ns guard interval 7.22...
  • Page 10 XBee® Wi-Fi RF Modules Receiver Sensitivity Receiver Sensitivity (25 ℃, < 10% PER) Standard Data rate Sensitivity (dBm) 1 Mbps 2 Mbps 802.11b 5.5 Mbps 11 Mbps 6 Mbps 9 Mbps 12 Mbps 18 Mbps 802.11g 24 Mbps 36 Mbps...
  • Page 11 XBee® Wi-Fi RF Modules RF Transmit Power - Typical RF Transmit Power (Average) Standard Data rate Power (dBm) North America Europe 1 Mbps 2 Mbps 802.11b 5.5 Mbps 11 Mbps 6 Mbps 9 Mbps 12 Mbps 18 Mbps 802.11g 24 Mbps...
  • Page 12 XBee® Wi-Fi RF Modules EVM – Typical, Maximum Output Power EVM (25 ℃, max output power) Standard Data rate EVM (dB) 1 Mbps 2 Mbps 802.11b 5.5 Mbps 11 Mbps 6 Mbps 9 Mbps 12 Mbps 18 Mbps 802.11g 24 Mbps...
  • Page 13: Electrical Specifications

    2 mA asleep, 100 mA awake. (See AP Associated Sleep section for details.) Serial Communications Specifications The XBee Wi-Fi RF modules support both UART (Universal Asynchronous Receiver/Transmitter) and SPI slave mode (Serial Peripheral Interface in slave mode only) serial connections.
  • Page 14: Spi

    2. GPIO Specifications The XBee Wi-Fi modules have 14 (Through-hole version) and 20 (Surface mount version) GPIO (General Purpose Input Output) ports available. Those available will depend on the module configuration as some GPIO’s are consumed by serial communication, etc.
  • Page 15: Agency Approvals

    Europe (DC) ETSI ETSI Australia C-Tick C-Tick Brazil Pending Pending Japan Pending Pending FCC Approval (USA) Refer to Chapter 12 FCC Requirements. Systems that contain XBee Wi-Fi modules inherit Digi Mechanical Drawings Certifications. Through-hole Version © 2013 Digi International, Inc.
  • Page 16 XBee® Wi-Fi RF Modules Surface Mount Version © 2013 Digi International, Inc.
  • Page 17: Pin Signals

    XBee® Wi-Fi RF Modules Pin Signals Pin Assignment for the XBee Wi-Fi Through-hole module (Low-asserted signals are distinguished with a lower case n before the signal name.) Pin # Name Direction Default State Description Power Supply DIO13/DOUT Both Output UART Data out...
  • Page 18: Design Notes

    Do Not Connect Design Notes XBee modules are designed to be self sufficient and do not specifically require any external circuitry other than the recommended pin connections described below. The following sections discuss general design guidelines that are recommended for help in troubleshooting and building a robust design.
  • Page 19: Power Supply

    Use internal or external pull-up or pull-down resistors, or set the unused I/O lines to outputs. The deep sleep (pin sleep) current specification can be achieved using a standard XBee Interface Board with the XBee Wi-Fi module's pull-up and pull- down resistors configured as default.
  • Page 20: Design Notes For Pcb Antenna Modules

    Design Notes for PCB Antenna Modules XBee modules with an embedded PCB antenna should not have any ground planes or metal objects above or below the module at the antenna location. The module should not be placed in a metal enclosure, which may greatly reduce the range. It should be placed at the edge of the PCB to which it is mounted.
  • Page 21 XBee® Wi-Fi RF Modules © 2013 Digi International, Inc.
  • Page 22 XBee® Wi-Fi RF Modules © 2013 Digi International, Inc.
  • Page 23: Design Notes For Rf Pad

    XBee® Wi-Fi RF Modules Design Notes for RF Pad The RF Pad is a soldered antenna connection. The RF signal travels from pin 36 on the module to the antenna through an RF trace transmission line on the PCB. Please note that any additional components between the module and antenna will violate modular certification.
  • Page 24 XBee® Wi-Fi RF Modules PCB Layer 1 of RF Pad Layout Example PCB Layer 2 of RF Pad Layout Example © 2013 Digi International, Inc.
  • Page 25: Mounting Considerations - Xbee Wi-Fi Through-Hole

    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. © 2013 Digi International, Inc.
  • Page 26: Rf Module Operation

    2. RF Module Operation Serial Communications The XBee RF Modules interface to a host device through a logic-level asynchronous serial port, or a Serial Peripheral Interface (SPI) port. Through its serial ports, the module can communicate with any logic and voltage compatible UART or SPI; or through a level UART Communications translator to any serial device (for example: through a RS-232 or USB interface board).
  • Page 27: Spi Communications

    SPI_nATTN(Attention) – alerts the master that slave has data queued to send. The XBee module will assert this pin as soon as data is available to send to the SPI master and it will remain asserted until the SPI master has clocked out all available data.
  • Page 28 SPI mode can be forced by holding DIO13/DOUT low while resetting the module until SPI_nATTN asserts. By this means, the XBee Wi-Fi module will disable the UART and go straight into SPI communication mode. Once configuration is completed, a modem status frame is queued by the module to the SPI port which will cause the SPI_nATTN line to assert.
  • Page 29: Serial Buffers

    XBee® Wi-Fi RF Modules Serial Buffers The XBee modules maintain buffers to collect received serial and RF data, which is illustrated in the figure below. The serial receive buffer collects incoming serial characters and holds them until they can be processed. The serial transmit buffer collects data that is received via the RF link that will be transmitted out the UART or SPI port.
  • Page 30: Uart Flow Control

    RF data packet will be discarded. Note: If RTS flow control is enabled and the XBee is sending data out the UART when nRTS is de-asserted (set high), the XBee could send up to 4 characters out the UART to clear its FIFO after nRTS is de-asserted.
  • Page 31: Serial Interface Protocols

    XBee® Wi-Fi 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 is queued up for RF transmission. When RF data is received, the data is sent out through the UART.
  • Page 32: A Comparison Of Transparent And Api Operation

    XBee® Wi-Fi RF Modules The API provides an alternative means of configuring modules and of routing data at the local host application layer. A local host application can send data frames to the module that contain address and payload information instead of using command mode to modify addresses.
  • Page 33: Modes Of Operation

    XBee® Wi-Fi RF Modules Modes of Operation Idle Mode When not receiving or transmitting data, the RF module is in Idle Mode. The module 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 34 XBee® Wi-Fi RF Modules NOTE: Failure to enter AT Command Mode is most commonly due to baud rate mismatch. By default, the BD (Baud Rate) parameter = 3 (9600 bps). To Send AT Commands, send AT commands and parameters using the syntax shown below: To read a parameter value stored in the RF module’s register, omit the parameter field.
  • Page 35: Configuration Mode

    5. Write the desired configuration to non-volatile memory using the WR command. 6. Set up the interface to the XBee to match the configuration just written to non- volatile memory. 7. Optionally, reset the module and then begin operation in the new mode.
  • Page 36: Using X-Ctu To Enter Configuration Mode

    Sleep modes allow the RF module to enter states of low power consumption when not in use. The XBee Wi-Fi modules support both pin sleep (sleep mode entered on pin transition) and cyclic sleep (module sleeps for a fixed time). For both pin sleep and cyclic sleep the sleep level may be either deep sleep or associated sleep.
  • Page 37: 3. 802.11 Bgn Networks

    XBee® Wi-Fi RF Modules 3. 802.11 bgn Networks Infrastructure Networks The main type of wireless network will involve a number of wireless devices (called stations) talking through a master wireless device known as an Access Point (AP for short). This type of setup is called an Infrastructure or BSS (Basic Service Set) network.
  • Page 38: Network Basics

    XBee® Wi-Fi RF Modules Note that ad hoc networks are point to point and that there can only be two nodes in the network, a creator and a joiner. Set up the creator first, and then the joiner. Ad Hoc Creator Set up the following parameters for the creator: •...
  • Page 39: Xbee® Wi-Fi Standards

    802.11 n The 802.11n standard was approved in 2009. It provides for data rates up to 300Mbps. The XBee® Wi-Fi module uses the single stream n mode with 20MHz bandwidth and is Encryption capable of up to 72.2 Mbps over the air in n mode.
  • Page 40 XBee® Wi-Fi RF Modules The center frequencies of the 13 possible channels range from 2412 to 2472 MHz, with each channel being 22 MHz wide and centered in 5 MHz intervals. This means that only 3 channels (1, 6, and 11) in North America are not subject to overlapping.
  • Page 41: Xbee Ip Services

    XBee® Wi-Fi RF Modules 4. XBee IP Services The XBee provides services using IP (Internet Protocol) for XBee and other clients on the network. IP services provide functionality to allow XBee configuration and direct serial port access. There are two XBee services: •...
  • Page 42: Network Client

    XBee® Wi-Fi RF Modules Transmitting Data The local host uses the TX64 frame to send data to another XBee using this service. When the frame is received through the serial port the XBee converts the contents of the frame to a serial data transfer command as defined by the XBee application service.
  • Page 43: Sending Configuration Commands

    XBee® Wi-Fi RF Modules Sending Configuration Commands AT commands can be sent to the XBee Wi-Fi module from a network client. The following packet structure demonstrates how to query the SSID from a network client: Packet Fields Offset Example Description...
  • Page 44: Sending Serial Data Command To Xbee

    Sample data generated by the module will be sent to the address configured by the DL commands. This data can be sent to another XBee or to a network client. It will be sent using UDP from the 0xBEE port as with other XBee Application services. Sample data will be received by the client as follows: ©...
  • Page 45: Sending Over-The-Air Firmware Upgrades

    ADC1 in this example. Sending Over-the-Air Firmware Upgrades A network client can also use the XBee IP services to send a firmware upgrade to the module. This is done by sending a frame formatted with an application header, followed by a GPM header, following by GPM data. The format of the application header is given above.
  • Page 46: Serial Communication Service

    The serial communication service connects an IP port to the serial peripheral (UART or SPI) of the XBee. No additional formatting or header is required and data will be transferred between the RF hardware and Serial Communication hardware as received.
  • Page 47 XBee® Wi-Fi RF Modules TCP packets may be sent on an existing connection or on a new connection. In order to send data on an existing TCP connection, the destination IP address and port in the API packet must match the remote IP address and port in an existing socket. In a sample application, a packet may arrive that expects return data on the same socket.
  • Page 48: Sleep

    SPI slave. Since the function of SPI_nATTN is to indicate when the XBee has data to send to the host, it may legitimately be driven high or low while the module is awake.
  • Page 49: Sleep Options

    XBee® Wi-Fi RF Modules When using the SPI, either SleepRq or SPI_nSSEL may be used for pin sleep. If D8 is configured as a peripheral (1), then it will be used for pin sleep. If not, and SPI_nSSEL is configured as a peripheral (which it must be to enable SPI operation), then SPI_nSSEL is used for pin sleep.
  • Page 50: Deep Sleep (Non-Associated Sleep)

    XBee® Wi-Fi RF Modules SPI operation is similar except that the radio asserts nATTN when data becomes available and then the local host is expected to assert SPI_nSSEL and to provide a clock until the data available is sent out.
  • Page 51: Sampling Data Using Sleep Modes

    XBee® Wi-Fi RF Modules module will sleep anyway. When it awakens from this state, then it will start the SA timer again to seek to establish association. Under normal conditions, SA is used for a time out for the first association following reset and ST is used for short wake cycles thereafter.
  • Page 52: Advanced Application Features

    6. Advanced Application Features XBee Analog and Digital I/O Lines XBee Wi-Fi firmware supports a number of analog and digital I/O pins that are configured through software commands. Analog and digital I/O lines can be set or queried. The following tables list the configurable I/O pins and the corresponding configuration commands.
  • Page 53: I/O Sampling

    XBee® Wi-Fi RF Modules I/O Configuration To enable an analog or digital I/O function on one or more XBee module pin(s), the appropriate configuration command must be issued with the correct parameter. After issuing the configuration command, changes must be applied on the module for the I/O settings to take effect.
  • Page 54: Queried Sampling

    XBee® Wi-Fi RF Modules • bit 8 = DIO8 • bit 9 = DIO9 • bit 10 = DIO10 • bit 11 = DIO11 • bit 12 = DIO12 For example, a digital channel mask of 0x002F means DIO0 1, 2, 3, and 5 are enabled as digital IO.
  • Page 55: Periodic I/O Sampling

    [Analog input ADIO 1=0x120] Periodic I/O Sampling Periodic sampling allows the XBee module to take an I/O sample and transmit it to a remote device at a periodic rate. The periodic sample rate is set by the IR command. If IR is set to 0 or there are no active I/O lines, periodic sampling is disabled.
  • Page 56: I/O Examples

    Accessing General Purpose Flash Memory The GPM of a target node can be accessed from the XBee serial port or from a non-XBee network client. Serial port access is done by sending explicit API frames to the MEMORY_ACCESS cluster ID (0x23) on the DIGI_DEVICE endpoint (0xE6) of the target node.
  • Page 57 XBee® Wi-Fi RF Modules Byte Offset in Number of Field Name General Field Description Payload Bytes GPM_CMD_ID Specific GPM commands are described below GPM_OPTIONS Command-specific option GPM_BLOCK_NUM The block number addressed in the GPM GPM_START_INDEX The byte index within the addressed GPM block...
  • Page 58 XBee® Wi-Fi RF Modules PLATFORM_INFO (0x80): When a PLATFORM_INFO_REQUEST command request has been unicast to a node, that node will send a response in the following format to the source endpoint specified in the requesting frame. Field Name Command –Specific Description GPM_CMD_ID Should be set to PLATFORM_INFO (0x80).
  • Page 59 XBee® Wi-Fi RF Modules ERASE_RESPONSE (0x81): When an ERASE command request has been unicast to a node, that node will send a response in the following format to the source endpoint specified in the requesting frame. Field Name Command –Specific Description GPM_CMD_ID Should be set to ERASE_RESPONSE (0x81).
  • Page 60 XBee® Wi-Fi RF Modules 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 will send a response in the following format to the source endpoint specified in the requesting frame.
  • Page 61 XBee® Wi-Fi RF Modules READ _RESPONSE (0x84): When a READ command request has been unicast to a node, that node will send a response in the following format to the source endpoint specified in the requesting frame. Field Name Command –Specific Description GPM_CMD_ID Should be set to READ_RESPONSE (0x84).
  • Page 62 XBee® Wi-Fi RF Modules FIRMWARE_VERIFY _RESPONSE (0x85): When a FIRMWARE_VERIFY command request has been unicast to a node, that node will send a response in the following format to the source endpoint specified in the requesting frame. Field Name Command –Specific Description GPM_CMD_ID Should be set to FIRMWARE_VERIFY_RESPONSE (0x85).
  • Page 63: Working With Flash Memory

    Over-the-Air Firmware Upgrades The XBee Wi-Fi RF modules provide two methods of updating the firmware on the module. Firmware can be updated locally via X-CTU (a free testing and configuration utility provided by Digi) using the radio's serial port interface. Firmware can also be updated using the radios' RF interface (Over-the-Air Updating.)
  • Page 64: Verifying The New Application

    XBee® Wi-Fi RF Modules The contents of the .ebin file should be sent to the target radio using general purpose memory WRITE commands. The entire GPM should be erased 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 65: Things To Remember

    XBee® Wi-Fi RF Modules Things to Remember • The firmware upgrade process requires that the module resets itself. Because of this reset parameters which have not been written to flash will be lost after the reset. To avoid this, write all parameters with the WR command before doing a firmware upgrade.
  • Page 66: Api Operation

    UART or SPI Data Frame. Please note that Digi may add new API frames to future versions of firmware, so please build into your software interface the ability to filter out additional API frames API Frame Specifications with unknown Frame Types.
  • Page 67 The cmdID frame (API-identifier) indicates which API messages will be contained in the cmdData frame (Identifier-specific data). Note that multi-byte values are sent big endian. The XBee modules support the following API frames: API Frame Names and Values API Frame Names...
  • Page 68 0xFF. API Examples Example: Create an API AT command frame to configure an XBee baud rate to 230,400 (set BD to 0x08). The frame should look like (in hex): 7E 00 05 08 01 42 44 08 68...
  • Page 69: Api Uart And Spi Exchanges

    XBee® Wi-Fi RF Modules API UART and SPI Exchanges AT Commands The following image shows the API frame exchange that takes place at the UART or SPI when sending an AT command request to read or set a module parameter. The response can be disabled by setting the frame ID to 0 in the request.
  • Page 70: Remote At Commands

    XBee® Wi-Fi RF Modules Remote AT commands The following image shows the API frame exchanges that take place at the UART or SPI when sending a remote AT command. A remote command response frame is not sent out the UART or SPI if the remote module does not receive the remote command.
  • Page 71: Api Frames

    The following sections illustrate the types of frames encountered while using the API. TX (Transmit) Request: 64-Bit Frame Type: 0x00 This frame type uses the XBee Application Service. This command allows for software compatibility with other XBee module such as the 802.15.4 module. Frame Fields...
  • Page 72: Remote At Command Request

    XBee® Wi-Fi RF Modules Remote AT Command Request Frame Type: 0x07 Used to query or set module parameters on a remote module. For parameter changes on the remote module to take effect, changes must be applied, either by setting the apply changes options bit, or by sending an AC command to the remote.
  • Page 73: At Command

    XBee® Wi-Fi RF Modules AT Command Frame Type: 0x08 Used to query or set module parameters on the local module. This API command applies changes after executing the command. (Changes made to module parameters take effect once changes are applied.) The API example below illustrates an API frame when modifying the NI parameter value of the module.
  • Page 74: At Command-Queue Parameter Value

    XBee® Wi-Fi RF Modules AT Command-Queue Parameter Value Frame Type: 0x09 This API type allows module parameters to be queried or set. In contrast to the “AT Command” API type, new parameter values are queued and not applied until either the “AT Command”...
  • Page 75: Zigbee Transmit Packet

    XBee® Wi-Fi RF Modules ZigBee Transmit Packet Frame Type: 0x10 This frame type is only provided for software compatibility with other XBee modules. Frame type 0x20 is recommended for data transmissions from this module. An example of this frame type is given below:...
  • Page 76: Zigbee Explicit Transmit Packet

    ZigBee Explicit Transmit Packet Frame Type: 0x11 This frame type is provided for software compatibility with other XBee modules and for sending GPM requests. If neither of these is required, then frame type 0x20 is recommended for data transmissions from this module. An example of a GPM request is given below:...
  • Page 77: Zigbee Remote At Command

    ZigBee Remote AT Command Frame Type: 0x17 This frame type is only provided for software compatibility with other XBee modules. Frame type 0x07 is recommended for sending remote commands from this module. An example of this frame type is given below:...
  • Page 78: Transmit (Tx) Request: Ipv4

    XBee® Wi-Fi RF Modules Transmit (TX) Request: IPv4 Frame Type: 0x20 This frame type utilizes the serial data service. The frame gives greater control to the application over the IP setting for the data. Frame Fields Offset Example Description Start...
  • Page 79: Put Request

    XBee® Wi-Fi RF Modules Put Request Frame Type: 0x28 This frame type is used to send a file of the given name and type to the iDigi server. Frame Fields Offset Example Description Start 0x7E Delimiter MSB 1 0x00 Length...
  • Page 80: Device Response

    XBee® Wi-Fi RF Modules Device Response Frame Type: 0x2A This frame type is sent to the serial port by the host in response to the device request (0xB9). It should be sent within five seconds to avoid a timeout error.
  • Page 81: Rx (Receive) Packet: 64-Bit

    Rx (Receive) Packet: 64-bit Frame Type: 0x80 This frame type is used by XBee when RF data is received using the XBee application service. It allows for software compatibility with other XBee modules such as 802.15.4. An example of this frame type is given below:...
  • Page 82: Remote Command Response

    XBee® Wi-Fi RF Modules Remote Command Response Frame Type: 0x87 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 or SPI.
  • Page 83: At Command Response

    XBee® Wi-Fi RF Modules AT Command Response Frame Type: 0x88 In response to an AT Command message, the module will send an AT Command Response message. Some commands will send back multiple frames (for example, the AS (Active Scan) command).
  • Page 84: Transmission Status

    XBee® Wi-Fi RF Modules Transmission Status Frame Type: (0x89) RF transmission status messages are sent from the module in response to transmission attempts. Example: The following API frame is returned when a successful transmission occurs on an API transmission using frame ID 01.
  • Page 85: Modem Status

    XBee® Wi-Fi RF Modules Modem Status Frame Type: (0x8A) RF module status messages are sent from the module in response to specific conditions. Example: The following API frame is returned when a module is powered on in API mode. Frame Fields...
  • Page 86: Zigbee Tx Status

    ZigBee TX Status Frame Type: 0x8B This frame type is only provided for software compatibility with other XBee modules. Frame type 0x89 is normally sent in response to transmissions. This frame type is sent in response to Zigbee (0x10) and Zigbee explicit (0x11) transmissions. An example of this frame type is given...
  • Page 87: Io Data Sample Rx Indicator

    XBee® Wi-Fi RF Modules IO Data Sample RX Indicator Frame Type: 0x8F When the module receives an IO sample frame from a remote module, it sends the sample out the UART or SPI using this frame type. Only modules running API mode will be able to receive IO samples.
  • Page 88 XBee® Wi-Fi RF Modules © 2013 Digi International, Inc.
  • Page 89: Zigbee Receive Packet

    This frame type is used by XBee when RF data is received using the XBee application service and AO is set to 0. It is not generally used, but it allows for software compatibility with other XBee modules if desired. An example of this frame type is given below:...
  • Page 90: Explicit Zigbee Receive Packet

    Frame Type: 0x91 This frame type is used by XBee when RF data is received using the XBee application service and AO is set to 1. Even when AO is not 1, this frame is also used for GPM response frames as described in chapter 6.
  • Page 91: Zigbee Remote At Command Response

    ZigBee Remote AT Command Response Frame Type: 0x97 This frame type is only provided for software compatibility with other XBee modules. It is used to generate a response to the ZigBee Remote AT Command (0x17). Normally, Remote AT command (0x07) is used instead with a remote command response of 0x87. An example of this...
  • Page 92: Rx (Receive) Packet: Ipv4

    RX (Receive) Packet: IPv4 Frame Type: 0xB0 This frame is used by XBee when RF data is received using the Serial Data service on the port defined by the C0 command. Example: When a module in API mode receives an IPv4 transmission, it will produce an RX notification (0xB0) and send it out the UART or SPI.
  • Page 93: Put Response

    XBee® Wi-Fi RF Modules Put Response Frame Type: 0xB8 This frame type is sent out the serial port in response to the put request, providing its frame ID is non-zero. Frame Fields Offset Example Description Start 0x7E Delimiter MSB 1...
  • Page 94: Device Request

    XBee® Wi-Fi RF Modules Device Request Frame Type: 0xB9 This frame type is sent out the serial port when the XBee module receives a valid device request from the iDigi server. Frame Fields Offset Example Description Start 0x7E Delimiter MSB 1...
  • Page 95: Device Response Status

    XBee® Wi-Fi RF Modules Device Response Status Frame Type: 0xBA This frame type is sent to the serial port after the serial port sends a device response (frame type 0x2A). Frame Fields Offset Example Description Start 0x7E Delimiter MSB 1...
  • Page 96: Xbee Command Reference Tables

    The protocol used is set by the IP command when UART is in transparent mode. Device Type Identifier. Stores a device type value. This value can be used to differentiate different XBee-based devices. Digi reserves the range 0 - 0-0xFFFFFFFF 0x90000 0xFFFFFF.
  • Page 97: Networking Commands

    XBee® Wi-Fi RF Modules Networking Commands Name and Description Parameter Range Default Command Device options. Set/Read device options. If bit 0 is set, it enables iDigi functions. All other bits are reserved and should be 0. SSID. Set/read the SSID of the access point, which may be up to 31 ASCII characters...
  • Page 98: Serial Interfacing

    XBee® Wi-Fi RF Modules Serial Interfacing Parameter Name and Description Default Command Range 0 = Transparent mode 1 = API-enabled API Enable. Enable API Mode. 2 = API-enabled (w/escaped control characters) 0=ZigBee Rx API Output Options. Indicates the type of frame to output when data is received on...
  • Page 99: I/O Settings

    XBee® Wi-Fi RF Modules I/O Settings Parameter Name and Description Default Command Range Force Sample Forces a read of all enabled digital and analog input lines. IO Sample Rate. Set/Read the IO sample rate to enable periodic sampling. For periodic sampling to be enabled, IR must be set to a non-zero value, and at least one...
  • Page 100 XBee® Wi-Fi RF Modules Parameter Name and Description Default Command Range 0 = Disabled 1 = SPI_nSSEL 4 = Digital output, P7** DIO17 Configuration. Select/Read function for the DIO17 line of the RF module. default low 5 = Digital output,...
  • Page 101 XBee® Wi-Fi RF Modules Parameter Name and Description Default Command Range 0 = Disabled 1 = Associated LED 3 = Digital input DIO5 Configuration. Select/Read function for DIO5 4 = Digital output, default low 5 = Digital output, default high...
  • Page 102: Diagnostics Interfacing

    Factory-set only] indicates the hardware revision. XBee WiFi modules return 0x1Fxx for the HV command. Hardware Series. Indicates the hardware series number of the module. This module should indicate 0x601 for S6B. Association Indication. Read information regarding last node join request: 0x00 - Successfully joined an access point, established IP addresses and IP listening sockets.
  • Page 103: At Command Options

    XBee® Wi-Fi RF Modules AT Command Options Parameter Name and Description Default Command Range Command Mode Timeout. Set/Read the period of inactivity (no valid commands 2 - 0x1770 [x 100 received) after which the RF module automatically exits AT Command Mode and 0x64 (100d) returns to Idle Mode.
  • Page 104: Execution Commands

    XBee® Wi-Fi RF Modules Execution Commands Where most AT commands set or query register values, execution commands cause an action to be executed on the module. Execution commands are executed immediately and do not require changes to be applied. Parameter...
  • Page 105: Module Support

    3, 9, and 16 (DIN, nDTR, and nRTS, respectively). By driving DIN low, nDTR low, and nRTS high at the time the module is reset, the XBee bootloader is forced to run, allowing a new version of firmware to load. This method works even when the current firmware version does not support the firmware upgrade feature.
  • Page 106: 10. Agency Certifications

    1. The system integrator must ensure that the text on the module label is placed on the outside of the final product. 2. XBee Wi-Fi Module may only be used with antennas that have been tested and approved for use with this module [refer to the antenna tables in this section].
  • Page 107 Antennas not listed in the table must be tested to comply with FCC Section 15.203 (Unique Antenna Connectors) and Section 15.247 (Emissions). XBee Wi-Fi RF Modules have been approved for use with all the antennas listed in the tables below. (Cable-loss is required when using gain antennas as shown below.) Digi does not carry all of these antenna variants.
  • Page 108 XBee® Wi-Fi RF Modules Dipole Antennas Minimum Cable Loss/Power Reduction/Attenuation Required Part Number Type (Description) Gain Application Separation b mode g mode n mode Dipole (Half-wave articulated A24-HASM-450 RPSMA-4.5") Fixed/Mobile 20 cm A24-HABSM Dipole (Articulated RPSMA) Fixed 20 cm Dipole (Half-wave bulkhead A24-HABUF-P5I mount U.FL s/ 5"...
  • Page 109 4.4 dB 7.9 dB 7.9 dB A24-Y18NF Yagi (18 element) 15.0 dBi Fixed 5.9 dB Antennas approved for use with the XBee Wi-Fi Surface Mount Module Integrated Antennas Minimum Cable Loss/Power Reduction/Attenuation Required Part Number Type (Description) Gain Application Separation...
  • Page 110 XBee® Wi-Fi RF Modules Omni-Directional Antennas Minimum Cable Loss/Power Reduction/Attenuation Required Part Number Type (Description) Gain Application Separation b mode g mode n mode Omni-Directional (Fiberglass A24-F2NF base station) Fixed/Mobile 20 cm Omni-Directional (Fiberglass A24-F3NF base station) Fixed/Mobile 20 cm...
  • Page 111 XBee® Wi-Fi RF Modules YAGI CLASS ANTENNAS Minimum Cable Loss/Power Reduction/Attenuation Required g mode n mode Type (Description) Gain Application Separation mode Part Number 0.8 dB 1.2 dB A24-Y6NF Yagi (6 element) 8.8 dBi Fixed 1.0 dB 1.5 dB A24-Y7NF Yagi (7 element) 9.0 dBi...
  • Page 112: Europe (Etsi)

    XBee® Wi-Fi RF Modules Europe (ETSI) The XBee Wi-Fi RF Module has been certified for use in several European countries. For a complete list, refer to www.digi.com If the module is incorporated into a product, the manufacturer must ensure compliance of the final product to the European harmonized EMC and low-voltage/safety standards.
  • Page 113: Restrictions

    XBee® Wi-Fi RF Modules Restrictions Declarations of Conformity Digi has issued Declarations of Conformity for the XBee RF Modules concerning emissions, EMC and safety. Files can be obtained by contacting Digi Support. © 2013 Digi International, Inc.
  • Page 114: Approved Antennas

    XBee® Wi-Fi RF Modules 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. For more information relating to European...
  • Page 115: Transmitters With Detachable Antennas

    In order to have a C-Tick mark on an end product, a company must comply with a or b below. a. have a company presence in Australia. b. have a company/distributor/agent in Australia that will sponsor the importing of the end product. Contact Digi for questions related to locating a contact in Australia. © 2013 Digi International, Inc.
  • Page 116: Manufacturing Information For Surface Mount Xbee

    11. Manufacturing Information for Surface Mount XBee The surface mount XBee 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 Recommended Solder Reflow Cycle the edge of the module, so that there are no hidden solder joints.
  • Page 117: Recommended Footprint

    XBee® Wi-Fi RF Modules Recommended Footprint It is recommended that you use the PCB footprint shown below for surface mounting. Dimensions are in inches. The solder footprint should be matched to the copper pads, but may need to be adjusted depending on the specific needs of assembly and product standards. While the underside of the module is mostly coated with solder resist, it is recommended that the copper layer directly below the module be left open to avoid unintended contacts.
  • Page 118: Common Footprint For Through-Hole And Surface Mount

    XBee® Wi-Fi RF Modules Common Footprint for Through-hole and Surface Mount Digi has designed a common footprint which will allow either module to be attached to a PCB. The layout is shown below. The round holes in the diagram are for the Through- hole version, and the semi-oval pads are for the Surface Mount version.
  • Page 119: Reworking

    XBee® Wi-Fi RF Modules Reworking Rework should never be performed on the module itself. The module has been optimized to give the best possible performance, and reworking the module itself will void warranty coverage and certifications. We recognize that some customers will choose to rework and void the warranty;...
  • Page 120: 12.Glossary Of Terms

    12.Glossary of Terms Definitions Local Host A device which is electrically connected to an XBee. Typically this is a microcontroller connected to the serial pins of the module. MAC address A unique network identifier. All network devices are required to have their own unique MAC address.
  • Page 121 XBee® Wi-Fi RF Modules Systems Interconnection (OSI) communication model, TCP is in layer 4, the Transport Layer. See User Datagram Protocol. User Datagram Protocol (UDP) A communications protocol that offers a limited amount of service when messages are exchanged between computers in a network that uses the Internet Protocol (IP). UDP is an alternative to the Transmission Control Protocol (TCP) and, together with IP, is sometimes referred to as UDP/IP.

Table of Contents