1. Manuals
  2. Brands
  3. MaxStream Manuals
  4. Modem
  5. XBee-PRO PKG-R RS-232 RF
  6. User manual

MaxStream XBee-PRO PKG-R RS-232 RF User Manual

Rs‐232 rf modem
Hide thumbs Also See for XBee-PRO PKG-R RS-232 RF:
Table of Contents

Advertisement

Quick Links

Download this manual
XBee-PRO PKG-R™ RS-232 RF Modem
XBee-PRO RS-232 RF Modem
Interfacing Protocol
RF Modem Operation
RF Modem Configuration
Appendices
Product Manual
For XBee-PRO RF Modem Part Numbers:
®
IEEE
802.15.4 Stand-alone RF Modems by MaxStream, Inc.
355 South 520 West, Suite 180
Lindon, UT 84042
Phone: (801) 765-9885
Fax: (801) 765-9895
rf-xperts@maxstream.net
www.MaxStream.net (live chat suport)
v1.x82
XBP24-PKI-...-R...
M100280
2006.04.24

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the XBee-PRO PKG-R RS-232 RF and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for MaxStream XBee-PRO PKG-R RS-232 RF

Summary of Contents for MaxStream XBee-PRO PKG-R RS-232 RF

  • Page 1 Appendices Product Manual v1.x82 For XBee-PRO RF Modem Part Numbers: XBP24-PKI-...-R... ® IEEE 802.15.4 Stand-alone RF Modems by MaxStream, Inc. 355 South 520 West, Suite 180 Lindon, UT 84042 Phone: (801) 765-9885 Fax: (801) 765-9895 rf-xperts@maxstream.net M100280 www.MaxStream.net (live chat suport)
  • Page 2 XBee‐PRO PKG‐R™ RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.x82 [2006.04.24] © 2006 MaxStream, 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 MaxStream, Inc. XBee‐PRO PKG‐R™ is a trademark of MaxStream, Inc. Technical Support:  Phone: (801) 765‐9885 Live Chat: www.maxstream.net E‐mail: rf‐xperts@maxstream.net © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       ii...

  • Page 3: Table Of Contents

    3.1.2. Host and RF Modem Settings 9 1-Year Warranty 52 3.1.3. Flow Control 10 Ordering Information 52 3.1.4. Transparent Operation 11 Contact MaxStream 53 3.1.5. API Operation 11 3.2. IEEE 802.15.4 Networks 12 3.2.1. NonBeacon 12 3.2.2. NonBeacon (w/ Coordinator) 12 3.2.3.

  • Page 4: Xbee-Pro Rs-232 Rf Modem

    1.1.1. Worldwide Acceptance FCC Approved (USA) Refer to Appendix A [p48] for FCC Requirements. Systems that include XBee-PRO RF Modems inherit MaxStream Certifications. Operates within the ISM (Industrial, Scientific & Medical) 2.4 GHz frequency band Manufactured under ISO 9001:2000 registered standards XBee-PRO RF Modems are optimized for use in US, Canada, Australia, Israel and Europe (contact MaxStream for complete list of approvals).

  • Page 5: Specifications

    5.25 oz. (150 g) Data Connection Female DB-9 Operating Temperature -40 - 85º C (Industrial) Certifications (partial list) United States (FCC Part 15.247) OUR-XBEEPRO Industry Canada (IC) 4214A XBEEPRO Europe (CE) ETSI (Max. 10 mW transmit power output)* * When operating in Europe: XBee‐PRO RF Modems must be configured to operate at a maximum transmit  power output level of 10 dBm. Set the PL parameter to “0” (10 dBm) in order to adhere to European regulations. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       5...

  • Page 6: External Interface

    The Reset Switch is used to reset (re-boot) the XBee-PRO RS-232 RF Figure 1‐01.  Front View Modem. This switch only applies when using the configuration tabs of MaxStream’s X-CTU Software. 1-01b. I/O & Power LEDs LEDs indicate RF modem activity as follows:...

  • Page 7: Interfacing Protocol

    Provides RTS flow control or RTS / CMD Command Mode enables "Command Mode" on the RF modem Clear-to-Send Provides CTS flow control Optional power input that is connected internally to Ring Indicator the positive lead of the front power connector * Functions listed in the implementation column may not be available at the time of release. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       7...

  • Page 8: Wiring Diagrams

    XBee‐PRO PKG‐R™ RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.x82 [2006.04.24] 2.1.2. Wiring Diagrams DTE RS-232 Device to a DCE RF Modem Figure 2‐02. RS‐232 Device (DTE ‐ male connector) wired to an XBee‐PRO RF Modem (DCE ‐ female)   DCE RF Modem to an DCE RS-232 Device Figure 2‐03. XBee‐PRO RF Modem (DCE ‐ female connector) wired to an RS‐232 device (DCE)   Sample Wireless Connection: DTE <--> DCE DCE <--> DCE Figure 2‐04. Typical wireless link between DTE and DCE devices © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       8...

  • Page 9: Rf Modem Operation

    NOTE: Failure to enter AT Command Mode is most commonly due to baud rate mismatch. Ensure the ‘Baud’ setting on the “PC Settings” tab matches the BD (Interface Data Rate) setting of the RF modem (by default, BD parameter = 3, which is associated to 9600 baud). © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       9...

  • Page 10: Flow Control

    If the host does not allow the modem to transmit data out from the DO buffer because of being held off by hardware or software flow control. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       10...

  • Page 11: Transparent Operation

    The API operation option facilitates many operations such as the examples cited below: -> Change destination addresses without having to enter command mode -> Receive success/failure status of each RF packet -> Identify the source address of each received packet To implement API operations, refer to API sections [p43]. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       11...

  • Page 12: Ieee 802.15.4 Networks

    Master/Slave relationships. This means that modems remain synchronized without use of master/server configurations and each modem in the network shares both roles of master and slave. MaxStream's peer-to-peer architecture features fast synchronization times and fast cold start times. This default configuration accommodates a wide range of RF data applications.

  • Page 13: Association

    Active Scan results. Otherwise, the ID (PAN ID) parameter setting will be updated to a PAN ID that was not detected. Not Set (bit 0 = 0) - The Coordinator retains its ID setting. No Active Scan is performed. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       13...
  • Page 14 BeaconRequest command as before. This process continues until all channels have been scanned, or until 5 PANs have been discovered. When the Active Scan is complete, the results include a list of PAN IDs and Channels that are being used by detected PANs. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       14...
  • Page 15 4. End Device Changes once an End Device has associated Changing A1, ID or CH parameters will cause the End Device to disassociate and restart the Association procedure. If the End Device fails to associate, the AI command can give some indication of the failure. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       15...

  • Page 16: Modes Of Operation

    Coordinator. Thus, if all devices in a network are End Devices, only Direct Trans- missions will occur. Indirect Transmissions are useful to ensure packet delivery to a sleeping device. The Coordinator currently is able to retain up to 2 indirect messages. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       16...
  • Page 17 If the transmission is not a broadcast message, the modem will expect to receive an acknowledge- ment from the destination device. If an acknowledgement is not received, the packet will be resent up to 3 more times. If the acknowledgement is not received after all transmissions, an ACK failure is recorded. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       17...

  • Page 18: Sleep Mode

    DTR is asserted and is ready to transmit or receive when the CTS line is low. When waking the modem, the pin must be asserted at least two 'byte times' after CTS goes low. This assures that there is time for the data to enter the DI buffer. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       18...
  • Page 19 Coordinator will send a direct message to that remote instead of queuing it. The Coordinator is always awake so that any remote unit can transmit either a poll request or a data message at any time. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       19...

  • Page 20: Command Mode

    If no valid AT Commands are received within the time specified by CT (Command Mode Timeout) Command, the RF modem automatically returns to Idle Mode. For an example that illustrates programming the RF modem using AT Commands, refer to the "RF Modem Configuration" chapter [p22]. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       20...

  • Page 21: Addressing

    Sample Network Configuration (All modems in the network): • DL (Destination Low Address) = 0x0000FFFF • DH (Destination High Address) = 0x00000000 (default value) NOTE: When programming the modem, parameters are entered in hexadecimal notation (without the “0x” prefix). Leading zeros may be omitted. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       21...

  • Page 22: Rf Modem Configuration

    RS-232 connection to a PC. Install MaxStream's X-CTU Software to a PC by double-clicking the "setup_X-CTU.exe" file. (The file is located on the MaxStream CD and under the 'Software' section of the following web page: www.maxstream.net/helpdesk/download.php) Connect the RF modem to a PC.

  • Page 23: Command Reference Tables

    (802.15.4 - macMinBE). MAC Mode. Set/Read MAC Mode value. MAC Mode enables/disables the use of a Networking MaxStream header in the 802.15.4 RF packet. When Mode 0 is enabled (MM=0), 0 - 2 {Addressing} duplicate packet detection is enabled as well as certain AT commands.
  • Page 24 1 - Coordinator will perform Energy Scan to find a free channel, then operate on that channel. bit 2 - AllowAssociation - 0 - Coordinator will not allow any devices to associate to it. 1 - Coordinator will allow devices to associate to it. bits 3 - 7 are reserved © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       24...
  • Page 25 0 - 6 {Association} scan time on each channel is measured as Time = [(2 ^ED) * 15.36] ms. Note the total scan time is this time multiplied by the number of channels to be scanned. Refer to SD parameter. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       25...
  • Page 26 2 - AD2/DIO2 Serial bit 3 - AD1/DIO1 0 - 0xFF 0xFF Interfacing bit 4 - AD0/DIO0 bit 5 - RTS bit 6 - SLEEP_RQ bit 7 - DIN/CONFIG “1” specifies pull-up enabled, “0” specifies no pull-up © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       26...
  • Page 27 The values returned represent the detected 0 - 7 energy level in units of -dBm. The actual scan time on each channel is measured as Time = [(2 ^ SD PARAM) * 15.36]ms. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       27...
  • Page 28 Command Sequence Character. Set/Read the ASCII character value to be used AT Command 0x2B between Guard Times of the AT Command Mode Sequence (GT+CC+GT). The AT 0 - 0xFF Mode Options (‘+’ ASCII) Command Mode Sequence enters the RF modem into AT Command Mode. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       28...

  • Page 29: Command Descriptions

    1 - Coordinator will perform Energy Scan to find a free channel, then operate on that channel. 0 - Coordinator will not allow any devices to associate to it. 2 - AllowAssociate 1 - Coordinator will allow devices to associate to it. 3 - 7 [reserved] The binary equivalent of the default value (0x06) is 00000110. ‘Bit 0’ is the last digit of the sequence. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       29...
  • Page 30 Parameter Range:0 - 2 based API operation. Parameter Configuration Disabled (UART operation) API enabled API enabled (with escaped characters) Default Parameter Value:0 Refer to the “API Operation” sections [p43] when API operation is enabled (AP = 1 or 2). © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       30...
  • Page 31 The RF data rate is not affected by the BD param- 57600 eter. If the interface data rate is set higher than 115200 the RF data rate, a flow control configuration may need to be implemented. Default Parameter Value:3 Command description is continued on the next page. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       31...
  • Page 32 BD register. For example, a rate of 19200 bps can be set by sending the following command line "ATBD4B00". NOTE: When using MaxStream’s X-CTU Software, non-standard interface data rates can only be set and read using the X-CTU ‘Ter- minal’...
  • Page 33 <Serial Interfacing> The D6 command is used to AT Command: ATD6 set and read the behavior of the DIO6 line. This Parameter Range:0 - 1 line can be configured to enable RTS flow control. Parameter Configuration Disabled RTS Flow Control Default Parameter Value:0 © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       33...
  • Page 34 To transmit using a 16-bit address, set the DH parameter to zero and the DL parameter less than 0xFFFF. 0x000000000000FFFF (DL concatenated to DH) is the broadcast address for the PAN. Refer to the “Addressing” section [p21] for more information. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       34...
  • Page 35 Time = [(2 ^ ED PARAM) * 15.36] ms. Note: Total scan time is this time multiplied by the number of channels to be scanned. Also refer to the SD (Scan Duration) table. Use the SC (Scan Channel) command to choose which channels to scan. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       35...
  • Page 36 (802.15.4 + MaxStream header) mands. Modes 1 and 2 are strict 802.15.4 modes. 802.15.4 (no ACKs) When the MaxStream header is disabled, the ND 802.15.4 (with ACKs) (Node Discover) and DN (Destination Node) parameters are also disabled. Default Parameter Value:0 MY (16-bit Source Address) Command <Networking {Addressing}>...
  • Page 37 PWM0 (Pulse Width Parameter Range: 0 - 1 Modulation Output 0). Parameter Configuration Note: The second character in the command is a Disabled zero (“0”), not the letter “O”. RSSI PWM0 enabled Default Parameter Value: 1 © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       37...
  • Page 38 The RE command does not write restored values to non-volatile (persistent) memory. Issue the WR (Write) command subsequent to issuing the RE command to save restored parameter values to non-volatile memory. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       38...
  • Page 39 (0 percent PWM) until another RF packet is received. The PWM output will also be set low at power-up until the first RF packet is received. A parameter value of 0xFF permanently enables the PWM output and it will always reflect the value of the last received RF packet. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       39...
  • Page 40 32 bits of the RF modem's unique IEEE Parameter Range: 0 - 0xFFFFFFFF [read-only] 64-bit address. Related Commands: SH (Serial Number High), The modem serial number is set at the factory MY (Source Address) and is read-only. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       40...
  • Page 41 <Diagnostics> The VL command is used to read AT Command: ATVL detailed version information about the RF Parameter Range:0 - 0xFF modem. The information includes: [x 100 milliseconds] application build date; MAC, PHY and bootloader Default Parameter Value: 0x28 (40 decimal) versions; and build dates. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       41...
  • Page 42 If changes are made without writing them to non-volatile memory, the modem reverts back to previously saved parameters the next time the modem is powered-on. NOTE: Once the WR command is sent to the modem, no additional characters should be sent until after the “OK/r” response is received. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       42...

  • Page 43: Api Operation

    Escape characters. When sending or receiving a UART data frame, specific data values must be escaped (flagged) so they do not interfere with the UART or UART data frame operation. To escape an interfering data byte, insert 0x7D and follow it with the byte to be escaped XOR’d with 0x20. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       43...

  • Page 44: Api Types

    API Identifier Identifier-specific Data 0x8A cmdData Status (Byte 5) 0 = Hardware reset 1 = Watchdog timer reset 2 = Associated 3 = Disassociated 4 = Synchronization Lost (Beacon-enabled only) 5 = Coordinator realignment 6 = Coordinator reset © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       44...
  • Page 45 If present, indicates the requested parameter correlate with a subsequent ACK (acknowledgement). ASCII characters that value to set the given register. If set to ‘0’, no response is requested. identify the AT Command. If no characters present, register is queried. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       45...

  • Page 46: At Command Response

    ACK (acknowledgement). 0x04 = Send packet with Broadcast Pan ID Up to 100 Bytes per packet Broadcast = 0xFFFF Setting Frame ID to ‘0' will disable response frame. All other bits must be set to 0. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       46...
  • Page 47 Hexadecimal equivalent of (-dBm) value. bit 1 = Address broadcast Up to 100 Bytes per packet LSB (least significant) last (For example: If RX signal strength = -40 bit 2 = PAN broadcast dBm, “0x28” (40 decimal) is returned) bits 3-7 [reserved] © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       47...

  • Page 48: Appendix A: Agency Certifications

    IMPORTANT: The XBee-PRO RS-232 RF Modem has been certified by the FCC for use with other products without any further certification (as per FCC section 2.1091). Modifications not expressly approved by MaxStream could void the user's authority to operate the equipment. IMPORTANT: OEMs must test final product to comply with unintentional radiators (FCC section 15.107 &...

  • Page 49: Fcc-Approved Antennas (2.4 Ghz)

    To ensure compliance, operations at closer than this distance is not recommended. The antenna used for this transmitter must not be co-located in conjunction with any other antenna or transmitter. The preceding statement must be included as a CAUTION statement in OEM product manuals in order to alert users of FCC RF Exposure compliance. © 2006 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved       49...

  • Page 50: European Certification

    EMC and safety. Files are located in the 'documentation' folder of the MaxStream CD. Important Note MaxStream does not list the entire set of standards that must be met for each country. MaxStream customers assume full responsibility for learning and meeting the required guidelines for each country in their distribution market.

  • Page 51: Approved Antennas

    XBee-PRO (@ 10 dBm Transmit Power, PL parameter value must equal 0) The following antennas have been tested and approved for use with the embedded XBee-PRO RF Module: • Dipole (2.1 dBi, Articulated RPSMA, MaxStream part number A24-HABSM) • Chip Antenna (-1.5 dBi) • Attached Monopole Whip (1.5 dBi) The RF modem encasement was designed to accommodate the RPSMA antenna option.

  • Page 52: Appendix B: Additional Information

    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. For warranty service, return the defective product to MaxStream, shipping prepaid, for prompt repair or replacement.

  • Page 53: Contact Maxstream

    XBee‐PRO PKG‐R™ RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.x82 [2006.04.24] Contact MaxStream Free and unlimited technical support is included with every MaxStream Radio Modem sold. For the best in wireless data solutions and support, please use the following resources: Documentation: www.maxstream.net/support/downloads.php Technical Support: Phone. (866) 765-9885 toll-free U.S.A. & Canada (801) 765-9885 Worldwide Live Chat.

This manual is also suitable for:

Xbee‐pro pkg‐r

Table of Contents