1. Manuals
  2. Brands
  3. AG Electronica Manuals
  4. Control Unit
  5. XBee 2 Series
  6. Manual

AG Electronica XBee 2 Series Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
www.agelectronica.com
www.agelectronica.com
XBee ZNet 2.5 (Formerly Series 2) - 1 mW, U.FL antenna
connector, 250000 bps, industrial grade (-40° C to 85° C)
Part Numbers:
 
DC Characteristics of the XBee Series 2 (VCC = 2.8 ‐ 3.4 VDC) 
www.agelectronica.com
www.agelectronica.com
North America: XB24-BUIT-004
International:
XB24-BUIT-004
www.agelectronica.com
www.agelectronica.com
www.agelectronica.com
www.agelectronica.com

Advertisement

Table of Contents
loading

Summary of Contents for AG Electronica XBee 2 Series

  • Page 1 www.agelectronica.com www.agelectronica.com www.agelectronica.com www.agelectronica.com XBee ZNet 2.5 (Formerly Series 2) - 1 mW, U.FL antenna connector, 250000 bps, industrial grade (-40° C to 85° C) Part Numbers: North America: XB24-BUIT-004 International: XB24-BUIT-004   DC Characteristics of the XBee Series 2 (VCC = 2.8 ‐ 3.4 VDC)  www.agelectronica.com www.agelectronica.com www.agelectronica.com www.agelectronica.com...
  • Page 2 www.agelectronica.com www.agelectronica.com XBee™ Series 2 OEM RF Modules XBee Series 2 Series 2 OEM RF Modules ZigBee™ Networks RF Module Operation RF Module Configuration Appendices Product Manual v1.x.2x - ZigBee Protocol For OEM RF Module Part Numbers: XB24-BxIT-00x ZigBee OEM RF Modules by MaxStream, Inc. - a Digi International brand Firmware Versions: 1.0xx - Coordinator, Transparent Operation 1.1xx - Coordinator, API Operation...
  • Page 3 www.agelectronica.com www.agelectronica.com XBee Series 2 OEM RF Modules‐ ZigBee ‐ v1.x2x  [2007.07.019] © 2007 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. ® ZigBee  is a registered trademark of the ZigBee Alliance. XBee™ Series 2  is a trademark of Digi International, Inc. Technical Support:  Phone: (801) 765‐9885 Live Chat: www.maxstream.net E‐mail: rf‐xperts@maxstream.net © 2007 Digi International, Inc.      ii www.agelectronica.com www.agelectronica.com...

  • Page 4: Table Of Contents

    www.agelectronica.com www.agelectronica.com XBee Series 2 OEM RF Modules ‐ ZigBee ‐ v1.x2x  [2007.07.019] Contents 1. XBee Series 2 OEM RF Modules 4.3. Sleep Mode Operation 32 4.3.1. End Device Operation 1.1. Key Features 4 4.3.2. Parent Operation 1.1.1. Worldwide Acceptance 4.4. I/O Line Configuration 32 1.2. Specifications 5 5. Advanced Features 1.3.

  • Page 5: Xbee Series 2 Oem Rf Modules

    www.agelectronica.com www.agelectronica.com 1. XBee Series 2 OEM RF Modules The XBee Series 2 OEM RF Modules were engineered to operate within the ZigBee protocol and 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. The modules operate within the ISM 2.4 GHz frequency band.

  • Page 6: Specifications

    www.agelectronica.com www.agelectronica.com XBee Series 2 OEM RF Modules ‐ ZigBee ‐ v1.x2x  [2007.07.019] Chapter 1 ‐ XBee Series 2 OEM RF Modules 1.2. Specifications Table 1‐01. Specifications of the XBee Series 2 OEM RF Module  Specification XBee Series 2 Performance Indoor/Urban Range up to 133 ft. (40 m)* Outdoor RF line-of-sight Range up to 400 ft. (120 m)* 2mW (+3dBm), boost mode enabled Transmit Power Output (software selectable) 1.25mW (+1dBm), boost mode disabled RF Data Rate 250,000 bps...

  • Page 7: Mechanical Drawings

    www.agelectronica.com www.agelectronica.com XBee Series 2 OEM RF Modules ‐ ZigBee ‐ v1.x2x  [2007.07.019] Chapter 1 ‐ XBee Series 2 OEM RF Modules 1.3. Mechanical Drawings Figure 1‐01. Mechanical drawings of the XBee Series 2 OEM RF Modules (antenna options not shown) .  XBee 1.4. Mounting Considerations The XBee Series 2 RF Module (through-hole) was designed to mount into a receptacle (socket) and therefore does not require any soldering when mounting it to a board. The XBee Series 2 Development Kits contain RS-232 and USB interface boards which use two 20-pin receptacles to receive modules.

  • Page 8: Pin Signals

    www.agelectronica.com www.agelectronica.com XBee Series 2 OEM RF Modules ‐ ZigBee ‐ v1.x2x  [2007.07.019] Chapter 1 ‐ XBee Series 2 OEM RF Modules 1.5. Pin Signals Figure 1‐03. XBee Series 2 RF Module Pin Number (top sides shown ‐ shields on bottom) Table 1‐02. Pin Assignments for the XBee Series 2 Modules (Low‐asserted signals are distinguished with a horizontal line above signal name.) Pin # Name Direction Description Power supply DOUT Output UART Data Out DIN / CONFIG Input UART Data In DIO12 Either Digital I/O 12 RESET Input Module Reset (reset pulse must be at least 200 ns) PWM0 / RSSI / DIO10 Either PWM Output 0 / RX Signal Strength Indicator / Digital IO...

  • Page 9: Electrical Characteristics

    www.agelectronica.com www.agelectronica.com XBee Series 2 OEM RF Modules ‐ ZigBee ‐ v1.x2x  [2007.07.019] Chapter 1 ‐ XBee Series 2 OEM RF Modules 1.6. Electrical Characteristics Table 1‐03. DC Characteristics of the XBee Series 2 (VCC = 2.8 ‐ 3.4 VDC) Symbol Parameter Condition Typical Units Input Low Voltage All Digital Inputs 0.2 * VCC Input High Voltage All Digital Inputs 0.8 * VCC 0.18* VCC = 2 mA, VCC >= 2.7 V Output Low Voltage 0.18*VCC = -2 mA, VCC >= 2.7 V...

  • Page 10: Rf Module Operation

    www.agelectronica.com www.agelectronica.com 2. RF Module Operation 2.1. Serial Communications The XBee Series 2 OEM 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 MaxStream proprietary RS-232 or USB interface board).

  • Page 11: Serial Flow Control

    www.agelectronica.com www.agelectronica.com XBee Series 2 OEM RF Modules ‐ ZigBee ‐ v1.x2x  [2007.07.019] Chapter 2 ‐ RF Module Operation Figure 2‐03. 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 www.agelectronica.com www.agelectronica.com XBee Series 2 OEM RF Modules ‐ ZigBee ‐ v1.x2x  [2007.07.019] Chapter 2 ‐ RF Module Operation RTS Flow Control If flow RTS control is enabled (D6 command), data in the serial transmit buffer will not be sent out the DOUT pin as long as RTS is de-asserted (set high). The host device should not de-assert RTS for long periods of time to avoid filling the serial transmit buffer.

  • Page 13: Transparent Operation

    www.agelectronica.com www.agelectronica.com XBee Series 2 OEM RF Modules ‐ ZigBee ‐ v1.x2x  [2007.07.019] Chapter 2 ‐ RF Module Operation 2.1.4. Transparent Operation RF modules that contain the following firmware versions will support Transparent Mode: 1.0xx (coordinator) and 1.2xx (router/end device). 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.

  • Page 14: Modes Of Operation

    www.agelectronica.com www.agelectronica.com XBee Series 2 OEM RF Modules ‐ ZigBee ‐ v1.x2x  [2007.07.019] Chapter 2 ‐ RF Module Operation 2.2. Modes of Operation 2.2.1. Idle Mode When not receiving or transmitting data, the RF module is in Idle Mode. During Idle Mode, the RF module is also checking for valid RF data. The module shifts into the other modes of operation under the following conditions: •...

  • Page 15: Receive Mode

    www.agelectronica.com www.agelectronica.com XBee Series 2 OEM RF Modules ‐ ZigBee ‐ v1.x2x  [2007.07.019] Chapter 2 ‐ RF Module Operation 2.2.3. Receive Mode If a valid RF packet is received, the data is transferred to the serial transmit buffer 2.2.4. 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 16: Sleep Mode

    www.agelectronica.com www.agelectronica.com XBee Series 2 OEM RF Modules ‐ ZigBee ‐ v1.x2x  [2007.07.019] Chapter 2 ‐ RF Module Operation 2.2.5. Sleep Mode Sleep modes allow the RF module to enter states of low-power consumption when not in use. To enter Sleep Mode, one of the following conditions must be met (in addition to the module having a non-zero SM parameter value): •...
  • Page 17 www.agelectronica.com www.agelectronica.com XBee Series 2 OEM RF Modules ‐ ZigBee ‐ v1.x2x  [2007.07.019] Chapter 2 ‐ RF Module Operation If CTS flow control is enabled, CTS (pin 12) is asserted (0V) when the module wakes and de- asserted (high) when the module sleeps, allowing for communication initiated by the host if desired. © 2007 Digi International, Inc.      16 www.agelectronica.com www.agelectronica.com...

  • Page 18: Zigbee Networks

    www.agelectronica.com www.agelectronica.com 3. ZigBee Networks 3.1. ZigBee Network Formation A ZigBee Personal Area Network (PAN) consists of one coordinator and one or more routers and/or end devices. A ZigBee Personal Area Network (PAN) is created when a coordinator selects a channel and PAN ID to start on. Once the coordinator has started a PAN, it can allow router and end device nodes to join the PAN.

  • Page 19: Joining An End Device

    www.agelectronica.com www.agelectronica.com XBee Series 2 OEM RF Modules ‐ ZigBee ‐ v1.x2x  [2007.07.019] Chapter 3 ‐ ZigBee Networks Once the router joins the PAN, it can communicate with other devices on the PAN and allow new devices to join to it. 3.1.3. Joining an End Device When an end device first comes up, it must also locate and join a PAN. End devices follow the same process as a router to join a PAN.

  • Page 20: Zigbee Network Communications

    www.agelectronica.com www.agelectronica.com XBee Series 2 OEM RF Modules ‐ ZigBee ‐ v1.x2x  [2007.07.019] Chapter 3 ‐ ZigBee Networks 3.2. ZigBee Network Communications Zigbee supports device addressing and application layer addressing. Device addressing specifies the destination address of the device a packet is destined to. Application layer addressing indicates a particular application recipient, known as a Zigbee endpoint, along with a message type field called a Cluster ID.

  • Page 21: Data Transmission And Routing

    www.agelectronica.com www.agelectronica.com XBee Series 2 OEM RF Modules ‐ ZigBee ‐ v1.x2x  [2007.07.019] Chapter 3 ‐ ZigBee Networks Figure 3‐03. ZigBee Layer‐Addressing Example  ZigBee Device B ZigBee Device A Endpoint 1 Endpoint 40 Endpoint 41 Endpoint 2 (radio B) Endpoint 3 Endpoint 42 (radio A) Cluster ID = TurnLightOff 3.2.3. Data Transmission and Routing All data packets are addressed using both device and application layer addressing fields. Data can be sent as a broadcast, multicast, or unicast transmission.
  • Page 22 www.agelectronica.com www.agelectronica.com XBee Series 2 OEM RF Modules ‐ ZigBee ‐ v1.x2x  [2007.07.019] Chapter 3 ‐ ZigBee Networks not endlessly transmitted. Each entry persists for 8 seconds. The broadcast transmission table holds 8 entries. For each broadcast transmission, the ZigBee stack must reserve buffer space for a copy of the data packet. This copy is used to retransmit the packet as needed.Large broadcast packets will require more buffer space.
  • Page 23 www.agelectronica.com www.agelectronica.com XBee Series 2 OEM RF Modules ‐ ZigBee ‐ v1.x2x  [2007.07.019] Chapter 3 ‐ ZigBee Networks Figure 3‐05. Sample Transmission Through a Mesh Networkʺ  AODV (Ad-hoc On-demand Distance Vector) Routing Algorithm Routing under the AODV protocol is accomplished using tables in each node that store the next hop (intermediary node between source and destination nodes) for a destination node. If a next hop is not known, route discovery must take place in order to find a path.
  • Page 24 www.agelectronica.com www.agelectronica.com XBee Series 2 OEM RF Modules ‐ ZigBee ‐ v1.x2x  [2007.07.019] Chapter 3 ‐ ZigBee Networks Figure 3‐06. Sample Route Request (Broadcast) Transmission Where R3 is Trying to Discover a Route to R6t  When the destination node receives a route request, it compares the ‘path cost’ field against previously received route request commands. If the path cost stored in the route request is better than any previously received, the destination node will transmit a route reply packet to the node that originated the route request.
  • Page 25 www.agelectronica.com www.agelectronica.com XBee Series 2 OEM RF Modules ‐ ZigBee ‐ v1.x2x  [2007.07.019] Chapter 3 ‐ ZigBee Networks the data, up to 2 times until an Ack is received. This Ack is called the ZigBee APS layer acknowledgment. Refer to the ZigBee specification for more details. Figure 3‐08. Unicast Data Transmission  Legend Data Transmission One Network ACK: Destination to Source Mac ACK © 2007 Digi International, Inc.

  • Page 26: Xbee Series 2 Networks

    www.agelectronica.com www.agelectronica.com 4. XBee Series 2 Networks 4.1. XBee Series 2 Network Formation To create a ZigBee network, a coordinator must be started on a channel and PAN ID. Once the coordinator has started, routers and end device can join the network. Routers and coordinator devices can support up to 8 end device children each.

  • Page 27: Network Reset

    www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Chapter 4 ‐ RF Module Configuration state 2x per second after the end device has joined. At this point, the operating channel and PAN ID can be read using the CH (Operating Channel) and ID (PAN ID) commands. The 16-bit network address of the end device can be read using the MY (16-bit Source Address) command. If API is enabled (AP parameter >...

  • Page 28: Xbee Series 2 Addressing

    www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Chapter 4 ‐ RF Module Configuration 4.2. XBee Series 2 Addressing XBee modules support both ZigBee device addressing and application-layer addressing. Device addressing provides a simple means of sending data from one device to another by hiding the application layer addressing information (ZigBee endpoints and cluster IDs).If a device will support multiple endpoints or cluster IDs, application addressing can be used to include endpoint and cluster ID information in the transmission.
  • Page 29 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Chapter 4 ‐ RF Module Configuration 64-bit Addressing (API) To send a packet to an RF module using its 64-bit Address (API Mode) Use the ZigBee Transmit Request API frame to set 64-bit destination address of the source node to match the 64-bit Address (SH (Serial Number High) and SL (Serial Number Low) parameters) of the destination node.

  • Page 30: Application-Layer Addressing

    www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Chapter 4 ‐ RF Module Configuration To send a transmission to a Coordinator using its 16-bit network address: Set the Destination Address of the transmitting module as shown below: AT Firmware DL (Destination Low Address) = 0 DH (Destination High Address) = 0 API Firmware Set the 64-bit destination address field in the API transmit frame to 0x0000000000000000.
  • Page 31 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Chapter 4 ‐ RF Module Configuration by setting the BI command to a valid index in AT firmware, or by using the Binding Table API Command frame in the API firmware. The binding table entries are organized as follows. Table 4‐04. Binding Table Index Name Access Coordinator Binding...

  • Page 32: Xbee Series 2 Endpoint Table

    www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Chapter 4 ‐ RF Module Configuration User Bindings These entries can be created and maintained by the application if needed. The following commands can be used to modify the user bindings. See the command descriptions for formatting details. Table 4‐05. Command Name Description Add Binding Creates a binding table entry at a specified User Binding index.

  • Page 33: Sleep Mode Operation

    www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Chapter 4 ‐ RF Module Configuration 4.3. Sleep Mode Operation XBee Series 2 modules support sleep mode operation in the Router / End Device firmware. Sleep modes allow a ZigBee end device to enter a low power mode when idle and wake as needed to transmit or receive data.
  • Page 34 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Chapter 4 ‐ RF Module Configuration Table 4‐08. Module Pin Names Module Pin Numbers Configuration Command RTS/DIO6 AD3/DIO3 AD2/DIO2 AD1/DIO1 AD0/DIO0 Setting the configuration command that corresponds to a particular pin will configure the pin. Parameters for the pin configuration commands typically include the following: Table 4‐09.
  • Page 35 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Chapter 4 ‐ RF Module Configuration The AT firmware returns a carriage return delimited list containing the above-listed fields. The API firmware returns an AT command response API frame with the IO data included in the command data portion of the packet. Example Sample AT Response 0x01\r...

  • Page 36: Advanced Features

    www.agelectronica.com www.agelectronica.com 5. Advanced Features The XBee Series 2 modules come with several features to assist with discovering, configuring, and testing ZigBee networks. These features include • Device Discovery • Remote Configuration • Loopback Testing • Join Indicators • Manual Device Identification •...

  • Page 37: Battery Life Monitoring

    www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Chapter 5 ‐ Advanced Features 64-bit and 16-bit addresses and its NI-string. (Only API coordinators will display the node identification packet.) Connecting a push-button to module pin 20 provides a simple mechanism for manually identifying a module to the coordinator during deployment. 5.6.

  • Page 38: Xbee Series 2 Command Reference Tables37

    www.agelectronica.com www.agelectronica.com 6.  XBee Series 2 Command Reference Tables Special Table 6‐01. Special Commands Node Type Name and Description Parameter Range Default Command Write. Write parameter values to non-volatile memory so that parameter modifications persist through subsequent resets. Note: Once WR is issued, no additional characters should be sent to the module until after the "OK\r"...
  • Page 39 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Chapter 6 ‐ XBee Series 2 Command Reference Tables Table 6‐02. Addressing Commands) Node Name and Description Parameter Range Default Command Type Cluster Identifier. Set/read Zigbee application layer cluster ID value. If ZigBee application layer addressing is enabled (ZA command), this value will be used as the 0 - 0xFF 0x11 cluster ID for all data transmissions.
  • Page 40 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Chapter 6 ‐ XBee Series 2 Command Reference Tables Table 6‐03. Networking Commands Node Name and Description Parameter Range Default Command Type Scan Channels. Set/Read the list of channels to scan. Coordinator - Bit field list of channels to choose from prior to starting network. Router/End Device - Bit field list of channels that will be scanned to find a Coordinator/ Router to join.
  • Page 41 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Chapter 6 ‐ XBee Series 2 Command Reference Tables Table 6‐05. Serial Interfacing Commands Node Name and Description Parameter Range Default Command Type 0 - Default receive API API Options. Configure options for API. Current options select the type of receive API indicators enabled frame to send out the Uart for received RF data packets. 1 - Explicit Rx data indicator API frame enabled (0x91)
  • Page 42 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Chapter 6 ‐ XBee Series 2 Command Reference Tables Table 6‐06. I/O Commands Node Name and Description Parameter Range Default Command Type 0 - Unmonitored digital input 3- Digital input, monitored DIO12 Configuration. Configure options for the DIO12 line of the RF module. 4- Digital output, default 5- Digital output, default high RSSI PWM Timer.
  • Page 43 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Chapter 6 ‐ XBee Series 2 Command Reference Tables Diagnostics Table 6‐07. Diagnostics Commands Node Name and Description Parameter Range Default Type Command Firmware Version. Read firmware version of the module. 0 - 0xFFFF [read-only] Factory-set Hardware Version. Read hardware version of the module. 0 - 0xFFFF [read-only] Factory-set Supply Voltage.

  • Page 44: Api Operation

    www.agelectronica.com www.agelectronica.com 7.  API Operation As an alternative to Transparent Operation, API (Application Programming Interface) Operations are available. API operation requires that communication with the module be done through a structured interface (data is communicated in frames in a defined order). The API specifies how commands, command responses and module status messages are sent and received from the module using a UART Data Frame.

  • Page 45: Api Frames

    www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x  [2007.07.019] Chapter 7 ‐ API Operation Data bytes that need to be escaped: • 0x7E – Frame Delimiter • 0x7D – Escape • 0x11 – XON • 0x13 – XOFF Example - Raw UART Data Frame (before escaping interfering bytes): 0x7E 0x00 0x02 0x23 0x11 0xCB 0x11 needs to be escaped which results in the following frame: 0x7E 0x00 0x02 0x23 0x7D 0x31 0xCB Note: In the above example, the length of the raw data (excluding the checksum) is 0x0002 and...
  • Page 46 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x  [2007.07.019] Chapter 7 ‐ API Operation Table 7‐010. API Frame Names and Values API Frame Names Values ZigBee Receive 0x90 Packet (AO=0) ZigBee Explicit Rx 0x91 Indicator (AO=1) XBee Sensor Read 0x94 Indicator (AO=0) Node Identification 0x95 Indicator (AO=0) Modem Status API Identifier Value: (0x8A) RF module status messages are sent from the module in response to specific conditions. Figure 7‐04.
  • Page 47 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x  [2007.07.019] Chapter 7 ‐ API Operation Figure 7‐05.  Advanced Modem Status Frames: Do Not Use! Start delim inator Length Fram e D ata C hecksum 0x7E M SB API-specific Structure 1 Byte Identifier specific data API Identifier 0x8C cm dD ata [Bind Table Index] + [Bind Type] Status ID Bind Type 1 –...
  • Page 48 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x  [2007.07.019] Chapter 7 ‐ API Operation AT Command API Identifier Value: (0x08) Allows for module parameter registers to be queried or set. Figure 7‐6. AT Command Frames Start Delimiter Length Frame Data Checksum 0x7E API-specific Structure 1 Byte API Identifier Identifier-specific Data 0x08 cmdData Frame ID (Byte 5) AT Command (Bytes 6-7) Parameter Value (Byte(s) 8-n) Identifies the UART data frame for the host to...
  • Page 49 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x  [2007.07.019] Chapter 7 ‐ API Operation 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 commands will send back multiple frames (for example, the ND (Node Discover) command).
  • Page 50 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x  [2007.07.019] Chapter 7 ‐ API Operation 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 51 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x  [2007.07.019] Chapter 7 ‐ API Operation Figure 7‐13. ZigBee Transmit Request. Frame Data Start delimiter Length Checksum 0x7E API-specific Structure 1 Byte API Identifier Identifier specific data 0x10 cmdData 16-bit Destination Network Address Frame ID (byte 5) RF Data: Bytes (s) 18-n Options (byte 17) (bytes 14-15) Identifies the UART data frame for the host to MSB first, LSB last.
  • Page 52 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x  [2007.07.019] Chapter 7 ‐ API Operation Explicit Addressing ZigBee Command Frame API Identifier Value: (0x11) Allows ZigBee application layer fields (endpoint and cluster ID) to be specified for a data transmission. Figure 7‐14. Explicit Addressing ZigBee Command Frame. Start delimiter Length Frame Data Checksum 0x7E API-specific Structure 1 Byte Identifier specific data API Identifier...
  • Page 53 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x  [2007.07.019] Chapter 7 ‐ API Operation ZigBee 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. Figure 7‐15.
  • Page 54 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x  [2007.07.019] Chapter 7 ‐ API Operation ZigBee Explicit Rx Indicator API Identifier Value:(0x91) When the modem receives a ZigBee RF packet it is sent out the UART using this message type (when AO=1). Figure 7‐17. ZigBee Explicit Rx Indicators Start delimiter Length Frame Data Checksum 0x7E API-specific Structure 1 Byte Identifier specific data...
  • Page 55 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x  [2007.07.019] Chapter 7 ‐ API Operation Figure 7‐18. XBee Sensor Read Indicator (0x94) Start Delimiter Length Frame Data Checksum 0x7E API-specific Structure 1 Byte API Identifier Identifier-specific Data 0x94 cmdData Receive Options (byte 15) 64-bit Address (bytes 5-12) A/D Read Values (bytes 17-24) 0x01 = Packet Acknowledged Indicates a 2-byte value for each Indicates the 64-bit address of the remote module that 0x02 = Packet was a broadcast...
  • Page 56 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x  [2007.07.019] Chapter 7 ‐ API Operation Node Identification Indicator API Identifier Value: 0x95 This frame is received on the coordinator when a module transmits a node identification message to identify itself to the coordinator (when AO=0). The data portion of this frame is similar to a Node Discovery response frame (see ND command).

  • Page 57: Examples

    www.agelectronica.com www.agelectronica.com 8.  Examples 8.0.1. Starting an XBee Network Start the coordinator Determine the operating channels list using the SC (Scan Channels) command and the PAN ID to operate using the ID (PAN ID) command. The default SD (Scan Duration) parameter value should suffice.

  • Page 58: At Command Programming Examples

    www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x  [2007.07.019] Chapter 8 ‐ Examples 8.0.2. AT Command Programming Examples Setup The programming examples in this section require the installation of MaxStream's X-CTU Soft- ware and a serial connection to a PC. (MaxStream stocks RS-232 and USB boards to facilitate Refer to the ‘X‐CTU’ sec‐ interfacing with a PC.) tion of the Develop‐...
  • Page 59 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x  [2007.07.019] Chapter 8 ‐ Examples Constructing API Frames Example: Create an API AT command frame to configure an XBee to allow joining (set NJ to 0xFF). The frame should look like: 0x7E 0x00 0x05 0x08 0x01 0x4E 0x4A 0xFF 5F Where 0x0005 = length 0x08 = AT Command API frame type 0x01 = Frame ID (set to non-zero value) 0x4E4A = AT Command ('NJ')

  • Page 60: Manufacturing Support

    www.agelectronica.com www.agelectronica.com 9.  Manufacturing Support 9.1. Interoperability with other EM250 Devices The XBee module can interoperate with other EM250-based devices. The following should be considered when communicating between a MaxStream XBee module and another EM250-based device. The XBee firmware inserts 8 bytes at the beginning of the data payload that represent the 64-bit address of the source module.
  • Page 61 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Chapter 9 ‐ Manufacturing Support Table 9‐011. XBee Series 2 Module Pin Number EM250 GPIO XBee Series 2 Module Pin Number EM250 GPIO © 2007 Digi International, Inc.      60 www.agelectronica.com www.agelectronica.com...

  • Page 62: Definitions

    www.agelectronica.com www.agelectronica.com Appendix A: Definitions Definitions Table A‐01. Terms and Definitions ZigBee Node Types Coordinator A node that has the unique function of forming a network. The coordinator is responsible for establishing the operating channel and PAN ID for an entire network. Once established, the coordinator can form a network by allowing routers and end devices to join to it.
  • Page 63 www.agelectronica.com www.agelectronica.com XBee Series 2 OEM RF Modules ‐ ZigBee ‐ v1.x2x [2007.07.019] Chapter A ‐ Definitions Table A‐01. Terms and Definitions Joining The process of a node becoming part of a ZigBee PAN. A node becomes part of a network by joining to a coordinator or a router (that has previously joined to the network). During the process of joining, the node that allowed joining (the parent) assigns a 16-bit address to the joining node (the child).

  • Page 64: Agency Certifications

    www.agelectronica.com www.agelectronica.com Appendix B: Agency Certifications United States FCC The XBee Series 2 RF Module complies with Part 15 of the FCC rules and regulations. Compliance with the labeling requirements, FCC notices and antenna usage guidelines is required. To fufill FCC Certification, 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.
  • Page 65 www.agelectronica.com www.agelectronica.com Xbee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Agency Certifications XBee Series 2 RF Modules: XBee Series 2 RF Modules have been tested and approved for use with all the antennas listed in the tables below. (Cable-loss IS required when using gain antennas as shown below.) Table A‐01.
  • Page 66 www.agelectronica.com www.agelectronica.com Xbee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Agency Certifications standards. A Declaration of Conformity must be issued for each of these standards and kept on file as described in Annex II of the R&TTE Directive. Furthermore, the manufacturer must maintain a copy of the XBee Series 2 user manual documentation and ensure the final product does not exceed the specified power ratings, antenna specifications, and/or installation requirements as specified in the user manual.
  • Page 67 www.agelectronica.com www.agelectronica.com Xbee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Agency Certifications Antenna Type: Yagi RF module was tested and approved with 15 dBi antenna gain with 1 dB cable-loss (EIRP Maimum of 14 dBm). Any Yagi type antenna with 14 dBi gain or less can be used with no cable-loss. Antenna Type: Omni-Directional RF module was tested and approved with 15 dBi antenna gain with 1 dB cable-loss (EIRP Maimum of 14 dBm).

  • Page 68: Migrating From The 802.15.4 Protocol

    www.agelectronica.com www.agelectronica.com Appendix C: Migrating from the 802.15.4  Protocol This following are some of the differences in the ZigBee firmware assuming familiarity with the 802.15.4 application: • ZigBee Command Set • Address Assignment • API / AT Firmware Versions Also, refer to the “Getting Started” section for more information. ZigBee Command Set Modified Commands •...

  • Page 69: Development Guide

    www.agelectronica.com www.agelectronica.com Appendix D: Development Guide XBee Series 2 Development Kits The XBee Series 2 Professional Development Kit includes the hardware and software needed to rapidly create long range wireless data links between nodes (XBee Series 2 Starter Kits that contain fewer modules and accessories are also available). Table D‐01.
  • Page 70 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Development Guide Note: In the following sections, an OEM RF Module mounted to an interface board will be referred to as a "Module Assembly". RS-232 Development Board External Interface B-01a. Reset Switch Figure B‐01. Front View The Reset Switch is used to reset (re-boot) the RF module. This switch only applies when using the configuration tabs of MaxStream’s X-CTU Software.
  • Page 71 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Development Guide RS-232 Pin Signals Figure B‐03. Pins used on the female RS‐232 (DB‐9) Serial Connector   Table D‐02. Pin Assignments and Implementations DB-9 Pin RS-232 Name Description Implementation* Data-Carrier-Detect Connected to DSR (pin6) Serial data exiting the module assembly Receive Data (to host) Serial data entering into the module assembly Transmit Data (from host) Data-Terminal-Ready Can enable Power-Down on the module assembly...
  • Page 72 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Development Guide Wiring Diagrams Figure B‐04. DTE node (RS‐232, male DB‐9 connector) wired to a DCE Module Assembly (female DB‐9)   © 2007 Digi International, Inc.       71 www.agelectronica.com www.agelectronica.com...
  • Page 73 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Development Guide Figure B‐05. DCE Module Assembly (female DB‐9 connector) wired to a DCE node (RS‐232, male DB‐9)   Sample Wireless Connection: DTE <--> DCE <--> DCE <--> DCE Figure B‐06. Typical wireless link between DTE and DCE nodes © 2007 Digi International, Inc.       72 www.agelectronica.com www.agelectronica.com...
  • Page 74 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Development Guide Adapters The development kit includes several adapters that support the following functions: • Performing Range Tests • Testing Cables • Connecting to other RS-232 DCE and DTE nodes • Connecting to terminal blocks or RJ-45 (for RS-485/422 nodes) NULL Modem Adapter (male-to-male) Part Number: JD2D2-CDN-A (Black, DB-9 M-M) The male-to-male NULL modem adapter is used to connect two DCE nodes.
  • Page 75 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Development Guide Serial Loopback Adapter Part Number: JD2D3-CDL-A (Red, DB-9 M-F) The serial loopback adapter is used for range testing. During a range test, the serial loopback adapter configures the module to function as a repeater by looping serial data back into the radio for retransmission. Figure D‐01.
  • Page 76 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Development Guide DIP Switch functions are not supported in this release. Future down- Figure D‐03. Back View loadable firmware versions will support the DIP Switch configurations. B-12b. Reset Switch The Reset Switch is used to reset (re-boot) the RF module. B‐12a.
  • Page 77 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Development Guide USB Pin Signals Table D‐03. USB signals and their implantations on the XBee Series 2 RF Module Name Description Implementation VBUS Power Power the RF module Transmitted & Received Data Transmit data to and from the RF module Transmitted & Received Data Transmit data to and from the RF module Ground Signal Ground X-CTU Software...
  • Page 78 www.agelectronica.com www.agelectronica.com XBee Series 2 ZigBee OEM RF Modules v1.x2x [2007.07.019] Development Guide NOTE: To read a parameter value stored in a register, leave the parameter field blank. The example above issues the DL (Destination Address Low) command to change destination address of the module to "0x1F". To save the new value to the module’s non-volatile memory, issue WR (Write) command after modifying parameters.

  • Page 79: Additional Information

    www.agelectronica.com www.agelectronica.com Appendix E: Additional Information 1-Year Warranty XBee Series 2 RF Modules from MaxStream, Inc. (the "Product") are warranted against defects in materials and workmanship under normal use, for a period of 1-year from the date of purchase. In the event of a product failure due to materials or workmanship, MaxStream will repair or replace the defective product.

This manual is also suitable for:

Xb24-buit-004

Table of Contents