XT09-PKT-R Digi International/Maxstream, XT09-PKT-R Datasheet

Page 1

... RS-232/485 RF Modem Interfacing Protocol RF Modem Operation RF Modem Configuration RF Communication Modes Appendices Product Manual v2.x4x For RF Modem Part Numbers: XT09-PK...-R... 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 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. XTend™ is a trademark of MaxStream, Inc. 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 E‐mail: rf‐xperts@maxstream.net Live Chat: www.maxstream.net      ii ...

Page 3

Contents 1. 9XTend RS-232/485 RF Modem 1.1. Key Features 4 1.1.1. Worldwide Acceptance 4 1.2. Specifications 5 1.3. External Interface 6 2. Interfacing Protocol 2.1. RS-232 Operation 7 2.1.1. DIP Switch Settings and Pin Signals 7 2.1.2. Wiring Diagrams ...

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

Page 5

Specifications Out-of-box, the 9XTend RF Modem is configured to provide immediate long range wireless links between devices. The modem can be configured to support additional functionality through the use of standard AT and binary commands [Refer to the ...

Page 6

External Interface Figure 1‐01. Front View 1‐01c. DB‐9 Serial Port 1‐01d RSSI LEDs 1‐01b. I/O & Power LEDs 1‐01e. Power Connector 1‐01a. Config Switch  * Note: The XTend RF modem can accept  voltages as low as 5V.  Contact MaxStream Technical Support  (801) 765‐9885 to implement this option. Figure 1‐02. Back View 1‐02a. 1‐02b. DIP Switch Antenna Conector Figure 1‐03. DIP Switch Settings of the XTIB‐R (RS‐232/485) Interface Board © 2007 MaxStream, Inc. Chapter 1 ‐ 9XTend RS‐232/485 RF Modem 1-01a. Config (Configuration) Switch The Config Switch provides an alternate ...

Page 7

The 9XTend RS-232/485 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 and Pin Signals Figure 2‐01. RS‐232 DIP Switch Settings DIP Switch settings are read and applied  only while powering‐on. Table 2‐01. RS‐232 Signals and their implementations on the XTend RF Modem  (Low‐asserted signals are distinguished by horizontal line over pin name.) RS-232 ...

Page 8

Wiring Diagrams Figure 2‐03. RS‐232 DTE Device (male DB‐9 connector) wired to a DCE RF modem (female DB‐9)   Figure 2‐04. DCE RF modem (female DB‐9 connector) wired to an RS‐232 DCE Device (male DB‐9)   Sample Wireless Connection: DTE <--> DCE Figure 2‐05. Typical wireless link between DTE and DCE devices © 2007 MaxStream, Inc. Chapter 2 ‐ Interfacing Protocol DCE <--> DCE      8 ...

Page 9

RS-485 (2-wire) Operation 2.2.1. DIP Switch Settings and Pin Signals Figure 2‐06. RS‐485 (2‐wire) Half‐duplex DIP Switch Settings Figure 2‐08. RS‐485 (2‐wire) w/ Termination (optional) Termination is the 120 Ω resistor between T+ and T‐. DIP Switch settings are read and applied  only while powering‐on. Note: Refer to Figure 2-15 and Figure 2-16 for the RJ-45 connector pin designations used in RS-485/422 environments. Table 2‐02. RS‐485 (2‐wire half‐duplex) signals and their implementations on the XTend RF Modem ...

Page 10

RS-485 (4-wire) & RS-422 Operation 2.3.1. DIP Switch Settings and Pin Signals Figure 2‐10. RS‐485 (2‐wire) Half‐duplex DIP Switch Settings Figure 2‐12. RS‐485 (2‐wire) w/ 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. RS‐485/422 (4‐wire) Signals and their implementations on the XTend RF Modem DB-9 Pin 2.3.2. Wiring Diagrams Figure 2‐13. XTend RF Modem in an RS‐485 (4‐wire) environment ...

Page 11

Figure 2‐14. XTend RF Modem in an RS‐422 environment 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 ...

Page 12

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. RS-232 and RS-485/422 Data Flow ...

Page 13

Flow Control Figure 3‐02. Internal Data Flow Diagram (The five most commonly‐used pin signals shown) DI (Data In) Buffer and Flow Control When serial data enters the modem through the DI pin (Data In), the data is stored in the DI Buffer until it can be processed. When the ...

Page 14

Transparent Operation By default, XTend RF Modems operate in Transparent Mode. The modems act as a serial line replacement - all UART data received through the DI pin is queued up for RF transmission. When RF data is ...

Page 15

Modes of Operation XTend RF Modems operate in five modes. Figure 3‐03. 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 16

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 17

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 18

Sleep Mode Software Sleep Sleep Modes enable the modem to enter states of low-power consumption when not in use. Three software Sleep Modes are supported: • Pin Sleep (Host Controlled) • Serial Port Sleep (Wake on Serial Port ...

Page 19

Serial Port Sleep ( • Wake on serial port activity • Typical power-down current: < Serial Port Sleep is a Sleep Mode in which the modem runs in a low power state until serial data ...

Page 20

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 21

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 22

Automatic DIP Switch Configurations Each time the RF modem is powered-on, AT commands are sent to the on-board module as dic- tated by the positions of the DIP switches. DIP switch configurations are sent automatically during the power-on ...

Page 23

Programming Examples Refer to the ‘Command Mode’ section [p20] for information regarding entrance into Command Mode, sending AT commands and exiting Command Mode. 4.2.1. AT Commands MaxStream has provided X-CTU software for programming the modem using an extensive ...

Page 24

Restore RF Modem Default Parameters (Using the ‘Terminal’ tab of the X-CTU Software) Example: Both of the following examples restore the XTend Modem's factory defaults and save the parameters to non-volatile memory. Method 1 (One line per command) Note:  Do not send com‐ ...

Page 25

Command Reference Table Table 4‐03. 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 26

Table 4‐03. 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 PE v2.x20* 0x46 (70d) Polling End Address PK 0x29 (41d) Maximum RF Packet Size PL 0x3A (58d) TX Power Level PW 0x1D (29d) Pin Wake-up RB 0x20 (32d) Packetization ...

Page 27

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 28

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 29

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 30

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 31

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 32

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 33

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 34

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 35

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 36

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 37

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 38

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 39

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 40

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 41

RT (GPI1 Configuration) Command <Serial Interfacing> The RT command is used to set/read the behavior of the GPI1 pin (GPI1) of the OEM RF Module. The pin can be configured to enable binary programming or RTS flow control. SB ...

Page 42

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 43

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 44

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 45

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 46

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 47

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 48

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

Page 49

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 50

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 51

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 52

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 53

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 54

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 55

Polling Mode (Basic) NOTE: Polling Mode (Basic) and Polling Mode (Acknowledged) [p58] 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 56

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 57

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 58

Polling Mode (Acknowledged) NOTE: Polling Mode (Acknowledged) and Polling Mode (Basic) [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 (Acknowledged), ...

Page 59

Appendix A: Agency Certifications FCC (United States) Certification The XTend RS-232/485 RF Modem complies with Part 15 of the FCC rules and regulations. Compli- ance with the labeling requirements, FCC notices and antenna usage guidelines is required. In order to operate under MaxStream’s ...

Page 60

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 61

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 62

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 63

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 64

... 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. For testing the modem's range, MaxStream recommends the purchase of one RF Modem with the accessories and one without. Table  ...

Page 65

Adapters The development kit includes several adapters that facilitate 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 ...

Page 66

Male DB-9 to RJ-45 Adapter Part Number: JD2D2-CDN-A (Yellow) This adapter facilitates adapting the DB-9 Connector of the MaxStream Interface Board to a CAT5 cable (male DB9 to female RJ45). Refer to the ‘RS-485 (4-wire) & RS-422 Operation’ sections ...

Page 67

Appendix C: 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 failure ...

Page 68

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