XBP24-PKI-001-RA Digi International/Maxstream, XBP24-PKI-001-RA Datasheet

Page 1

... XBee-PRO RS-232 RF Modem Interfacing Protocol RF Modem Operation RF Modem Configuration Appendices Product Manual v1.xAx For XBee-PRO RF Modem Part Numbers: ® IEEE 802.15.4 Stand-alone RF Modems by MaxStream, Inc. Digi International World Headquarters 11001 Bren Road East Minnetonka, MN 55343 Phone: 952-912-3444 or 877-912-3444 Fax: 952-912-4952 XBP24-PKI-...-R... 90000829_A 2008.4.24 ...

Page 2

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx © 2008 Digi International, Inc. All rights reserved No part of the contents of this manual may be transmitted or reproduced in any  form or by any means without the written permission of Digi International, Inc. XBee‐PRO PKG‐R® is a trademark of Digi International, Inc. Technical Support:  © 2008 Digi International, Inc.  Phone: (801) 765‐9885 Live Chat: http://www.digi.com/support/ E‐mail: support@digi.com      ii ...

Page 3

XBee®/XBee‐PRO® RS‐232 RF Modems ‐ 802.15.4 ‐ Product Manual v1.xAx Table of Contents 1. XBee-PRO RS-232 RF Modem 1.1. Features Overview 4 1.1.1. Worldwide Acceptance 4 1.2. Specifications 5 1.3. External Interface 6 2. Interfacing Protocol 2.1. RS-232 Operation 7 2.1.1. Pin Signals 7 2.1.2. Wiring Diagrams Modem ...

Page 4

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  1. XBee‐PRO RS‐232 RF Modem The XBee-PRO RS-232 RF Modem is an IEEE 802.15.4 compliant solution that features an RS-232 interface. Out-of-box, the modem is equipped to sustain outstanding range (2-3x the range of typical 802.15.4 solutions) and requires no additional configuration for ...

Page 5

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  1.2. Specifications Table 1‐01. Specifications of the XBee‐PRO PKG‐R RS‐232 RF Modem Specification Performance Indoor/Urban Range (w/ 2.1 dB dipole antenna) Outdoor/Urban Range (w/ 2.1 dB dipole antenna) Transmit Power Output Receiver Sensitivity Interface Data Rate RF Data Rate Networking & Security Frequency Modulation Supported Network Topologies ...

Page 6

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  1.3. External Interface Figure 1‐01.  Front View 1-01c. Serial Port 1-01d. RSSI LEDs 1-01b. I/O & Power LEDs 1-01e. Power Connector 1-01a. Reset Switch Figure 1‐02. Back View 1-02b. Antenna Port 1-02a. DIP Switch © 2008 Digi International, Inc.  1-01a. Reset Switch The Reset Switch is used ...

Page 7

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  2. Interfacing Protocol 2.1. RS-232 Operation 2.1.1. Pin Signals Figure 2‐01. Pins used on the female RS‐232 (DB‐9) Serial Connector   Table 2‐01. Pin Assignments and Implementations DB-9 Pin * Functions listed in the implementation column may not be available at the time of release. © 2008 Digi International, Inc.  RS-232 Name Description DCD Data-Carrier-Detect RXD Received Data TXD Transmitted Data DTR Data-Terminal-Ready GND Ground ...

Page 8

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  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 Figure 2‐04. Typical wireless link between DTE and DCE devices © 2008 Digi International, Inc.  DCE <--> DCE      8 ...

Page 9

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  3. RF Modem Operation 3.1. Serial Communications 3.1.1. RS-232 Data Flow The XBee-PRO RS-232 RF Modem interfaces to a host device through a standard RS-232 (DB-9) connector. Devices that have a standard RS-232 serial port can connect directly through the pins of ...

Page 10

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  3.1.3. Transparent Operation By default, XBee-PRO RF Modems operate in Transparent Mode. When operating in this mode, the modems act as a serial line replacement - all UART data received through the DI pin is queued up for RF ...

Page 11

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  3.1.5. Flow Control Figure 3‐02. Internal Data Flow Diagram DI (Data In) Buffer When serial data enters the RF modem through the DI (Data In) pin, the data is stored in the DI Buffer until it can be processed. Hardware Flow Control (CTS). ...

Page 12

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  3.2. IEEE 802.15.4 Networks The following IEEE 802.15.4 network types are available to the RF modem: • NonBeacon • NonBeacon (w/ Coordinator) The following terms will be used to explicate the network system types: Table 3‐02. Terms and definitions (Applicable networking network types are designated within <brackets>.) Term Association Coordinator ...

Page 13

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  3.2.3. Association Association is the establishment of membership between End Devices and a Coordinator and is only applicable in NonBeacon (w/ Coordinator) networks. The establishment of membership is useful in scenarios that require a central unit (Coordinator) to relay ...

Page 14

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  2. Check A2 parameter - Reassign_Channel Flag (bit 1) Set (bit The Coordinator issues an Energy Scan. The Energy Scan selects one channel and scans for energy on that channel. The duration of the scan ...

Page 15

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  The End Device selects a Coordinator to associate with according to the A1 parameter “Reassign_PANID” and “Reassign_Channel” flags: Reassign_PANID Bit Set (bit 0 = 1)- End Device can associate with a PAN with any ID value. Reassign_PANID Bit Not ...

Page 16

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  3.3. Addressing Every RF data packet sent over-the-air contains a Source Address and Destination Address field in its header. The RF modem conforms to the 802.15.4 specification and supports both short 16-bit addresses and long 64-bit addresses. A unique ...

Page 17

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  3.4. Modes of Operation XBee-PRO RF Modems operate in five modes. Figure 3‐04. Modes of Operation 3.4.1. Idle Mode When not receiving or transmitting data, the RF modem is in Idle Mode. The modem shifts into the other modes of operation under ...

Page 18

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  Direct Transmission A NonBeaconing Coordinator can be configured to use only Direct Transmission by setting the SP (Cyclic Sleep Period) parameter to “0”. Also, a NonBeaconing Coordinator using indirect transmissions will revert to direct transmission if it knows the ...

Page 19

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  3.4.3. Sleep Mode Sleep Modes enable the RF modem to enter states of low-power consumption when not in use. In order to enter Sleep Mode, one of the following conditions must be met (in addition to the modem having ...

Page 20

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  Pin Doze ( • Pin/Host-controlled • Typical power-down current: < • Wake-up time: 2 msec Pin Doze Mode functions as does Pin Hibernate Mode; however, Pin Doze features faster wake-up time and higher power consumption. ...

Page 21

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  3.4.4. Command Mode To modify or read RF Modem parameters, the modem must first enter into Command Mode - a state in which incoming characters are interpreted as commands. Two command mode types are supported: AT Command Mode and ...

Page 22

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  4. RF Modem Configuration 4.1. Programming the RF Modem Refer to the ‘Command Mode’ section [p21] for more information about entering Command Mode, sending AT commands and exiting Command Mode. For information regarding modem programming using API Mode, refer to the ‘API ...

Page 23

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  4.1.2. X-CTU Software X-CTU is a Digi-provided software program used to interface with and configure the RF Modems. The software application is organized into the following four tabs: • PC Settings tab - Setup PC serial ports for interfacing ...

Page 24

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  4.2. Command Reference Tables XBee-PRO RF Modems expect numerical values in hexadecimal. Hexadecimal values are designated by a “0x” prefix. Decimal equivalents are designated by a “d” suffix. Table rows are sorted by command category, then by logic of ...

Page 25

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  Table 4‐02. XBee‐PRO Commands ‐ Networking & Security (Sub‐categories designated within {brackets}) AT Command Name and Description Command Category Node Discover. Discovers and reports all RF modems found. The following information is reported for each modem discovered (the example cites use of Transparent operation (AT command format) - refer ...

Page 26

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  Table 4‐02. XBee‐PRO Commands ‐ Networking & Security (Sub‐categories designated within {brackets}) AT Command Name and Description Command Category Coordinator Association. Set/Read Coordinator association options. bit 0 - ReassignPanID 0 - Coordinator will not perform Active Scan to locate available PAN ID. It will operate on ID (PAN ID). ...

Page 27

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  Table 4‐02. XBee‐PRO Commands ‐ Networking & Security (Sub‐categories designated within {brackets}) AT Command Name and Description Command Category Active Scan. Send Beacon Request to Broadcast Address (0xFFFF) and Broadcast PAN (0xFFFF) on every channel. The parameter determines the time the radio will listen for Beacons on each channel. ...

Page 28

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  Sleep (Low Power) Table 4‐04. XBee‐PRO Commands ‐ Sleep (Low Power) AT Command Name and Description Command Category Sleep SM Sleep Mode. <NonBeacon firmware> Set/Read Sleep Mode configurations. (Low Power) Time before Sleep. <NonBeacon firmware> Set/Read time period of inactivity (no serial or RF data ...

Page 29

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  I/O Settings NOTE: The “I/O Settings” commands listed below refer to the I/O lines of the OEM RF module embedded inside the boxed RF modem. Implementation of these commands requires board-level development and is not supported when using the ...

Page 30

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  Table 4‐06. XBee‐PRO Commands ‐ I/O Settings (sub‐category designated within {brackets}) AT Command Name and Description Command Category I/O Settings {I/O P1 (v1.xA0*) PWM1 Configuration. Select/Read function for PWM1 pin. Line Passing} I/O Settings {I/O M0 (v1.xA0*) PWM0 Output Level. Set/Read the PWM0 output level. Line Passing} I/O ...

Page 31

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  4.3. Command Descriptions Command descriptions in this section are listed alphabetically. Command categories are designated within "< >" symbols that follow each command title. XBee-PRO RF Modems expect parameter values in hexadecimal (designated by the "0x" prefix). All modems ...

Page 32

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  AC (Apply Changes) Command <AT Command Mode Options> The AC command is used to explicitly apply changes to modem parameter values. ‘Applying changes’ means that the modem is re-initialized based on changes made to its parameter values. Once changes ...

Page 33

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  AP (API Enable) Command <Serial Interfacing> The AP command is used to enable the RF modem to operate using a frame- based API instead of using the default Transparent (UART) mode. Refer to the API Operation section [p50] when ...

Page 34

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  AV (ADC Voltage Reference) Command <Serial Interfacing> The AV command is used to set/read the ADC reference voltage switch. The XBee-PRO has an ADC voltage reference switch which allows the modem to select between an on- board voltage reference ...

Page 35

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  CC (Command Sequence Character) Command <AT Command Mode Options> The CC command is used to set and read the ASCII character used between guard times of the AT Command Mode Sequence ( GT). This sequence enters ...

Page 36

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  (DIOn Configuration) Commands <I/O Settings> The D0, D1, D2, D3 and D4 commands are used to select/read the behavior of their respective AD/DIO lines (pins 20, 19, 18, 17 and 11 respectively). Options include: • Analog-to-digital ...

Page 37

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  D7 (DIO7 Configuration) Command <I/O Settings> The D7 command is used to select/read the behavior of the DIO7 line (pin 12). Options include: • CTS flow control • Analog-to-digital converter • Digital input • Digital output D8 (DI8 Configuration) ...

Page 38

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  DL (Destination Address Low) Command <Networking {Addressing}> The DL command is used to set and read the lower 32 bits of the RF modem's 64-bit destination address. When combined with the DH (Destination Address High) parameter, it defines the ...

Page 39

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  EC (CCA Failures) Command <Diagnostics> The EC command is used to read and reset the count of CCA (Clear Channel Assessment) failures. This parameter value increments when the RF modem does not transmit a packet due to the detection ...

Page 40

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  FR (Software Reset) Command <Special> The FR command is used to force a software reset on the RF modem. The reset simulates powering off and then on again the modem. GT (Guard Times) Command <AT Command Mode Options> GT ...

Page 41

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  IO (Digital Output Level) Command <I/O Settings> The IO command is used to set digital output levels. This allows DIO lines setup as outputs to be changed through Command Mode. IR (Sample Rate) Command <I/O Settings> The IR command ...

Page 42

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  IU (I/O Output Enable) Command <I/O Settings> The IU command is used to disable/enable I/O UART output. When enabled (IU = 1), received I/O line data packets are sent out the UART. The data is sent using an API ...

Page 43

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  MM (MAC Mode) Command <Networking {Addressing}> The MM command is used to set and read the MAC Mode value. The MM command disables/enables the use of a Digi header contained in the 802.15.4 RF packet. By default (MM = ...

Page 44

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  NI (Node Identifier) Command <Networking {Identification}> The NI command is used to set and read a string for identifying a particular node. Rules: • Register only accepts printable ASCII data. • A string can not start with a space. ...

Page 45

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  PL (Power Level) Command <RF Interfacing> The PL command is used to select and read the power level at which the RF modem transmits conducted power. WHEN OPERATING IN EUROPE: XBee-PRO RF Modems must be configured to operate at ...

Page 46

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  RN (Random Delay Slots) Command <Networking & Security> The RN command is used to set and read the minimum value of the back-off exponent in the CSMA-CA algorithm. The CSMA-CA algorithm was engineered for collision avoidance (random delays are ...

Page 47

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  RR (XBee Retries) Command <Networking {Addressing}> The RR command is used set/read the maximum number of retries the modem will execute in addition to the 3 retries provided by the 802.15.4 MAC. For each XBee retry, the 802.15.4 MAC ...

Page 48

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  SH (Serial Number High) Command <Diagnostics> The SH command is used to read the high 32 bits of the RF modem's unique IEEE 64-bit address. The modem serial number is set at the factory and is read-only. SL (Serial ...

Page 49

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  ST (Time before Sleep) Command <Sleep Mode (Low Power)> The ST command is used to set and read the period of inactivity (no serial or RF data is sent or received) before activating Sleep Mode. NonBeacon Firmware Set/Read time ...

Page 50

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  4.4. API Operation By default, XBee-PRO RF Modems act as a serial line replacement (Transparent Operation) - all UART data received through the DI pin is queued up for RF transmission. When the modem receives an RF packet, the ...

Page 51

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  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): 0x11 needs to be escaped ...

Page 52

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  AT Command API Identifier Value: 0x08 The “AT Command” API type allows for modem parameters to be queried or set. When using this command ID, new parameter values are applied immediately. This includes any register set with the “AT ...

Page 53

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  AT Command Response API Identifier Value: 0x88 Response to previous command. In response Command message, the modem will send an AT Command Response message. Some commands will send back multiple frames (for example, the ND (Node ...

Page 54

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  TX (Transmit) Status API Identifier Value: 0x89 When a TX Request is completed, the modem sends a TX Status message. This message will indicate if the packet was transmitted successfully or if there was a failure. Figure 4‐14. TX Status Frames NOTES: ...

Page 55

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  5. Appendix A: Agency Certifications 5.1. FCC Certification XBee-PRO RF Modems comply with Part 15 of the FCC rules and regulations. Compliance with the labeling requirements, FCC notices and antenna usage guidelines is required. To fulfill FCC Certification requirements, the OEM must comply ...

Page 56

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  5.1.3. FCC-Approved Antennas (2.4 GHz) The XBee-PRO RF Modem can be installed utilizing antennas and cables constructed with standard connectors (Type- N, SMA, TNC, etc.) if the installation is performed professionally and according to FCC guidelines. For installations not ...

Page 57

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  RF Exposure WARNING: To satisfy FCC RF exposure requirements for mobile transmitting devices, a separation distance more should be maintained between the antenna of this device and persons during device operation. To ensure compliance, operations ...

Page 58

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  5.2. European Certification The XBee-PRO RF Modem has been certified for use in several European countries. For a complete list, refer to www.Digi.com. If the XBee-PRO RF Modems are incorporated into a product, the manufacturer must ensure compliance of ...

Page 59

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  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, Omni-directional, Articulated RPSMA, Digi part number A24-HABSM) ...

Page 60

... Ordering Information Figure B‐01. Divisions of the XBee‐PRO RF Modem Part Numbers  For example: XBP24-PKI-001-RA = XBee-PRO RF Modem (2.4 GHz), Industrial temperature rating, IEEE 802.15.4 standard, RS-232 Interface w/ accessories © 2008 Digi International, Inc.       59 ...

Page 61

XBee‐PRO PKG‐R® RS‐232 RF Modem – 802.15.4 ‐ Product Manual v1.xAx  6.3. Contact Digi International Free and unlimited technical support is included with every Digi Radio Modem sold. For the best in wireless data solutions and support, please use the following resources: Documentation: Technical Support: © 2008 Digi International, Inc.  http://www.digi.com/support/ Phone. U.S.A. & ...