9XTend-PKG-R™ RS-232/485 RF Modem 9XTend-PKG-R RF Modem Interfacing Protocol Modem Operation Modem Configuration RF Communication Modes Appendices Product Manual v1.2.4 For MaxStream part numbers: XT09-PK…-R… 1 Watt Transmit Power, -110 dBm Receiver Sensitivity, 256-bit AES Encryption 355 south, 520 west, suite 180 Lindon, UT 84042 Phone: (801) 765-9885 Fax: (801) 765-9895 rf-xperts@maxstream.net M100171 www.maxstream.net (live chat support) 2005.08.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 © 2005 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. XTend™ and 9XTend‐PKG‐R™ are registered trademarks of MaxStream, Inc. AES Encryption Source Code © 2005 Dr. Brian Gladman, Worcester, UK. All rights reserved.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 Contents 1. 9XTend-PKG-R™ RF Modem 4 1.1. Features Overview 4 1.1.1. Worldwide Acceptance 4 5.2. Streaming Mode 42 5.2.1. Connection Sequence 42 1.2.1. Specifications 5 5.3. Acknowledged Mode 43 1.3. XTend-PKG-R Interface 6 5.3.1. Connection Sequence 43 7 2.1. RS-232 Operation 7 5.4. Multi-Transmit Mode 45 5.4.1. Connection Sequence 45 Appendix A: Agency Certifications 2.1.1. DIP Switch Settings & Pin Signals 7 2.1.2.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 1. 9XTend‐PKG‐R™ RF Modem The 900 MHz XTend RF Modem is MaxStream’s longest range drop-in wireless solution. Out-of-box, the RF modem is equipped to sustain long range wireless links between devices. Simply enter serial data into one modem and the data surfaces on the other end of the wireless link. The modem transfers a standard asynchronous serial data stream between two or more modems.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 1.2. Product Overview The XTend-PKG-R RF Modem comes configured to provide immediate long range wireless links between devices. The RF modem can be configured for additional functionality through the use of standard AT and binary commands [Refer to the Command Mode [p18] & Modem Configuration [p20] sections for programming options]. 1.2.1. Specifications Table 1‐01.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 1.3. XTend-PKG-R Interface 1-01a. Config (Configuration) Switch The Configuration Switch provides an alternate method for entering into Command Mode. To enter Command Mode at the default RF data rate of the RF modem, depress the Config Switch for two seconds. Figure 1‐01. Front View 1-01b. I/O & Power LEDs LEDs indicate modem activity as follows: 1‐01c. Serial Port 1‐01d.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 2. Interfacing Protocol The XTend-PKG-R RF Modem supports the following interfacing protocols: • RS-232 • RS-485 (2-wire) Half-Duplex • RS-485 (4-wire) and RS-422 2.1. RS-232 Operation 2.1.1. DIP Switch Settings & Pin Signals Figure 2‐01. RS‐232 DIP Switch Settings Figure 2‐02. Pins used on the female RS‐232 (DB‐9) Serial Connector DIP Switch settings are read and applied only while powering‐on. Table 2‐01.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 2.1.2. Wiring Diagrams RS-232 DTE Device to a DCE RF Modem Figure 2‐03. RS‐232 DTE (male connector) device wired to an XTend RF Modem (female connector) DCE RF Modem to an RS-232 DCE Device Figure 2‐04. XTend RF Modem (female connector) wired to an RS‐232 DTE (male connector) device Sample Wireless Connection: DTE Ù DCE DCE Ù DCE Figure 2‐05.
XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 2.2. RS-485 (2-wire) Operation 2.2.1. DIP Switch Settings & Pin Signals Figure 2‐06. RS‐485 (2‐wire) Half‐Duplex DIP Switch Settings Figure 2‐07. Pins used on the female RS‐232 (DB‐9) Serial Connector Figure 2‐08. RS‐485 (2‐wire) with Termination (optional) Termination is the 120 Ω resistor between T+ and T‐. DIP Switch settings are read and applied only while powering‐on.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 2.3. RS-485 (4-wire) & RS-422 Operation 2.3.1. DIP Switch Settings & Pin Signals Figure 2.10. RS‐485 (4‐wire) and RS‐422 DIP Switch Settings Figure 2.11. Pins used on the female RS‐232 (DB‐9) Serial Connector Figure 2.12. RS‐485 (4‐wire) & RS‐422 with Termination (optional) Termination is the 120 Ω resistor between T+ and T‐. DIP Switch settings are read and applied only while powering‐on. Table 2‐03.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 RS-422 Figure 2‐14. XTend RF Modem in an RS‐485 (4‐wire) environment 2.3.3. RS-485/422 Connection Guidelines The RS-485/422 protocol provides a solution for wired communications that can tolerate high noise and push signals over long cable lengths. RS-485/422 signals can communicate as far as 4000 feet (1200 m). RS-232 signals are suitable for cable distances up to 100 feet (30.5 m).
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 3. Modem Operation WARNING: When operating at 1 Watt power output, observe a minimum separation distance of 2’ (0.6 m) between modems. Transmitting in close proximity of other modems can damage modem front ends. 3.1. Serial Communications 3.1.1. RS-232 and RS-485/422 Data Flow The XTend-PKG-R RF Modem interfaces to a host device through a standard RS-232 (DB-9) connector.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 3.1.3. Flow Control Figure 3‐02. Internal Data Flow Diagram DI (Data In) Buffer and Flow Control When serial data enters the XTend Modem through the DI Pin, the data is stored in the DI Buffer until it can be transmitted. When the RB and RO parameter thresholds are satisfied (refer to Transmit Mode section [p14] for more information), the modem attempts to initialize an RF connection.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 3.2. Modes of Operation XTend RF Modems operate in five modes. Figure 3‐03. Modes of Operation The RF modem can only be in one mode at a time. 3.2.1. Idle Mode When not receiving or transmitting data, the modem is in Idle Mode. The modem uses the same amount of power in Idle Mode as it does in Receive Mode.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 After either of the RB and RO conditions are met, the modem then initializes a communications channel. Serial data in the DI buffer is grouped into RF packets (up to 2048 bytes in each packet - refer to PK (Maximum RF Packet Size) Command), converted to RF data and then is transmitted over-the-air until the DI buffer is empty.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 CRC (Cyclic Redundancy Check) To verify data integrity and provide built-in error checking, a 16-bit CRC (Cyclic Redundancy Check) is computed for the transmitted data and attached to the end of each RF packet before transmission. On the receiving end, the receiving modem computes the CRC on all incoming RF data. Received data that has an invalid CRC is discarded [Refer to the Receive Mode section]. 3.2.3.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 3.2.4. Sleep Mode Software Sleep Sleep Modes enable the XTend Modem to operate at minimal power consumption when not in use. Three Sleep Mode options are available: • Host Controlled (Pin Sleep) • Wake on Serial Port activity (Serial Port Sleep) • Wake on RF activity (Cyclic Sleep) For the modem to transition into Sleep Mode, SM (Sleep Mode) Parameter must have a non-zero value and one of the following must occur: 1.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 3.2.6. Command Mode To set or read modem parameters; the modem must first enter Command Mode (a state in which incoming characters are interpreted as commands). Two command types are available: • AT Commands • Binary Commands For modified parameter values to persist in the modem’s registry, changes must be saved to nonvolatile memory using WR (Write) Command.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 Binary Command Mode Sending and receiving parameter values using binary commands is the fastest way to change the operating parameters of the XTend RF Modem. Binary commands are used most often to sample signal strength (DB parameter) and/or error counts; or change modem addresses and channels for polling data systems.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 4. Modem Configuration 4.1. Automatic DIP Switch Configurations Each time an RF Modem is powered on, AT commands are sent to the on-board RF module as dictated by the positions of the DIP switches. DIP switch configurations are sent automatically during the power-on sequence and affect modem parameter values as shown in the table below. Figure 4‐01. DIP Switches Table 4‐01.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 4.2. Programming Examples For information about entering and exiting AT and Binary Command Modes, refer to the Command Mode section [p18]. 4.2.1. AT Commands (Using X-CTU Software) MaxStream has provided X-CTU software for programming the modem using an extensive list of AT Commands.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 EXAMPLE: Restore RF Modem Default Parameters using the Terminal tab: Note: Do not send commands to the module during flash programming (when parameters are being written to the module registry). Wait for the ʺOKʺ system response that follows the ATWR command before entering the next command or use flow control. Example: Both of the following examples restore the XTend Modem’s factory defaults and save the parameters to non-volatile memory.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 4.3. Command Reference Table 4‐03. XTend Commands as of firmware v1.2.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 4.4. Command Descriptions Commands in this section are listed alphabetically. Command categories are designated between the “< >” symbols that follow each command title. By default, XTend RF Modems expect numerical values in hexadecimal since the default value of the CF (Number Base) Parameter is ‘1’. Hexadecimal values are designated by the “0x” prefix and decimal values by the “d” suffix.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 BR (RF Data Rate) Command BR Command is used to set/read the RF data rate (rate that RF data is transmitted over-the-air) of the modem.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 CN (Exit Command Mode) Command CN Command is used to explicitly exit AT Command Mode. AT Command: ATCN Binary Command: 0x09 (9 decimal) CS (GP01 Configuration) Command CS Command is used to select the behavior of the GP01 pin. This output can provide RS-232 flow control, control the TX enable signal (for RS-485 or RS-422 operations), or set the default level for the I/O line passing function.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 DT (Destination Address) Command DT Command is used to set/read the networking address of an XTend Modem. XTend Modems uses three network layers –Vendor Identification Number (ATID), Channels (ATHP), and Destination Addresses (ATDT). DT Command assigns an address to a modem that enables it to communicate only with other modems having the same addresses.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 FS (Forced Synch Time) Command AT Command: ATFS FS Command only applies to Binary Command: 0x3E (62 decimal) streaming data. Normally, only the first packet of Parameter Range: 0 – 0xFFFF a continuous stream has the full RF initializer. The [x 10 milliseconds] modems then remain synchronized for subsequent Default Parameter Value: 0 packets of the stream.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 HT (Time before Wake-up Initializer) Command Set/read time of inactivity (no serial or RF data is sent or received) before a wake-up initializer is sent by a TX modem. HT should be set shorter than inactivity timeout [ST Command] time of any RX modems operating in Cyclic Sleep (SM=4-8). The wake-up initializer sent by the TX modem instructs all RX modems to remain awake to receive RF data.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 LH (Wake-up Initializer Timer) Command LH Command is used to set/read the duration of time for which the wakeup initializer is sent. When receiving modems are put into Cyclic Sleep Mode, they power-down after a period of inactivity [specified by ST (Time before Sleep) Command] and will periodically awaken and listen for transmitted data.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 MY (Source Address) Command Set/Read the source address of the modem. AT Command: ATMY Binary Command: 0x2A (42 decimal) Parameter Range: 0 – 0xFFFF Default Parameter Value: 0xFFFF (Disabled, DT (Destination Address) parameter serves as both source and destination address.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 PW (Pin Wake-up) Command Under normal operation, a modem in Cyclic Sleep Mode cycles from an active state to a low-power state at regular intervals until data is ready to be received. If the PW Parameter is set to 1, the SLEEP Pin can be used to awaken the modem from Cyclic Sleep. If the SLEEP Pin is de-asserted (low), the modem will be fully operational and will not go into Cyclic Sleep.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 RM Command (continued) A graphical spectrum analyzer application can be implemented by repeatedly calling ATRM with no arguments and reading the resultant 50 power levels (easiest to do when CF = 1 or 2). Sample output [when CF = 0]: Ch 0: -100 dBm Ch 1: -103 dBm ... Ch 49: -99 dBm Sample output [when CF = 1]: 64 67 ...
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 RO Command (continued) When RO is the transmission-beginning criteria: The actual time between the reception of the last character from the UART and the beginning of RF transmission will be at least 800 µsec longer than the actual RO time to allow for transmission setup. Additionally, it is subject to 100 - 200 µsec of additional uncertainty, which could be significant for small values of RO at high UART bit rates.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 RT (GPI1 Configuration) Command RT Command is used to set/read the behavior of the GPI1 pin. The pin can be configured to enable flow control.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 SM (Sleep Mode) Command SM Command is used to set/read the modem’s Sleep Mode settings that configure the modem to run in states that require minimal power consumption. AT Command: ATSM Binary Command: 0x01 Pin Sleep (SM = 1) Disabled Pin Sleep Serial Port Sleep reserved Cyclic 1.0 second sleep 4 (Modem wakes every 1.0 second) 5 Cyclic 2.0 second sleep 6 Cyclic 4.0 second sleep 7 Cyclic 8.0 second sleep 8 Cyclic 16.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 SM Command (continued) The modem remains in Sleep Mode for a user-defined period of time ranging from 0.5 seconds to 16 seconds (SM Parameters 3 through 8). After this interval of time, the modem returns to Idle Mode and listens for a valid data packet for 100 ms. If the modem does not detect valid data (on any frequency), the modem returns to Sleep Mode.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 ST (Time before Sleep) Command ST Command is used to set/read the period of time (milliseconds) in which the modem remains inactive before entering Sleep Mode. For example, if the ST Parameter is set to 0x64 (100 decimal), the modem will enter into Sleep mode after 10 seconds of inactivity (no transmitting or receiving).
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 VL (Firmware Version - verbose) Command VL Command is used to read the verbose firmware version of the XTend Modem. Sample output: Firmware version 1.0, Jan 16 2005 10:46:57 AT Command: ATVL Parameter Range: Returns string Number of bytes returned: 2 VR (Firmware Version) Command VR Command is used to read the firmware version of the XTend Modem.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 WR (Write) Command AT Command: ATWR <(Special)> WR Command writes configurable Binary Command: 0x08 parameters to the modem’s non-volatile memory (Parameter values remain in the modem’s memory until overwritten by future use of WR Command). 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.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 5. RF Communication Modes The XTend RF Modem can be configured to operate in any of several RF communication modes: • Streaming • Acknowledged • Multi-Transmit The mode is defined by parameters stored in the transmitting modem [see table below]. Receiving modems automatically adapt to the correct mode on a per-packet basis, based on the contents of each received packet. Table 5‐01.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 5.2.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 5.3. Acknowledged Mode Attributes: Reliable delivery through positive acknowledgements for each packet Throughput, latency and jitter vary depending on the quality of the channel and the strength of the signal. Required Parameter Values (TX Modem): RR (Retries) >= 1 Related Commands: Networking (DT, MK, RR), Serial Interfacing (PK, RN, RO, RB, TT) Recommended Use: Use for applications that require Reliable Delivery.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 RB and RO parameters are not applied to subsequent packets, meaning that once transmission has begun, it will continue uninterrupted until the DI buffer is empty or the streaming limit (TT) has been reached. As with the first packet, the payload of each subsequent packet includes up to the maximum packet size (PK), and the transmitting modem checks for more pending data near the end of each packet.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 5.4.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 Appendix A: Agency Certifications FCC Certification The XTend RF Modem complies with Part 15 of the FCC rules and regulations. Compliance with labeling requirements, FCC notices and antenna regulations is required. Labeling Requirements In order to inherit MaxStream’s FCC Certification, OEMs and integrators are required to publish the text shown in Figure A-01 on the final product and within the final product operation manual.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 NOTE: This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation. This equipment generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communications.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 FCC-Approved Antennas (900 MHz) Fixed Base Station and Mobile Applications MaxStream Modems are pre-FCC approved for use in fixed base station and mobile applications. When the antenna is mounted at least 20 cm (8”) from nearby persons, the application is considered a mobile application.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 Table A‐03. Omni‐directional base station antennas (approved when operating at 1 Watt power output or lower.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 100 milliWatt Transmit Power Output or Lower Table A‐06. Monopole antennas (approved when operating at 100 mW power output or lower.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 Appendix B: Development Guide RS-232 Accessories Kit Contents The accessories listed below are included with XTend RF Modems that carry the “-RA” suffix on the product number. For example: Part number “XT09-PKC-RA” includes the listed accessories and part number “XT09-PKC-R” does not. The accessories kit includes hardware and software needed for developing long range wireless links.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 Adapters The XTend Development Kit comes with several adapters that support the following functions: • Performing Range Tests • Testing Cables • Connecting to other RS-232 DCE and DTE devices • Connecting to terminal blocks or RJ-45 (for RS-485/422 devices) 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 devices.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 Antennas [Refer to Appendix A for a list of FCC-Approved Antennas] Factors that determine wireless link range: • Ambient RF noise (interference) • Line-of-sight obstructions • Transmit power • Receive sensitivity • Antenna configuration XTend Antenna Connector Options To comply with the FCC rules and obtain a “modular” certification, it is required that XTend Modems utilize a “non standard” connector.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 Appendix C: Additional Information 1 Year Warranty XTend RF Modems 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.
9XTend‐PKG‐R™ RS‐232/485 RF Modem – Product Manual v1.2.4 Contact MaxStream Free and unlimited technical support is included with every MaxStream Radio Modem sold. Please use the following resources for additional support: Documentation: http://www.maxstream.net/helpdesk/download.php Technical Support: Phone. (866) 765-9885 toll-free U.S. & Canada (801) 765-9885 Worldwide Live Chat. www.maxstream.net E-Mail. rf-xperts@maxstream.net MaxStream office hours are 8:00 am – 5:00 pm [U.S.