A09-HSM-7 Digi International/Maxstream, A09-HSM-7 Datasheet

Page 1

OEM RF Module 9XTend OEM RF Module RF Module Operation RF Module Configuration RF Communication Modes Appendices Product Manual v2.x4x For OEM RF Module Part Numbers that begin with: XT09-R..., XT09-M... 1 Watt Transmit Power, 256-bit AES Encryption MaxStream ...

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 OEM RF Module 1.1. Key Features 4 1.1.1. Worldwide Acceptance 4 1.2. Specifications 5 1.3. Pin Signals 6 1.4. Electrical Characteristic 7 1.4.1. Timing Specifications 7 1.5. Mechanical Drawings Module Operation 2.1. Serial ...

Page 4

The 9XTend OEM RF Module was engineered to provide OEMs an easy-to-use RF solution that provides reliable delivery of critical data between remote devices. The module transfers a standard asynchronous serial data stream, operates within the ISM 900 MHz ...

Page 5

Specifications Table 1‐01. 9XTend‐PKG‐R OEM RF Module 9XTend 900 MHz OEM RF Module Specifications Performance Transmit Power Output (software selectable using PL command) Indoor/Urban Range Outdoor RF line-of-sight Range Interface Data Rate (software selectable using BD command) Throughput Data Rate (software selectable ...

Page 6

Pin Signals Figure 1‐01. XTend OEM RF Module Pin Numbers   Table 1‐03. Pin Signal Descriptions (Low‐asserted signals distinguished with a horizontal line over signal name.) Pin Mnemonic I/O Number 1 GND - 2 VCC I GPO2 / LED 4 TX_PWR SHDN I 8 GPI2 / ...

Page 7

Electrical Characteristic Figure 1‐02. System Block Diagram  Basic RF Link between Hosts The data flow sequence is initiated when the first byte of data is received in the DI Buffer of the transmitting module (XTend RF Module A). As long as XTend RF Module A ...

Page 8

Table 1‐05. DC Characteristics (Vcc = 2.8 ‐ 5.5 VDC) Symbol V V Figure 1‐04. Input Thresholds vs. Supply Voltage 1.5. Mechanical Drawings Figure 1‐05. Mechanical drawings of the XTend OEM RF Module (w/RPSMA Connector)  Figure 1‐06. Mechanical drawings of the XTend OEM RF Module (w/MMCX Connector)  © 2007 MaxStream, Inc. Parameter Output Low Voltage OL Output High Voltage OH Input thresholds vs. supply voltage 2.5 2 1.5 1 0.5 0 2.5 3.5 4.5 5.5 ...

Page 9

WARNING: When operating at 1 Watt power output, observe a minimum separation distance of 2' (0.6m) between modules. Transmitting in close proximity of other modules can damage module front ends. 2.1. Serial Communications The XTend OEM RF Modules interface ...

Page 10

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

Page 11

Transparent Operation By default, XTend RF Modules operate in Transparent Mode. The modules 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 12

Modes of Operation XTend RF Modules operate in six modes. Figure 2‐04. XTend RF Module Modes of Operation 2.2.1. Idle Mode When not receiving or transmitting data, the RF module is in Idle Mode. The module shifts into the other modes of operation under ...

Page 13

Channel initialization is the process of sending an RF initializer that synchronizes receiving mod- ules with the transmitting module. During channel initialization, incoming serial data accumulates in the DI buffer. RF data, which includes the payload data, follows the ...

Page 14

Receive Mode If a module detects RF data while operating in Idle Mode, the module transitions to Receive Mode to start receiving RF packets. Once a packet is received, the module checks the CRC (cyclic redun- dancy check) ...

Page 15

Sleep Mode Software Sleep Sleep Modes enable the module 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 16

Once in Pin Sleep, CTS (GPO1) is de-asserted (high), indicating that data should not be sent to the module. The PWR pin is also de-asserted (low) when the module is in Pin Sleep Mode. Note: The module will complete ...

Page 17

Command Mode To modify or read module parameters, the module 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 18

Binary Command Mode Sending and receiving parameter values using binary commands is the fastest way to change operating parameters of the module. Binary commands are used most often to sample signal strength [refer to DB (Received Signal Strength) parameter] ...

Page 19

Programming Examples Refer to the ‘Command Mode’ section [p17] for information regarding entrance into Command Mode, sending AT commands and exiting Command Mode. Refer to the ‘X-CTU’ section [p69] of the ‘Development Guide’ for more information regarding MaxStream’s ...

Page 20

Command Reference Table Table 3‐01. XTend Commands (The RF modules 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 21

Table 3‐01. XTend Commands (The RF modules 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 22

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 Modules expect numerical values in hexadecimal since the default value of ...

Page 23

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 module and host. This parameter determines the rate at which serial data ...

Page 24

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

Page 25

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

Page 26

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

Page 27

FL (Software Flow Control) Command <Serial Interfacing> The FL command is used to configure software flow control. Hardware flow control is implemented with the module as the GP01 pin (CTS pin of the OEM RF module), which regulates when ...

Page 28

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

Page 29

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 mod- ule by any ...

Page 30

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

Page 31

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

Page 32

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 module. The maximum packet size can be used along with the RB and ...

Page 33

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 34

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

Page 35

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 36

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 37

SM (Sleep Mode) Command <Sleep Mode (Low Power)> The SM Command is used to set/read the RF module's Sleep Mode set- tings that configure the module to run in states that require minimal power consumption. For more information regarding ...

Page 38

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 39

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 40

API Operation By default, XTend RF Modules act as a serial line replacement (Transparent Operation) - all UART data received through the DI pin is queued up for RF transmission. When the module receives an RF packet, the ...

Page 41

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 42

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

Page 43

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 44

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 45

Basic Communications Basic Communications are accomplished through two sub-types: • Broadcast - By default, XTend RF Modules communicate through Broadcast communications and within a peer-to-peer network topology. When any module transmits, all other modules within range will receive ...

Page 46

Multi-transmit Mode Attributes: Required Parameter Values (TX module): 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 47

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

Page 48

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 49

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 50

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

Acknowledged Communications 4.3.1. Acknowledged Mode Attributes: Required Parameter Values (TX module): 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 52

The TT parameter (streaming limit) specifies the maximum number of bytes that the TX module will send in one transmission event, which may consist of many packets and retries. If the TT parameter is reached, the TX module will ...

Page 53

Polling Mode (Acknowledged) NOTE: Polling Mode (Acknowledged) and Polling Mode (Basic) [p50] operate in the same way. The difference between the two modes is in their means of achieving reliable delivery of data. In Poll- ing Mode (Acknowledged), ...

Page 54

Appendix A: Agency Certifications FCC (United States) Certification The XTend OEM RF Module 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 ...

Page 55

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

Page 56

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

Page 57

... Table A‐06. Half‐wave antennas (approved when operating at 100 mW power output or lower) Part Number A09-QW Quarter-wave wire A09-QRAMM 3 " Quarter-wave wire A09-QSM-3 Quarter-wave straight A09-QSM-3H Heavy duty quarter-wave straight A09-QBMM-P6I Quarter-wave w/ 6" pigtail A09-QHRN Miniature Helical Right Angle solder A09-QHSN Miniature Helical Right Angle solder A09-QHSM-2 2" Straight A09-QHRSM-2 2" Right angle A09-QHRSM-170 1.7" ...

Page 58

... Element Yagi A09-Y15 13 Element Yagi A09-Y15 15 Element Yagi A09-Y6TM 2 Element Yagi A09-Y7TM 3 Element Yagi A09-Y8TM 4 Element Yagi A09-Y9TM 4 Element Yagi A09-Y10TM 5 Element Yagi A09-Y11TM 6 Element Yagi A09-Y12TM 7 Element Yagi A09-Y13TM 9 Element Yagi A09-Y14TM 10 Element Yagi A09-Y14TM 12 Element Yagi A09-Y15TM 13 Element Yagi ...

Page 59

... Contains documentation, software and tools needed for RF operation. 1 Familiarizes users with some of the module's most important functions. MD0016 Part Number XT09-SI XT09-MI A09-HASM-675 A09-HABMM-P5I XTIB-R JD2D3-CDS-6F JD2D3-CDL-A JD2D2-CDN-A JD3D3-CDN-A JE1D2-CDA-A JE1D3-CDA-A JP4P2-9V10-6F MD0010      59 ...

Page 60

XTIB-R RS-232/485 Interface Board Figure B‐01. Front View B‐01c. DB‐9 Serial Port B‐01d RSSI LEDs B‐01b. I/O & Power LEDs B‐01e. Power Connector B‐01a. Config Switch Figure B‐02. Back View B‐02a. DIP Switch Figure B‐03. DIP Switch Settings of the XTIB‐R (RS‐232/485) Interface Board © 2007 MaxStream, Inc. B-01a. Config (Configuration) Switch The Config Switch provides an alternate method for entering into Command Mode. ...

Page 61

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

Page 62

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 63

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 64

Interfacing Protocols The XTend Module Assembly (XTend OEM RF Module mounted to the XTIB-R Interface Board) sup- ports the following interfacing protocols: • RS-232 • RS-485 (2-wire) Half-Duplex • RS-485 (4-wire) and RS-422 RS-232 Operation DIP Switch Settings and ...

Page 65

Wiring Diagrams Figure B‐13.  DTE Device (RS‐232, male DB‐9 connector) wired to a DCE Module Assembly (female DB‐9)   Figure B‐14.  DCE Module Assembly (female DB‐9 connector) wired to a DCE Device (RS‐232, male DB‐9)   Sample Wireless Connection: DTE <--> DCE Figure B‐15.  Typical wireless link between DTE and DCE devices © 2007 MaxStream, Inc. Appendix B: Development Guide DCE <--> DCE      65 ...

Page 66

RS-485 (2-wire) Operation When operating within the RS-485 protocols, all communications are half-duplex. DIP Switch Settings and Serial Port Connections Figure B‐16. RS‐485 (2‐wire) Half‐duplex  DIP Switch Settings Figure B‐18. 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 Figures B-09 and B-10 for RJ-45 connector pin designations ...

Page 67

RS-485 (4-wire) & RS-422 Operation DIP Switch Settings and Serial Port Connections Figure B‐20. RS‐485 (4‐wire) & RS‐422  DIP Switch Settings Figure B‐22. RS‐485 (4‐wire)& RS‐422 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 Figures B-09 and B-10 for RJ-45 connector pin designations used in RS-485/422 environments. Table B‐06. RS‐485/422 (4‐wire) Signals and their implementations on the XTend Module Assembly DB-9 Pin ...

Page 68

Figure B‐24.  XTend Module Assembly 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 are ...

Page 69

X-CTU Software X-CTU is a MaxStream-provided software program used to interface with and configure Max- Stream RF Modules. The software application is organized into the following four tabs: • PC Settings tab - Setup PC serial ports for interfacing ...

Page 70

Appendix C: Additional Information 1-Year Warranty XTend RF Modules 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 71

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