9XTend-PKG-E™ Ethernet RF Modem 9XTend Ethernet RF Modem System Setup RF Modem Operation RF Modem Configuration RF Communication Modes Appendices Product Manual v2.x4x For RF Modem Part Numbers: XT09-PK...-E... 1 Watt Transmit Power, 256-bit AES Encryption MaxStream 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 support) M100217 2007.01.
9XTend‐PKG‐E™ Ethernet RF Modem ‐ Product Manual v2.x4x [2007.01.04] © 2007 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 XTend‐PKG‐E™ are trademarks of MaxStream, Inc. Ethernet™ is a registered trademark of Xerox. AES Encryption Source Code © 2007, Dr. Brian Gladman, Worcester, UK. All rights reserved.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] Contents 1. 9XTend Ethernet RF Modem 4 1.1. Key Features 4 5.1.1. Address Recognition 46 1.2. Specifications 5 5.2. Basic Communications 47 1.3. External Interface 6 5.2.1. Streaming Mode (Default) 47 7 5.2.2. Multi-Transmit Mode 48 5.2.3. Repeater Mode 49 2.1. Data Radio System Components 7 5.2.4. Polling Mode (Basic) 52 2.1.1. System Description 7 5.3. Acknowledged Communications 53 2.2. Com Port Communications 8 5.3.1.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] 1. 9XTend Ethernet RF Modem The 9XTend RF Modem affords OEMs and integrators an easy-to-use RF solution that sustains reliable delivery of data between remote devices. Out-of-box, the modem is configured to immediately sustain long range wireless links between devices. Simply feed serial data into one modem then the data will surface on the other end of the wireless link.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] 1.2. Specifications The XTend-PKG-E RF Modem ships configured to provide immediate long range wireless links between devices. The modem can be configured for additional functionality using standard AT and binary commands [Refer to the Command Mode [p18] & RF Modem Configuration [p20] sections]. The built-in Ethernet interface makes RF data available to any TCP/IP network.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] 1.3. External Interface 1-01a. Power Switch Move Power Switch to the ON (up) position to power the XTend Ethernet RF Modem. Figure 1‐01. Front View 1-01b. I/O & Power LEDs LEDs indicate modem activity as follows: Yellow (top LED) = Serial Data Out (to host) Green (middle) = Serial Data In (from host) Red (bottom) = Power/TX Indicator (Red light is on when powered; it pulses on/off briefly during RF transmission.) 1‐01d.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] 2. System Setup 2.1. Data Radio System Components MaxStream RF Modems were designed to provide reliable wireless links between devices contained in a data system. The PKG-E Ethernet RF Modem allows integrators to connect the MaxStream Modems into an Ethernet network.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] 2.2. Com Port Communications 2.2.1. Install Software The X-CTU and Com Port Redirector software facilitate communications through a PC com port. Follow the instructions below to setup a com port for configuring and testing the RF modem. Installation #1: X-CTU Software (version 4.8.0 or higher*) Use the X-CTU software to configure the Ethernet RF Modem and PC com port.
XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] 2.2.2. Setup Com Port and IP Address The XTend-PKG-E Ethernet RF Modem supports DHCP (Dynamic Host Configuration Protocol) and Auto IP protocols. Both protocols automatically assign IP addresses to nodes of a network. Ethernet RF Modem Discovery The X-CTU Software provides an easy-to-use interface that searches a local network and then displays Ethernet RF Modems found. Discover Ethernet RF Modem, Map Com Port & Assign IP Address: 1.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] 2.2.3. Assign Static IP Address To assign a static IP address to the Ethernet RF Modem, follow the steps outlined below. A static IP address may be necessary when: • The Ethernet RF Modem and the host PC are on different subnets • The Ethernet RF Modem IP address might be changed by a DHCP server Configure a static IP address on a local network: 1.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] 2.2.5. Test Communications (X-CTU Loopback) When testing a wireless link, consider using the following components: • XTend-PKG-E Ethernet RF Modem (connected to a local network) • XTend-PKG-R RS-232/485 RF Modem (w/ loopback adapter) • PC (connected to a local network) • Accessories (Loopback adapter, CAT5 UTP cable, power supplies and RPSMA antennas) Hardware Setup for Loopback Test: 1.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] 2.3. Telnet Communications In addition to com port communications, Telnet communications are also supported. 2.3.1. Test Communications (Telnet Loopback) A wireless link can be tested by connecting to the specific IP address and port number. Test a Wireless Link (Telnet Connection): 1. Follow steps in the "Ethernet RF Modem Discovery" section [p9]. 2.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] 3. RF Modem Operation WARNING: When operating at 1 Watt power output, observe a minimum separation distance of 2' (0.6m) between modems. Transmitting in close proximity of other modems can damage modem front ends. 3.1. Serial Communications 3.1.1. Transparent Operation By default, XTend RF Modems operate in Transparent Mode.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] 3.2. Modes of Operation XTend RF Modems operate in five modes. Figure 3‐01. Modes of Operation 3.2.1. Idle Mode When not receiving or transmitting data, the RF modem is in Idle Mode.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] Channel initialization is the process of sending an RF initializer that synchronizes receiving modems with the transmitting modem. During channel initialization, incoming serial data accumulates in the DI buffer. RF data, which includes the payload data, follows the RF initializer. The payload includes up to the maximum packet size (PK Command) bytes.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] 3.2.3. Receive Mode If a modem detects RF data while operating in Idle Mode, the modem transitions to Receive Mode to start receiving RF packets. Once a packet is received, the modem checks the CRC (cyclic redundancy check) to ensure that the data was transmitted without error. If the CRC data bits on the incoming packet are invalid, the packet is discarded. If the CRC is valid, the packet proceeds to the DO Buffer. Figure 3‐04.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] The SM (Sleep Mode) command is central to setting all Sleep Mode configurations. By default, Sleep Modes are disabled (SM = 0) and the modem remains in Idle/Receive Mode. When in this state, the modem remains constantly ready to respond to serial or RF activity.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] 3.2.5. Command Mode To modify or read modem parameters, the modem must first enter into Command Mode (state in which incoming characters are interpreted as commands). Two command types are supported: • AT Commands • Binary Commands For modified parameter values to persist in the modem registry, changes must be saved to nonvolatile memory using the WR (Write) command.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] Binary Command Mode Sending and receiving parameter values using binary commands is the fastest way to change operating parameters of the modem. Binary commands are used most often to sample signal strength [refer to DB (Received Signal Strength) parameter] and/or error counts; or to change modem addresses and channels for polling systems when a quick response is necessary.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] 4. RF Modem Configuration 4.1. Programming Examples Refer to the ‘Command Mode’ section [p18] for information regarding entrance into Command Mode, sending AT commands and exiting Command Mode. 4.1.1. Configuration Setup Options Examples in this section cite the use of MaxStreamʹs X‐CTU Soft‐ ware for programming the RF modem. Other programs such as Telnet Software can also be used to program the modem.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] 4.1.2. AT Command Examples Terminal Tab (X-CTU Software) A terminal program has been built into the X-CTU software and is located under the 'Terminal' tab. The Terminal tab provides an easy-to-use interface for programming the modem. System Response. When a command is sent to the modem, the modem will parse and execute the command. Upon successful execution of a command, the modem returns an "OK" message.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] 4.2. Command Reference Table Table 4‐01. XTend Commands (The RF modems expect numerical values in hexadecimal. Hexadecimal values are designated by a “0x” prefix. Decimal equivalents are designated by a “d” suffix.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] Table 4‐01. XTend Commands (The RF modems expect numerical values in hexadecimal. Hexadecimal values are designated by a “0x” prefix. Decimal equivalents are designated by a “d” suffix.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] 4.3. 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‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] BD (Interface Data Rate) Command The BD command is used to set and read the serial interface data rate (baud rate) used between the RF modem and host. This parameter determines the rate at which serial data is sent to the modem from the host. Modified interface data rates do not take effect until the CN (Exit AT Command Mode) command is issued and the system returns the 'OK' response.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] BT (Guard Time Before) Command The CC command is used to set/read the ASCII character used between guard times of the AT Command Mode Sequence (BT + CC + AT). This sequence enters the modem into AT Command Mode so that data entering the modem (from the host) is recognized as commands instead of payload.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] CN (Exit AT Command Mode) Command The CN command is used to explicitly exit the modem from AT Command Mode. AT Command: ATCN Binary Command: 0x09 (9 decimal) CS (GPO1 Configuration) Command CS Command is used to select the behavior of the GP01 pin (pin 9). This output can provide RS-232 flow control, control the TX enable signal (for RS-485 or RS-422 operations).
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] DT (Destination Address) Command DT Command is used to set/read the networking address of an RF modem. The modems utilize three filtration layers: Vendor ID Number (ATID), Channel (ATHP), and Destination Address (ATDT). The DT command assigns an address to a modem that enables it to communicate only with other modems having the same address.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] FL (Software Flow Control) Command The FL command is used to configure software flow control. Hardware flow control is implemented with the modem as the GP01 pin (CTS pin of the OEM RF module), which regulates when serial data can be transferred to the modem. FL Command can be used to allow software flow control to also be enabled. The XON character used is 0x11 (17 decimal).
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] HP (Hopping Channel) Command The HP command is used to set/read the RF modem's hopping channel number. A channel is one of three layers of filtration available to the modem. In order for modems to communicate with each other, the modems must have the same channel number since each channel uses a different hopping sequence.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] KY (AES Encryption Key) Command The KY command is AT Command: ATKY used to set the 256-bit AES (Advanced Encryption Binary Command: 0x3C (60 decimal) Standard) key for encrypting/decrypting data. Parameter Range: Once set, the key cannot be read out of the 0 - (any other 64-digit hex valid key) modem by any means.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] MK (Address Mask) Command The MK command is used to set/read the Address Mask of a modem. AT Command: ATMK Binary Command: 0x12 (18 decimal) All RF data packets contain the Destination Parameter Range: 0 - 0xFFFF Address of the TX (transmitting) modem.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] NB (Parity) Command The NB command is used to select/read the parity settings of the RF modem for UART communications.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] PK (Maximum RF Packet Size) Command The PK command is used to set/ read the maximum size of RF packets transmitted from an RF modem. The maximum packet size can be used along with the RB and RO parameters to implicitly set the channel dwell time.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] RB (Packetization Threshold) Command The RB command is used to set/read the character threshold value.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] RN (Delay Slots) Command The RN command is used to set/read the time delay that the transmitting RF modem inserts before attempting to resend a packet. If the transmitting modem fails to receive an acknowledgement after sending a packet, it inserts a random number of delay slots (ranging from 0 to (RN minus 1)) before attempting to resend the packet. Each delay slot is 5 msec (when BR=1) and 54 msec (when BR=0).
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] RP (RSSI PWM Timer) Command RP Command is used to enable a PWM ("Pulse Width Modulation") output on the Config/RSSI pin (pin 11 of the OEM RF Module). The pin is calibrated to show the difference between received signal strength and the sensitivity level of the RF modem. PWM pulses vary from zero to 95 percent. Zero percent means the received RF signal is at or below the published sensitivity level of the modem.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] RT (GPI1 Configuration) Command The RT command is used to set/read the behavior of the GPI1 pin (pin 10) of the OEM RF Module. The pin can be configured to enable binary programming or RTS flow control.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] SM (Sleep Mode) Command The SM Command is used to set/read the RF modem's Sleep Mode settings that configure the modem to run in states that require minimal power consumption. AT Command: ATSM Binary Command: 0x01 Parameter Range: 0 - 8 (3 is reserved) Parameter Configuration 0 Disabled 1 Pin Sleep 2 Serial Port Sleep 3 [reserved] 4 Cyclic 1.0 second sleep (RF modem wakes every 1.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] TR (Transmit Error Count) Command The TR command is used to report the number of retransmit failures. This number is incremented each time a packet is not acknowledged within the number of retransmits specified by the RR (Retries) parameter. The number of packets therefore are counted that were not successfully received and subsequently discarded.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] WA (Active Warning Numbers) Command The WA command reports the warning numbers of all active warnings - one warning number per line. No further information is shown and warning counts are not reset. AT Command: ATWA Parameter Range: Returns string - one warning number per line.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] 4.4. API Operation By default, XTend 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 data is sent out the DO pin with no additional information.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] TX (Transmit) Request: 16-bit address API Identifier Value: 0x01 A TX Request message will cause the modem to send RF Data as an RF Packet. Figure 4‐7.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] 5. RF Communication Modes The network configurations covered in this chapter are described in terms of the following: • Network Topology (Point-to-Point, Point-to-Multipoint or Peer-to-Peer) • RF Communication Type (Basic or Acknowledged) • RF Mode (Streaming, Multi-Transmit, Repeater, Acknowledged or Polling) The following table provides a summary of the network configurations supported by the XTend RF Modem. Table 5‐01.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] 5.1. Addressing Each RF packet contains addressing information that is used to filter incoming RF data. Receiving modules inspect the Hopping Channel (HP parameter), Vendor Identification Number (ID parameter) and Destination Address (DT parameter) contained in each RF packet. Data that does not pass through all three network security layers is discarded. Figure 5‐01. Addressing layers contained in the RF packet header 5.1.1.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] 5.2. Basic Communications Basic Communications are accomplished through two sub-types: • Broadcast - By default, XTend RF Modems communicate through Broadcast communications and within a peer-to-peer network topology. When any modem transmits, all other modems within range will receive the data and pass it directly to their host device.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] 5.2.2.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] 5.2.3. Repeater Mode Attributes: Low power consumption Minimized interference Each RF packet is tagged with a unique Packet ID (PID). Each repeater will repeat a packet only once (tracked by the PID). Increased latency and decreased throughput (Latency and throughput is determined by number of hops, not by number of repeaters. Multiple repeaters within range of source node count as one hop.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] Repeater Network Configuration A network may consist of End Nodes (EN), End/Repeater Nodes (ERN) and a Base Node (BN). The base node initiates all communications. A repeater network can be configured to operate using Basic Broadcast or Basic Addressed communications. The addressing capabilities of the modem allow integrators to send a packet as a global packet (DT = 0xFFFF) and shift out of every modem in the network (Basic Broadcast).
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] Response Packet Delay As a packet propagates through the repeater network, if any node receives the data and generates a quick response, the response needs to be delayed so as not to collide with subsequent retransmissions of the original packet.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] 5.2.4. Polling Mode (Basic) NOTE: Polling Mode (Basic) and Polling Mode (Acknowledged) [p55] operate in the same way. The only difference between the two modes is in their means of achieving reliable delivery of data. In Polling Mode (Basic), reliable delivery is achieved using multiple transmissions.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] 5.3. Acknowledged Communications 5.3.1. 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.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] The TT parameter (streaming limit) specifies the maximum number of bytes that the TX modem will send in one transmission event, which may consist of many packets and retries. If the TT parameter is reached, the TX modem will force a random delay of 1 to RN delay slots (exactly 1 delay slot if RN is zero). Each packet is counted only once toward TT, no matter how many times the packet is retransmitted.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] 5.3.2. Polling Mode (Acknowledged) NOTE: Polling Mode (Acknowledged) and Polling Mode (Basic) [p52] operate in the same way. The only difference between the two modes is in their means of achieving reliable delivery of data. In Polling Mode (Acknowledged), reliable delivery is achieved using retries and acknowledgements.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] Appendix A: Agency Certifications FCC (United States) Certification The XTend Ethernet RF Modem complies with Part 15 of the FCC rules and regulations. Compliance with the labeling requirements, FCC notices and antenna usage guidelines is required. In order to operate under MaxStream’s FCC Certification, OEMs/integrators must comply with the following regulations: 1.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] Limited Modular Approval Power output is conducted at the antenna terminal and can be adjusted from 1 mill-watt to 1 Watt at the OEM level. This is an RF modem approved for Limited Modular use operating as a mobile transmitting device with respect to section 2.1091 and is limited to OEM installation for Mobile and Fixed applications only. During final installation, end-users are prohibited from access to any programming parameters.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] Antenna Options (1-watt transmit power output or lower) Table A‐01.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] Table A‐04. Mag Mount antennas (approved when operating at 1‐watt power output or lower) Part Number A09-M0SM A09-M2SM A09-M3SM A09-M5SM A09-M7SM A09-M8SM A09-M0TM A09-M2TM A09-M3TM A09-M5TM A09-M7TM A09-M8TM Type Mag Mount Mag Mount Mag Mount Mag Mount Mag Mount Mag Mount Mag Mount Mag Mount Mag Mount Mag Mount Mag Mount Mag Mount Connector RPSMA RPSMA RPSMA RPSMA RPSMA RPSMA RPTNC RPTNC RPTNC RPTNC RPTNC RPTNC Gain 0 dBi 2.1 dBi 3.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] Table A‐07.
9XTend‐PKG‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] Appendix B: 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‐E™ Ethernet RF Modem – Product Manual v2.x4x [2007.01.04] 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/helpdesk/download.php Technical Support: Phone. (866) 765-9885 toll-free U.S.A. & Canada (801) 765-9885 Worldwide Live Chat. www.maxstream.net E-Mail. rf-xperts@maxstream.
