MaxStream 9XTend User manual
9XTend™ OEM RF Module
9XTend OEM RF Module
Module Operation
Module Configuration
RF Communication Modes
Appendices
Product Manual v1.2.4
For MaxStream OEM RF Module part numbers that begin with: XT09-R…, XT09-M…
1 Watt Transmit Power, 256-bit AES Encryption
355 South 520 West, Suite 180
Lindon, UT 84042
Phone: (801) 765-9885
Fax: (801) 765-9895
M100115
2005.08.02
www.maxstream.net
9XTend™OEMRFModule–ProductManualv1.2.4
© 2005 MaxStream, Inc. All rights reserved
Nopartofthecontentsofthismanualmaybetransmittedor
reproducedinanyformorbyanymeanswithoutthewritten
permissionofMaxStream,Inc.
XTend™isatrademarkofMaxStream,Inc.
AESEncryptionSourceCode
©2005,DrBrianGladman,Worcester,UK.Allrightsreserved.
Conditions:
‐DistributionsofAESsourcecodeincludetheabovecopyrightnotice,
thislistofconditionsanddisclaimer.
‐Distributionsinbinaryformincludetheabovecopyrightnotice,this
listofconditionsanddisclaimerinthedocumentationand/orother
associatedmaterials.
‐Thecopyrightholderʹsnameisnotusedtoendorseproductsbuilt
usingthissoftwarewithoutspecificwrittenpermission.
Alternatively,providedthatthisnoticeisretainedinfull,thisproduct
maybedistributedunderthetermsoftheGNUGeneralPublicLicense
(GPL),inwhichcasetheprovisionsoftheGPLapplyINSTEADOF
thosegivenabove.
Disclaimer‐ThisAESsoftwareisprovidedʹasisʹwithnoexplicitor
impliedwarrantiesinrespectofitsproperties,including,butnot
limitedto,correctnessand/orfitnessforpurpose.
Technical Support:
Phone:(801)765‐9885
LiveChat:www.maxstream.net
©2005MaxStream,Inc.Confidential&Proprietaryii
9XTend™OEMRFModule–ProductManualv1.2.4
Contents
1. 9XTend™ OEM RF Module 4
1.1. Features 4
1.1.1. Worldwide Acceptance 4
1.2. Specifications 5
1.3. Pin Signals 6
1.4. Electrical Characteristics 7
1.4.1. Timing Specifications 7
1.5. Mechanical Drawings 8
2. Module Operation 9
2.1. Serial Communications 9
2.1.1. UART-Interfaced Data Flow 9
2.1.2. Serial Data 9
2.1.3. Flow Control 10
2.2. Modes of Operation 11
2.2.1. Idle Mode 11
2.2.2. Transmit Mode 11
2.2.3. Receive Mode 13
2.2.4. Shutdown Mode 13
2.2.5. Sleep Mode 14
2.2.6. Command Mode 15
3. Module Configuration 17
3.1. Hands-on Programming Examples 17
3.1.1. AT Command Example 17
3.1.2. Binary Command Example 17
3.2. Command Reference 18
3.3. Command Descriptions 19
4. RF Communication Modes 37
4.1. Addressing Options 37
4.2. Streaming Mode 38
4.2.1. Streaming Mode Connection Sequence 38
4.3. Acknowledged Mode 39
4.3.1. Acknowledged Mode Connection Sequence 39
4.4. Multi-Transmit Mode 41
4.4.1. Multi-Transmit Mode Connection Sequence 41
Appendix A: Agency Certifications 42
FCC Certification 42
Labeling Requirements 42
FCC Notices 42
FCC-Approved Antennas (900 MHz) 44
IC (Industry Canada) Certification 46
Appendix B: Development Guide 47
XTend Development Kit Contents 47
Interfacing Hardware 47
MaxStream RS-232/485 Interface Board 48
4.4.2. Adapters 50
4.4.3. Antennas 51
Interfacing Protocols 52
RS-232 Operation 52
RS-485 (2-wire) Operation 54
RS-485 (4-wire) & RS-422 Operation 55
X-CTU Software 57
Appendix C: Additional Information 58
1-Year Warranty 58
Ordering Information 58
Contact MaxStream 59
©2005MaxStream,Inc.Confidential&Proprietaryiii
9XTend™OEMRFModule–ProductManualv1.2.4
©2005MaxStream,Inc.Confidential&Proprietary4
1. 9XTend™OEMRFModule
The XTend OEM RF Module is MaxStream’s longest range drop-in
wireless solution. The module transfers a standard asynchronous serial
data stream between two or more modules and sustains throughput
data rates up to 115,200 bps.
1.1. Features
Long Range
1 Watt Power Output (1 mW – 1 W, selectable)
Range (@ 9600 baud):
•Indoor/Urban: up to 3000’ (900 m)
•Outdoor line-of-sight:
up to 14 miles (22 km) w/ dipole antenna
•Outdoor line-of-sight:
up to 40 miles (64 km) w/ high gain antenna
Range (@ 115200 baud):
•Indoor/Urban: up to 1500’ (450 m)
•Outdoor line-of-sight:
up to 7 miles (11 km) w/ dipole antenna
•Outdoor line-of-sight:
up to 20 miles (32 km) w/ high gain antenna
Receiver Sensitivity: -110 dBm (@ 9600 baud),
–100 dBm (@ 115200 baud)
Advanced Networking & Security
True Peer-to-Peer (no “master” required),
Point-to-Point, Point-to-Multipoint & Multidrop
Retries and Acknowledgements
10 hopping channels, each with over 65,000
network addresses available
FHSS (Frequency Hopping Spread Spectrum)
256-bit AES Encryption
(Refer to KY Command [p25])
1.1.1. Worldwide Acceptance
FCC Approved (USA) [Refer to Appendix A for FCC Requirements]
Systems that contain XTend Modules inherit MaxStream’s FCC Certification
IC Approved (Canada)
ISM (Industrial, Scientific & Medical) license-free 902-928 MHz frequency band
Manufactured under ISO 9001:2000 registered standards
Easy-to-Use
2.8 to 5.5 V power supply
Continuous RF data stream
up to 115.2 kbps
No configuration required
Advanced configurations available
through standard AT Commands
X-CTU Software for testing and
configuration
Transparent Operation
(Wireless links replace serial wires)
Portable
(small form-factor easily designed into a
wide range of data radio systems)
Software-selectable I/O interfacing rates
MODBUS, , , , (& more)
I/O Support
Support for multiple data formats
(parity, start and stop bits, etc.)
XII™ Interference Immunity
Power-saving Shutdown & Sleep Modes
(< 1µA)
Free & Unlimited Technical Support
9XTend™OEMRFModule–ProductManualv1.2.4
©2005MaxStream,Inc.Confidential&Proprietary5
1.2. Specifications
Table1.1. XTendOEMRFModule
XTend 900 MHz OEM RF Module Specifications
Performance
Transmit Power Output
(software selectable using PL command) 1 mW - 1 W
Indoor/Urban Range Up to 3000’ (900 m)
Outdoor
RF line-of-sight Range Up to 14 miles (22 km) w/ dipole antenna
Up to 40 miles (64 km) w/ high-gain antenna
Interface Data Rate
(software selectable using BD command) 1200 – 230400 bps
Throughput Data Rate
(software selectable using BR command) 9,600 bps 115,200 bps
RF Data Rate 10,000 bps 125,000 bps
Receiver Sensitivity -110 dBm -100 dBm
Power Requirements
Receive Current 80 mA
Shutdown Mode Power Down < 1 µA
Pin Sleep Power Down 147 µA
16 sec cyclic sleep (SM=8) 0.3 - 0.8 mA
8 sec cyclic sleep (SM=7) 0.4 - 1.4 mA
4 sec cyclic sleep (SM=6) 0.6 - 2.6 mA
2 sec cyclic sleep (SM=5) 0.9 - 4.8 mA
Idle
Currents
1 sec cyclic sleep (SM=4) 1.6 - 8.7 mA
General
Frequency 902-928 MHz
Spread Spectrum FHSS (Frequency Hopping Spread Spectrum)
Modulation FSK (Frequency Shift Keying)
Supported Network Topologies Peer-to-Peer (“Master/Slave” relationship not required), Point-to-Point, Point-to-Multipoint & Multidrop
Channel Capacity 10 hop sequences share 50 frequencies
Encryption 256-bit AES Encryption – Refer to the KY Command [p25] to implement
Physical Properties
Module Board Size 1.44” x 2.38” x 0.20” (3.65 cm x 6.05 cm x 0.51 cm)
Weight 0.64 oz (18 g)
Connector 20-pin
Operating Temperature -40 to 85º C (industrial)
Antenna
Connector Options RPSMA (Reverse-polarity SMA) or MMCX
Impedance 50 ohms unbalanced
Certifications (partial list)
FCC Part 15.247 OUR-9XTEND
Industry Canada (IC) 4214A-9XTEND
Table1.2. XTendOEMRFModuleSpecifications–Relativetouser‐selectedTXPowerOutput
Power Requirements (Supply voltage and TX currents relative to each TX Power Output option)
Transmit Power Output 1 mW 10 mW 100 mW 500 mW ** 1 W *
Supply Voltage 2.8 – 5.5 VDC 3.0 – 5.5 VDC 4.75 – 5.5 VDC
Transmit Current (5 V) typical 110 mA 140 mA 270 mA 500 mA 730 mA
Transmit Current (3.3 V) typical 90 mA 110 mA 260 mA 600 mA **
*Ifthesupplyvoltageforagivenpowersettingislowerthantheminimumsupplyvoltagerequirement(asshowninTable1.2),the
TXPowerOutputwilldecreasetothehighestpowerlevelsettinggiventhecurrentsupplyvoltage.
**1WPowerOutputisnotsupportedwhenusinga3.3supplyvoltage.
9XTend™OEMRFModule–ProductManualv1.2.4
©2005MaxStream,Inc.Confidential&Proprietary6
1.3. Pin Signals
Figure1.1. XTendOEMRFModulePinNumbers
Table1.3. PinSignalDescriptions
(Low‐assertedsignalsdistinguishedwithahorizontallineoversignalname.)
Pin
Number Mnemonic I/O High Impedance
during Shutdown Must
Connect Function
1 GND - - yes Ground
2 VCC I - yes Power: 2.8 – 5.5 VDC
General Purpose Output 2: <Default (CD=2)> Pin is driven low. Refer to the
CD Command [p21] for other configuration options.
3 GPO2 /
RX LED O yes -
RX LED: Pin is driven high during RF data reception; otherwise, the pin is
driven low. Refer to the CD Command [p21] to enable.
4 _PWR O yes - Transmit_Power: Pin pulses low during RF transmission; otherwise, the pin
is driven high to indicate power is on and the module is not in Sleep or
Shutdown Mode.
5 DI I yes yes
Data In: Serial data entering the module (from the UART host). Refer to the
Serial Communications [p9] section for more information.
6 DO O yes -
Data Out: Serial Data exiting the module (to the UART host). Refer to the
Serial Communications [p9] section for more information.
7 I no yes
Shutdown: Pin is driven high during operation and low during Shutdown.
Shutdown enables the lowest power mode (< 1 µA) available to the module.
Refer to the Shutdown Mode [p13] section for more information.
General Purpose Input 2: reserved for future use
8 GPI2 / SLEEP I yes - SLEEP: By default, SLEEP is not used. To configure this pin to enable Sleep
Modes, refer to the Sleep Mode [p14], SM Command [p32] & PW Command
[p28] sections.
General Purpose Output 1: reserved for future use
(Clear-to-Send): <Default (CS=0)> When pin is driven low, the UART
host is permitted to send serial data to the module. Refer to the Serial
Communications [p9] & CS Command [p21] sections for more information.
9 GPO1 / /
RS-485 TX EN O yes -
RS-485 Transmit Enable: To configure this pin to enable RS-485 half and
full duplex communications. Refer to the Serial Communications [p9] & CS
Command [p21] sections.
General Purpose Input 1: reserved for future use
(Request-to-Send): By default, is notused. To configure this pin to
regulate the flow of serial data exiting the module, refer to the Serial
Communications [p9] & RT Command [p31] sections.
10 GPI1 / /
CMD I yes -
CMD (Command): By default, CMD is not used. To configure this pin to
enable binary command programming, refer to the Binary Commands [p16]
& RT Command [p31] sections.
I* no -
Configuration:Pin can be used as a backup method for entering Command
Mode during power-up. Refer to the Command Mode [p15] section for more
information.
11 /
RSSI O* no -
Receive Signal Strength Indicator: By default, pin is used as an RSSI
PWM output after at the conclusion of the power-up sequence.Refer to the
RP Command [p30] for more information.
12-20 reserved / do not connect
*Modulehas10KΩinternalpull‐upresistor
Note: When integrating the XTend Module with a Host PC Board, all lines that are not used should be left disconnected (floating).
9XTend™OEMRFModule–ProductManualv1.2.4
©2005MaxStream,Inc.Confidential&Proprietary7
1.4. Electrical Characteristics
Figure1.2. SystemBlockDiagram
Basicwirelesslinkbetweenhosts
The data flow sequence is initiated when the first byte of data is received in the DI Buffer of the
transmitting module (XTend Module A). As long as XTend Module A is not already receiving RF
data, data in the DI Buffer is packetized then transmitted over-the-air to XTend Module B.
1.4.1. Timing Specifications
Figure1.3. TimingSpecifications(“A”and“B”refertoFigure1.2)
Table1.4. ACCharacteristics(SymbolscorrespondwithFigure1.2andFigure1.3,ATSYParameter=0)
Symbol Description Sleep Mode 115200 Baud Rate 9600 Baud Rate
SM = 0
(No sleep) 9.4 msec 94 msec
SM = 8 16 sec 16 sec
SM = 7 8 sec 8 sec
SM = 6 4 sec 4 sec
SM = 5 2 sec 2 sec
TTX Latency from the time data is
transmitted until it is received.
SM = 4 1 sec 1 sec
TTL Time that _PWR pin (pin 4) is
driven low -- 2.45 msec 29.6 msec
TRL Time that RX LED (pin 3)
is driven high -- 2.26 msec 27.2 msec
TCLDL Time starting when goes low
until the first bit appears on DOUT -- 44 µsec 75 µsec
TCHDH Time after last bit of data until
goes high -- 7 µsec 7 µsec
9XTend™OEMRFModule–ProductManualv1.2.4
©2005MaxStream,Inc.Confidential&Proprietary8
Table1.5. DCCharacteristics(Vcc=2.8–5.5VDC)
Symbol Parameter Condition
VOL Output Low Voltage VOL = 0.33V (IO = 6 mA)
VOH Output High Voltage VOH = VSUPPLY - 0.7V (-IO = 6 mA)
Figure1.4. InputThresholdsvs.SupplyVoltage
1.5. Mechanical Drawings
Input thresholds vs. supply voltage
0
0.5
1
1.5
2
2.5
2.5 3.5 4.5 5.5
Vcc
I/O Voltage
V(IL)
V(IH)
Figure1.5. XTendModuleMechanicalDrawings(withRPSMAantennaconnector)
Figure1.6. XTendModuleMechanicalDrawings(withMMCXantennaconnector)
9XTend™OEMRFModule–ProductManualv1.2.4
©2005MaxStream,Inc.Confidential&Proprietary9
2. ModuleOperation
WARNING: When operating at 1 Watt power output, observe a minimum separation distance of 2’ (0.6 m) between
modules. Transmitting in close proximity of other modules can damage module front ends.
2.1. Serial Communications
The XTend OEM RF Module interfaces to a host device through a TTL-level asynchronous serial
port. Through its serial port, the module can communicate with any UART voltage compatible
device or through a level translator to any RS-232/485/422 device.
2.1.1. UART-Interfaced Data Flow
Devices that have a UART interface can connect directly through the pins of the XTend Module as
is shown in the figure below.
Figure2.1. SystemDataFlowDiagraminaUART‐interfacedenvironment
(Low‐assertedsignalsdistinguishedwithhorizontallineoversignalname.)
2.1.2. Serial Data
Data enters the XTend Module through the DI pin (pin 5) as an asynchronous serial signal. The
signal should idle high when no data is being transmitted.
The UART performs tasks, such as timing and parity checking, that are needed for
communications. Serial communication consists of two UARTs configured with compatible
parameters (baud rate, parity, start bits, stop bits, data bits) to have successful communication.
Each data packet consists of a start bit (low), 8 data bits (least significant bit first) and a stop bit
(high). The following figure illustrates the serial bit pattern of data passing through the module.
Figure2.2. UARTdatapacket0x1F(decimalnumber“31”)astransmittedthroughtheXTendModule
ExampleDataFormatis8‐N‐1(bits–parity‐#ofstopbits)
9XTend™OEMRFModule–ProductManualv1.2.4
©2005MaxStream,Inc.Confidential&Proprietary10
2.1.3. Flow Control
Figure2.3. InternalDataFlowDiagram(Thefivemostcommonly‐usedpinsignalsshown.)
DI (Data In) Buffer and Flow Control
When serial data enters the XTend Module through the DI Pin (pin 5), the data is stored in the DI
Buffer until it can be transmitted.
When the RB and RO parameter thresholds are satisfied (refer to Transmit Mode section [p11] for
more information), the module attempts to initialize an RF connection. If the module is already
receiving RF data, the serial data is stored in the module’s DI Buffer. The DI buffer stores at least
2.1 KB. If the DI buffer becomes full, hardware or software flow control must be implemented in
order to prevent overflow (loss of data between the host and XTend Module).
How to eliminate the need for flow control:
1. Send messages that are smaller than the DI buffer size. The size of the DI buffer varies
according to the packet size (PK parameter) and the parity setting (NB parameter) used.
2. Interface at a lower baud rate (BD parameter) than the RF data rate (BR parameter).
Two cases in which the DI Buffer may become full and possibly overflow:
1. If the serial interface data rate is set higher than the RF data rate of the module, the module
will receive data from the host faster than it can transmit the data over-the-air.
2. If the module is receiving a continuous stream of RF data or if the module is monitoring data
on a network, any serial data that arrives on the DI pin (pin 5) is placed in the DI Buffer. The
data in the DI buffer will be transmitted over-the-air when the module no longer detects RF
data in the network.
Hardware Flow Control ( ). When the DI buffer is 17 bytes away from being full; by
default, the module de-asserts (high) to signal to the host device to stop sending data [refer
to FT (Flow Control Threshold, p24) and CS (GPO1 Configuration, p21) Commands.]. is re-
asserted after the DI Buffer has 34 bytes of memory available.
Software Flow Control (XON). XON/XOFF software flow control can be enabled using the FL
(Software Flow Control) Command [p23]. This option only works with ASCII data.
DO (Data Out) Buffer & Flow Control
When RF data is received, the data enters the DO buffer and is sent out the serial port to a host
device. Once the DO Buffer reaches capacity, any additional incoming RF data is lost. The DO
buffer stores at least 2.1 KB.
Two cases in which the DO Buffer may become full and possibly overflow:
1. If the RF data rate is set higher than the interface data rate of the module, the module will
receive data from the transmitting module faster than it can send the data to the host.
2. If the host does not allow the module to transmit data out from the DO buffer because of
being held off by hardware or software flow control.
Hardware Flow Control ( ). If is enabled for flow control (RT Parameter = 2, p31), data
will not be sent out the DO Buffer as long as (pin 10) is de-asserted.
Software Flow Control (XOFF). XON/XOFF software flow control can be enabled using the FL
(Software Flow Control) Command [p23]. This option only works with ASCII data.
9XTend™OEMRFModule–ProductManualv1.2.4
©2005MaxStream,Inc.Confidential&Proprietary11
2.2. Modes of Operation
XTend OEM RF Modules operate in six modes.
Figure2.4. XTendModesofOperation
Modulecanonlybeinonemodeatatime.
2.2.1. Idle Mode
When not receiving or transmitting data, the module is in Idle Mode. The module uses the same
amount of power in Idle Mode as it does in Receive Mode.
The module shifts into the other modes of operation under the following conditions:
•Serial data is received in the DI Buffer (Transmit Mode)
•Valid RF data is received through the antenna (Receive Mode)
•Command Mode Sequence is issued (Command Mode)
•Sleep Mode condition is met (Sleep Mode)
•Shutdown condition is met (Shutdown Mode)
The module automatically transitions back to Idle Mode after responding to these conditions.
2.2.2. Transmit Mode
When the first byte of serial data is received from the UART in the DI buffer, the module attempts
to shift to Transmit Mode and initiate an RF connection with other modules. After transmission is
complete, the module returns to Idle Mode.
RF transmission begins after either of the following criteria is met:
1. RB bytes have been received by the UART and are pending for RF transmission.
[Refer to the RB (Packetization Threshold) Command, p28]
2. At least one character has been received by the UART and is pending for RF transmission;
and RO character times of silence been observed on the UART.
[Refer to the RO (Packetization Timeout) Command, p29]
Figure2.5. TransmitModeDataFlow
ter timeout trigThe charac ger can
1
be disabled by setting RO to zero.
In this case, transmission will not
begin until RB bytes have been
received and are pending for RF
transmission. The RB parameter
may be set to any value between
and the RF packet size (PK (Max RF
Packet Size, p27), inclusive. Note
that transition to Transmit Mode
cannot take place during RF
reception; the RF reception must
complete before the radio can
transition into Transmit Mode.
9XTend™OEMRFModule–ProductManualv1.2.4
©2005MaxStream,Inc.Confidential&Proprietary12
If RB or RO conditions are met, the module initializes a communications channel. Serial data in
the DI buffer is grouped into RF packets (up to 2048 bytes in each packet, refer to PK
Command), converted to RF data and is transmitted over-the-air until the DI buffer is empty.
Channel initialization is the process of sending an RF initializer that synchronizes receiving
modules with the transmitting module. During channel initialization, incoming serial data
accumulates in the DI buffer.
RF data, which includes the payload data, follows the RF initializer. The payload includes up to
the maximum packet size (PK Command) bytes. As the TX module nears the end of the
transmission, it inspects the DI buffer to see if more data exists to be transmitted. This could be
the case if more than PK bytes were originally pending in the DI buffer or if more bytes arrived
from the UART after the transmission began. If more data is pending, the transmitting module
assembles a subsequent packet for transmission.
Refer to the RF Communication Modes [p37] section to view state diagrams that illustrate
channel initialization and the sequence of events that follow.
RF Packet
Figure2.6. RFPacketComponents
* When streaming multiple RF packets, the RF Initializer is only sent in front of the first packet.
RF Initializer
An RF initializer is sent each time a new connection sequence begins. The RF initializer contains
channel information that notifies receiving modules of information such as the hopping pattern
used by the transmitting module. The first transmission always sends an RF initializer.
An RF initializer can be of various lengths depending on the amount of time determined to be
required to prepare a receiving module. For example, a wake-up initializer is a type of RF
initializer used to wake remote modules from Sleep Mode (Refer to the FH, LH, HT and SM
Commands for more information). The length of the wake-up initializer should be longer than the
length of time remote modules are in cyclic sleep.
Header
The header contains network addressing information that filters incoming RF data. The receiving
module checks for matching a Hopping Channel, VID and Destination Address. Data that does not
pass through all three network filter layers is discarded.
Figure2.7. NetworkLayersContainedintheHeader
9XTend™OEMRFModule–ProductManualv1.2.4
©2005MaxStream,Inc.Confidential&Proprietary13
CRC (Cyclic Redundancy Check)
To verify data integrity and provide built-in error checking, a 16-bit CRC (Cyclic Redundancy
Check) is computed for the transmitted data and attached to the end of each RF packet. On the
receiving end, the receiving module computes the CRC on all incoming RF data. Received data
that has an invalid CRC is discarded [See Receive Mode section, next page].
2.2.3. Receive Mode
If a module detects RF data while operating in Idle Mode, the module transitions into Receive
Mode to start receiving RF packets. Once a packet is received, the module 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. If the CRC is valid, the packet proceeds
to the DO Buffer.
Figure2.8. ReceiveModeDataFlow
*RefertotheAddressingOptions[p37]sectionof
theRFCommunicationOptionssectionformore
informationaboutaddressrecognition.
The module returns to Idle Mode when valid
RF data is no longer detected or after an
error is detected in the received RF data. If
serial data is stored in the DI buffer while
the module is in Receive Mode, the serial
data will be transmitted after the module is
finished receiving data and returns to Idle
Mode.
2.2.4. Shutdown Mode
Hardware Sleep
For applications where power consumption must be kept to a minimum during idle periods,
Shutdown Mode offers the lowest power mode available to the module.
When the pin (pin 7) is driven low, the module is forced into shutdown mode. Any
communication in progress (transmit or receive) will be halted and any buffered data will be lost.
For any other mode of operation, must be driven or pulled high. While in shutdown mode,
the module’s VCC pin draws less than 1 µA.
Immediately after the pin changes state from low to high, the module resets. After reset,
there is a delay that must be observed. See reset section for the delay time.
While pin is driven low, the following pins are set to high impedance by the module: DCD,
TX_PWR, RX LED, DO and (See pin signal descriptions, p6). The line (also used for
RSSI indication) is driven low during shutdown.
The following input pins may continue to be driven by external circuitry when in shutdown mode:
PIN_PWR_DWN, , DI and .
Note: Because the DO pin also goes high impedance, if the XTend Module is connected to a
processor, the UART receive pin could be floating. A weak pull-up should be placed between the
module and the microcontroller so that data isn’t interpreted as being transmitted to the
microprocessor.
9XTend™OEMRFModule–ProductManualv1.2.4
©2005MaxStream,Inc.Confidential&Proprietary14
2.2.5. Sleep Mode
Software Sleep
Sleep Modes enable the XTend Module to operate at minimal power consumption when not in
use. Three Sleep Mode options are available:
•Pin Sleep (Host Controlled)
•Serial Port Sleep (Wake on Serial Port activity)
•Cyclic Sleep (Wake on RF activity)
For the module to transition into Sleep Mode, the module must have a non-zero SM (Sleep Mode)
Parameter and one of the following must occur:
1. The module is idle (no data transmission or reception) for a user-defined period of time [See
ST (Time before Sleep) Command, p34].
2. SLEEP pin (pin 8) is asserted (only for Pin Sleep option).
In Sleep Mode, the module will not transmit or receive data until the module first transitions to
Idle Mode. All Sleep Modes are enabled and disabled using SM Command. Transitions into and
out of Sleep Modes are triggered by various mechanisms as shown in the table below.
Table2.1. SummaryofSleepModeConfigurations
Sleep Mode
Setting Transition into
Sleep Mode Transition out of
Sleep Mode Related
Commands Typical Power
Consumption
Pin Sleep
(SM = 1)
A microcontroller can shut down and
wake modules by asserting (high)
SLEEP pin (pin 8).
Note: The module will complete a
transmission or reception before
activating Pin Sleep.
De-assert (low)
SLEEP pin (pin 8). SM 147 µA
Serial Port Sleep
(SM = 2)
Automatic transition to Sleep Mode
occurs after a user-defined period of
inactivity (no transmitting or receiving of
data). The period of activity is defined
using the ST (Time before Sleep)
Command.
When serial byte is
received on the DI pin
(pin 5). SM, ST 10 mA
Cyclic Sleep
(SM = 4-8)
Automatic transition to Sleep Mode
occurs in cycles as defined by the SM
(Sleep Mode) Command.
Note: The cyclic sleep time interval must
be shorter than the “Wake-up Initializer
Timer” (set by LH Command).
After the cyclic sleep time
interval elapses.
Note: Module can be
forced into Idle Mode if
PW (Pin Wake-up)
Command is issued.
HT, LH, PW,
SM, ST
1.6 mA
(when sleeping,
SM=4, 1 sec,
@120,000 baud)
FormoreinformationaboutSleepModes,refertotheindividualcommandslistedin“RelatedCommands”
columnofthetable.SMCommandisthebeststartingpointforimplementingSleepModeconfigurations.
Refer to the Hardware Sleep entry of the Shutdown Mode section [previous page] to enable the
module’s lowest power-consuming state (1 µA power down current).
9XTend™OEMRFModule–ProductManualv1.2.4
©2005MaxStream,Inc.Confidential&Proprietary15
2.2.6. Command Mode
To set or read module parameters, the module must first enter “Command Mode” (state in which
incoming characters are interpreted as commands). Two command types are available for use:
•AT Commands
•Binary Commands
For modified parameter values to persist in the module registry, changes must be saved to non-
volatile memory using WR (Write) Command. Otherwise, parameters are restored to previously
saved values when the module is powered off and then on again.
AT Command Mode
To Enter AT Command Mode:
1. Send the 3-character command sequence “+++” and observe guard times before and after
the command characters. [See “Default AT Command Mode Sequence” below.] The
“Terminal” tab (or other serial communications software) of the X-CTU Software can be used
to enter the sequence.
[OR]
2. Assert (low) the pin and turn the power going to the module off and back on (or
pulse the pin).
[If the module is mounted to a MaxStream XTIB-R Interface Board, press the configuration
switch down for 2 seconds.]
Default AT Command Mode Sequence (for transition to AT Command Mode):
•No characters sent for one second [refer to the BT (Guard Time Before) Command]
•Input three plus characters (“+++”) within one second
[refer to the CC (Command Sequence Character) Command.]
•No characters sent for one second [refer to the AT (Guard Time After) Command.]
To Send AT Commands:
Send AT commands and parameters using the syntax shown below:
Figure2.9. SyntaxforsendingATCommands
NOTE: To read a parameter value stored in a register, leave the parameter field blank.
The preceding example would change the module Destination Address to “1F”. To store the new
value to non-volatile (long term) memory, subsequently send the Write (ATWR) Command before
powering off the module.
To Exit AT Command Mode:
1. Send ATCN (Exit Command Mode) Command.
[OR]
2. If no valid AT Commands are received within the time specified by CT (Command Mode
Timeout) Command, the Module automatically returns to Idle Mode.
For an example that illustrates programming the module using AT Commands, refer to the
“Module Configuration” chapter [p17].
9XTend™OEMRFModule–ProductManualv1.2.4
©2005MaxStream,Inc.Confidential&Proprietary16
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 (DB parameter) and/or error counts; or to change module addresses and channels for
polling systems when a quick response is necessary. Since the sending and receiving of
parameter values takes place through the same serial data path as 'live' data (received RF
payload), interference between the two types of data can be a concern.
Common questions about using binary commands:
•What are the implications of asserting CMD while live data is being sent or received?
•After sending serial data, is there a minimum time delay before CMD can be asserted?
•Is a time delay required after CMD is de-asserted before payload data can be sent?
•How does one discern between live data and data received in response to a command?
The CMD pin [pin 10] must be asserted in order to send binary commands to the module. The
CMD pin can be asserted to recognize binary commands anytime during the transmission or
reception of data. The status of the CMD signal is only checked at the end of the stop bit as the
byte is shifted into the serial port. The application does not allow control over when data is
received, except by waiting for dead time between bursts of communication.
If the command is sent in the middle of a stream of payload data to be transmitted, the
command will essentially be executed in the order it is received. If the module is continuously
receiving data, the radio will wait for a break in the received data before executing the command.
The signal will frame the response coming from the binary command request [Figure 2.10]
A minimum time delay of 100 µs (after the stop bit of the command byte has been sent) must be
observed before the CMD pin can be de-asserted. The command executes after all parameters
associated with the command have been sent. If all parameters are not received within 0.5
seconds, the modem returns to Idle Mode.
Note: When parameters are sent, they are two bytes long with the least significant byte sent first.
Binary commands that return one parameter byte must be written with two parameter bytes.
Refer to p17 for a binary programming example (DT command example returns two bytes).
Commands can be queried for their current value by sending the command logically ORed (bit-
wise) with the value 0x80 (hexadecimal) with CMD asserted. When the binary value is sent (with
no parameters), the current value of the command parameter is sent back through the DO pin.
Figure2.10. BinaryCommandWritethenRead
Signal#4isCMD(pin10)
Signal#1istheDIN(pin5)sig
Signal#2isthe
nal
DOUT(pin6)
signalfromtheradio
Signal#3is(pin9)
In this graph, a value was written to a register
and then read out to verify it. While not in the
middle of other received data, note that the
signal outlines the data response out of
module.the
IMPORTANT: In order for the XTend Module to recognize a binary command, the RT (GPI1
Configuration) parameter must be set to one. If binary programming is not
enabled (RT ≠1), the module will not recognize that the CMD pin (Pin 10) is
asserted and therefore will not recognize the data as binary commands.
9XTend™OEMRFModule–ProductManualv1.2.4
©2005MaxStream,Inc.Confidential&Proprietary17
3. ModuleConfiguration
3.1. Hands-on Programming Examples
For information about entering and exiting AT and Binary Command Modes, refer to the
Command Mode section [p15].
3.1.1. AT Command Example
To Send AT Commands (Using the Terminal tab of MaxStream’s X-CTU Software)
Example: Both of the following examples change the module’s destination address to 0x1A0D and
save the new address to non-volatile memory. <CR> stands for “Carriage Return”.
Method 1 (One line per command)
Send AT Command System Response
+++ OK <CR> (Enter into Command Mode)
ATDT <Enter> current destination address <CR>
ATDT1A0D <Enter> OK <CR> (Change destination address)
ATWR<Enter> OK<CR>(Write to non-volatile memory)
ATCN <Enter> OK <CR> (Exit AT Command Mode)
Method 2 (Multiple commands on one line)
Send AT Command System Response
+++ OK <CR> (Enter into Command Mode)
ATDT <Enter> current destination address <CR>
ATDT1A0D,WR <Enter> OK <CR> (Execute commands)
ATCN<Enter> OK(ExitATCommandMode)
Note: When using X-CTU Software to program a module, PC com port settings must match the baud
(interface data rate), parity & stop bits parameter values of the module. Use the ‘Com Port Setup’
section of the “PC Settings” tab to configure PC com port settings to match those of the module.
3.1.2. Binary Command Example
To Send Binary Commands:
Example: Use binary commands to change the XTend Module’s destination address to 0x1A0D
and save the new address to non-volatile memory.
1. RT Command must be set to ‘1’ in AT Command Mode to enable binary programming.
2. Assert CMD (Pin 10 is driven high). (Enter Binary Command Mode)
3. Send Bytes [parameter bytes must be 2 bytes long]:
00 (Send DT (Destination Address) Command)
0D (Least significant byte of parameter bytes)
1A (Most significant byte of parameter bytes)
08 (Send WR (Write) Command)
4. De-assert CMD (Pin 10 is driven low) (Exit Binary Command Mode)
Note: (pin 9) is high when command is being executed. Hardware flow control must be disabled
as will hold off parameter bytes.
Note:Donotsend
commandstothemodule
duringflashprogramming
(whenparametersare
beingwrittentothe
moduleregistry).
WaitfortheʺOKʺsystem
responsethatfollowsthe
ATWRcommandbefore
enteringthenextcommand
oruseflowcontrol.
9XTend™OEMRFModule–ProductManualv1.2.4
©2005MaxStream,Inc.Confidential&Proprietary18
3.2. Command Reference
Table3.1. XTendCommands(“d”denotesdecimalequivalent)
AT
Command Binary
Command AT Command Name Parameter Range Command
Category # Bytes
Returned Factory
Default
%V 0x3B (59d) Board Voltage 0x2CCCA – 0x5BFFA [read-only] Diagnostics 4 -
AM 0x40 (64d) Auto-set MY - Networking & Security - -
AT 0x05 (5d) Guard Time After 2 - (ATST-3) [x 100 msec] Command Mode Options 2 0x0A (10d)
BD 0x15 (21d) Baud Rate (Interface Data Rate) 0 - 8 Serial Interfacing 1 3
BR 0x39 (57d) RF Data Rate 0 - 1 RF Interfacing 1 1
BT 0x04 (4d) Guard Time Before 0 – 0xFFFF [x 100 msec] Command Mode Options 2 0x0A (10d)
CC 0x13 (19d) Command Sequence Character 0x20 - 0x7F Command Mode Options 1 0x2B [“+”] (43d)
CD 0x28 (40d) GPO2 Configuration 0 - 2 Serial Interfacing 1 2
CF - Number Base 0 - 2 Command Mode Options 1 1
CN 0x09 (9d) Exit Command Mode - Command Mode Options - -
CS 0x1F (31d) GPO1 Configuration 0 - 4 Serial Interfacing 1 0
CT 0x06 (6d) Command Mode Timeout 2 – 0xFFFF [x 100 ms] Command Mode Options 2 0xC8 (200d)
DB 0x36 (54d) Received Signal Strength 0x6E to 0x28 [read-only] Diagnostics 2 -
DT 0x00 (0d) Destination Address 0 - 0xFFFF Networking & Security 2 0
E0 0x0A (10d) Echo Off - Command Mode Options - -
E1 0x0B (11d) Echo On - Command Mode Options - -
ER 0x0F (15d) Receive Error Count 0 – 0xFFFF Diagnostics 2 0
FH 0x0D (13d) Force Wake-up Initializer - Sleep (Low Power) - -
FL 0x07 (7d) Software Flow Control 0 - 1 Serial Interfacing 1 0
FS 0x3E (62d) Forced Sync Time 1 – 0xFFFF [x 10 msec] RF Interfacing 2 0
FT 0x24 (36d) Flow Control Threshold 0 – DI Buffer size (bytes) Serial Interfacing 2 varies
GD 0x10 (16d) Receive Good Count 0 – 0xFFFF Diagnostics 2 0
HP 0x11 (17d) Hopping Channel 0 - 9 Networking & Security 1 0
HT 0x03 (3d) Time before Wake-up Initializer 0 – 0xFFFF [x 100 msec] Sleep (Low Power) 2 0xFFFF (65535d)
HV - Hardware Version 0 – 0xFFFF [read-only] Diagnostics 2 -
ID 0x27 (39d) Modem VID 0 - 0x7FFF (user-settable)
0x8000 - 0xFFFF (factory-set) Networking & Security 2 0x3332 (13106d)
KY 0x3C (60d) AES Encryption Key 0 – (Any other 64-digit hex valid key) Networking & Security 2 0
LH 0x0C (12d) Wake-up Initializer Timer 0 – 0xFF [x 100 msec] Sleep (Low Power) 1 1
MK 0x12 (18d) Address Mask 0 - 0xFFFF Networking & Security 2 0xFFFF (65535d)
MT 0x3D (61d) Multi-Transmit 0 – 0xFF Networking & Security 1 0
MY 0x2A (42d) Source Address 0 - 0xFFFF Networking & Security 2 0xFFFF (65535d)
NB 0x23 (35d) Parity 0 - 4 Serial Interfacing 1 0
PK 0x29 (41d) Maximum RF Packet Size 1 – 0x800 [Bytes] RF Interfacing 2 0x800 (2048d)
PL 0x3A (58d) TX Power Level 0 - 4 RF Interfacing 1 4 [1 Watt]
PW 0x1D (29d) Pin Wake-up 0 - 1 Sleep (Low Power) 1 0
RB 0x20 (32d) Packetization Threshold 1 - Current value of PK Serial Interfacing 2 0x800 (2048d)
RC - Ambient Power - Single Channel 0 – 0x31 [dBm, read-only] Diagnostics 1 -
RE 0x0E (14d) Restore Defaults - (Special) - -
RM - Ambient Power - All Channels No parameter – 0x7D0 Diagnostics 2 -
RN 0x19 (25d) Delay Slots 0 – 0xFF (slots) Networking & Security 1 0
RO 0x21 (33d) Packetization Timeout 0 – 0xFFFF [x UART character time] Serial Interfacing 2 3
RP 0x22 (34d) RSSI PWM Timer 0 – 0xFF [x 100 msec] Diagnostics 1 0x20 (32d)
RR 0x18 (24d) Retries 0 – 0xFF Networking & Security 1 0x0A (10d)
RT 0x16 (22d) GPI1 Configuration 0 - 2 Serial Interfacing 1 0
SB 0x37 (55d) Stop Bits 0 - 1 Serial Interfacing 1 0
SH 0x25 (37d) Serial Number High 0 – 0xFFFF [read-only] Diagnostics 2 varies
SL 0x26 (38d) Serial Number Low 0 – 0xFFFF [read-only] Diagnostics 2 varies
SM 0x01 (1d) Sleep Mode 0 - 2, 4 - 8; 3 reserved Sleep (Low Power) 1 0
ST 0x02 (2d) Time before Sleep (ATAT+3) – 0x7FFF [x 100 msec] Sleep (Low Power) 2 0x64 (100d)
TP 0x38 (56d) Board Temperature 0 – 0x7F [read-only] Diagnostics 1 -
TR 0x1B (27d) Delivery Failure Count 0 – 0xFFFF [read-only] Diagnostics 2 0
TT 0x1A (26d) Streaming Limit 0 – 0xFFFF [0 = disabled] Networking & Security 2 0
TX 0x3F (63d) Transmit Only 0 - 1 RF Interfacing 1 0
VL - Firmware Version - verbose Returns string Diagnostics - -
VR 0x14 (20d) Firmware Version 0 - 0xFFFF [read-only] Diagnostics 2 -
WA - Active Warning Numbers Returns string Diagnostics - -
WN - Warning Data Returns string Diagnostics - -
WR 0x08 (8d) Write - (Special) - -
WS - Sticky Warning Numbers Returns string Diagnostics - -
*Firmwareversioninwhichthecommandandparameteroptionswerefirstsupported.
9XTend™OEMRFModule–ProductManualv1.2.4
©2005MaxStream,Inc.Confidential&Proprietary19
3.3. Command Descriptions
Commands in this section are listed alphabetically. Command categories are designated between
the “< >” symbols that follow each command title. By default, XTend Modules expect numerical
values in hexadecimal since the default value of the CF (Number Base) Parameter is ‘1’.
Hexadecimal values are designated by the “0x” prefix and decimal values by the “d” suffix.
%V (Board Voltage) Command
AT Command: AT%V
Binary Command: 0x3B (59 decimal)
Parameter Range (read-only):
0x2CCCA – 0x5BFFA
(2.80 – 5.75 decimal)
Number of bytes returned: 4
<Diagnostics> %V Command is used to read the
current voltage of the XTend Module circuit
board.
Sample Output: 5.02 V (when ATCF = 0)
5051F (when ATCF = 1) *
5.02 (when ATCF = 2)
* When CF = 1 (default), a hex integer is shown that is equal to (voltage * 65536d).
AM (Auto-set MY) Command
<Networking & Security> AM Command is used
to automatically set the MY (Source Address)
parameter from the factory-set module serial
number. The address is formed with bits 29, 28 and 13-0 of the serial number (in that order).
The value is displayed as a result of this command.
AT Command: ATAM
Binary Command: 0x40 (64 decimal)
AT (Guard Time After) Command
AT Command: ATAT
Binary Command: 0x05 (5 decimal)
Parameter Range: 2 – (ATST-3), up to 0x7FFC
[x 100 milliseconds]
Default Parameter Value: 0x0A (10 decimal)
Number of bytes returned: 2
Related Commands: BT (Guard Time Before),
CC (Command Sequence Character)
<Command Mode Options> AT Command is used
to set/read the time-of-silence that follows the
command sequence character (CC Command). By
default, 1 second must elapse before and after
the command sequence character.
The default sequence used to enter AT Command
Mode is as follows:
•No characters sent for 1 second [BT (Guard
Time Before) Command]
•Send three plus characters “+++” [CC (Command Sequence Character) Command]
•No characters sent for 1 second [AT (Guard Time After) Command]
All of the values in this sequence can be adjusted. AT Command is used to adjust the period of
silence that follows the command sequence character.
9XTend™OEMRFModule–ProductManualv1.2.4
©2005MaxStream,Inc.Confidential&Proprietary20
BD (Baud Rate) Command
AT Command: ATBD
Binary Command: 0x15 (21 decimal)
Parameter Range: 0 – 8
Parameter
Value
BAUD (bps)
Configuration
0 1200
1 2400
2 4800
3 9600
4 19200
5 38400
6 57600
7 115200
8 230400
Default Parameter Value: 3
Number of bytes returned: 1
<Serial Interfacing> BD Command is used to
set/read the UART I/O serial data rate (the rate at
which serial data is sent to the module). Newly
modified serial data rates do not take effect until
the module exits Command Mode [refer to CN
(Exit Command Mode) and CT (Command Mode
Timeout) Commands].
The RF data rate is not affected by the BD
Command.
Note: If the serial data rate is set to exceed the
fixed RF data rate of the XTend module, flow
control may need to be implemented. Refer to the
Pin Signals [p6] and CS (GPO1 Configuration
Command [p21] sections for more information.
BR (RF Data Rate) Command
AT Command: ATBR
Binary Command: 0x39 (57 decimal)
Parameter Range: 0 – 1
Parameter
Value
BAUD (bps)
Configuration
0 9600
1 115200
Default Parameter Value: 1
Number of bytes returned: 1
<RF Interfacing> BR Command is used to
set/read the RF data rate (rate that RF data is
transmitted over-the-air) of the module.
BT (Guard Time Before) Command
AT Command: ATBT
Binary Command: 0x04 (4 decimal)
Parameter Range: 0 – 0xFFFF
[x 100 milliseconds]
Default Parameter Value: 0x0A (10 decimal)
Number of bytes returned: 2
Related Commands: AT (Guard Time After),
CC (Command Sequence Character)
<Command Mode Options> BT Command is used
to set/read the time-of-silence that precedes the
command sequence character (CC Command) of
the AT Command Mode Sequence.
Refer to the CC command to view the default AT
Command Sequence.
CC (Command Sequence Character) Command
AT Command: ATCC
Binary Command: 0x13 (19 decimal)
Parameter Range: 0x20 – 0x7F
Default Parameter Value: 0x2B (ASCII “+” sign)
Number of bytes returned: 1
Related Commands: AT (Guard Time After), BT
(Guard Time Before)
<Command Mode Options> CC Command is used
to set/read the ASCII character used between
Guard Times of the AT Command Mode Sequence
(BT+ CC + AT). The AT Command Mode
Sequence activates AT Command Mode (from
Idle Mode).
The default sequence used to enter AT Command Mode is as follows:
•No characters sent for 1 second [BT (Guard Time Before) Command]
•Send three plus characters “+++” [CC (Command Sequence Character) Command]
•No characters sent for 1 second [AT (Guard Time After) Command]
All of the values in this sequence can be adjusted.
Table of contents
Other MaxStream Control Unit manuals
Popular Control Unit manuals by other brands
Lindy
Lindy EDID 32100 user manual
Henry Pratt Company
Henry Pratt Company AirPro Max WAR Series Operation and maintenance manual
System Sensor
System Sensor Supervised Control Module M500S Installation and maintenance instructions
Honeywell
Honeywell 7800 SERIES manual
Intellijel
Intellijel Springray2 manual
Viessmann
Viessmann 5204 Operation manual
SinoCon
SinoCon KonNaD C2000-A2-SDXA000-AX1 user manual
Watts
Watts 800 Series Instructions for installing
Baker Hughes
Baker Hughes Consolidated 2900 series Maintenance manual
ICP DAS USA
ICP DAS USA ZT-2055 quick start guide
Fastrax
Fastrax SD5LCDN instruction manual
Hitachi
Hitachi HX-RIO3 Series user manual