XStream-PKG-E™ Ethernet RF Modem XStream Ethernet RF Modem System Setup RF Modem Operation RF Modem Configuration RF Communication Modes Appendices Product Manual v5.x00 For XStream RF Modem Part Numbers X09-001PK…-E… X24-009PK…-E... XH9-001PK…-E... X09-009PK…-E… X09-019PK…-E… X24-019PK…-E… XH9-009PK…-E… XH9-019PK…-E… 900 MHz & 2.4 GHz 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.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] © 2006 MaxStream, Inc. All rights reserved The contents of this manual may not be transmitted or reproduced in any form or by any means without the written permission of MaxStream, Inc. XStream™ and XStream‐PKG‐E™ are trademarks of MaxStream, Inc. XPort™ is a registered trademark of Lantronix. Ethernet™ is a registered trademark of XEROX. Technical Support: Phone: (801) 765-9885 Live Chat: www.maxstream.net E-Mail: rf-xperts@maxstream.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] Contents 1. XStream Ethernet RF Modem 1.1. Features Overview 4 4 FCC Notices 6 7 2.1. Data Radio System Components 7 Restrictions 1-Year Warranty 8 2.2.2. Setup Com Port and IP Address 2.2.3. Assign Static IP Address 2.2.4. Change Com Port Number Contact MaxStream 55 56 10 2.2.5. Test Communications (X-CTU) 2.3.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] 1. XStream Ethernet RF Modem XStream-PKG-E Ethernet RF Modems extend system performance and flexibility by adding serial connectivity to Ethernet networks. MaxStream RF Modems handle the complexities inherent to RF communications (modulation, demodulation, frequency synthesizers, amplifiers, filters, FCC approvals, etc.), so OEMs and integrators can focus resources beyond the wireless portion of the data system. 1.1.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] 1.2. Product Overview The XStream-PKG-E RF Modem comes configured to provide immediate wireless links between devices; however, the RF modem can be configured for additional functionality through the use of a simple AT command interface [Refer to the Command Mode [p18] & RF Modem Configuration [p20] sections for programming options]. 1.2.1. Specifications Table 1‐01.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] 1.3. External Interface 1.3.1. Front and Back Views 1-01a. Power Switch Move Power Switch to the ON (up) position to power the XStream PKG-E Ethernet RF Modem. Figure 1‐01. Front View 1-01b.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] 2. System Setup 2.1. Data Radio System Components XStream Radio Modems are designed to provide long range wireless links between devices of a data system. The PKG-E Ethernet RF Modem connects serial modems to Ethernet networks.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] 2.2. Com Port Communications 2.2.1. Install Software The X-CTU and Com Port Redirector software facilitate communications through a PC’s com port. Follow the instructions below to setup a com port for configuring and testing RF modems. 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.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] 2.2.2. Setup Com Port and IP Address The XStream-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.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] 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.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] 2.2.5. Test Communications (X-CTU) When testing a wireless link, MaxStream suggests creating the link using the following components: • XStream-PKG-E Ethernet RF Modem (connected to a local network) • XStream-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.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] 2.3. Telnet Communications In addition to com port communications, Telnet communications are also supported. 2.3.1. Test Communications (Telnet) MaxStream Wireless links 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.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] 3. RF Modem Operation 3.1. Modes of Operation An on-board RF module enables the XStream RF Modem to send and receive data over-the-air. The RF modem operates in five modes. Figure 3‐01. RF Modem Modes of Operation The RF modem can only be in one mode at a time. 3.1.1. Idle Mode When not receiving or transmitting data, the RF modem is in Idle Mode. The RF modem uses the same amount of power in Idle Mode as it does in Receive Mode.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] Figure 3‐02. Data Transmission Sequence Æ After either RB or RO conditions are met, the modem then initializes a communications channel. [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.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] 3.1.3. Receive Mode If a modem detects RF data while operating in Idle Mode, the modem transitions into Receive Mode to start receiving RF packets. Figure 3‐04. Reception of RF Data Æ After 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.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] Pin Sleep (SM = 1) Pin Sleep requires the least amount of power. In order to achieve this state, DI3 (SLEEP) pin must be asserted (high). The modem remains in Pin Sleep until the DI3 pin is de-asserted. After enabling Pin Sleep, the SLEEP pin controls whether the XStream Modem is active or in Sleep Mode. When DI3 is de-asserted (low), the modem is fully operational.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] Cyclic Scanning. Each RF transmission consists of an RF Initializer and payload. The wake-up initializer contains initialization information and all receiving modems must wake during the wake-up initializer portion of data transmission in order to be synchronized with the transmitting modem and receive the data. Figure 3‐05. Correct Configuration (LH > SM) Length of the wake‐up initializer exceeds the time interval of Cyclic Sleep.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] 3.1.5. Command Mode To modify or read RF module parameters, the module must first enter into Command Mode - a state in which incoming characters are interpreted as commands and parameters. Two command types are available for programming the RF modem: AT Commands and Binary Commands. IMPORTANT: For modified parameter values to persist in the RF modem’s registry, changes must be saved to non-volatile memory using the WR (Write) Command.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] Binary Commands Sending and receiving parameter values using binary commands is the fastest way to change operating parameters of the XStream RF Modem. Binary commands are used most often to sample signal strength (RS parameter) and/or error counts; or change modem addresses and channels for polling data systems.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] 4. RF Modem Configuration 4.1. Hands-On Programming Examples For more information about entering Command Mode, sending commands and exiting Command Mode, refer to the Command Mode section [p18]. 4.1.1. Configuration Setup Options After installing the X-CTU and Com Port Redirector Software [refer to p8] to a PC, use one of the connection options below to send commands to the XStream-PKG-E Ethernet RF Modem.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] 4.1.2. AT Command Examples Send AT Commands (Using the X-CTU Terminal Tab): After following the steps outlined in the Configuration Setup section [previous page], the RF modem is ready to be programmed. The following steps utilize the Terminal tab of the X-CTU Software to read and write parameter values. 1. Highlight the Com Port from the ‘Select Com Port’ list that is mapped to the Ethernet RF Modem. 2.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] 4.2. Command Reference Table Table 4‐01. XStream Commands (The RF modem expects numeric values in hexadecimal. ‘d’ denotes decimal equivalents.) AT Command AM v4.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] 4.3. Command Descriptions Commands in this section are listed alphabetically. Command categories are designated between the “< >” symbols that follow each command title. XStream Modems expect numerical values in hexadecimal and those values are designated by a “0x” prefix.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] BK (Serial Break Passing) Command Pass a serial break condition on the DI pin to the DO pin of another modem. AT Command: ATBK Binary Command: 0x2E (46 decimal) Parameter Range: 0 – 1 Parameter Configuration 0 disable 1 enable Default Parameter Value: 0 Number of bytes returned: 1 Related Commands: BO (Serial Break Timeout) Minimum Firmware Version Required: 4.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] CD (DO3 Configuration) Command CD Command is used to redefine the behavior of the DO3/RX LED line. AT Command: ATCD Binary Command: 0x28 (40 decimal) Parameter Range: 0 – 2 Parameter Configuration 0 RX LED 1 Default high 2 Default low 3 (reserved) Assert only when packet addressed to module sent 4 Default Parameter Value: 0 Number of bytes returned: 1 Minimum Firmware Version Required: 4.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] CN (Exit AT Command Mode) Command CN Command is used to explicitly exit AT Command Mode. AT Command: ATCN Binary Command: 0x09 (9 decimal) CO (DO3 Timeout) Command DO3 (Data Output 3) output AT Command: ATCO will return to default after no DI3 (Data Input 3) Binary Command: 0x2F (47 decimal) status information is received during the timeout period.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] DR (DI3 Configuration) Command The DR Command is used to AT Command: ATDR configure the DI3 (Data Input 3 / SLEEP) line for Binary Command: 0x2D (45 decimal) I/O line passing (use with CD = 1 or 2 and CO) or controlling connection status (use with MD = 1 or 2).
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] FH (Force Wake-up Initializer) Command FH Command is used to force a Wake-up Initializer to be sent on the next transmit. WR (Write) Command does not need to be issued with FH Command. AT Command: ATFH Binary Command: 0x0D (13 decimal) Use only with cyclic sleep modes active on remote modems.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] HT (Time before Wake-up Initializer) Command If any modems within range are running in a “Cyclic Sleep” setting, a wake-up initializer must be used by the transmitting modem for sleeping modems to remain awake [refer to the LH (“Wake-up Initializer Timer”) Command]. When a receiving modem in Cyclic Sleep wakes, it must detect the wake-up initializer in order to remain awake and receive data.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] LH (Wake-up Initializer Timer) Command LH Command adjusts the duration of time for which the RF initializer is sent.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] MY (Source Address) Command Set/Read the source address of the modem. AT Command: ATMY Refer to the Addressing section [p39] of the RF Parameter Range: 0 – 0xFFFF Communication Modes chapter for more information. Binary Command: 0x2A (42 decimal) Default Parameter Value: 0xFFFF (Disabled – the DT (Destination Address) parameter serves as both source and destination address.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] PW (Pin Wake-up) Command Under normal operation, a AT Command: ATPW modem in Cyclic Sleep Mode cycles from an Binary Command: 0x1D (29 decimal) active state to a low-power state at regular intervals until data is ready to be received. If the Parameter Range: 0 – 1 PW Parameter is set to 1, the SLEEP/DI3 Pin can be used to awaken the modem from Cyclic Sleep.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] RO (Packetization Timeout) Command RO Command is used to specify/read the time of silence (no bytes received) after which transmission begins. After a serial byte is received and if no other byte is received before the RO timeout, the transmission will start.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] RS (RSSI) Command RS Command returns the signal level of the last packet received. This reading is useful for determining range characteristics of the XStream Modems under various conditions of noise and distance. Once the command is issued, the modem will AT Command: ATRS Binary Command: 0x1C (28 decimal) Parameter Range: 0x06 – 0x36 [Read-only] Number of bytes returned: 1 Minimum Firmware Version Required: 4.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] SL (Serial Number Low) Command Set/Read the serial number low word of the modem. AT Command: ATSH Binary Command: 0x26 (38 decimal) Parameter Range: 0 – 0xFFFF [Read-only] Number of bytes returned: 2 Related Commands: SH (Serial Number High) Minimum Firmware Version Required: 4.27C SM (Sleep Mode) Command SM Command is AT Command: ATSM used to adjust Sleep Mode settings.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] SY (Time before Initialization) Command SY Command keeps a communication channel open as long as modem transmits or receives before the active connection expires. It can be used to reduce latency in a query/response sequence and should be set 100 ms longer than the delay between transmissions. This command allows multiple XStream Modems to share a hopping channel for a given amount of time after receiving data.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] TT (Streaming Limit) Command TT Command defines a limit on the number of bytes that can be sent out before a random delay is issued. TT Command is used to simulate full-duplex behavior. If a modem is sending a continuous stream of RF data, a delay is inserted which stops its transmission and allows other modems time to transmit (once it sends number of bytes specified by TT Command).
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] 5. RF Communication Modes 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, Repeater, Acknowledged or Multi-Streaming) The following table provides a summary of the network configurations supported. Table 5‐01.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] 5.1. Addressing Each RF packet contains addressing information that is used to filter incoming RF data. Receiving modems 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. Filtration layers contained in the RF packet header 5.1.1.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] 5.2. Basic Communications Basic Communications are accomplished through two sub-types: • Broadcast - By default, XStream 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.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] 5.2.2. Repeater Mode Characteristics: Self-organizing - No route configuration is necessary Self-healing / Fault-tolerant Low power consumption and Minimized interference Network throughput is determined by number of hops, not by number of repeaters. Multiple repeaters within range of source node count as one hop. Supports “transparent” multi-drop mode or addressed data filtering mode.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] 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. The repeater network can be configured to operate using Basic Broadcast or Basic Addressed communications. The addressing capabilities of the modems allow integrators to send a packet as a global packet (DT = 0xFFFF) and shift out of every radio in the network (Basic Broadcast).
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] 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.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] 5.3. Acknowledged Communications 5.3.1. Acknowledged Mode Characteristics: 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. Recommended Use: Acknowledge Mode configuration is appropriate when reliable delivery is required between modems.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] After receiving and acknowledging a packet, the receiving modem will move to the next frequency and listen for either a retransmission or new data for a specific period of time. Even if the transmitting modem has indicated that it has no more pending transmit data, it may have not received the previous ACK, and so it may retransmit the packet (potentially with no delay after the ACK slot).
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] 5.3.2. Multi-Streaming Mode Characteristics: definition] Enables exclusive connections [refer to Theory of Operation section for Supports the passing of large data streams (> 256 bytes) from multiple remote modems to a base modem (If a complete data stream from a remote modem is less than 256 bytes, data can be sent from several remotes to a base location without enabling this mode and latencies will be much less.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] Initiating a Connection Connection Guidelines: • A remote modem can only request a connection with the base modem. • The base modem may hold off or grant a connection request to another modem. • A remote modem will not try to establish a connection if one already exists. • A connection fails if no response is received after RR (Retries) CRP packets. After a failure, whatever condition was causing a connection to be established is cleared.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] Configuration AT Command Mode AT command mode is used for all commands on base and remote modems. Binary command mode is not available when MD = 1 or 2. The base is in AT command mode when not engaged in an exclusive connection with a remote. No AT Command Mode sequence is needed. When a base modem is connected to a remote modem, the AT Command Mode sequence is used to enter AT command mode. The connection with the remote is maintained.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] Sleep Modes and Connections Cyclic sleep can be used with the remote modems to conserve power. ST “Time before Sleep” Parameter defines how long after a disconnect a remote will stay awake. A modem is not allowed to enter sleep mode when it is engaged in a connection. A modem will wake as defined by SM parameter and check for an RF message.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] Appendix A: Agency Certifications FCC Certification The XStream 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. To fulfill the FCC Certification requirements, the OEM must comply with the following FCC regulations: 1.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] OEM Labeling Requirements Label Warning WARNING The Original Equipment Manufacturer (OEM) must ensure that FCC labeling requirements are met. This includes a clearly visible label on the outside of the final product enclosure that displays the contents shown in the figure below. Figure A‐01.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] FCC Approved Antennas Table A‐01. Antennas approved for use with 9XStream (900 MHz) RF Modems. Manufacturer Part Number Type Gain Application Min. Separation Distance * * MaxStream * * MaxStream MaxStream MaxStream MaxStream * * MaxStream MaxStream MaxStream MaxStream * * A09-Y8 * * A09-Y11 (FCC pending) A09-F2 A09-F5 A09-F8 * * A09-M7 A09-H A09-HBMM-P5I A09-QBMM-P5I 6.2 dBi 7.2 dBi 8.2 dBi 9.2 dBi 10.2 dBi 11.2 dBi 2.2 dBi 5.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] European Compliance (2.4 GHz only) The 24XStream has been certified for use in several European countries. For a complete list, refer to http://www.maxstream.net. If the 24XStream modems are incorporated into a product, the manufacturer must ensure compliance of the final product to the European harmonized EMC and low-voltage/safety standards.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] Notifications and Required Information Since the 2.4 GHz band is not harmonized throughout Europe, a notification must be sent to each country prior to shipping product according to Article 6.4 of the R&TTE Directive. A list of national contacts for most European countries may be found at www.ero.dk/. The following technical data (relating to the 24XStream) is often required in filling out a notification form. • Frequency Band: 2400.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] Appendix B: Additional Information 1-Year Warranty XStream 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.
XStream‐PKG‐E™ Ethernet RF Modem – Product Manual v5.x00 [2006.02.24] Contact MaxStream Free and unlimited technical support is included with every MaxStream Radio Modem sold. Please use the following resources for additional support: Documentation: www.maxstream.net/support/downloads.php Technical Support: Phone. Live Chat. www.maxstream.net E-Mail. rf-xperts@maxstream.net (866) 765-9885 toll-free U.S. & Canada (801) 765-9885 Worldwide MaxStream office hours are 8:00 am – 5:00 pm [U.S.
