XT09-PKI-EA Digi International/Maxstream, XT09-PKI-EA Datasheet

Page 1

... 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 ...

Page 2

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. Conditions:  ‐ Distributions of AES source code include the above copyright notice, this list of  conditions and disclaimer. ‐ Distributions in binary form include the above copyright notice, this list of con‐ ditions and disclaimer in the documentation and/or other associated materials. ‐ The copyright holderʹs name is not used to endorse products built using this  software without specific written permission. Alternatively, provided that this notice is retained in full, this product may be dis‐ tributed under the terms of the GNU General Public License (GPL), in which case  the provisions of the GPL apply INSTEAD OF those given above. Disclaimer ‐ This AES software is provided ʹas isʹ with no explicit or implied war‐ ranties in respect of its properties, including, but not limited to, correctness and/or  fitness for purpose. Technical Support:  © 2007 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved  Phone: (801) 765‐9885 Live Chat: www.maxstream.net E‐mail: rf‐xperts@maxstream.net      ii ...

Page 3

Contents 1. 9XTend Ethernet RF Modem 1.1. Key Features 4 1.1.1. Worldwide Acceptance 4 1.2. Specifications 5 1.3. External Interface 6 2. System Setup 2.1. Data Radio System Components 7 2.1.1. System Description 7 2.2. Com Port Communications 8 ...

Page 4

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 ...

Page 5

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 ...

Page 6

External Interface Figure 1‐01. Front View 1‐01d. RJ‐45 port 1‐01c. RSSI LEDs (all green) 1‐01b. I/O & Power LEDs 1‐01a. Power Switch * The Ethernet RF Modem does not sup‐ port Power‐over‐Ethernet (PoE). The  device cannot be powered directly from a  PoE port on a compatible hub. However, it may be useful to send power  on the unused wires of the CAT‐5 cable in  a situation where the radio will be  mounted in a location that optimizes radio  coverage, but may not have a power outlet  nearby. There are several third party  devices available that can inject the power  onto the cable and then remove it at the  remote side. Figure 1‐02. Back View 1‐02b. Reset Switch 1‐02a. Antenna Port © 2007 MaxStream, Inc., Confidential & Proprietary ‐ All Rights Reserved  1-01a. Power Switch Move Power Switch to ...

Page 7

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. ...

Page 8

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: ...

Page 9

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 ...

Page 10

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 ...

Page 11

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 ...

Page 12

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 ...

Page 13

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, ...

Page 14

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. The modem shifts into the other modes of operation under ...

Page 15

Channel initialization is the process of sending an RF initializer that synchronizes receiving modems with the transmitting modem. During channel initialization, incoming serial data accumu- lates in the DI buffer. RF data, which includes the payload data, follows the ...

Page 16

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 redun- dancy check) ...

Page 17

The SM (Sleep Mode) command is central to setting all Sleep Mode configurations. By default, Sleep Modes are disabled ( and the modem remains in Idle/Receive Mode. When in this state, the modem remains constantly ready to ...

Page 18

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 ...

Page 19

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] ...

Page 20

Programming Examples Refer to the ‘Command Mode’ section [p18] for information regarding entrance into Command Mode, sending AT com- mands and exiting Command Mode. 4.1.1. Configuration Setup Options After installing the X-CTU and Com Port Redirector Software ...

Page 21

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 ...

Page 22

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.) AT Binary AT Command Name Command Command %V 0x3B (59d) Board Voltage AM 0x40 (64d) Auto-set MY AP v2.x20* -- API Enable AT 0x05 (5d) Guard Time After BD 0x15 (21d) Interface ...

Page 23

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.) AT Binary AT Command Name Command Command PK 0x29 (41d) Maximum RF Packet Size PL 0x3A (58d) TX Power Level PW 0x1D (29d) Pin Wake-up RB 0x20 (32d) Packetization Threshold RC -- Ambient Power - Single ...

Page 24

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 ...

Page 25

BD (Interface Data Rate) Command <Serial Interfacing> 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 ...

Page 26

BT (Guard Time Before) Command <AT Command Mode Options> The CC command is used to set/read the ASCII character used between guard times of the AT Command Mode Sequence ( AT). This sequence enters the modem ...

Page 27

CN (Exit AT Command Mode) Command <Command Mode Options> The CN command is used to explicitly exit the modem from AT Com- mand Mode. CS (GPO1 Configuration) Command <Serial Interfacing> CS Command is used to select the behavior of ...

Page 28

DT (Destination Address) Command <Networking & Security> DT Command is used to set/read the networking address modem. The modems utilize three filtration lay- ers: Vendor ID Number (ATID), Channel (ATHP), and Destination Address (ATDT). The DT ...

Page 29

FL (Software Flow Control) Command <Serial Interfacing> 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 ...

Page 30

HP (Hopping Channel) Command <Networking & Security> The HP command is used to set/read the RF modem's hopping channel number. A channel is one of three layers of filtra- tion available to the modem. In order for modems to ...

Page 31

KY (AES Encryption Key) Command <Networking & Security> The KY command is used to set the 256-bit AES (Advanced Encryption Standard) key for encrypting/decrypting data. Once set, the key cannot be read out of the modem by any means. ...

Page 32

MK (Address Mask) Command <Networking & Security> The MK command is used to set/read the Address Mask of a modem. All RF data packets contain the Destination Address of the TX (transmitting) modem. When a packet is received, the ...

Page 33

NB (Parity) Command <Serial Interfacing> The NB command is used to select/read the parity settings of the RF modem for UART communications. PB (Polling Begin Address) Command <Networking & Security> PB command is used to set/read the modem’s Polling ...

Page 34

PK (Maximum RF Packet Size) Command <RF Interfacing> 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 ...

Page 35

RB (Packetization Threshold) Command <Serial Interfacing> The RB command is used to set/read the character threshold value. RF transmission begins after data is received in the DI Buffer and either of the following criteria is met: • RB characters ...

Page 36

RN (Delay Slots) Command <Networking & Security> The RN command is used to set/read the time delay that the transmit- ting RF modem inserts before attempting to resend a packet. If the transmitting modem fails to receive an acknowledgement ...

Page 37

RP (RSSI PWM Timer) Command <Diagnostics> 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 ...

Page 38

RT (GPI1 Configuration) Command <Serial Interfacing> 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. ...

Page 39

SM (Sleep Mode) Command <Sleep Mode (Low Power)> The SM Command is used to set/read the RF modem's Sleep Mode set- tings that configure the modem to run in states that require minimal power consumption. ST (Time before Sleep) ...

Page 40

TR (Transmit Error Count) Command <Diagnostics> The TR command is used to report the number of retransmit failures. This number is incremented each time a packet is not acknowl- edged within the number of retransmits specified by the RR ...

Page 41

WA (Active Warning Numbers) Command <Diagnostics> 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. Sample Output (indicates warnings 1 ...

Page 42

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 ...

Page 43

Data bytes that need to be escaped: • 0x7E – Frame Delimiter • 0x7D – Escape • 0x11 – XON • 0x13 – XOFF Example - Raw UART Data Frame (before escaping interfering bytes): 0x7E 0x00 0x02 0x23 0x11 ...

Page 44

TX (Transmit) Request: 16-bit address API Identifier Value: 0x01 A TX Request message will cause the modem to send RF Data Packet. Figure 4‐7. Start Delimiter 0x7E Frame ID (Byte 5) Identifies the UART data frame for ...

Page 45

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 ...

Page 46

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 parame- ter) and Destination Address (DT parameter) contained in each RF ...

Page 47

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 ...

Page 48

Multi-Transmit Mode Attributes: Required Parameter Values (TX modem): MT (Multi-Transmit) >= 1 Other Related Commands: Networking (DT, MK, MY, RN, TT), Serial Interfacing (BR, PK, RB, RO), RF Interfacing (FS) Recommended Use: Use for applications that require Reliable ...

Page 49

Repeater Mode Attributes: Constraints: Suggestions: Required Parameter Values (TX modem unique value (can be accom- plished by issuing the AM (Auto-set MY) and WR (Write) commands to all modems in the ...

Page 50

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 ...

Page 51

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 retrans- missions of the ...

Page 52

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), ...

Page 53

Acknowledged Communications 5.3.1. Acknowledged Mode Attributes: 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. If ...

Page 54

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 ...

Page 55

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), ...

Page 56

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 ...

Page 57

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 modem approved for Limited Modular use operating as a mobile ...

Page 58

Antenna Options (1-watt transmit power output or lower) Table A‐01. Half‐wave antennas (approved when operating at 1‐watt power output or lower) Part Number Type A09-HSM-7 Straight half-wave A09-HASM-675 Articulated half-wave A09-HABMM-P6I Articulated half-wave w/ 6" pigtail A09-HABMM-6-P6I Articulated half-wave w/ 6" pigtail A09-HBMM-P6I Straight half-wave w/ 6" pigtail A09-HRSM Right ...

Page 59

Table A‐04. Mag Mount antennas (approved when operating at 1‐watt power output or lower) Part Number Type A09-M0SM Mag Mount A09-M2SM Mag Mount A09-M3SM Mag Mount A09-M5SM Mag Mount A09-M7SM Mag Mount A09-M8SM Mag Mount A09-M0TM Mag Mount A09-M2TM Mag Mount A09-M3TM Mag Mount A09-M5TM Mag Mount A09-M7TM Mag Mount A09-M8TM ...

Page 60

Table A‐07. Yagi antennas (approved when operating at 100 mW power output or lower) Part Number A09-Y6 2 Element Yagi A09-Y7 3 Element Yagi A09-Y8 4 Element Yagi A09-Y9 4 Element Yagi A09-Y10 5 Element Yagi A09-Y11 6 Element Yagi A09-Y12 7 Element Yagi A09-Y13 9 Element Yagi A09-Y14 10 Element ...

Page 61

Appendix B: Additional Information 1-Year Warranty XTend RF Modems from MaxStream, Inc. (the "Product") are warranted against defects in materi- als and workmanship under normal use, for a period of 1-year from the date of purchase. In the event of a product ...

Page 62

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: Technical Support: MaxStream office hours are 8: ...