MaxStream XStream-PKG-E Product Manual

MaxStream XStream-PKG-E Product Manual

Ethernet rf modem
Hide thumbs Also See for XStream-PKG-E:

Advertisement

Quick Links

XStream-PKG-E™ Ethernet RF Modem
XStream Ethernet RF Modem
System Setup
RF Modem Operation
RF Modem Configuration
RF Communication Modes
Appendices
Product Manual
For XStream RF Modem Part Numbers
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.net
www.maxstream.net (live chat support)
v5.x00
X09-001PK...-E...
X09-009PK...-E...
X09-019PK...-E...
X24-009PK...-E...
X24-019PK...-E...
XH9-001PK...-E...
XH9-009PK...-E...
XH9-019PK...-E...
M100110
2006.02.24

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the XStream-PKG-E and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Summary of Contents for MaxStream XStream-PKG-E

  • Page 1 X09-001PK…-E… X24-009PK…-E... XH9-001PK…-E... X09-009PK…-E… X24-019PK…-E… XH9-009PK…-E… X09-019PK…-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.net M100110 www.maxstream.net (live chat support)
  • Page 2 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.net    © 2006 MaxStream, Inc. Confidential and Proprietary  ii ...
  • Page 3: Table Of Contents

    1-Year Warranty 55 2.2.1. Install Software 2.2.2. Setup Com Port and IP Address Ordering Information 55 2.2.3. Assign Static IP Address Contact MaxStream 56 2.2.4. Change Com Port Number 2.2.5. Test Communications (X-CTU) 2.3. Telnet Communications 12 2.3.1. Test Communications (Telnet) 3.
  • Page 4: Xstream Ethernet Rf Modem

    1.1.1. Worldwide Acceptance FCC Certified (USA) Refer to Appendix A for FCC Requirements. Systems that contain XStream RF Modems automatically inherit MaxStream Certifications. ISM (Industrial, Scientific & Medical) frequency band Manufactured under ISO 9001:2000 registered standards 9XStream-PKG-E (900 MHz) RF Modems approved for use in US, Canada, Australia, Israel (and more).
  • Page 5: Product Overview

    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].
  • Page 6: External Interface

    To enter Command Mode at the Modem’s default baud rate: 1‐02b. Antenna Port Simultaneously press the Reset [1-02a] and Config switches; release the Reset Switch; then after 1 sec., release the Config Switch. The RF Modem then enters AT Command Mode at the modem’s default baud rate.    © 2006 MaxStream, Inc. Confidential and Proprietary  6 ...
  • Page 7: System Setup

    2.1.1. System Description The PKG-E Ethernet RF Modem can be used as an access point in a network of MaxStream RS- 232/RS-485 RF Modems (or other OEM RF Module Embedded Devices). XStream RF Modems support point-to-point, peer-to-peer, point-to-multipoint and multidrop network topologies.
  • Page 8: Com Port Communications

    To Install the X-CTU Software: Double-click the “setup_X-CTU.exe” file then follow prompts of the installation screens. This file is located on the MaxStream CD and under the ‘Downloads’ section of the following web page: www.maxstream.net/support/. Installation #2: Ethernet Com Port Redirector MaxStream provides com port redirection software that creates a com port in the operating system that will forward serial data to the IP address of the Ethernet-connected RF modem.
  • Page 9: Setup Com Port And Ip Address

    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.
  • Page 10: Assign Static Ip Address

    Select the ‘OK’ button of the “Properties” dialog box. Select the ‘Apply’ button that is under the ‘Changes’ section of the “Ethernet Com Ports” sub- tab. XStream-PKG-E Ethernet RF Modem re-boots and the new IP Address is saved. Figure 2‐05. Properties & Change IP dialog boxes  2.2.4. Change Com Port Number During Com Port Redirector setup, one com port is automatically assigned.
  • Page 11: Test Communications (X-Ctu)

    Accessories (Loopback adapter, CAT5 UTP cable, power supplies and RPSMA antennas) Hardware Setup for Loopback Test: Connect the XStream-PKG-E (Ethernet) RF Modem and a PC to active Ethernet ports of the same local network using CAT5 cables (included w/ PKG-EA accessories package).
  • Page 12: Telnet Communications

    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): Follow steps in the “Ethernet RF Modem Discovery”...
  • Page 13: Rf Modem Operation

    RO time has been observed on the UART [refer to RO (Packetization Timeout) command]. The timeout can be disabled by setting RO to zero. In this case, transmission will begin after RB bytes have been received in the DI buffer.    © 2006 MaxStream, Inc. Confidential and Proprietary  13 ...
  • Page 14 UART after the transmission began. If more data is pending, the transmitting modem assembles a subsequent packet for transmission. RF Data Packet The RF packet is the sequence of data used for communicating information between MaxStream Modems. An RF Packet consists of an RF Initializer and RF Data. Figure 3‐03. RF Data Packet Components ...
  • Page 15: Receive Mode

    Idle Mode if PW the “Wake-up Initializer Timer” (set by LH Command). (Pin Wake-up) Command is issued. For more information about Sleep Modes, refer to the individual commands listed in “Related Commands” column of the table.    © 2006 MaxStream, Inc. Confidential and Proprietary  15 ...
  • Page 16 ST Command, at which point it resumes its low-power cyclic state. Note: The cyclic interval time defined by SM (Sleep Mode) Command must be shorter than the interval time defined by LH (Wake-up Initializer Timer). [Refer to figures below.]    © 2006 MaxStream, Inc. Confidential and Proprietary  16 ...
  • Page 17 Figure 3‐05. Correct Configuration (LH > SM)  Length of the wake‐up initializer exceeds the time interval of Cyclic Sleep. The receiver is guaranteed to detect  the wake‐up initializer and receive the accompanying payload data.                    Figure 3‐06. Incorrect Configuration (LH < SM)  Length of wake‐up initializer is shorter than the time interval of Cyclic Sleep. This configuration is vulnerable  to the receiver waking and missing the wake‐up initializer (and therefore also the accompanying payload data).         © 2006 MaxStream, Inc. Confidential and Proprietary  17 ...
  • Page 18: Command Mode

    If no valid AT Commands are received within the time specified by CT (Command Mode Timeout) Command, the Modem automatically returns to Idle Mode. For examples that step through the programming the modem using AT Commands, refer to the RF Modem Configuration [p20] chapter.    © 2006 MaxStream, Inc. Confidential and Proprietary  18 ...
  • Page 19 RT (DI2 Configuration) parameter must be set to one. If binary programming is not enabled (RT ≠ 1), the modem will not recognize that the CMD pin is asserted and therefore will not recognize the data as binary commands.    © 2006 MaxStream, Inc. Confidential and Proprietary  19 ...
  • Page 20: Rf Modem Configuration

    PC, use one of the connection options below to send can also be used to  commands to the XStream-PKG-E Ethernet RF Modem. program the modem. Option #1 – Local Network Connection Connect a PC and the Ethernet RF Modem to active Ethernet connections of the same local network [as shown in the figure below].
  • Page 21: At Command Examples

    Send Bytes [Parameter bytes must be 2 bytes long]: (Send DT (Destination Address) Command) (Least significant byte of parameter bytes) (Most significant byte of parameter bytes) (Send WR (Write) Command) De-assert CMD (Pin is driven low). (Exit Binary Command Mode)    © 2006 MaxStream, Inc. Confidential and Proprietary  21 ...
  • Page 22: Command Reference Table

    Transmit Error Count 0 – 0xFFFF Diagnostics TT v4.22* 0x1A (26d) Streaming Limit 0 – 0xFFFF [0 = disabled] Networking & Security 0xFFFF 0x14 (20d) Firmware Version 0 x 0xFFFF [read-only] Diagnostics 0x08 (8d) Write (Special) * Firmware version in which the command and parameter options were first supported.  NOTE: AT Commands issued without a  parameter value will return the currently  stored parameter.     © 2006 MaxStream, Inc. Confidential and Proprietary  22 ...
  • Page 23: Command Descriptions

    (refer to the table below). Reading the BD command will return the value that was actually stored to the BD register. Table 4‐02. Parameter Sent vs. Parameter Stored  BD Parameter Sent (HEX) Interface Data Rate (bps) BD Parameter Stored (HEX) 1200 19,200 115,200 1C200 115,200 1B207    © 2006 MaxStream, Inc. Confidential and Proprietary  23 ...
  • Page 24 Default Parameter Value: 0x2B (ASCII “+” sign) Sequence activates AT Command Mode. Number of bytes returned: 1 Related Commands: AT (Guard Time After), BT Refer to the AT Command Mode section to view (Guard Time Before) the default AT Command Mode Sequence.    © 2006 MaxStream, Inc. Confidential and Proprietary  24 ...
  • Page 25 “CONNECTXXXX” string is sent to the host of the Parameter Configuration base modem. “XXXX” is the MY (Source Address) enable of the connected remote modem. disable Default Parameter Value: 0 Number of bytes returned: 1 Minimum Firmware Version Required: 4.30    © 2006 MaxStream, Inc. Confidential and Proprietary  25 ...
  • Page 26 If MD = 1, the base MD (RF Mode) modem will force the disconnection of an Minimum Firmware Version Required: 4.30 exclusive connection. If MD = 2, the remote modem will send a “Disconnect Request Packet” to the base modem.    © 2006 MaxStream, Inc. Confidential and Proprietary  26 ...
  • Page 27 Once the “Receive Error Count” reaches its Related Commands: GD (Receive Good Count) maximum value (up to 0xFFFF), it remains at its maximum count value until the maximum count value is explicitly changed or the modem is reset.    © 2006 MaxStream, Inc. Confidential and Proprietary  27 ...
  • Page 28 Related Commands: DT (Destination Address), ID (Modem VID), MK (Address Mask) Different channels can be used to prevent modems in one network from listening to transmissions of another.    © 2006 MaxStream, Inc. Confidential and Proprietary  28 ...
  • Page 29 ID (Modem VID) Command <Networking> Read the modem’s VID. VID is a AT Command: ATID MaxStream-specific acronym that stands for Binary Command: 0x27 (39 decimal) “Vendor Identification Number”. This number is Parameter Range (user-settable):...
  • Page 30 HP (Hopping Channel), ID (Modem VID), MY port. If the “ANDed” value does not match either (Source Address) the Destination Address or the Address Mask of the receiver, the packet is discarded. (All “0” values are treated as “irrelevant” values and are ignored.)    © 2006 MaxStream, Inc. Confidential and Proprietary  30 ...
  • Page 31 Minimum Firmware Version Required: 4.30 Characters) parameter. RB must always be less than or equal to PK. If PK is changed to a value less than the current value of RB, RB is automatically lowered to be equal to PK.    © 2006 MaxStream, Inc. Confidential and Proprietary  31 ...
  • Page 32 If two modems attempted to transmit at the same time, the random time delay after packet failure would allow one of the two modems to transmit the packet successfully, while the other would wait until the channel opens up to begin transmission.    © 2006 MaxStream, Inc. Confidential and Proprietary  32 ...
  • Page 33 RN (Delay Slots) Command, the transmitter will transmit the original packet again. The packet will be transmitted repeatedly until an acknowledgement is received or until the packet has been sent RR times. Note: For retries to work correctly, all modems in the system must have retries enabled.    © 2006 MaxStream, Inc. Confidential and Proprietary  33 ...
  • Page 34 <Diagnostics> Set/Read the serial number high AT Command: ATSH word of the modem. Binary Command: 0x25 (37 decimal) Parameter Range: 0 – 0xFFFF [Read-only] Number of bytes returned: 2 Related Commands: SL (Serial Number Low) Minimum Firmware Version Required: 4.27C    © 2006 MaxStream, Inc. Confidential and Proprietary  34 ...
  • Page 35 This command can Related Commands: SM (Sleep Mode), LH only be used if Cyclic Sleep or Serial Port Sleep (Wake-up Initializer Timer), HT (Time before Mode settings have been selected using SM Wake-up Initializer) (Sleep Mode) Command.    © 2006 MaxStream, Inc. Confidential and Proprietary  35 ...
  • Page 36 Related Commands: RR (Retries) Minimum Firmware Version Required: 4.22 The TR Parameter is not non-volatile and will therefore be reset to zero each time the modem is reset.    © 2006 MaxStream, Inc. Confidential and Proprietary  36 ...
  • Page 37 (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.    © 2006 MaxStream, Inc. Confidential and Proprietary  37 ...
  • Page 38: Rf Communication Modes

    Acknowledged Mode [p44], Multi-Streaming Mode [p46] Peer-to-Peer Modems remain synchronized without use of a master/server. Each modem shares the roles of master and slave. MaxStream’s peer-to- Definition peer architecture features fast synch times (35ms to synchronize modems) and fast cold start times (50ms before transmission).
  • Page 39: Addressing

    “ANDed” with the Address Mask of the RX modem. Figure 5‐03. Address Recognition (Receiving Modem)  TX_DT = Transmitter Destination Address  RX_DT = Receiver Destination Address  RX_MY = Receiver Source Address  NOTE: For more information regarding addressing and masks, refer to Application Note ‘XST- AN004b’. (Located on the MaxStream CD and on the web: www.maxstream.net)    © 2006 MaxStream, Inc. Confidential and Proprietary  39 ...
  • Page 40: Basic Communications

    0 and (RN-1) if the local (i.e. receiving modem’s) RN parameter is set to a non-zero value. These delays are intended to lessen congestion following long bursts of packets from a single transmitting modem, during which several receiving modems may have become ready to transmit.    © 2006 MaxStream, Inc. Confidential and Proprietary  40 ...
  • Page 41: Repeater Mode

    When in Repeater Mode, the network repeats each message among all available nodes exactly one time. This mechanism eliminates the need for configuring specific routes. The network is self- organizing and self-healing so that the system is able to receive transmissions in the event of a modem going down. Figure 5‐05. Sample Repeater Network Topology     © 2006 MaxStream, Inc. Confidential and Proprietary  41 ...
  • Page 42 Where L is the length of the transmitted packet in milliseconds, DS is the number of delay slots to wait, RSSI is the received signal strength in dBm, RN is the value of the RN register and RandomInt(A,B) is a function that returns a random integer from A to B-0    © 2006 MaxStream, Inc. Confidential and Proprietary  42 ...
  • Page 43 32 byte packet in 12 ms for a round trip with UART transfer times of ~30ms or 33 polls per second (1066 bytes per second) with no repeaters. With two repeaters the time would be ~100ms round trip time for 10 polls per second or 320 bytes per second network throughput with two repeaters.    © 2006 MaxStream, Inc. Confidential and Proprietary  43 ...
  • Page 44: Acknowledged Communications

    Idle Mode and may receive RF data. This can h the effect of increasing the ba ck-off delay, as the radio cannot return to RF transmit (or retransmit) mode as long as it is receiving RF data.    © 2006 MaxStream, Inc. Confidential and Proprietary  44 ...
  • Page 45 0 and (RN-1), if the local RN parameter is set to a nonzero value. These delays are intended to lessen congestion following long bursts of packets from a single transmitting modem, during which several receiving modems may have themselves become ready to transmit.    © 2006 MaxStream, Inc. Confidential and Proprietary  45 ...
  • Page 46: Multi-Streaming Mode

    CGP (Connection Grant Packet) is broadcast to all remote modems in the network to communicate the base in engaged in an exclusive connection. Upon receipt of the CGP notification, remote modems will wait for a DGP (Disconnect Grant Packet) before attempting again to send data to the base modem.    © 2006 MaxStream, Inc. Confidential and Proprietary  46 ...
  • Page 47 DI3 line high. If no connection is active, the de-assertion is ignored. A remote will request a disconnect if DI3 is de-asserted and the remote is currently connected the base. Refer to DR (DI3 Configuration) Command. A remote or a base modem receives the ATDC (Disconnect) Command.    © 2006 MaxStream, Inc. Confidential and Proprietary  47 ...
  • Page 48 The CGP and DGP packets will be sent RR times to begin and end the global connection respectively. The connection can be terminated by CE, CB timers, DI3 or ATDC Command as any other connections.    © 2006 MaxStream, Inc. Confidential and Proprietary  48 ...
  • Page 49 (low) when there is no connection. A base modem can also be set to send the “CONNECT XXXX” string (where “XXXX” is the connecting modem’s MY (Source Address) parameter) anytime a connection is established. Refer to CM (Connection Message) Command.    © 2006 MaxStream, Inc. Confidential and Proprietary  49 ...
  • Page 50: Appendix A: Agency Certifications

    IMPORTANT: The 9XStream (900 MHz) and 24XStream (2.4 GHz) RF Modems have been certified by the FCC for use with other products without any further certification (as per FCC section 2.1091). Changes or modifications not expressly approved by MaxStream could void the user’s authority to operate the equipment.
  • Page 51: Oem Labeling Requirements

    This test is called the Specific Absorption Rate (SAR) testing and measures the emissions from the radio modem and how they affect the person. Over 100 additional antennas have been tested and are approved for use with MaxStream 900 MHz Radio Modems (including “Mag Mount”, “Dome”, “Multi-path” and “Panel” antennas).
  • Page 52: Fcc Approved Antennas

    Type Gain Application Min. Separation Distance Yagi 6.2 dBi Fixed/Mobile ** 20 cm Yagi 7.2 dBi Fixed/Mobile ** 20 cm MaxStream A09-Y8 Yagi 8.2 dBi Fixed/Mobile ** 20 cm Yagi 9.2 dBi Fixed/Mobile ** 20 cm Yagi 10.2 dBi Fixed/Mobile **...
  • Page 53: European Compliance (2.4 Ghz Only)

    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 54: Europe (2.4 Ghz) Approved Antenna List

    Channel Spacing: 400 kHz • ITU Classification: 400KF1D • Output Power: 100 mW EIRP • Notified Body Number: 0891 Contact MaxStream (801) 765-9885 if additional information is required. Europe (2.4 GHz) Approved Antenna List Table A‐03. Antennas approved for use with 24XStream (2.4 GHz) RF Modems in Europe  Minimum Separation Manufacturer Part Number Type...
  • Page 55: Appendix B: Additional Information

    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. For warranty service, return the defective product to MaxStream, shipping prepaid, for  prompt repair or replacement.  The foregoing sets forth the full extent of MaxStreamʹs warranties regarding the Product. Repair or  replacement at MaxStreamʹs option is the exclusive remedy. THIS WARRANTY IS GIVEN IN LIEU  OF ALL OTHER WARRANTIES, EXPRESS OR IMPLIED, AND MAXSTREAM SPECIFICALLY  DISCLAIMS ALL WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR  PURPOSE. IN NO EVENT SHALL MAXSTREAM, ITS SUPPLIERS OR LICENSORS BE LIABLE FOR  DAMAGES IN EXCESS OF THE PURCHASE PRICE OF THE PRODUCT, FOR ANY LOSS OF USE,  LOSS OF TIME, INCONVENIENCE, COMMERCIAL LOSS, LOST PROFITS OR SAVINGS, OR  OTHER INCIDENTAL, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE  OR INABILITY TO USE THE PRODUCT, TO THE FULL EXTENT SUCH MAY BE DISCLAIMED BY  LAW. SOME STATES DO NOT ALLOW THE EXCLUSION OR LIMITATION OF INCIDENTAL OR  CONSEQUENTIAL DAMAGES. THEREFOR, THE FOREGOING EXCLUSIONS MAY NOT APPLY  IN ALL CASES. This warranty provides specific legal rights. Other rights which vary from state to  state may also apply.  Ordering Information Figure B‐01.  MaxStream RF Modem Part Numbers Key       © 2006 MaxStream, Inc. Confidential and Proprietary  55 ...
  • Page 56: Contact Maxstream

    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. (866) 765-9885 toll-free U.S. & Canada (801) 765-9885 Worldwide Live Chat.

Table of Contents