XTend RF Module - Digi Internationalftp1.digi.com/support/documentation/90000958.pdf · 2016. 5....

XTend RF Module

User Guide

XTend RF Module User Guide

90000958

Product documentation

To find up-to-date documentation for all Digi products, visit www.digi.com/documentation.

To provide feedback on this documentation, send your comments to [email protected].

Trademarks and copyright

Digi, Digi International, and the Digi logo are trademarks or registered trademarks in the United States and other countries worldwide. All other trademarks mentioned in this document are the property of their respective owners.

© 2016 Digi International. All rights reserved.

Disclaimers

Information in this document is subject to change without notice and does not represent a commitment on the part of Digi International. Digi provides this document “as is,” without warranty of any kind, expressed or implied, including, but not limited to, the implied warranties of fitness or merchantability for a particular purpose. Digi may make improvements and/or changes in this manual or in the product(s) and/or the program(s) described in this manual at any time.

Warranty

To view product warranties online, visit www.digi.com/howtobuy/terms.

Customer support

Digi offers multiple technical support plans and service packages to help our customers get the most out of their Digi product. For information on Technical Support plans and pricing, please contact us at 952.912.3456 or visit www.digi.com/support.

If you have a customer account, sign in to the Customer Support Web Portal at www.digi.com/support/eservice.

Revision Date Description

G May, 2015 Updated the factory default values for the PD command, which were incorrect.

H April, 2016 Removed key features and worldwide acceptance sections. Updated the indoor range specification and the Australian certification.

XTend RF Module User Guide 2

http://www.digi.com/documentation

http://www.digi.com/support/eservice

http://www.digi.com/howtobuy/terms

http://www.digi.com/support

mailto:[email protected]

Contents

XTend RF ModuleApplicable firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7Pin signals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Electrical characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Timing specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Mechanical drawings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

RF Module operationSerial communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

UART data flow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14Serial data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Flow control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15DI (Data In) buffer and flow control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15DO (Data Out) buffer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Transparent Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16API Operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16Modes of operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Idle mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Transmit mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17Receive mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Shutdown mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Sleep Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Command mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22AT Command mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Binary Command mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

RF Module ConfigurationUse XCTU to configure the RF Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25Load default firmware settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Binary commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Command reference table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Command descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

%V (Board Voltage) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29AM (Auto-set MY) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30AP (API Enable) command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30


AT (Guard Time After) command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30BD (Interface Data Rate) command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31BR (RF Data Rate) command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32BT (Guard Time Before) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32CC (Command Sequence Character) command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33CD (GPO2 Configuration) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33CF (Number Base) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34CN (Exit AT Command Mode) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34CS (GPO1 Configuration) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34CT (Command Mode Timeout) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35DB (Received Signal Strength) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35DT (Destination Address) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36E0 (Echo Off) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36E1 (Echo On) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36ER (Receive Error Count) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36FH (Force Wake-up Initializer) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37FL (Software Flow Control) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37FS (Forced Sync Time) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37FT (Flow Control Threshold) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38GD (Receive Good Count) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38HP (Hopping Channel) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38HT (Time before Wake-up Initializer) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39HV (Hardware Version) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39ID (Modem VID) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40KY (AES Encryption Key) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40LH (Wake-up Initializer Timer) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41MD (RF Mode) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41MK (Address Mask) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42MT (Multi-transmit) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42MY (Source Address) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43NB (Parity) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43PB (Polling Begin Address) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44PD (Minimum Polling Delay) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44PE (Polling End Address) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44PK (Maximum RF Packet Size) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45PL (TX Power Level) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46PW (Pin Wake-up) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46RB (Packetization Threshold) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47RC (Ambient Power - Single Channel) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47RE (Restore Defaults) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47RM (Ambient Power - All Channels) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48RN (Delay Slots) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48RO (Packetization Timeout) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49RP (RSSI PWM Timer) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49RR (Retries) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50RT (GPI1 Configuration) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50SB (Stop Bits) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51SH (Serial Number High) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51SL (Serial Number Low) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52SM (Sleep Mode) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52ST (Time before Sleep) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53TP (Board Temperature) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53TR (Transmit Error Count) command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54TT (Streaming Limit) command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54


TX (Transmit Only) command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54VL (Firmware Version - Verbose) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55VR (Firmware Version - Short) Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55WA (Active Warning Numbers) command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55WN (Warning Data) command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56WR (Write) command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57WS (Sticky Warning Numbers) command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

API operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57API frame specifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57API Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59RF Module Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

RF communication modesNetwork topologies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Point-to-point networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Sample network profile (Broadcast communications) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62Sample network profile (Acknowledged communications) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

Point-to-multipoint networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Sample network profile (Broadcast communications) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63Basic RF modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Acknowledged RF mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Peer to peer networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Sample network profile (Broadcast communications) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Sample network profile (Acknowledged communications) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Basic RF modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64Acknowledged RF mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Addressing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Address recognition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Basic communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Streaming mode (default) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Streaming mode connection sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Multi-transmit mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Multi-transmit mode connection sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Repeater mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Repeater mode theory of operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68Configure a repeater network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

Repeater network: configure communications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Repeater network algorithm details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Repeat delay based on RSSI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69Response packet delay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70Bandwidth considerations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Polling mode (basic) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71Polling mode theory of operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Configure a Polling Base . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Configure a Polling Remote . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Acknowledged communications: Acknowledged mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72Acknowledged mode connection sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Polling mode (acknowledged) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74


Agency certificationsFCC (United States) certification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Integrator labeling requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75FCC notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75Limited modular approval . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76FCC-approved antennas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76Antenna options (1-watt transmit power output or lower) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78

IC (Industry Canada) certification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Labeling requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Transmitters for detachable antennas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Detachable antennas . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Australia (RCM) certification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85Power requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85

Development guideDevelopment Kit contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Interface hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88XTIB-R RS-232/485 Interface Board . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Configuration switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89I/O and Power LEDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Serial port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89RSSI LEDs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Power connector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

XTIB-R Dip switch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Automatic DIP switch configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92

NULL Modem Adapter (male-to-male) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92NULL Modem Adapter (female-to-female) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Serial Loopback Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Male DB-9 to RJ-45 Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93Female DB-9 to RJ-45 Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94

Interface protocols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94RS-232 operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94RS-232 wiring diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95RS-485 (2-wire) operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96RS-485 wiring diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97RS-485 (4-wire) and RS-422 operation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98RS-422 wiring diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99RF module RS-485/422 connection guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100


XTend RF Module

The XTend RF Module was engineered to provide customers with 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 frequency band and sustains up to 115.2 Kbps data throughput.

Applicable firmwareFirmware versions supported in this manual:

Standard firmware: 2x6x

For DigiMesh version refer to XTend DigiMesh manual (90002166)

Specifications

Specification @9600 bps Throughput Data Rate@115200 bps Throughput Data Rate

Performance specifications

Transmit Power Output

(software selectable using PL command)

1mW - 1 Watt 1mW - 1 Watt

Indoor Range (Non-Line of Sight) Up to 1,000 feet (300 m) Up to 500 feet (150 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

Up to 7 miles (11 km) w/ dipole antenna

Up to 20 miles (32 km) w/ high-gain antenna

Interface Data Rate

(software selectable using BD command)

1200 – 230400 bps 1200 – 230400 bps


Specifications

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 5 µA typical

Pin Sleep Power Down 147 µA

Idle Currents

16 sec cyclic sleep (SM=8)

0.3 - 0.8 mA


0.4 - 1.4 mA


0.6 - 2.6 mA


0.9 - 4.8 mA


1.6 - 8.7 mA

Networking and Security

Frequency 902-928 MHz, 915-928 MHz International variant

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

Channel Capacity 10 hop sequences share 50 frequencies

Encryption 256-bit or 128-bit AES Encryption – Refer to KY (AES Encryption Key) Command on page 40 to implement

Physical Properties

RF 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)



Pin signals

Pin signalsXTend RF Module Pin Numbers

The following table shows the Pin Signal Descriptions (Low-asserted signals distinguished with a horizontal line over signal name).

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) 421A-9XTEND

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 800 mA

Transmit Current (3.3 V) typical

90 mA 110 mA 260 mA 600 mA **

* If the supply voltage for a given power setting is lower than the minimum supply voltage requirement, the TX Power Output will decrease to the highest power level setting given the current supply voltage.

** 1W Power Output is not supported when using a 3.3 supply voltage.


Pin Number Name I/O

High Impedance during Shutdown

Must Connect Function

1 GND - - yes Ground

2 VCC I - yes Power: 2.8 - 5.5 VDC (Power supply ripple: +/- 250mV max @ 5V, 1A or +/- 125mV max @ 3.3V, 600mA.)


Pin signals

3 GPO2 / RX LED

O yes - General Purpose Output 2: <Default (CD=2)> Pin is driven low. Refer CD (GPO2 Configuration) Command on page 33 for other configuration options.

RX LED: Pin is driven high during RF data reception; otherwise, the pin is driven low. Refer to the CD Command [CD (GPO2 Configuration) Command on page 33] to enable.

4 TX_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).

6 DO O yes - Data Out: Serial Data exiting the module (to the UART host).

7 SHDN I no yes Shutdown: Pin is driven high during operation and low during Shutdown. Shutdown enables the lowest power mode (~5 µA) available to the module.

8 GPI2 / SLEEP I yes - General Purpose Input 2: reserved for future use

SLEEP: By default, SLEEP is not used. To configure this pin to enable Sleep Modes, use the SM and PW commands.

9 GPO1 / CTS / RS-485 TX_EN

O yes - General Purpose Output 1: reserved for future use

CTS (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 CS (GPO1 Configuration) Command on page 34 for more information.

RS-485 Transmit Enable: To configure this pin to enable RS-485 half and full-duplex communications. Refer to CS (GPO1 Configuration) Command on page 34 for more information.

10 GPI1 / RTS / CMD I yes - General Purpose Input 1: reserved for future use

RTS (Request-to-Send): By default, is not used. To configure this pin to regulate the flow of serial data exiting the module, refer to RT (GPI1 Configuration) Command on page 50.

CMD (Command): By default, CMD is not used. To configure this pin to enable binary command programming, refer to Binary commands on page 26] and RT (GPI1 Configuration) Command on page 50.

Pin Number Name I/O




Electrical characteristics

Note When integrating the module with a Host PC board, all lines not used should be left disconnected (floating).

Electrical characteristicsThe following drawing shows the 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 is not already receiving RF data, data in the DI Buffer is packetized then transmitted over-the-air to XTend RF Module B.

11 CONFIG / RSSI I* no - Configuration: Pin can be used as a backup method for entering Command Mode during power-up.

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 for more information. The PWM output is 2.8V-level.

12-20 reserved / do not connect

* RF module has 10K W internal pull-up resistor

Pin Number Name I/O




Timing specifications

Timing specificationsThe following drawing shows the timing specifications (A and B refer to the previous figure).

The following table shows the AC Characteristics (Symbols correspond with the previous two figures) ATSY Parameter = 0)

The following table shows the DC Characteristics (Vcc = 2.8 - 5.5 VDC).

Symbol Description Sleep Mode 115200 Baud Rate 9600 Baud Rate

TTX Latency from the time data is transmitted until it is received.

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

SM = 4 1 sec 1 sec

TTL Time that TX_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 CTS goes low until the first bit appears on DOUT

-- 44 µsec 75 µsec

TCHDH Time after last bit of data until CTS goes high -- 7 µsec 7 µsec

Symbol Parameter Condition

VOL Output Low Voltage VOL = 0.33V (IO = 6 mA)

VOH Output High Voltage VOH = VSUPPLY - 0.7V (-IO = 6 mA)


Mechanical drawings

Input Thresholds vs. Supply Voltage

Mechanical drawingsMechanical drawings of the XTend RF Module (w/RPSMA Connector)

Mechanical drawings of the XTend RF Module (w/MMCX Connector)

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

Vo

ltag

e

V(IL)

V(IH)


RF Module operation

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.

Serial communicationsThe XTend RF Modules interface 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 serial device (For example: RS-232/485/422 or USB interface board).

UART data flowDevices that have a UART interface can connect directly to the pins of the RF module as shown in the figure below.

System Data Flow Diagram in a UART-interfaced environment (Low-asserted signals distinguished with horizontal line over signal name.)

Serial dataData enters the module UART through the pin 5 as an asynchronous serial signal. The signal should idle high when no data is being transmitted.

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

UART data packet 0x1F (decimal number "31") as transmitted through the RF module Example Data Format is 8-N-1 (bits - parity - # of stop bits)


Flow control

The module UART performs tasks, such as timing and parity checking, that are needed for data communications. Serial communications depend on the two UARTs to be configured with compatible settings (baud rate, parity, start bits, stop bits, data bits).

Flow controlInternal Data Flow Diagram (The five most commonly-used pin signals shown)

DI (Data In) buffer and flow controlWhen 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 RB and RO parameter thresholds are satisfied, 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 RF 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 (CTS). When the DI buffer is 17 bytes away from being full; by default, the module de-asserts CTS (high) to signal to the host device to stop sending data [refer to FT (Flow Control Threshold) and CS (GPO1 Configuration) Commands]. CTS 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. This option only works with ASCII data.


Transparent Operation

DO (Data Out) bufferWhen 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 (RTS). If RTS is enabled for flow control (RT Parameter = 2), data will not be sent out the DO Buffer as long as RTS (pin 10) is de-asserted.

Software Flow Control (XOFF). XON/XOFF software flow control can be enabled using the FL (Software Flow Control) Command. This option only works with ASCII data.

Transparent OperationBy 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 received, the data is sent out the DO pin.

When the RO (Packetization Timeout) parameter threshold is satisfied, the module attempts to initialize an RF transmission. If the module cannot immediately transmit (for instance, if it is already receiving RF data), the serial data continues to be stored in the DI Buffer. Data is packetized and sent at any RO timeout or when the maximum packet size is received.

The module operates as described above unless the Command Mode Sequence is detected. The Command Mode Sequence consists of three copies of the command sequence character [CC parameter] surrounded by the before and after guard times [BT and AT parameters].

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

API OperationAPI (Application Programming Interface) Operation is an alternative to the default Transparent Operation. The API is frame-based and extends the level to which a host application can interact with the networking capabilities of the module. When in API mode, all data entering and leaving the RF module is contained in frames that define operations or events within the module.

Transmit Data Frames (received through the DI (Data In) pin) include:

• 16-bit address

Receive Data Frames (sent out the DO (Data Out) pin) include:

• Showing a received RF packet (16 bits only)

• Response to a TX (Transmit) packet

• Showing events such as hardware reset, watchdog reset, asynchronous events, etc.

The module will send data frames to the application containing status packets; as well as source, RSSI and payload information from received data packets.

API operation option facilitates many operations such as the examples cited below:


Modes of operation

• Change destination addresses without having to enter command mode

• Receive success/failure status of each RF packet

• Identify the source address of each received packet

To implement API operations, refer to API operation on page 57.

Modes of operationXTend RF Modules operate in six modes.XTend RF Module Modes of Operation (RF modules can only be in one mode at a time)

Idle modeWhen not receiving or transmitting data, the RF module is in Idle Mode. The module shifts into the other modes of operation under the following conditions:

• Transmit Mode: Serial data is received in the DI Buffer

• Receive Mode: Valid RF data is received through the antenna

• Shutdown Mode: Shutdown condition is met

• Sleep Mode: Sleep Mode condition is met

• Command Mode: Command Mode Sequence is issued

The module automatically transitions back to Idle Mode after responding to these conditions.

Transmit modeWhen 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]

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]

The following diagram shows the Transmit Mode Data Flow.


Modes of operation

The character timeout trigger can 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 1 and the RF packet size [refer to PK (Max RF Packet Size) parameter], 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.

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.

RF packet

The following diagram shows the RF packet components.

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


Modes of operation

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.

Refer to the Addressing on page 65 for more information.

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.

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

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.

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 SHDN 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, SHDN must be driven or pulled high. While in shutdown mode, the module's VCC pin draws 5 µA (typical).

Immediately after the SHDN pin changes state from low to high, the module resets. After reset, there is a delay that must be observed. Delay time is <100ms.

While SHDN pin is driven low, the following pins are set to high impedance by the module: DCD, TX_PWR, RX LED, DO and CTS (See pin signal descriptions, p6). The SHDN 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, RTS, DI and SHDN.

Note Because the DO pin also goes high impedance, if the XTend RF 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 is not interpreted as being transmitted to the microprocessor.


Modes of operation

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 activity)

• Cyclic Sleep (Wake on RF activity)

In order to enter Sleep Mode, one of the following conditions must be met (in addition to the module having a non-zero SM parameter value):

1. The module is idle (no data transmission or reception) for the amount of time defined by the ST (Time before Sleep) parameter. [ST is only active when SM = 4-5.]

2. SLEEP (pin 8) is asserted (only for the Pin Sleep option).

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

The SM (Sleep Mode) command is central to setting all Sleep Mode configurations. By default, Sleep Modes are disabled (SM = 0) and the module remains in Idle/Receive Mode. When in this state, the module remains constantly ready to respond to serial or RF activity.

Refer to Hardware Sleep on page 19 to enable the module's lowest power-consuming state (5 µA typical power-down current).

Sleep Mode (Setting)

Transition into Sleep Mode

Transition out of Sleep Mode (wake)

Related Commands

Power Consumption

Pin Sleep(SM = 1)

Assert (high) SLEEP pin - A micro controller can shut down and wake modules via the SLEEP pin.

Note The module will complete a transmission or reception before activating Pin Sleep.

De-assert (low) SLEEP pin

(SM) < 147A

Serial Port Sleep(SM = 2)

Automatic transition to Sleep Mode occurs after a user-defined period of inactivity (no transmitting or receiving of data).

Period of inactivity is defined by the ST (Time before Sleep) Command.

When a serial byte is received on the DI pin

(SM), ST < 10 mA

Cyclic Sleep(SM = 4 - 8)

RF module transitions in and out of Sleep Mode in cycles (user-selectable wake-up interval of time is set using the SM command). The cyclic sleep interval of time must be shorter than the interval of time that is defined by the LH (Wake-up Initializer Timer) command.

Note The module can be forced into Idle Mode using the SLEEP pin if the PW (Pin Wake-up) command is issued.

(SM), ST, HT, LH, PW

< 1.6 mA

when sleeping

(SM=4, 1 sec., @120K baud)


Modes of operation

Pin Sleep (SM = 1)

• Pin/Host-controlled

• Typical power-down current: < 147 A 147 µA

This mode is voltage level activated. When the SLEEP pin is asserted, the module will finish any transmitting or receiving activity; enter Idle Mode; then enter a state of sleep. When in Pin Sleep Mode, the module will not respond to serial or RF activity.

After enabling Pin Sleep, the SLEEP pin controls whether the module is active or sleeping. When SLEEP is de-asserted, the module is fully operational. When SLEEP is asserted, the module transitions to Sleep Mode and remains in its lowest power-consuming state until the pin is de-asserted. This pin is only active if the module is setup to operate in this mode; otherwise the pin is ignored.

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 a transmission or reception before activating Pin Sleep.

Serial Port Sleep (SM = 2)

• Wake on serial port activity

• Typical power-down current: < 10 mA

Serial Port Sleep is a Sleep Mode in which the module runs in a low power state until serial data is detected on the DI pin.

The period of time the module sleeps is determined by ST (Time before Sleep) Command. Once a character is received through the DI pin, the module returns to Idle Mode and is fully operational.

Cyclic Sleep (SM = 4-8)

• Typical Power-down Current: < 1.6 mA (when asleep)

Cyclic Sleep Modes allow modules to periodically wake and check for RF data. The module wakes according to the times designated by the Cyclic sleep settings. If the module detects a wake-up initializer during the time it is awake, the module synchronizes with the transmitting module and receives data after the wake-up initializer runs its duration. Otherwise, the module returns to Sleep Mode and continues to cycle in and out of activity until a wake-up initializer is detected.

While the module is in Cyclic Sleep Mode, CTS (GPO1) is de-asserted (high) to indicate that data should not be sent to the module. When the module awakens to listen for data, GPO1 is asserted and any data received on the DI Pin is transmitted. The PWR pin is also de-asserted (low) when the module is in Cyclic Sleep Mode.

The module remains in Sleep Mode for a user-defined period of time ranging from 0.5 seconds to 16 seconds (SM parameters 4 through 8). After this interval of time, the module returns to Idle Mode and listens for a valid data packet. The listen time will depend on the [BR] (RF Data Rate) parameter setting.The default [BR] setting of 1 will require at least a 35ms wake time, while the [BR] setting of 0 will require a wake time of up to 225ms. If the module does not detect valid data (on any frequency), the module returns to Sleep Mode. If valid data is detected, the module transitions into Receive Mode and receives the incoming RF packets. The module then returns to Sleep Mode after a period of inactivity determined by the ST (Time before Sleep) parameter.

The module can also be configured to wake from cyclic sleep when the SLEEP pin is de-asserted. To configure a module to operate in this manner, PW (Pin Wake-up) Command must be issued. Once the SLEEP pin is de-asserted, the module is forced into Idle Mode and can begin transmitting or receiving data. It remains active until data is no longer detected for the period of time specified by the ST Command, at which point it resumes its low-power cyclic state.


Modes of operation

Cyclic scanning

Each RF transmission consists of an RF Initializer and payload. The RF initializer contains initialization information and all receiving modules must wake during the wake-up initializer portion of data transmission in order to be synchronized with the transmitting module and receive the data.

The cyclic interval time defined by the SM (Sleep Mode) command must be shorter than the interval time defined by LH (Wake-up Initializer Timer) command.

Correct Configuration (LH > SM): The length of the wake-up initializer exceeds the time interval of Cyclic Sleep. The receiver is guaranteed to detect the wake-up initializer and receive the accompanying payload data.

Command modeTo 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 parameter values to persist in the module registry, changes must be saved to non-volatile memory using the WR (Write) command. Otherwise, parameters are restored to previously saved values when the module is powered off and then on again.

AT Command modeTo Enter AT Command Mode:

1. Send the 3-character command sequence "+++" and observe guard times before and after the command characters. [refer to ‘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 CONFIG pin and turn the power going to the module off and back on (or pulse the SHDN pin).

3. [If the module is mounted to a Digi RS-232/485 Interface Board, the result can be achieved by pressing the configuration switch down for 2 seconds.]

Default AT Command Mode Sequence (for transition to 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.]


Modes of operation

All of the parameter values in the sequence can be modified to reflect user preferences.

Send AT commands and parameters using the syntax shown below.

To read a parameter value stored in the module register, leave the parameter field blank.

The preceding example would change the module’s Destination Address to "0x1F". To store the new value to non-volatile (long term) memory, the Write (ATWR) command must subsequently be sent before powering off the module.

System Response. When a command is sent to the module, the module will parse and execute the command. Upon successful execution of a command, the module returns an “OK” message. If execution of a command results in an error, the module returns an “ERROR” message.

To Exit AT Command Mode:

1. If no valid AT Commands are received within the time specified by CT (Command Mode Timeout) Command, the module automatically returns to Idle Mode.[OR]

2. Send ATCN (Exit Command Mode) Command.

Binary Command modeSending 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] 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 CTS signal will frame the response coming from the binary command request [refer to figure below].

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


Modes of operation

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.

The figure shows Binary Command Write then Read

Signal #4 is CMD

Signal #1 is the DI signal

Signal #2 is the DO signal from the radio

Signal #3 is CTS

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 CTS signal outlines the data response out of the module.

In order for the module to recognize a binary command, the RT (GPI1 Configuration) parameter must be set to one. If binary programming is not enabled (RT parameter value is not equal to ‘1’), the module will not recognize that the CMD pin is asserted and therefore will not recognize the data as binary commands.


RF Module Configuration

Use XCTU to configure the RF ModuleXBee Configuration and Test Utility (XCTU) is a multi-platform program that enables developers to interact with Digi radio frequency (RF) devices through a graphical interface. The application includes built-in tools that make it easy to set up, configure, and test Digi RF devices.

For instructions on downloading and using XCTU, go to:

http://www.digi.com/products/xbee-rf-solutions/xctu-software/xctu

Refer to the online help for XCTU for more information on the program and how to use it. The help information is available at:

https://docs.digi.com/display/XCTU/XCTU+Overview

Refer to Command mode on page 29 for information regarding entrance into Command Mode, sending AT commands and exiting Command Mode.

Load default firmware settingsIn XCTU, you can load default module firmware settings onto a module in your device list. To load default firmware settings:

1. Switch to Configuration working mode.

2. Select a module from the device list. XCTU displays the current firmware settings for that module.

3. From the Configuration toolbar, click the Load default firmware settings button to load the default values established by the firmware.

4. Firmware settings are loaded but not written to the module. In order to write them in the module, click the Write module settings button on the toolbar.

Note You can also load default firmware settings with the Firmware explorer tool, but the tool does not have write functionality.

CAUTION! Do not send commands to the module during flash programming (when parameters are being written to the module registry).


http://www.digi.com/products/xbee-rf-solutions/xctu-software/xctu

https://docs.digi.com/display/XCTU/XCTU+Overview

Binary commands

Binary commandsTo Send Binary commands:

Example: Use binary commands to change the RF 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 CTS (pin 9) is high when a command is being executed. Hardware flow control must be disabled as CTS will hold off parameter bytes.

Command reference tableThe RF modules expect numerical values in hexadecimal. Hexadecimal values are designated by a “0x” prefix. Decimal equivalents are designated by a “d” suffix.

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

-- --

AP v2.x20* -- API Enable 0 - 2 Serial Interfacing 1 0

AT 0x05 (5d) Guard Time After 2 - (ATST-3) [x 100 msec] Command Mode Options

2 0x0A (10d)

BD 0x15 (21d) Interface Data Rate 0 - 8 (standard rates)

0x39 - 0x1C9C38 (non-standard rates)

Serial Interfacing 4 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 - 4 Serial Interfacing 1 2


Command reference table

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 - 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 0 - 0xFFFF [x 10 msec] RF Interfacing 2 0

FT 0x24 (36d) Flow Control Threshold 0 - (DI buffer size - 0x11) [Bytes]

Serial Interfacing 2 DI buffer size minus 0x11

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 0x11 - 0x7FFF (user-settable)

0x8000 - 0xFFFF (factory-set, read-only)

Networking & Security

2 0x3332 (13106d)

KY 0x3C (60d) AES Encryption Key 0 - (64 hex digits all set to 'F') Networking & Security

2 0 (disabled)

LH 0x0C (12d) Wake-up Initializer Timer 0 - 0xFF [x 100 msec] Sleep (Low Power)

1 1

AT Command


Command Category

# Bytes Returned

Factory Default


Command reference table

MD v2.x20* 0x31 (49d) RF Mode 0 - 6 Networking & Security

1 0

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

PB v2.x20* 0x45 (69d) Polling Begin Address 0 - 0xFFFF Networking & Security

2 0

PD v2.x20* 0x47 (71d) Minimum Polling Delay 0 - 0xFFFF (Base: (x 1 ms), Remote: [x 10 ms])

Networking & Security

2 0

PE v2.x20* 0x46 (70d) Polling End Address 0 - 0xFFFF Networking & Security

2 0

PK 0x29 (41d) Maximum RF Packet Size 1 - 0x800 [Bytes] RF Interfacing 2 varies

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

AT Command


Command Category

# Bytes Returned

Factory Default


Command descriptions

Command descriptionsCommands 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 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<Diagnostics> %V Command is used to read the current voltage of the 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).

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 - 8 (3 is 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 -- --

* Firmware version in which command and parameter options were first supported.

AT Command


Command Category

# Bytes Returned

Factory Default



AM (Auto-set MY) Command

<Networking and Security> AM Command is used to automatically set the MY (Source Address) parameter from the factory-set serial number of the module. The address is formed with bits 29, 28 and 13-0 of the serial number (in that order). The resulting value is displayed as a result of this command.

AP (API Enable) command<Serial Interfacing> The AP command is used to enable the module to operate using the frame-based API operation.

AT (Guard Time After) command<Command Mode Options> AT Command is used to set/read the time-of-silence that follows the command sequence character (CC Command) of the AT Command Mode Sequence (BT + CC + AT). By default, 1 second must elapse before and after the command sequence character.

The times-of-silence surrounding the command sequence character are used to prevent inadvertent entrance into AT Command Mode.

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

AT Command: ATAM

Binary Command: 0x40 (64 decimal)

AT Command: ATAP

Parameter Range:0 - 2

Parameter Configuration

0 API Disabled (Transparent Operation)

1 API enabled (w/out escaped characters)

2 API enabled (with escaped characters)

Default Parameter Value:0

Number of Bytes Returned:1

Legacy Modem Minimum Firmware Version Required: 2.x20



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 is sent to the module from the host. Modified interface data rates do not take effect until the CN (Exit AT Command Mode) command is issued and the system returns the 'OK' response.

When parameters 0-8 are sent to the module, the respective interface data rates are used (as shown in the table on the right).

The RF data rate is not affected by the BD parameter. If the interface data rate is set higher than the RF data rate, a flow control configuration may need to be implemented.

The range between standard and non-standard baud rates is invalid.

AT Command: ATAT


Parameter Range:2 - (ATST-3), up to 0x7FFC

[x 100 milliseconds]

Default Parameter Value: 0x0A (10 decimal)


Related Commands: BT (Guard Time Before), CC (Command Sequence Character)

AT Command: ATBD


Parameter Ranges: 0 - 8 (standard rates)0x39 - 0x1C9C38 (Legacy Modem non-standard rates)

0x4B0 - 0x2580 and 0x4B00 - 0x1C9468 (XTend vB Modem non-standard rates)

Parameter Configuration (b/s)

0 1200

1 2400

2 4800

3 9600

4 19200

5 38400

6 57600

7 115200

8 230400

Default Parameter Value: 3



Non-standard Interface Data Rates

BD values above 0x38 (Legacy) or 0x4AF (XTend vB) are interpreted as an actual baud rate. When a non-standard value is sent, the closest interface data rate represented by the number is stored in the BD register. For example, a rate of 19200 b/s can be set by sending the following command line "ATBD4B00".

Note on Legacy only: when the BD command is sent with a non-standard interface data rate, the UART will adjust to accommodate the requested interface rate. In most cases, the clock resolution will cause the stored BD parameter to vary from the parameter that was sent. Reading the BD command (send the "ATBD" command without an associated parameter value) will return the value actually stored in the module’s BD register.

BR (RF Data Rate) command<RF Interfacing> The BR command is used to set and read the RF data rate (rate that RF data is transmitted over-the-air) of the module.

BT (Guard Time Before) Command<AT Command Mode Options> BT Command is used to set the DI pin silence time that must precede the command sequence character (CC command) of the AT Command Mode sequence.

Legacy Modem Non-standard baud rates supported as of firmware v2.x20


AT Command: ATBR


Parameter Range:0 - 1

Parameter RF data rate

0 10 kb/s

1 125 kb/s

Default Parameter Value:1


AT Command: ATBT

Binary Command: 0x04

Parameter Range: 0 - 0xFFFF

Default Parameter Value: 0x0A


AT Command: ATBD



CC (Command Sequence Character) 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 (BT + CC + AT). This sequence enters the module into AT Command Mode so that data entering the module (from the host) is recognized as commands instead of payload.

CD (GPO2 Configuration) Command<Serial Interfacing> CD Command is used to select/read the behavior of the GPO2 line (pin 3).

AT Command: ATCC


Parameter Range: 0x20 - 0x7F

Default Parameter Value: 0x2B (ASCII “+”)


Related Commands: AT (Guard Time After), BT (Guard Time Before)

AT Command: ATCD


Parameter Range: 0 - 8 (standard rates)


0 RX LED

1 Default High

2 Default Low

3 (reserved)

4 RX LED (valid address only)





CF (Number Base) Command<Command Mode Options> CF command is used to set/read the command formatting setting.

The following commands are always entered and read in hex, no matter the CF setting:

VR (Firmware Version)HV (Hardware Version)KY (AES Encryption Key)

CN (Exit AT Command Mode) Command<Command Mode Options> The CN command is used to explicitly exit the module from AT Command Mode.

CS (GPO1 Configuration) Command<Serial Interfacing> CS Command is used to select the behavior of the GP01 pin (pin 9). This output can provide RS-232 flow control, control the TX enable signal (for RS-485 or RS-422 operations).

By default, GP01 provides RS-232 CTS (Clear-to-Send) flow control.

AT Command: ATCF

Parameter Range: 0 – 2


0 Commands utilize default number base; decimal commands may output units

1 All commands forced to unsigned, unit-less hex

2 Commands utilize their default number base; no units are output



AT Command: ATCN


AT Command: ATCS

Binary Command: 0x1F (31 decimal)

Parameter Range: 0 - 4


0 RS-232 CTS flow control

1 RS-485 TX enable low

2 High

3 RS-485 TX enable high



CT (Command Mode Timeout) Command<Command Mode Options> The CT command is used to set and read the amount of inactive time that elapses before the module automatically exits from AT Command Mode and returns to Idle Mode.

Use the CN (Exit AT Command Mode) command to exit AT Command Mode manually.

DB (Received Signal Strength) Command<Diagnostics> DB Command is used to read the receive signal strength (in decibels relative to milliwatts) of the last received packet. This parameter is useful in determining range characteristics of the RF modules under various conditions.

In default mode, this command shows the power level in signed decimal format with the units (dBm). If CF = 1, the magnitude of the value is presented in unsigned hex. If CF = 2, the value is presented in decimal, but without the units.

Sample Output:

-88 dBm (when ATCF = 0)58 (when ATCF = 1)-88 (when ATCF = 2)

Note If the DB register is read before the module has received an RF packet, the module will return a value of 0x8000 (which means an RF packet has not yet been received).

4 Low



Related Commands: RT (GPI1 Configuration), TO (GP01 Timeout)

AT Command: ATCT


Parameter Range:2 - 0xFFFF


Default Parameter Value: 0xC8 (200d)


Related Command: CN (Exit AT Command Mode)

AT Command: ATDB


Parameter Range (read-only): 0x6E - 0x28 (-110 to -40 Decimal)


AT Command: ATCS



DT (Destination Address) Command<Networking and Security> DT Command is used to set/read the networking address of an RF module. The modules utilize three filtration layers: Vendor ID Number (ATID), Channel (ATHP), and Destination Address (ATDT). The DT command assigns an address to a module that enables it to communicate only with other modules having the same address. All modules that share the same DT parameter can communicate with each other.

RF modules in the same network with a different destination address (than that of the transmitter) will listen to all transmissions to stay synchronized, but will not send any of the data out their serial ports.

E0 (Echo Off) Command<Command Mode Options> E0 Command turns off character echo in AT Command Mode.

By default, echo is off.

E1 (Echo On) Command<Command Mode Options> E1 Command enables character echo in AT Command Mode. Each typed character will be echoed back to the terminal when ATE1 is active. E0 (Echo Off) is the default.

ER (Receive Error Count) Command<Diagnostics> The ER command is used to set/read the number of receive-errors. The error count records the number of packets partially received then aborted on a reception error. This value returns to 0 after a reset and is not non-volatile (Value does not persist in the module's memory after a power-up sequence). Once the Receive Error Count reaches its maximum value (up to 0xFFFF), it remains at its maximum count value until the maximum count value is explicitly changed or the module is reset.

The ER parameter is not reset by pin, serial port or cyclic sleep modes.

AT Command: ATDT





Related Commands: HP (Hopping Channel), ID (Modem VID), MK (Address Mask), MY (Source Address)

AT Command: ATE0

Binary Command: 0x0A (10 decimal)

AT Command: ATE1




FH (Force Wake-up Initializer) Command<Sleep (Low Power)> The FH command is used to force a Wake-up Initializer to be sent on the next transmission. Use only with cyclic sleep modes active on remote modules.

ATFH will not send a long header if ATHT = 0xFFFF. WR (Write) Command does not need to be issued with FH Command.

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 serial data can be transferred to the module.

FL Command can be used to allow software flow control to also be enabled. The XON character used is 0x11 (17 decimal). The XOFF character used is 0x13 (19 decimal)

FS (Forced Sync Time) Command<RF Interfacing> The FS command only applies to streaming data. Normally, only the first packet of a continuous stream contains the full RF initializer. The RF modules then remain synchronized for subsequent packets of the stream. This parameter can be used to periodically force an RF initializer during such streaming. Any break in UART

AT Command: ATER





Related Commands: GD (Receive Good Count)

AT Command: ATFH

Binary Command: 0x0D (13 decimal)

AT Command: ATFL




0 Disable software flow control

1 Enable software flow control





character reception long enough to drain the DI Buffer (UART receive buffer) and cause a pause in RF data transmission will also cause an RF initializer to be inserted on the next transmission.

FT (Flow Control Threshold) Command<Serial Interfacing> The FT command is used to set/read the flow control threshold. When FT bytes have accumulated in the DI buffer (UART Receive), CTS is de-asserted or the XOFF software flow control character is transmitted.

GD (Receive Good Count) Command<Diagnostics> The GD command is used to set/read the count of good received RF packets. Its parameter value is reset to 0 after every reset and is not non-volatile (The parameter value does not persist in the RF module's memory after a power-up sequence). Once the "Receive Good Count" reaches its maximum value (up to 0xFFFF), it remains at its maximum count value until the maximum count value is manually changed or the module is reset.

The GD parameter is not reset by pin, serial port or cyclic sleep modes.

HP (Hopping Channel) Command<Networking and Security> The HP command is used to set/read the RF module's hopping channel number. A channel is one of three layers of filtration available to the module.

AT Command: ATFS

Binary Command: 0x3E (62 decimal)

Parameter Range:0 - 0xFFFF [x 10 milliseconds]



AT Command: ATFT


Parameter Range: 0 - (DI buffer size minus 0x11) [Bytes]

Default Parameter Value: DI Buffer size minus 0x11 (17 decimal)


AT Command: ATGD





Related Commands: ER (Receive Error Count)



In order for modules to communicate with each other, the modules must have the same channel number since each channel uses a different hopping sequence. Different channels can be used to prevent modules in one network from listening to transmissions of another.

HT (Time before Wake-up Initializer) Command<Sleep (Low Power)> The HT command is used to set/read the time of inactivity (no serial or RF data is sent or received) before a wake-up initializer is sent by a TX (transmitting) RF module. The HT parameter should be set shorter than inactivity timeout [ST Command] time of any RX (receiving) modules operating in Cyclic Sleep (SM=4-8). The wake-up initializer sent by the TX module instructs all RX modules to remain awake to receive RF data.

From the RX module perspective: After HT time elapses and the inactivity timeout [ST Command] is met, the RX module goes into cyclic sleep. In cyclic sleep, the RX module wakes once per sleep interval [SM Command] to check for a wake-up initializer. When a wake-up initializer is detected, the module stays awake to receive data. The wake-up initializer must be longer than the cyclic sleep interval to ensure that sleeping modules detect incoming data.

When HT time elapses, the TX module knows it needs to send a wake-up Initializer for all RX modules to remain awake and receive the next transmission.

HV (Hardware Version) Command<Diagnostics> The HV command is used to read the hardware version of the RF module.

AT Command: ATHP





Related Commands: ID (Modem VID), DT (Destination Address), MK (Address Mask)

AT Command: ATHT


Parameter Range:0 - 0xFFFF [x 100 milliseconds]

Default Parameter Value: 0xFFFF (wake-up initializer will not be sent)


Related Commands: LH (Wake-up Initializer Timer), SM (Sleep Mode), ST (Time before Sleep)

AT Command: ATHV

Parameter Range:0 - 0xFFFF [Read-only]

Legacy Modem Minimum Firmware Version Required: v1.x80



ID (Modem VID) Command<Networking and Security> The ID command is used to set/read the VID (Vendor Identification Number) of the RF module. RF modules must have matching VIDs in order to communicate.

KY (AES Encryption Key) Command<Networking and 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 module by any means. The entire payload of the packet is encrypted using the key and the CRC is computed across the ciphertext. When encryption is enabled, each packet carries an additional 16 bytes to convey the random CBC Initialization Vector (IV) to the receiver(s). The KY value may be “0” or any 256-bit value (= 64 hex digits = 32 bytes). Any other value, including entering ATKY by itself with no parameters, causes an error.

A module with the wrong key (or no key) will receive encrypted data, but the data driven out the serial port will be meaningless. Likewise, a module with a key will receive unencrypted data sent from a module without a key, but the output will be meaningless. Because CBC mode is utilized, repetitive data appears differently in different transmissions due to the randomly-generated IV.

Note For international (non-U.S.) variants of XTend modules, the encryption key is 128-bit AES. The command operates the same except the key length is 16 bytes rather than 32 bytes. This pertains to part numbers ending with -NA or -128 (the -NA and -128 suffix mean the same thing), no matter what firmware version is loaded. This also pertains to the Australia version of firmware 22xx, no matter what part number XTend it is loaded onto.

AT Command: ATID


Parameter Range:

0x11 - 0x7FFF (user-settable)

0 - 0x10 and 0x8000 - 0xFFFF (factory-set)

Default Parameter Value: 0x3332 (13106d)


AT Command: ATKY

Binary Command: 0x3C (60 decimal)

Parameter Range: 0 - (any other 64-digit hex valid key)

Default Parameter Value: 0 (disabled)


Number Base: Always Hexadecimal



LH (Wake-up Initializer Timer) Command<Sleep (Low Power)> The LH Command is used to set/read the duration of time during which the wake-up initializer is sent. When receiving modules are in Cyclic Sleep Mode, they power-down after a period of inactivity (as specified by the ST parameter) and will periodically wake and listen for transmitted data. In order for the receiving modules to remain awake, they must detect ~35ms of the wake-up initializer.

LH Command must be used whenever a receiving module is operating in Cyclic Sleep Mode. The Wake-up Initializer Time must be longer than the cyclic sleep time that [as determined by SM (Sleep Mode) parameter]. If the wake-up initializer time were less than the Cyclic Sleep interval, the connection would be at risk of missing the wake-up initializer transmission.

Refer to figures located under the SM command description to view diagrams of correct and incorrect configurations. The images emphasize that the LH value must be greater than the SM value.

MD (RF Mode) Command<Networking and Security> The MD command is used to select/read the settings that enable the Polling and Repeater Modes on the module.

Polling Mode - A ‘Polling Base’ is responsible for polling remotes. A ‘Polling Remote’ requires a poll in order to transmit.

Repeater Mode - A ‘Repeater’ re-sends RF data unless the transmission is addressed to it or if the transmission has already been detected. A ‘Repeater End Node’ handles repeated messages, but will not repeat the message over-the-air.

Refer to the Polling and Repeater Mode sections of the ‘RF Communication Modes’ chapter for more information.

AT Command: ATLH

Binary Command: 0x0C (12 decimal)

Parameter Range:0 - 0xFF




Related Commands: HT (Time before Wake-up Initializer), SM (Sleep Mode), ST (Time before Sleep)

AT Command: ATMD




0 Transparent Operation (Repeater Base)

1 [reserved - not used]

2 [reserved - not used]

3 Polling Base



MK (Address Mask) Command<Networking and 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 TX module Destination Address is logically "ANDed" (bitwise) with the Address Mask of the RX (receiving) module. The resulting value must match the Destination Address or Address Mask of the RX module for the packet to be received and sent out the RX module's DO (Data Out) pin. If the "ANDed" value does not match the Destination Address or Address Mask of the RX module, the packet is discarded.

Sniffer Mode (when MK = 0): ACK requests are ignored and every RX (receive) frame is sent to the UART, without regard for repeated frames.

All “0” values are treated as irrelevant values and ignored.

MT (Multi-transmit) Command<Networking and Security> The MT command is used to enabled multiple transmissions of RF data packets. When Multi-transmit Mode is enabled (MT > 0), packets do not request an ACK (acknowledgment) from the receiving RF module(s). MT takes precedence over RR, so if both MT and RR are non-zero, then MT+1 packets will be sent (with no ACK requests).

When a receiving module receives a packet with remaining forced retransmissions, it calculates the length of the packet and inhibits transmission for the amount of time required for all retransmissions. Thereafter, a random number of delay slots are inserted between 0 and RN before transmission is allowed from the receiving module(s). This prevents all listening modules from transmitting at once upon conclusion of a multiple transmission event (when RN > 0).

NOTE: The actual number of forced transmissions is the parameter value plus one. For example, if MT = 1, two transmissions of each packet will be sent.

4 Polling Remote

5 Repeater

6 Repeater End Node




AT Command: ATMK



Default Parameter Value: 0xFFFF (65535d)


Related Commands: DT (Destination Address), HP (Hopping Channel), ID (Modem VID), MY (Source Address)

AT Command: ATMD



MY (Source Address) Command<Networking and Security> The MY command is used to set/read the Source Address of the RF module.

NB (Parity) Command<Serial Interfacing> The NB command is used to select/read the parity settings of the RF module for UART communications.

AT Command: ATMT


Parameter Range: 0 - 0xFF

Default Parameter Value:0 (no forced retransmissions)


Related Commands: Networking (DT, MK, MY, RN, TT), Serial Interfacing (BR, PK, RB, RO), RF Interfacing (FS)

AT Command: ATMY



Default Parameter Value: 0xFFFF (Disabled - DT (Destination Address) parameter serves as both source and destination address.)


Related Commands: DT (Destination Address), HP (Hopping Channel), ID (Modem VID), MK (Address Mask)

AT Command: ATNB




0 8-bit (no parity or

7-bit (any parity)

1 8-bit even

2 8-bit odd

3 8-bit mark

4 8-bit space





PB (Polling Begin Address) Command<Networking and Security> PB command is used to set/read the module’s Polling Begin Address - the first address polled Polling Mode is enabled.

Polling Operations: The ‘Polling Base’ (MD = 3) cycles through a sequential range of addresses, polling each ‘Polling Remote’ (MD = 4). The base then waits for a response and proceeds to the next ‘Polling Remote’. Each ‘Polling Remote’ responds by sending the data from the Data In buffer following the RB and RO parameters. When there is no eligible data to send, the ‘Polling Remote’ will not respond. The ‘Polling Base’ will move to the next address in the polling sequence after a short delay.

PD (Minimum Polling Delay) Command<Networking and Security> The PD command is used to set/read Polling Delay (Base, MD=3) or Polling Timeout (Remote, MD=4).

Polling Delay (Base) is the time between polling cycles. The Polling Base will start the polling cycle after sending the first poll. After the polling cycle has completed, the timer is restarted.

Polling Timeout (Remote) is the amount of time the remote unit will hold data from the serial port before discarding it. Data entered within the PD time of the poll is transmitted and not discarded.

PE (Polling End Address) Command<Networking and Security> PE command is used to set/read the module’s Polling End Address - the last address polled when Polling Mode is enabled.

AT Command: ATPB






Related Commands: MD (RF Mode), PE (Polling End Address), PD (Minimum Polling Delay)

AT Command: ATPD


Parameter Range: 0 - 0xFFFF(Base: [x 1ms], Remote: [x 10ms])




Related Commands: MD (RF Mode), PB (Polling Begin Address), PE (Polling End Address)



Polling Operations: The ‘Polling Base’ (MD = 3) cycles through a sequential range of addresses, polling each ‘Polling Remote’ (MD = 4). The base then waits for a response and proceeds to the next ‘Polling Remote’. Each ‘Polling Remote’ responds by sending data from the DI buffer following the RB and RO parameters. When there is no eligible data to send, the ‘Polling Remote’ will not respond. The ‘Polling Base’ will move to the next address in the polling sequence after a short delay.

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 RO parameters to implicitly set the channel dwell time.

If PK is set above 256 and BR is subsequently changed to 0, PK will automatically be lowered to 256 and a warning will be raised (refer to the BR (RF Data Rate) and WN (Warning Data) commands for details).

Changes to the PK parameter may have a secondary effect on the RB (Packetization Threshold) parameter. RB must always be less than or equal to PK. If PK is changed to a value that is less than the current value of RB, the RB value is automatically lowered to be equal to PK.

* When BR = 0 (9600 baud), the maximum PK value is 0x100 (256d). When BR = 1 (115,200 baud), the maximum PK value is 0x800 (2048d).

AT Command: ATPE






Related Commands: MD (RF Mode), PB (Polling Begin Address), PD (Minimum Polling Delay)

AT Command: ATPK


Parameter Range:1 - 0x800 [Bytes]

Default Parameter Value:0x100* or 0x800* (256 or 2048 decimal)


Related Commands: BR (RF Data Rate) RB (Packetization Threshold), RO (Packetization Timeout), WN (Warning Data)



PL (TX Power Level) Command<RF Interfacing> The PL command is used to set/read the power level at which the RF module transmits data

PW (Pin Wake-up) Command<Sleep (Low Power)> Under normal operation, an RF module in Cyclic Sleep Mode cycles from an active state to a low-power state at regular intervals until data is ready to be received. If the PW parameter is set to 1, the SLEEP pin (pin 8) can be used to awaken the module from Cyclic Sleep. When the SLEEP Pin is de-asserted (low), the module will be fully operational and will not go into Cyclic Sleep.

Once the SLEEP pin is asserted, the module will remain active for the period of time specified by the ST (Time before Sleep) parameter and will return to Cyclic Sleep Mode (if no data is ready to be transmitted). PW Command is only valid if Cyclic Sleep has been enabled.

AT Command: ATPL




0 1 mW

1 10 mW

2 100 mW

3 500 mW

4 1000 mW (1 Watt)



AT Command: ATPW




0 Disabled

1 Enabled



Related Commands: SM (Sleep Mode), ST (Time before Sleep)



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 received by the UART

• RO character times of silence detected on the UART receive lines (after receiving at least 1 Byte of data)

If PK (Max. RF Packet Size) is lowered below the value of RB, RB is automatically lowered to match the PK value. If (RO = 0), RB bytes must be received before beginning transmission.

Note: RB and RO criteria only apply to the first packet of a multi-packet transmission. If data remains in the DI Buffer after the first packet, transmissions will continue in a streaming manner until there is no data left in the DI Buffer (UART receive buffer).

RC (Ambient Power - Single Channel) Command<Diagnostics> The RC command is used to examine and report the power level on a given channel.

Sample output:

-78 dBm [when CF = 0] 4e [when CF = 1] -78 [when CF = 2]

RE (Restore Defaults) Command<Diagnostics> The RE command is used to restore all configurable parameters to their factory default settings.

The RE Command does not cause default values to be stored to non-volatile (persistent) memory. For the restored default settings to persist in the module’s non-volatile memory and be saved in the event of RF module reset or power-down, the WR (Write) command must be issued prior to power-down or reset.

AT Command: ATRB


Parameter Range:0 - PK parameter value (up to 0x800 Bytes)

Default Parameter Value: 0x800 Bytes


Related Commands: BR (RF Data Rate), PK (RF Packet Size), RO (Packetization Timeout)

AT Command: ATRC

Parameter Range (read-only): 0 - 0x31 [dBm]


Related Commands: RM (Ambient Power - All Channels)

AT Command: ATRE

Binary Command: 0x0E (14 decimal)



RM (Ambient Power - All Channels) Command<Diagnostics> The RM command is used to examine and report power levels on all channels. If no parameter is given, the channels are scanned one time. If a parameter is given, the channels are repeatedly scanned for that number of seconds. The maximum power level seen for each channel is reported (i.e. peak hold).

A graphical spectrum analyzer can be implemented by repeatedly sending the RM command (with no arguments) and reading the resultant 50 power levels (this is easiest to do when CF = 1 or 2).

Sample output [when CF = 0]: Ch 0: -100 dBm Ch 1: -103 dBm...Ch 49: -99 dBm

Sample output [when CF = 1]: 6467 ... 63

Sample output [when CF = 2]: 100-103 … -99

RN (Delay Slots) Command<Networking and Security> The RN command is used to set/read the time delay that the transmitting RF module inserts before attempting to resend a packet. If the transmitting module fails to receive an acknowledgment after sending a packet, it inserts a random number of delay slots (ranging from 0 to (RN minus 1)) before attempting to resend the packet. Each delay slot is 5 msec (when BR=1) and 54 msec (when BR=0).

If two modules attempt to transmit at the same time, the random time delay after packet failure allows only one module to transmit the packet successfully; while the other module waits until the channel available for RF transmission.

RN Command is only applicable if retries have been enabled [RR (Retries) Command] or if forced delays will be inserted into a transmission [TT (Streaming Limit) Command].

AT Command: ATRM

Parameter Range: no parameter - 0x7D0)


Related Commands: RC (Ambient Power - Single channel)

AT Command: ATRN


Parameter Range:0 - 0xFF [38 ms slots]

Default Parameter Value: 0 (no delay slots inserted)


Related Commands: RR (Retries), TT (Streaming Limit)



RO (Packetization Timeout) Command<Serial Interfacing> The RO command is used to set/read the Packetization Timeout setting. RF transmission begins when data is in the DI buffer and either of the following criteria are met:

• RO character times of silence on the UART receive lines (after receiving at least 1 byte)

• RB characters have been received by the UART

RB and RO criteria only apply to the first packet of a multi-packet transmission. If data remains in the DI Buffer (UART receive) after the first packet, transmissions will continue in a streaming manner until there is no data left in the DI Buffer.

When RO is the transmission-beginning criteria: The actual time between the reception of the last character from the UART and the beginning of RF transmission will be at least 800 µsec longer than the actual RO time to allow for transmission setup. Additionally, it is subject to 100-200 µsec of additional uncertainty, which could be significant for small values of RO at high UART bit rates.

The correct UART character time (10, 11, or 12 bits) is calculated based on the following criteria:

• 1 start bit

• 8 data bits

• 0 or 1 parity bit [as determined by the NB (Parity) Command)

• 1 or 2 stop bits [as determined by SB (Stop Bits) Command]

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 signal strength and the sensitivity level of the RF module. PWM pulses vary from zero to 95 percent. Zero percent means the received RF signal is at or below the published sensitivity level of the module.

The following table shows dB levels above sensitivity and PWM values (The total time period of the PWM output is 8.32 ms. PWM output consists of 40 steps and therefore the minimum step size is 0.208 ms.):

AT Command: ATRO


Parameter Range:0 - 0xFFFF [ x UART character times ]



Related Commands: RB (Packetization Threshold)

AT Command: ATRP


Parameter Range:0 - 0xFF [x 100 milliseconds]

Default Parameter Value: 0x20 (32d)




A non-zero value defines the time that PWM output is active with the RSSI value of the last received RF packet. After the set time when no RF packets are received, PWM output is set low (0 percent PWM) until another RF packet is received. PWM output is also set low at power-up. A parameter value of 0xFF permanently enables PWM output and always reflects the value of the last received RF packet.

The Config/RSSI pin is shared between PWM output and Config input. When the module is powered, the Config pin is an input. During the power-up sequence, if RP parameter is a non-zero value, the Config pin is configured as an output and set low until the first RF packet is received. With a non-zero RP parameter, the Config pin is an input for RP ms after power up.

RR (Retries) Command<Networking and Security> The RR command is used to set/read the maximum number of retries sent for a given RF packet. When RR Command is enabled (RR>0), RF packet retries and ACKs (acknowledgments) are enabled.

Exceptions: If the MT command in enabled (MT>0) or if a broadcast Destination Address is used (DT = 0xFFFF); RF packet retries and ACKs are disabled.

After transmitting a packet, the transmitting RF module waits to receive an acknowledgment from a receiving module. If the acknowledgment is not received in the period of time specified by RN (Delay Slots) Command, the original packet is transmitted again. The RF packet is transmitted repeatedly until an acknowledgment is received or until the packet is sent RR times.

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.

dBm above sensitivity PWM percentage (high period / total period)

10 20%

20 35%

30 50%

AT Command: ATRR


Parameter Range:0 - 0xFF

Default Parameter Value: 0x0A (10 decimal)


AT Command: ATRT




0 Disabled



SB (Stop Bits) Command<Serial Interfacing> The SB Command is used to set/read the number of stop bits in the data packet.

SH (Serial Number High) Command<Diagnostics> SH Command is used to set/read the serial number high word of the RF module.

1 Enable Binary Programming

2 Enable RTS Flow Control



Related Commands: SM (Sleep Mode), ST (Time before Sleep)

AT Command: ATSB




0 1 stop bit

1 2 stop bits



AT Command: ATSH


Parameter Range (read-only): 0 - 0xFFFF

Default Parameter Value: varies


Related Commands: SL (Serial Number Low)

AT Command: ATRT



SL (Serial Number Low) Command<Diagnostics> SL Command is used to set/read the serial number low word of the RF module.

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

AT Command: ATSL



Default Parameter Value: varies


Related Commands: SH (Serial Number High)

AT Command: ATSM


Parameter Range: 0 - 8 (3 is reserved)


0 Disabled

1 Pin Sleep

2 Serial Port Sleep

3 [reserved]

4 Cyclic 1.0 second sleep

(RF module wakes every 1.0 seconds)








ST (Time before Sleep) Command<Sleep Mode (Low Power)> The ST Command is used to set/read the period of time (in milliseconds) in which the RF module remains inactive before entering Sleep Mode.

For example, if the ST Parameter is set to 0x64 (100 decimal), the module will enter into Sleep mode after 10 seconds of inactivity (no transmitting or receiving).

This command can only be used if Cyclic Sleep or Serial Port Sleep Mode settings have been selected using SM (Sleep Mode) Command.

TP (Board Temperature) Command<Diagnostics> TP Command is used to read the current temperature of the board.

Sample Output:

26 C [when ATCF = 0]1A [when ATCF = 1] 26 [when ATCF = 2].


Related Commands:

Pin Sleep - PC (Power-up Mode), PW (Pin Wake-up)

Serial Port Sleep - ST (Time before Sleep)

Cyclic Sleep - ST (Time before Sleep), LH (Wake-up Initializer Timer), HT (Time Before Wake-up Initializer), PW (Pin Wake-up)

AT Command: ATST


Parameter Range:(ATAT+3) - 0x7FFF [x 100 milliseconds]

Default Parameter Value: 0x64 (100 decimal)


Related Commands: SM (Sleep Mode), LH (Wake-up Initializer Timer), HT (Time before Wake-up Initializer)

AT Command: ATTP


Parameter Range (read-only): 0- 0x7F


Related Command: WN (Warning Data)

AT Command: ATSM



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 acknowledged within the number of retransmits specified by the RR (Retries) parameter. The number of packets therefore are counted that were not successfully received and subsequently discarded.

The TR parameter is not non-volatile and is reset to zero when the RF module is reset.

TT (Streaming Limit) command<Networking and Security> The TT command is used to set/read the limit on the number of bytes that can be sent out before a random delay is issued.

If an RF module is sending a continuous stream of RF data, a delay is inserted which stops its transmission and allows other modules time to transmit (once it sends TT bytes of data). Inserted random delay lasts between 1 and 'RN + 1' delay slots, where each delay slot lasts 38 ms.

The TT command can be used to simulate full-duplex behavior.

TX (Transmit Only) command<RF Interfacing> The TX command is used to set/read the transmit/receive behaviors of the RF module. Setting a module to TX-only (TX = 1) may reduce latency because the transmitting module will never be confined to receiving data from other modules.

AT Command: ATTR





Related Commands: RR (Retries)

AT Command: ATTT



Default Parameter Value: 0 (disabled)


Related Commands: RN (Delay Slots)

AT Command: ATTX






VL (Firmware Version - Verbose)<Diagnostics> The VL command is used to read the verbose firmware version of the RF module.

VR (Firmware Version - Short) Command<Diagnostics> The VR command is used to read the firmware version of the RF module.

Note: Firmware versions contain four significant digits - “A.B.C.D”. If B=2, the module is programmed for operation in Australia only.

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 and 3 are currently active):

13OK

0 TX and RX

1 TX-only



AT Command: ATVL

Parameter Range: returns string



AT Command: ATVR




AT Command: ATWA

Parameter Range:Returns string - one warning number per line.

AT Command: ATTX



WN (Warning Data) command<Diagnostics> WN command is used to report the following data for all active and sticky warnings:

• Warning number and description

• Number of occurrences since the last WN or WS command

• Whether the warning is currently active

Warnings, which are not currently active and have not been active since the last issuance of the WN or WS commands, are not displayed. The WN command also resets all non-zero warning counts; except for warnings that are presently active, which are set to 1.

Sample output:

Warning 4: Over-temperature 5 occurrences; presently inactive.

AT Command: ATWN

Parameter Range: returns string

Warning # Description

1 Under-voltage. This is caused if the supply voltage falls below the minimum threshold for the lowest power level (2.8 V). If/when the voltage rises above the threshold, the warning is deactivated. The module will not transmit below this voltage threshold.

2 Over-voltage. This is caused if the supply voltage exceeds 5.75 V. Transmission is not allowed while this warning is active.

3 Under-temperature. This is caused if the temperature sensed by the module is less than -40 C. The module does not artificially limit operation while this warning is active, but module functionality is not guaranteed.

4 Over-temperature. This is caused if the temperature sensed by the module is greater than 105 C. The module does not allow transmission nor reception while this warning is active. The warning is deactivated when the temperature falls to 100 C.

5 Power reduced. This is caused if the transmit power has to be reduced from the level programmed by PL Command due to insufficient supply voltage. The 1 W power level requires 4.75 V or higher; 500 mW requires 3.0 V or higher; 100 mW, 10 mW and 1 mW require 2.8 V or higher.

6 Default calibration data in flash. This is caused if the module-specific power calibration data is either not present or is invalid, or if none of the parameters have been modified from their default values. Power levels may be incorrect.

7 Default configuration parameters in flash. This is caused if user-modifiable parameters (i.e. those stored by a 'WR' command) in flash are all the compiled-in default values. This is caused if the user configuration is found to be not present or invalid at power-up and there is no custom configuration, or if no user-modifiable parameters have been modified from the compiled-in defaults. Modification of one or more parameters without the subsequent WR to commit the changes to flash will not deactivate this warning, since it reflects the status of the parameters in flash. Note that this warning does not reflect usage of the custom configuration defaults, only usage of the compiled-in defaults.

8 Default factory configuration parameters in flash. This is caused if the factory parameters in flash are all the default values. This is caused if the factory configuration is found to be not present or invalid at power-up, or if no factory parameters have been modified.


API operation

WR (Write) command<(Special)> The WR command is used to write configurable parameters to non-volatile memory (Values remain in the module's memory until overwritten by another use of WR Command).

If changes are made without writing them to non-volatile memory, the module will revert back to previously saved parameters the next time the module is powered-on.

If the non-volatile user configuration is not correct, WR will re-attempt (up to 3x). If all three attempts fail, the command will return an ERROR alert.

WS (Sticky Warning Numbers) command<Diagnostics> The WS command reports warning numbers of all warnings active since the last use of the WS or WN command (including any warnings which are currently active). This command also resets all non-zero warning counts, except for warnings that are presently active, which are set to 1.

API operationBy 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 data is sent out the DO pin with no additional information.

Inherent to Transparent Operation are the following behaviors:

• If module parameter registers are to be set or queried, a special operation is required for transitioning the module into Command Mode; see Command mode on page 29.

• In point-to-multipoint systems, the application must send extra information so that the receiving module(s) can distinguish between data coming from different remotes.

As an alternative to the default Transparent Operation, API (Application Programming Interface) Operations are available. API operation requires that communication with the module be done through a structured interface (data is communicated in frames in a defined order). The API specifies how commands, command responses and module status messages are sent and received from the module using a UART Data Frame.

API frame specificationsTwo API modes are supported and both can be enabled using the AP (API Enable) command. Use the following AP parameter values to configure the module to operate in a particular mode:

• AP = 0 (default): Transparent Operation (UART Serial line replacement)API modes are disabled.

• AP = 1: API Operation

• AP = 2: API Operation (with escaped characters)

AT Command: ATWR


AT Command: ATWS

Parameter Range (read-only): 1 - 8



API operation

Any data received prior to the start delimiter is silently discarded. If the frame is not received correctly or if the checksum fails, the data is silently discarded.

API Operation (AP parameter = 1)

When this API mode is enabled (AP = 1), the UART data frame structure is defined as follows:

MSB = Most Significant Byte, LSB = Least Significant Byte

API Operation - with Escape Characters (AP parameter = 2)

When this API mode is enabled (AP = 2), the UART data frame structure is defined as follows::

MSB = Most Significant Byte, LSB = Least Significant Byte

Escape characters

When sending or receiving a UART data frame, specific data values must be escaped (flagged) so they do not interfere with the UART or UART data frame operation. To escape an interfering data byte, insert 0x7D and follow it with the byte to be escaped XOR’d with 0x20.

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 0xCB

0x11 needs to be escaped which results in the following frame:

0x7E 0x00 0x02 0x23 0x7D 0x31 0xCB

Note In the above example, the length of the raw data (excluding the checksum) is 0x0002 and the checksum of the non-escaped data (excluding frame delimiter and length) is calculated as:0xFF - (0x23 + 0x11) = (0xFF - 0x34) = 0xCB.

Checksum

Start Delimiter(Byte 1)

Length(Bytes 2-3)

Frame Data(Bytes 4-n)

Checksum(Byte n + 1)

0x7E MSB LSB API-specific Structure 1 Byte


Length(Bytes 2-3)



0x7E MSB LSB API-specific Structure 1 Byte

Characters Escaped If Needed


API operation

To test data integrity, a checksum is calculated and verified on non-escaped data.

To calculate: Not including frame delimiters and length, add all bytes keeping only the lowest 8 bits of the result and subtract from 0xFF.

To verify: Add all bytes (include checksum, but not the delimiter and length). If the checksum is correct, the sum will equal 0xFF.

API TypesFrame data of the UART data frame forms an API-specific structure as follows:

The cmdID frame (API-identifier) indicates which API messages will be contained in the cmdData frame (Identifier-specific data). Refer to the sections that follow for more information regarding the supported API types. Note that multi-byte values are sent big endian.

RF Module StatusAPI Identifier: 0x8ARF module status messages are sent from the module in response to specific conditions.

RF Module Status Frames

TX (Transmit) Request: 16-bit address

API Identifier Value: 0x01A TX Request message will cause the module to send RF Data as an RF Packet.

Length(Bytes 2-3)


MSB LSB 1 Byte


0x7E


API-specific Structure

Identifier-specific Data

cmdData

API Identifier

cmdID

cmdData0x8A

Length ChecksumStart Delimiter Frame Data

Identifier-specific DataAPI Identifier

MSB LSB0x7E 1 ByteAPI-specific Structure

Status (Byte 5)

0 = Hardware reset1 = Watchdog timer reset


API operation

TX Packet (16-bit address) Frames

Example: TX Packet API Frames

TX (Transmit) Status

API Identifier Value: 0x89When a TX Request is completed, the module sends a TX Status message. This message will indicate if the packet was transmitted successfully or if there was a failure.

TX Status Frames

Note “STATUS = 1” occurs when all retries are expired and no ACK is received.“STATUS = 3” occurs when a packet is purged due to a ‘Polled Remote’ not receiving a poll.

RX (Receive) Packet: 16-bit address

API Identifier Value: 0x81When the module receives an RF packet, it is sent out the UART using this message type.

cmdData0x01




Frame ID (Byte 5)

Identifies the UART data frame for the host tocorrelate with a subsequent ACK (acknowledgement).Setting Frame ID to ‘0' will disable response frame.

Destination Address (Bytes 6-7)

MSB first, LSB last.Broadcast = 0xFFFF

Options (Byte 8)

0 = Standard1 = Disable ACK

RF Data (Byte(s) 9-n)

Up to 2048 Bytes per packet

* Length [Bytes] = API Identifier + Frame ID + Option + RF Data

** “R” value was arbitrarily selected

Checksum

0x18

Byte 12

Destination Address

Bytes 6-7

0xFFFF

Option

0x00

Byte 8

Frame ID**

R (0x52)

Byte 5

Length*

Bytes 2-3

0x00 0x08

API Identifier

0x01

Byte 4

Start Delimiter

Byte 1

0x7E

RF Data

1 (0x31) 2 (0x32) 3 (0x33)

Bytes 9-11

cmdData0x89




Frame ID (Byte 5) Status (Byte 6)

0 = Success1 = No ACK (Acknowledgement) received

Identifies UART data frame being reported.Note: If Frame ID = 0 in the TX Request, noAT Command Response will be given.


API operation

RX Packet (16-bit address) Frames

cmdData0x81




bit 0 = ACKbit 1 = Indicate broadcastbits 2-7 [reserved]

Up to 2048 Bytes perpacket

Received Signal Strength Indicator -Hexadecimal equivalent of (-dBm) value.(For example: If RX signal strength = -40dBm, “0x28” (40 decimal) is returned)

Source Address (Bytes 5-6) RSSI (Byte 7)

MSB (most significant byte) first,LSB (least significant) last

Options (Byte 8) RF Data (Byte(s) 9-n)


RF communication modes

Network topologiesThe XTend RF Module supports three different network topologies: point-to-point, point-to-multipoint and peer-to-peer.

Point-to-point networksThis following section provides the RF communication type and RF mode for XTend RF Module point-to-point networks.

DefinitionPoint-to-point means an RF data link between two devices.

Sample network profile (Broadcast communications)Use the default values for all devices.

Sample network profile (Acknowledged communications)Assume the default value for all parameters that are not in this list. These profiles do not reflect addressing implementations.

1. Use XCTU or another terminal program to send the AM command. See the AM command for details.

2. Set the destination address to 0xFFFF, send: ATDT FFFF

Basic RF modes

Streaming, Multi-Transmit, Repeater.

Acknowledged RF mode


Point-to-multipoint networks

Acknowledged mode.

Point-to-multipoint networksThis following section provides the RF communication type and RF mode for XTend RF Module point-to-multipoint networks.

DefinitionPoint-to-multipoint means a network with RF data links between one base and multiple remotes.

Sample network profile (Broadcast communications)Assume the default value for all parameters that are not in this list. These profiles do not reflect addressing implementations.

Base:

1. Send ATMY 0 to set the source address to 0x00.

2. Send ATDT FFFF to set the destination address to 0xFFFF.

Remotes:

1. Use XCTU or another terminal program to send the AM command. See the AM command for details.

2. Send ATDT 0 to set the destination address to 0x00.


Base:



3. Send ATRR 3 to set the number of retries to 3.

Remotes:

1. Use XCTU or another terminal program to send the AM command.



Peer to peer networks


Basic RF modesStreaming, Multi-Transmit, Repeater, and Polling.

Acknowledged RF modeAcknowledged and Polling.

Peer to peer networksThis following section provides the RF communication type and RF mode for XTend RF Module peer-to-peer networks.

DefinitionIn Peer-to-peer networks, RF devices remain synchronized without the use of master/server dependencies. Each device shares the roles of master and slave. Digi's peer-to-peer architecture features fast synch times (35 ms to synchronize devices) and fast cold start times (50 ms before transmission).

Sample network profile (Broadcast communications)Assume the default value for all parameters that are not in this list. These profiles do not reflect addressing implementations.

Use the default values for all devices.


All devices:




Basic RF modesStreaming.


Addressing

Acknowledged RF modeAcknowledged.

AddressingEach RF packet contains addressing information that the receiving devices use to filter incoming RF data. Receiving devices inspect the Preamble ID (HP parameter), Vendor Identification Number (ID parameter) and Destination Address (DT parameter) in each RF packet. A receiving device discards all data that does not pass through all three network security layers.

The following image illustrates the addressing layers in the RF packet header.

Address recognitionThe transmitting device can address transmissions to a specific device or group of devices using the DT and MK commands. A receiving device only accepts a packet if it determines that the packet is addressed to it, either as a global or local packet. The receiving device makes this determination by inspecting the destination address of the packet and comparing it to its own address and address mask.

The transmitting device determines whether the packet is for a specific node (local address) or multiple nodes (global address) by comparing the packet's destination address (DT) and its own address mask (MK). This assumes you program the address masks on the transmitting device and receiving device to the same value for proper operation in each RF communication mode.

For more information, see the DT (Destination Address and MK (Address Mask) commands.

Basic communicationsBasic communications includes two sub-types:

• Broadcast. By default, the XTend RF Module communicates through Broadcast communications and within a peer-to-peer network topology. When any device transmits, all other devices within range receive the data and pass it directly to their host device.

• Addressed. If addressing parameters match, the device forwards the RF data it receives to the DOUT buffer; otherwise, it discards the RF data.

When using Basic communications, the integrator handles any functions, such as acknowledgments, at the application layer. The Broadcast modes provide transparent communications, meaning that the RF link replaces a wired link.


Streaming mode (default)

Streaming mode (default)Streaming mode is most appropriate for data systems that are more sensitive to latency and/or jitter than to occasional packet loss; for example: streaming audio or video.

Streaming mode connection sequenceEvents and processes in this mode are common to all of the other RF modes.

When streaming data, the firmware only observes the RB and RO parameters on the first packet.

After transmission begins, the transmission event continues without interruption until the DIN buffer is empty or the device reaches the streaming limit (TT parameter). As with the first packet, the payload of each subsequent packet includes up to the maximum packet size (PK parameter).

The TX (transmitting) device specifies the TT parameter as the maximum number of bytes the TX device can send in one transmission event. After the device reaches the TT parameter threshold, the TX device forces a random delay of 1 to RN delay slots; exactly 1 delay slot if RN = 0.

The TX device sends subsequent packets without an RF initializer since RX (receiving) devices remain synchronized with the TX device for the duration of the transmission (from preceding packet information). However, due to interference, some RX devices may lose data (and synchronization to the TX device), particularly during long transmission events.

Once the TX device has sent all pending data or has reached the TT limit, the transmission event ends. The TX device does not transmit again for exactly RN delay slots if the local (for example the TX device's) RN parameter is set to a nonzero value. The RX device(s) do not transmit for a random number of delay slots between 0 and (RN-1) if the local (for example the RX device's) RN parameter is set to a non-zero value. These delays lessen congestion following long bursts of packets from a single TX device, during which several RX devices may have become ready to transmit.

Multi-transmit modeUse Multi-transmit mode for applications that require reliable delivery without using retries and acknowledgments.

Characteristics Highest data throughput

Lowest latency and jitter

Reduced immunity to interference

Transmissions never acknowledged (ACK) by receiving device(s)

Required parameter values (TX device) RR = 0

Related commands Networking (DT, MK, MY), Serial interfacing (PK, RB, RO, TT)

Characteristics Reliable delivery through forcing the transmission of every RF packet.

Every RF packet is sent exactly MT + 1 times, with no delays between packets.

Diminished throughput and increased latency.

Required parameter values (TX device)

MT ≥ 1.

Related commands Networking (DT, MK, MY, RN, TT), Serial interfacing (BR, PK, RB, RO), RF interfacing (FS).


Repeater mode

Multi-transmit mode connection sequenceIn Multi-transmit mode, the device re-transmits each packet MT times, for a total of (MT+1) transmissions. There is no delay between retransmissions, and the TX (transmitting) device never receives RF data between retransmissions. Each retransmission includes an RF initializer. A transmission event may include follow-on packets, each of which retransmit MT times. Devices ignore the Forced Sync (FS) parameter in Multi-Transmit Mode.

The firmware does not apply the RB and RO parameters to follow-on packets, meaning that once transmission has begun, it continues without interruption until the DIN buffer is empty or the device reaches the streaming limit (TT parameter). As with the first packet, the payload of each follow-on packet includes up to the maximum packet size (PK parameter) bytes, and the TX device checks for more pending data near the end of each packet. The device does not send follow-on packets until it finishes all retransmissions of the previous packet.

The TX device specifies the streaming limit (TT) as the maximum number of bytes that the TX device can send in one transmission event, which may consist of many packets. If the device reaches the TT parameter limit, the TX device forces a random delay of 1 to RN delay slots (exactly 1 delay slot if RN is zero). In Multi-transmit mode, the firmware counts each packet only once when tracking the streaming limit (TT), no matter how many times it is retransmitted.

When an RX (receiving) device receives a Multi-transmit packet, it calculates the amount of time remaining in the Multi-transmit event, and inhibits its own transmissions for the duration of the Multi-transmit event, plus a random number of delay slots between 0 and (RN-1). If the local RN parameter is zero, the delay is only for the calculated duration of the event. An RX device only needs to receive one of the transmissions, and it keep the channel off until the TX device is complete. If follow-on packets are coming, the RX devices move to the new frequency and listen for the follow-on packet for a specific period of time.

Repeater modeUse Repeater mode in networks where you need intermediary devices to relay data to devices beyond the transmission range of the base device.

Characteristics Low power consumption.

Minimizes interference

Tags each RF packet with a unique Packet ID (PID).

Each repeater only repeats a packet once (the PID tracks the packet).

Increases latency and decreases throughput. The number of hops determine latency and throughput, not the number of repeaters. Multiple repeaters within range of a source node count as one hop.

All RF packets propagate to every device in the network (filtering rules apply).

Packet destination addresses (DT) determine which packets the device sends out the serial port and/or retransmits.

Broadcast communications: each packet comes out every node exactly once.

Addressed communications: all devices see every packet. Only the devices with a matching address forward it to the DOUT buffer.

Constraints Requires that each device have a unique MY parameter.

System must introduce only one packet at a time to the network for transmission. The PK parameter determines the maximum number of bytes.

Each hop (H) decreases network throughput by a factor of 1/(H+1). Additional repeaters add network redundancy without decreasing throughput.


Configure a repeater network

Repeater mode theory of operationYou can extend the effective range and reliability of your data system by forwarding traffic through one or more repeaters. Instead of using routing tables and path discovery to establish dynamic paths through a network, the repeater system uses a sophisticated algorithm to propagate each RF packet through the entire network.

The network supports RF packets up to 2048 bytes when the RF data rate is set at 9600 bps (BR = 0). The repeater network can operate using broadcast or addressed communications for multi-drop networks, and it works well in many systems with no special configuration.

When in Repeater mode, the network repeats each message among all available devices exactly one time. This mechanism eliminates the need for configuring specific routes. The following figure illustrates the Repeater network topology.

Configure a repeater networkIf an RF link is weak, a device is out-of-range or a difficult RF environment is present; you can use repeaters to extend the effective range and reliability of the network.

A network may consist of End Nodes (EN), End/Repeater Nodes (ERN) and a Base Node (BN). The base node initiates all communications. Both Repeater Nodes and End Nodes can source data, allowing connection to host devices. Repeater Nodes however, are able to repeat information in a simple store and forward fashion. As an example, one End Node (which can be a base or remote) must send a message to another End Node. Because the End Node is out of range of the base device, you can use a repeater to forward information from the Base to the End Node.

You can configure a repeater network to operate using Basic Broadcast or Basic Addressed communications. The addressing capabilities of the device allow integrators to send a packet as a global packet (DT = 0xFFFF) and shift out of every device in the network (Basic Broadcast). Alternately, you can send the packet with a specific DT parameter so that only a specific remote node accepts it (Basic Addressed).

Suggestions Insert a variable delay before repeating packets to avoid collisions (based on RSSI).

Buffer any incoming serial data and delay response packet transmissions until the previous packet clears out of the network.

For best results, use the RO and RB commands to ensure that the RF packets align with the underlying protocol packets as the network can only accept one RF packet at a time.


MD = 5 or 6.

MY = unique value. You can accomplish this by issuing the AM and WR commands to all devices in the network.

Related commands Networking (MD, DT, MY, AM), Serial interfacing (RN, PK, RO, RB)



Repeater network: configure communicationsTo configure a Repeater network for Basic broadcast communications:

1. Assign each device a unique MY (source) address. Use the AM command to configure a unique source address based on the device serial number. This is essential because a unique packet ID on each RF packet is based on the originator’s MY value.

2. Set DT = 0xFFFF to enable Basic Broadcast communications OR Basic Addressed communications (DT specifies a specific destination).

3. Configure PK, RO and RB to ensure that the RF packet aligns with the protocol packet. For example:PK=0x100RB=0x100RO depends on baud rate

4. Set MD = 5 to configure one or more devices that you do not intend to be repeaters as repeater End Nodes in the system.

5. Set MD = 6 to configure remote nodes as destinations. This ensures that the remote node waits for the repeater traffic to subside before it transmits a response.

To configure a Repeater network for Basic addressed communications, use DT to assign unique addresses to each device in the network.

Repeater network algorithm detailsThe firmware uses an algorithm to propagate each RF packet through the entire repeater network. Within a repeater network, the firmware only defines Repeater Nodes and repeater End Nodes. Repeater Nodes forward messages on to other devices within range; End Nodes do not.

The algorithm maintains a list of messages previously received in a buffer. The firmware discards messages already in the buffer. This eliminates End Nodes receiving multiple copies of a packet from more than one source, and also eliminates multiple repeaters within range of each other from continually passing messages in an infinite loop.

Packet ID (PID) is composed of the TX (transmitting) device MY address and the packet sequence number.

The firmware ignores incoming packets with a PID already in the buffer.

Each device maintains a PID buffer 4-deep of previously received packets (managed as FIFO).

The firmware may shift packets out the serial port and/or repeat them depending on the DT parameter in the RF packet. The following table shows the basis for these decisions.

Repeat delay based on RSSIA transmitted packet may be received by more that one repeater at the same time. In order to reduce the probability that the repeaters will transmit at the same instant, resulting in a collision and possible data loss; the firmware uses an algorithm that allows a variable back-off prior to a repeater retransmitting the packet. The algorithm allows devices that receive the packet with a stronger RF signal (RSSI) to have the first opportunity to retransmit the packet.

Address Match Send out serial port? Repeat?

Global Yes Yes

Local Yes No

None No Yes



Use the RN (Delay Slots) parameter to configure this delay. Set RN = 0 (no delays) for small networks with few repeaters or repeaters that are not within range of each other. Set RN = 1 for systems with two to five repeaters that may be within range of each other.

The actual length of the delay is computed by the formula:

Delay (ms) = L * DS

DS = (-41-RSSI)/10*RN)+RandomInt(0,RN)

Where L is the length of the transmitted packet in milliseconds, DS is the number of delay slots to wait, RSSI is the received signal strength in dBm, RN is the value of the RN register and RandomInt (A,B) is a function that returns a random integer from A to B-0

Response packet delayAs a packet propagates through the repeater network, if any node receives the data and generates a quick response, the network needs to delay the response so as not to collide with subsequent retransmissions of the original packet. To reduce collisions, both repeater and end node devices in a repeater network delay transmission of data shifted in the serial port to allow any repeaters within range to complete their retransmissions.

The time for this delay is computed by the formula:

Maximum Delay (ms) = L * DS

DS = ((-41-(-100))/10)*RN)+RN+1

Where L is the length of the transmitted packet in milliseconds, DS is the number of delay slots to wait, RSSI is the received signal strength in dBm, and RN is the value of the RN register.

Use case - Broadcast Repeater network

Consider modules R1 through R10 each communicating to a PLC using the ModBus protocol and spaced evenly in a line. All ten modules are configured as 'destinations and repeaters' within the scope of Basic Broadcast Communications (MD=5, AM, DT=0xFFFF, PK=0x100, RO=0x03, RB=0x100, RN=1). The Base Host (BH) shifts payload that is destined for R10 to R1. R1 initializes RF communication and transmits payload to nodes R2 through R5 which are all within range of R1. The modules R2 through R5 receive the RF packet and retransmit the packet simultaneously. They also send the data out the serial ports, to the PLCs. The following table shows commands used to configure repeater functions.

ATCommand

BinaryCommand

AT CommandName Range

# Bytes Returned

FactoryDefault

AM 0x3A (58d) Auto-set MY - - -

DT 0x00 (0d) Destination Address 0 - 0xFFFF 2 0

MD 0x3C (60d) RF Mode 0 - 6 1 0

MY 0x2A (42d) Source Address 0 - 0xFFFF 2 0xFFFF

RN 0x19 (25d) Delay Slots 0 - 0xFF [slots] 1 0

WR 0x08 (8d) Write - - -


Polling mode (basic)

Bandwidth considerationsUsing broadcast repeaters in a network reduces the overall network data throughput as each repeater must buffer an entire packet before retransmitting it. For example: if the destination is within range of the transmitter and the packet is 32-bytes long, the transmission takes 12 ms on a device operating at 115,200 baud. If the same packet must propagate through two repeaters, it takes 12 ms to arrive at the first repeater, 12 ms to get to the second and a final 12 ms to reach the destination for a total of 36 ms. Accounting for UART transfer times (~1ms/byte at 9600 baud), the time for a server to send a 32-byte query and receive a 32-byte response is about 200 ms, allowing for 5 polls per second. With the two repeaters in the path, the same query/response sequence would take about 500 ms for two polls per second.

Generally, network throughput decreases by a factor of 1/(R+1), with R representing the number of repeaters between the source and destination.

Polling mode (basic)Polling mode (basic) and Polling mode (acknowledged) operate in the same way. The only difference between the two modes is in their means of achieving reliable delivery of data. Polling mode (basic) uses multiple transmissions to achieve reliable delivery.

Characteristics Uses a high percentage of available network bandwidth.

Eliminates collisions.

Works with reliable delivery (RR or MT parameters).

Supports binary data transfers.

Base device requests packets from remote device by polling a sequential range of addresses.

Base device is configured to specify the range of addresses being polled.

Uses inter-character delay to create RF packet lengths aligned with protocol packet lengths up to 2048 bytes long.

Constraints The minimum time interval between polling cycles is configurable. However, if the remote devices cannot all be processed within that time interval, the polling cycle is ineffective (i.e. it will impose no additional delay). In order to ensure a pause between polling cycles, you must set PD to a value that is large enough to accommodate the pause.

Recommended use Use for point-to-multipoint applications that require Reliable Delivery of data. Use this mode when it is critical that a base device be able to discern data coming from multiple devices.

Required parameter values (Base)

MD (RF Mode) = 3

PB (Polling Begin Address)

PE (Polling End Address)

Required parameter values (Remote)

MD (RF Mode) = 4

Related commands Networking: MT, PD, DT, MY, and AM


Acknowledged communications: Acknowledged mode

Polling mode theory of operationA Polling Base device cycles through a sequential range of addresses. The Polling Base polls each Polling Remote device, waits for a response, then poll the next remote address in the sequence. Each Polling Remote responds by sending the data from its DIN buffer following the RB and RO parameters. When there is no eligible data to send, the Polling Remote does not respond. The Polling Base polls the next address in the polling sequence after a short delay.

Configure a Polling BaseTo configure a device as a Polling Base:

1. Set MD = 3.

2. Set MY = 0.

3. Set the sequential range of polling addresses using PB and PE.

4. (Optional) Enable Basic Reliable Delivery (MT ≥ 0). The firmware also supports Acknowledged Reliable Delivery. For more information, see Polling mode (acknowledged) on page 74.

5. (Optional) Use PD to configure a delay between polls to slow down the system, if needed.

6. (Optional) Enable API Mode to address remote devices within polling range on a packet-by-packet basis.

Configure a Polling RemoteTo configure a device as a Polling Remote:

1. Set MD = 4.

2. Configure sequential source addresses for all remote devices using MY.

3. Set DT to point to the Polling Base (DT = 0x0000).

4. (Optional) Enable Basic Reliable Delivery (MT >= 0). The firmware also supports Acknowledged Reliable Delivery. For more information, see Polling mode (acknowledged) on page 74.

Acknowledged communications: Acknowledged modeUse Acknowledged mode for applications that need reliable delivery. If messages are smaller than 256 bytes, use the RB and RO commands to align RF packets to application packets.

Characteristics Reliable delivery through positive acknowledgments for each packet.

Throughput, latency and jitter vary depending on the quality of the channel and the strength of the signal.


RR (Retries) >= 1

Related commands Networking (DT, MK, RR), Serial Interfacing (PK, RN, RO, RB, TT)


Acknowledged communications: Acknowledged mode

Acknowledged mode connection sequenceAfter sending a packet while in Acknowledged mode, the TX (transmitting) device listens for an acknowledgment (ACK). If it receives the ACK, it either moves on to sending a subsequent packet if more transmit data is pending or waits for exactly RN random delay slots before allowing another transmission if no more data is pending transmit.

If the TX device does not receive the ACK within the allotted time, it retransmits the packet with a new RF initializer following the ACK slot. There is no delay between the first ACK slot and the first retransmission. Subsequent retransmissions incur a delay of a random number of delay slots, between 0 and RN. If RN is set to 0 on the TX device, there are never any back-off delays between retransmissions. During back-off delays, the TX device goes into Idle Mode and may receive RF data. This can have the effect of increasing the back-off delay, as the device cannot return to Transmit (or retransmit) mode as long as it is receiving RF data.

After receiving and acknowledging a packet, the RX (receiving) device moves to the next frequency and listens for either a retransmission or new data for a specific period of time. Even if the TX device indicates that it has no more pending transmit data, it may not have received the previous ACK, and so may retransmit the packet, possibly with no delay after the ACK slot. In this case, the RX device always detects the immediate retransmission, which holds off the communications channel and reduces collisions. RX devices acknowledge each retransmission they receive, but they only pass the first copy of a packet they receive out the UART.

The device does not apply the RB and RO parameters to subsequent packets, meaning that once transmission begins, it continues uninterrupted until the DIN buffer is empty or it reaches the streaming limit (TT parameter. As with the first packet, the payload of each subsequent packet includes up to the maximum packet size (PK parameter), and the TX device checks for more pending data near the end of each packet.

The TT parameter specifies the maximum number of bytes that the TX device sends in one transmission event, which may consist of many packets and retries. If a device reaches the TT parameter limit, the TX device forces a random delay of 1 to RN delay slots (exactly 1 delay slot if RN is zero). Each packet counts only once toward TT, no matter how many times the packet is retransmitted.

Subsequent packets in Acknowledged mode are similar to those in Streaming mode, with the addition of an ACK between each packet, and the possibility of retransmissions. The device sends subsequent packets without an RF initializer, as the RX devices are already synchronized to the TX device from the preceding packet(s) and they remain synchronized for the duration of the transmission event. Each packet retransmission includes an RF initializer.

Once the TX device sends all pending data or reaches the TT limit, the acknowledged transmission event is complete. The TX device does not transmit again for exactly RN delay slots, if the local RN parameter is set to a non-zero value. The RX device does not transmit for a random number of delay slots between 0 and (RN-1), if the local RN parameter is set to a non-zero value. The intent of these delays is to lessen congestion following long bursts of packets from a single TX device, during which several RX devices may have themselves become ready to transmit.


Polling mode (acknowledged)

Polling mode (acknowledged)Polling mode (acknowledged) and Polling mode (basic) operate in the same way. The difference between the two modes is in their means of achieving the reliable delivery of data. In Polling mode (acknowledged), the firmware achieves reliable delivery using retries and acknowledgments.

For configuration and theory of operation information, see Polling mode theory of operation on page 72, Configure a Polling Base on page 72 and Configure a Polling Remote on page 72.

Characteristics Uses a high percentage of available network bandwidth.

Eliminates collisions.

Works with reliable delivery (RR or MT parameters).

Supports binary data transfers.

Base device requests packets from remote device by polling a sequential range of addresses.

Base device is configured to specify the range of addresses being polled.

Uses inter-character delay to create RF packet lengths aligned with protocol packet lengths up to 2048 bytes long.

Constraints The minimum time interval between polling cycles is configurable. However, if the remote devices cannot all be processed within that time interval, the polling cycle is ineffective (i.e. it will impose no additional delay). In order to ensure a pause between polling cycles, PD must be set to a value which is large enough to accommodate the pause.

Recommended use Use for point-to-multipoint applications that require Reliable Delivery of data. Use this mode when it is critical that a base device be able to discern data coming from multiple devices.

Required parameter values (Base)

MD (RF Mode) = 3,

PB (Polling Begin Address)

PE (Polling End Address)

Required parameter values (Remote)

MD (RF Mode) = 4

Related commands Networking (RR, PD, DT, MY, AM)


Agency certifications

FCC (United States) certificationThe XTend 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 Digi’s FCC Certification, integrators must comply with the following regulations:

1. The integrator must ensure that the text provided with this device [Figure 1] is placed on the outside of the final product and within the final product operation manual.

2. The XTend RF Module may only be used with antennas that have been tested and approved for use with this module [refer to FCC-approved antennas on page 76].

Integrator labeling requirements

WARNING! The Original Equipment Manufacturer (OEM) must ensure that FCC labeling requirements are met. This includes a clearly visible label on the outside of the final product enclosure that displays the text shown in the figure below.

Figure 1: Required FCC Label for OEM products containing the XTend RF Module

Contains FCC ID: OUR-9XTEND OUR-9XTEND

The enclosed device complies with Part 15 of the FCC Rules. Operation is subject to the following two conditions: (i.) this device may not cause harmful interference and (ii.) this device must accept any interference received, including interference that may cause undesired operation.

FCC noticesIMPORTANT: The XTend RF Module has been certified by the FCC for use with other products without any further certification (as per FCC section 2.1091). Modifications not expressly approved by Digi could void the user’s authority to operate the equipment.

IMPORTANT: Integrators must test final product to comply with unintentional radiators (FCC sections 15.107 & 15.109) before declaring compliance of their final product to Part 15 of the FCC rules.


FCC (United States) certification

IMPORTANT: The RF module has been certified for remote and base radio applications. If the module will be used for portable applications, the device must undergo SAR testing.

This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to Part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful interference in a residential installation. This equipment generates, uses and can radiate radio frequency energy and, if not installed and used in accordance with the instructions, may cause harmful interference to radio communications. However, there is no guarantee that interference will not occur in a particular installation.

If this equipment does cause harmful interference to radio or television reception, which can be determined by turning the equipment off and on, the user is encouraged to try to correct the interference by one or more of the following measures: Re-orient or relocate the receiving antenna, Increase the separation between the equipment and receiver, Connect equipment and receiver to outlets on different circuits, or Consult the dealer or an experienced radio/TV technician for help.

Limited modular approvalPower output is conducted at the antenna terminal and can be adjusted from 1 milliwatt to 1 Watt at the integrator level. This is an RF module approved for limited modular use operating as a mobile transmitting device with respect to Section 2.1091 and is limited to integrator installation for mobile and fixed applications only. During final installation, end users are prohibited from access to any programming parameters. Professional installation adjustment is required for setting module power and antenna gain to meet EIRP compliance for high gain antenna(s).

Final antenna installation and operating configurations of this transmitter including antenna gain and cable loss must not exceed the EIRP of the configuration used for calculating MPE. Grantee (Digi) must coordinate with integrators to ensure the end users and installers of products operating with the module are provided with operating instructions to satisfy RF exposure requirements.

The FCC grant is valid only when the device is sold to integrators. Integrators are instructed to ensure the end user has no manual instructions to remove, adjust or install the device.

FCC-approved antennas

WARNING! This device has been tested with Reverse Polarity SMA connectors with the antennas listed in the tables of this section. When integrated into products, fixed antennas require installation preventing end users from replacing them with non-approved antennas. Antennas not listed in the tables must be tested to comply with FCC Section 15.203 (unique antenna connectors) and Section 15.247 (emissions).

Fixed base station and mobile applications

Digi RF Modules are pre-FCC approved for use in fixed base station and mobile applications. When the antenna is mounted at least 20cm (8") from nearby persons, the application is considered a mobile application.

Portable Applications and SAR Testing

When the antenna is mounted closer than 20cm to nearby persons, then the application is considered "portable" and requires an additional test be performed on the final product. This test is called Specific Absorption Rate (SAR) testing and measures the emissions from the module and how they affect the person.

RF exposure

This statement must be included as a CAUTION statement in integrator product manuals.


FCC (United States) certification

CAUTION! This equipment is approved only for mobile and base station transmitting devices. Antenna(s) used for this transmitter must be installed to provide a separation distance of at least 30 cm from all persons and must not be co-located or operating in conjunction with any other antenna or transmitter.

Note The separation distance indicated in the above is 30 cm, but any distance greater than or equal to 23 cm can be used (per MPE evaluation).



XT 78

ntenna variants. Contact Digi Sales for available

ication

/ Mobile

/ Mobile

/ Mobile

/ Mobile

/ Mobile

pplication

xed / Mobile

xed / Mobile

xed / Mobile

xed / Mobile

end RF Module User Guide

Antenna options (1-watt transmit power output or lower) The antennas in the tables below have been approved for use with this module. Digi does not carry all of these aantennas.

(1-watt transmit power output or lower)

Yagi antennas (approved when operating at 1-watt power output or lower)

Part Number Type Connector Gain Appl

A09-HSM-7 Straight half-wave RPSMA 3.0 dBi Fixed

A09-HASM-675 Articulated half-wave RPSMA 2.1 dBi Fixed

A09-HABMM-P6I Articulated half-wave w/ 6" pigtail MMCX 2.1 dBi Fixed

A09-HABMM-6-P6I Articulated half-wave w/ 6" pigtail MMCX 2.1 dBi Fixed

A09-HBMM-P6I Straight half-wave w/ 6" pigtail MMCX 2.1 dBi Fixed

A09-HRSM Right angle half-wave RPSMA 2.1 dBi Fixed

A09-HASM-7 Articulated half-wave RPSMA 2.1 dBi Fixed

A09-HG Glass mounted half-wave RPSMA 2.1 dBi Fixed

A09-HATM Articulated half-wave RPTNC 2.1 dBi Fixed

A09-H Half-wave dipole RPSMA 2.1 dBi Fixed

Part Number Type Connector Gain Required Antenna Cable Loss A

A09-Y6 2 Element Yagi RPN 6.1 dBi 0.1 dB* Fi



A09-Y6TM 2 Element Yagi RPTNC 6.1 dBi 0.1 dB* Fi


XT 79

xed / Mobile

xed / Mobile

lication

d

d

d

d

d

d

d

d

d

d

d

d

d

d

d

d

pplication


Omni-directional base station antennas (approved when operating at 1-watt power output or lower)



Part Number Type Connector Gain Required Antenna Cable Loss App

A09-F0 Fiberglass Base Station RPN 0 dBi - Fixe

A09-F1 Fiberglass Base Station RPN 1.0 dBi - Fixe





A09-F6 Fiberglass Base Station RPN 6.1 dBi 0.1 dB* Fixe



A09-W7 Wire Base Station RPN 7.1 dBi 1.1 dB* Fixe

A09-F0 Fiberglass Base Station RPSMA 0 dBi - Fixe

A09-F1 Fiberglass Base Station RPSMA 1.0 dBi - Fixe





Part Number Type Connector Gain Required Antenna Cable Loss A


XT 80

d

d

d

d

d

d

d

d

d

d

d

d

d

d

6.0 dB must s and antenna

lication

d

d

d

lication


Mag Mount antennas (approved when operating at 1-watt power output or lower)

A09-F6 Fiberglass Base Station RPSMA 6.1 dBi 0.1 dB* Fixe



A09-W7SM Wire Base Station RPSMA 7.1 dBi 1.1 dB* Fixe

A09-F0TM Fiberglass Base Station RPTNC 0 dBi - Fixe

A09-F1TM Fiberglass Base Station RPTNC 1.0 dBi - Fixe





A09-F6TM Fiberglass Base Station RPTNC 6.1 dBi 0.1 dB* Fixe



A09-W7TM Wire Base Station RPTNC 7.1 dBi 1.1 dB* Fixe

* FCC regulations stipulate a 36 dBm EIRP power requirement. Users implementing antenna gain greater than compensate for the added gain with cable loss. When operating at 1 W power output, the sum (in dB) of cable losgain shall not exceed 6.0 dB.


A09-M0SM Mag Mount RPSMA 0 dBi - Fixe

A09-M2SM Mag Mount RPSMA 2.1 dBi - Fixe




XT 81

d

d

d

d

d

d

d

d

d

lication

d

d

d

d

d

d

d

d

lication


Multi-path antennas (approved when operating at 1-watt power output or lower)


A09-M7SM Mag Mount RPSMA 7.1 dBi -1.1 dB* Fixe

A09-M8SM Mag Mount RPSMA 8.1 dBi -2.1 dB* Fixe

A09-M0TM Mag Mount RPTNC 0 dBi - Fixe

A09-M2TM Mag Mount RPTNC 2.1 dBi - Fixe



A09-M7TM Mag Mount RPTNC 7.1 dBi -1.1 dB* Fixe

A09-M8TM Mag Mount RPTNC 8.1 dBi -2.1 dB* Fixe

Part Number Type Connector Gain App

A09-DPSM-P12F omni directional permanent mount w/ 12ft pigtail RPSMA 3.0 dBi Fixe

A09-D3NF-P12F omni directional magnetic mount w/ 12ft pigtail RPN 3.0 dBi Fixe

A09-D3SM-P12F omni directional w/ 12ft pigtail RPSMA 3.0 dBi Fixe

A09-D3PNF omni directional permanent mount RPN 3.0 dBi Fixe

A09-D3TM-P12F omni directional w/ 12ft pigtail RPTNC 3.0 dBi Fixe

A09-D3PTM omni directional permanent mount RPTNC 3.0 dBi Fixe

A92-D4PNF 900 MHz / 2.4GHz permanent mount RPN 2.1 dBi Fixe

A92-D4P 900 MHz / 2.4GHz permanent mount RPSMA 2.1 dBi Fixe



XT 82

d

6.0 dB must loss and

on

bile

bile

bile

bile

bile

bile

bile

bile

bile

bile

bile

bile

bile

bile

bile

lication


Half-wave antennas (approved when operating at 100 mW power output or lower)

Yagi antennas (approved when operating at 100 mW power output or lower)

A92-D4PTM 900 MHz / 2.4GHz permanent mount RPTNC 2.1 dBi Fixe

* FCC regulations stipulate a 36 dBm EIRP power requirement. Users implementing antenna gain greater than compensate for the added gain with cable loss. When operating at 1 W power output, the sum (in dB) of cable antenna gain shall not exceed 6.0 dB.

Part Number Type Connector Gain Applicati

A09-QW Quarter-wave wire Permanent 1.9 dBi Fixed / Mo

A09-QRAMM 3 " Quarter-wave wire MMCX 2.1 dBi Fixed / Mo

A09-QSM-3 Quarter-wave straight RPSMA 1.9 dBi Fixed / Mo

A09-QSM-3H Heavy duty quarter-wave straight RPSMA 1.9 dBi Fixed / Mo

A09-QBMM-P6I Quarter-wave w/ 6" pigtail MMCX 1.9 dBi Fixed / Mo

A09-QHRN Miniature Helical Right Angle solder Permanent -1 dBi Fixed / Mo

A09-QHSN Miniature Helical Right Angle solder Permanent -1 dBi Fixed / Mo

A09-QHSM-2 2" Straight RPSMA 1.9 dBi Fixed / Mo

A09-QHRSM-2 2" Right angle RPSMA 1.9 dBi Fixed / Mo

A09-QHRSM-170 1.7" Right angle RPSMA 1.9 dBi Fixed / Mo

A09-QRSM-380 3.8" Right angle RPSMA 1.9 dBi Fixed / Mo

A09-QAPM-520 5.2" Articulated Screw mount Permanent 1.9 dBi Fixed / Mo

A09-QSPM-3 3" Straight screw mount Permanent 1.9 dBi Fixed / Mo

A09-QAPM-3 3" Articulated screw mount Permanent 1.9 dBi Fixed / Mo

A09-QAPM-3H 3" Articulated screw mount Permanent 1.9 dBi Fixed / Mo

Part Number Type Connector Gain App


XT 83
Part Number Type Connector Gain Application

A09-Y6 2 Element Yagi RPN 6.1 dBi Fixed / Mobile












A09-Y6TM 2 Element Yagi RPTNC 6.1 dBi Fixed / Mobile










XT 84



Part Number Type Connector Gain Application

IC (Industry Canada) certification

IC (Industry Canada) certificationThis device complies with Industry Canada license-exempt RSS standard(s). Operation is subject to the following two conditions: (1) this device may not cause interference, and (2) this device must accept any interference, including interference that may cause undesired operation of the device.

Le présent appareil est conforme aux CNR d'Industrie Canada applicables aux appareils radio exempts de licence. L'exploitation est autorisée aux deux conditions suivantes: (1) l'appareil ne doit pas produire de brouillage, et (2) l'utilisateur de l'appareil doit accepter tout brouillage radioélectrique subi, même si le brouillage est susceptible d'en compromettre le fonctionnement.

Labeling requirementsLabeling requirements for Industry Canada are similar to those of the FCC. A clearly visible label on the outside of the final product must display the following text:

Contains Model XT09 Radio, IC: 4214A-9XTEND

The integrator is responsible for its product to comply with IC ICES-003 and FCC Part 15, Sub. B - Unintentional Radiators. ICES-003 is the same as FCC Part 15 Sub. B and Industry Canada accepts FCC test report or CISPR 22 test report for compliance with ICES-003.

Transmitters for detachable antennasThis radio transmitter has been approved by Industry Canada to operate with the antenna types listed in the table above with the maximum permissible gain and required antenna impedance for each antenna type indicated. Antenna types not included in this list, having a gain greater than the maximum gain indicated for that type, are strictly prohibited for use with this device. The required antenna impedance is 50 ohms.

Le présent émetteur radio a été approuvé par Industrie Canada pour fonctionner avec les types d'antenne énumérés ci-dessous et ayant un gain admissible maximal et l'impédance requise pour chaque type d'antenne. Les types d'antenne non inclus dans cette liste, ou dont le gain est supérieur au gain maximal indiqué, sont strictement interdits pour l'exploitation de l'émetteur.

Detachable antennasUnder Industry Canada regulations, this radio transmitter may only operate using an antenna of a type and maximum (or lesser) gain approved for the transmitter by Industry Canada. To reduce potential radio interference to other users, the antenna type and its gain should be so chosen that the equivalent isotropically radiated power (e.i.r.p.) is not more than that necessary for successful communication.

Conformément à la réglementation d'Industrie Canada, le présent émetteur radio peut fonctionner avec une antenne d'un type et d'un gain maximal (ou inférieur) approuvé pour l'émetteur par Industrie Canada. Dans le but de réduire les risques de brouillage radioélectrique à l'intention des autres utilisateurs, il faut choisir le type d'antenne et son gain de sorte que la puissance isotrope rayonnée équivalente (p.i.r.e.) ne dépasse pas l'intensité nécessaire àl'établissement d'une communication satisfaisante.

Australia (RCM) certification

Power requirementsRegulations in Australia stipulate a maximum of 30 dBm EIRP (Effective Isotropic Radiated Power). The EIRP equals the sum (in dBm) of power output, antenna gain and cable loss and cannot not exceed 30 dBm.


Australia (RCM) certification

Figure 2: EIRP Formula for Australia

Note NOTE: The maximum EIRP for the FCC (United States) and IC (Canada) is 36 dBm.

These modules comply with requirements to be used in end products in Australia. All products with EMC and radio communications must have a registered RCM mark. Registration to use the compliance mark will only be accepted from Australian manufacturers or importers, or their agent, in Australia. In order to have an RCM mark on an end product, a company must comply with a or b below:

a. have a company presence in Australia.

b. have a company/distributor/agent in Australia that will sponsor the import of the end product.

Contact Digi for questions related to locating a contact in Australia.


Development guide

Development Kit contentsThe XTend Development Kit includes the hardware and software needed to rapidly create long range wireless links between devices.

Item Qty Description Part Number

XTend RF Module 1 Long Range 900 MHz RF Module (w/ RPSMA Connector) XT09-SI

XTend RF Module 1 Long Range 900 MHz RF Module (w/ MMCX antenna) XT09-MI

Antenna 1 900 MHz RPSMA, 6" Half-Wave, dipole, articulating, RPSMA A09-HASM-675

Antenna 1 900 MHz RPSMA, 7" Half-Wave, dipole, articulating, w/ pigtail, MMCX A09-HABMM-P5I

RS-232 Interface Board 2 Enables communication to RS-232 devices XTIB-R

RS-232 Cable (6') 2 Connects interface board to devices having an RS-232 serial port JD2D3-CDS-6F

Serial Loopback Adapter 1 Connects to the female RS-232 (DB-9) serial connector of the Digi Interface Board and can be used to configure the module to function as a repeater (for range testing)

JD2D3-CDL-A

NULL Modem Adapter (male-to-male)

1 Connects to the female RS-232 (DB-9) serial connector of the Digi Interface Board and can be used to connect the module to another DCE (female DB9) device

JD2D2-CDN-A

NULL Modem Adapter (female-to-female)

1 Used to bypass radios to verify serial cabling is functioning properly JD3D3-CDN-A

Male DB-9 to RJ-45 Adapter 1 Facilitates adapting the DB-9 Connector of the Digi Interface Board to a CAT5 cable (male DB9 to female RJ45)

JE1D2-CDA-A

Female DB-9 to RJ-45 Adapter

1 Facilitates adapting the DB-9 Connector of the Digi Interface Board to a CAT5 cable (female DB9 to female RJ45)

JE1D3-CDA-A

Power Adapter 2 Allows Interface Board to be powered by a 110 Volt AC power supply(not included with international (-INT) development kits)

JP4P2-9V10-6F


Interface hardware

Interface hardwareThe product model Development Kit includes a pair of RS-232 interface boards that support the RS-232, RS-485 and RS-422 protocols. When you mount the devices to the interface boards, the boards provide the following development tools:

• Fast and direct connection to serial devices (such as PCs) and easy access to the device registries. The parameters stored in the registry allow you to customize the devices to suit the specific needs of your data systems.

• External DIP switch to automatically configure common device profiles.

• Signal conversion between TTL levels and RS-232 levels.

The Digi Interface board can connect the device to any device that has an available RS-232, RS-485 or RS-422 connection.

This documentation refers to a product model mounted to an interface board as a "Module Assembly."

XTIB-R RS-232/485 Interface BoardThe following figure shows a front view of the board. The table explains the numbered callouts in the figure.

CD 1 Contains documentation, software and tools needed for RF operation. MD0010

Quick Start Guide 1 Familiarizes users with some of the module's most important functions. MD0016

Item Qty Description Part Number

Number Description

1 Configuration switch

2 I/O and Power LEDs

3 DB-9 Serial port

4 RSSI LEDs


XTIB-R RS-232/485 Interface Board

Configuration switchThe Configuration switch provides an alternate method for entering Command mode. To enter Command mode at the device's default RF data rate, hold the Configuration switch down for two seconds.

I/O and Power LEDsThe LEDS visualize status information and indicate device activity as follows:

Serial portThe serial port is a standard female DB-9 (RS-232) connector. You can also use this connector for RS-485 and RS-422 connections.

RSSI LEDs

The RSSI LEDs indicate the amount of fade margin present in an active wireless link. Fade margin is the difference between the incoming signal strength and the device's receiver sensitivity. The LED indications are as follows:

Power connector7-28 VDC power connector (center positive, 5.5/2.1 mm). The XTIB-R interface board can accept voltages as low as 5 V. Contact Digi Technical Support to enable this option.

5 Power connector

LED color

LED location Indication

Yellow Top Serial data out (to the host)

Green Middle Serial data in (from the host)

Red Bottom Power/TX indicator (the red light is on when powered, it pulses on and off briefly during RF transmission)

Number of LEDs on Indicates

3 Very strong signal (> 30 dB fade margin)

2 Strong signal (> 20 dB fade margin)

1 Moderate signal (> 10 dB fade margin)

0 Weak signal (< 10 dB fade margin)

Number Description


XTIB-R Dip switch

XTIB-R Dip switch

The DIP switch automatically configures the device to operate in different modes during the power-on sequence. Each time the Module Assembly (interface board with a device) powers-on, intelligence on the board programs the attached device according to the positions of the DIP Switch.

The following figure illustrates the DIP Switch settings.

Automatic DIP switch configurationsEach time you power on the Module Assembly, the firmware sends AT commands to the on-board RF module as dictated by the positions of the DIP switches. The following figure shows the DIP switch with the various configurations.

The following table shows the commands that the firmware sends to the module as a result of DIP switch settings. DIP switches 3 and 4 are only used for RS-485/422 termination and do not affect the configuration of the device. In the tables, SW means switch.


Automatic DIP switch configurations

The following table shows the user-defined mode, when switches 5 and 6 are ON (up). The behavior of pin 9 (GPO1) varies depending on the state of the DIP switches and the CS command parameter upon power-up.

Switch condition Behavior Commands sent during power-up

Switches 1 and 2: Restore defaults / serial interfacing

SW1: ON (up)

SW2: ON (up)

Restore defaults

RE (restore defaults)

WR (write defaults to non-volatile memory)

SW1: ON (up)

SW2: OFF (down)

RS-232 operation

CS 0 (RS-232, CTS flow control)

SW1: OFF (down)

SW2: OFF (down)

RS-485/422 operation

CS 3 (RS-485 or RS-422 operation)

Switches 5 and 6: TX/TX modes

SW5: OFF (down)

SW6: OFF (down)

Multipoint base

MY 0 (Source address = 0)

DT FFFF (Destination address = broadcast address)

MT 3 (Enable 3 multi-transmit retries)

SW5: OFF (down)

SW6: ON (up)

Multipoint remote

AM (Generate unique source address)

DT 0 (Destination address = 0)

MT 0 (Disable multi-transmit)

RR A (Enable 10 unicast retries)

SW5: ON (up)

SW6: OFF (down)

Point-to-point AM (Generate unique source address)

DT FFFF (Set destination address to broadcast)

MT 3 (Enable 3 multi-transmit retries)

SW5: ON (up)

SW6: ON (up)

User defined No addressing commands are sent to the device, refer to the following table for details.

Switch condition CS Condition Command sent during power-up

SW1: ON (up)

SW2: OFF (down)

SW5: ON (up)

SW6: ON (up)

If CS = 0, 1, 2 or 4 CS parameter remains the same

If CS = 3 CS 0 (RS-232 operation with CTS flow control)

SW1: OFF (down) SW2: ON (up) SW5: ON (up) SW6: ON (up)

If CS = 2 CS parameter remains the same

If CS = 0, 1, 3 or 4 CS 3 (RS-485 or RS-422 operation)


Adapters

AdaptersThe 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 Modem Adapter (male-to-male)

Part Number: JD2D2-CDN-A (Black, DB-9 M-M)

The male-to-male NULL modem adapter is used to connect two DCE devices. A DCE device connects with a straight-through cable to the male serial port of a computer (DTE). The following image shows the Male NULL modem adapter and its pinouts.

NULL Modem Adapter (female-to-female)

Part Number: JD3D3-CDN-A (Gray, DB-9 F-F)

Use the female-to-female NULL modem adapter to verify that serial cabling is functioning properly. To test cables, insert the female-to-female NULL modem adapter in place of a pair of device assemblies (RS-232 interface board and product model) and test the connection without devices in the connection.

The following figure shows the adapter and its pinouts.

SW1: OFF (down)

SW2: OFF (down)

SW5: ON (up)

SW6: ON (up)

If CS = 2 CS parameter remains the same

If CS = 0, 1, 3 or 4 CS 3 (RS-485 or RS-422 operation)

Switch condition CS Condition Command sent during power-up


Adapters

Serial Loopback Adapter

Part Number: JD2D3-CDL-A (Red, DB-9 M-F)

Use the serial loopback adapter for range testing. During a range test, the serial loopback adapter causes the device to function as a repeater by looping serial data back into the device for retransmission.

The following image shows the adapter and its pinouts.

Male DB-9 to RJ-45 Adapter

Part Number: JD2D2-CDN-A (Yellow)

This adapter facilitates adapting the DB-9 connector of the Interface Board to a CAT5 cable (male DB9 to female RJ45).

For connection guidelines, see RS-485 (4-wire) and RS-422 operation on page 98.



Interface protocols

Female DB-9 to RJ-45 Adapter

Part Number: JD3D3-CDN-A (Green)

This adapter facilitates adapting the DB-9 Connector of the Interface Board to a CAT5 cable (female DB9 to female RJ45).

For connection guidelines, see ‘RS-485 (4-wire) & RS-422 Operation’ sections.


Interface protocolsThe product model Module Assembly supports the following interfacing protocols:

• RS-232

• RS-485 (2-wire) half-duplex

• RS-485 (4-wire) and RS-422

RS-232 operationThe following figures show the RS-232 DIP switch settings and the pins used on the female RS-232 (DB-9) serial connector. The Module Assembly reads and applies the DIP switch settings only during power-on.


RS-232 wiring diagrams

The following table provides the RS-232 signals and their implementations on the Module Assembly. Low-asserted signals have a horizontal line over the pin name.

RS-232 wiring diagramsThe following diagram shows the DTE device (RS-232, male DB-9 connector) wired to a DCE Module Assembly (female DB-9).

DB-9 pin

RS-232 name

XCTU name Description Implementation

1 DCD GPO2 Data-Carrier-Detect

Connected to DSR (pin6 of DB-9)

2 RXD DOUT Received Data Serial data exiting the Module Assembly (to host)

3 TXD DIN Transmitted Data Serial data entering into the Module Assembly (from host)

4 DTR GPI2 Data-Terminal-Ready

Can enable power-down on the Module Assembly

5 GND - Ground Signal Ground

6 DSR GPO2 Data-Set-Ready Connected to DCD (pin1 of DB-9)

7 RTS / CMD

GPI1 Request-to-Send/ Command Mode

Provides RTS flow control or enables Command mode

8 CTS GPO1 Clear-to-Send Provides CTS flow control

9 RI - Ring Indicator Optional power input that is connected internally to the positive lead of the front power connector


RS-485 (2-wire) operation

The following diagram shows the DCE Module Assembly (female DB-9 connector) wired to a DCE device (RS-232, male DB-9).

RS-485 (2-wire) operation When operating within the RS-485 protocols, all communications are half-duplex. The Module Assembly reads and applies the DIP switch settings only during power-on.

The following figure shows the RS-485 (2-wire) half-duplex DIP switch settings.



The following figure shows the RS-485 (2-wire) with termination (optional) DIP switch settings.

Enabling termination activates a 120 Ω resistor between T+ and T-.

The following figure shows the pins that the female RS-232 (DB-9) serial connector uses.

For the RJ-45 connector pin designations to use in RS-485/422 environments see Male DB-9 to RJ-45 Adapter on page 93 and Female DB-9 to RJ-45 Adapter on page 94.

The following table provides the RS-485 (2-wire half-duplex) signals and their implementations on the Module Assembly.

RS-485 wiring diagramsThe following diagram shows the Module Assembly in an RS-485 (2-wire) half-duplex environment.

DB-9 Pin RS-485 name Description Implementation

2 T/R- (TRA) Negative data line

Transmit serial data to and from the Module Assembly

5 GND Ground signal Ground

8 T/R+ (TRB) Positive data line Transmit serial data to and from the Module Assembly

9 PWR Power Optional power input that is connected internally to the front power connector

1, 3, 4, 6, 7 not used


RS-485 (4-wire) and RS-422 operation

RS-485 (4-wire) and RS-422 operationThe Module Assembly reads and applies the DIP switch settings only during power-on.

The following figure shows the RS-485 (4-wire) and RS-422 DIP switch settings.

The following figure shows the RS-485 (4-wire) and RS-422 DIP switch settings with termination (optional).

Enabling termination activates a 120 Ω resistor between T+ and T-.

The following figure shows the pins that the female RS-232 (DB-9) serial connector uses.

For the RJ-45 connector pin designations to use in RS-485/422 environments see Male DB-9 to RJ-45 Adapter on page 93 and Female DB-9 to RJ-45 Adapter on page 94.

The following table provides the RS-485/422 (4-wire) signals and their implementations on the Module Assembly.



RS-422 wiring diagramsThe following figure shows the Module Assembly in an RS-485 (4-wire) environment.

The following figure shows the Module Assembly in an RS-422 environment.

DB-9 pin

RS-485/422 name Description Implementation

2 T- (TA) Transmit negative data line Serial data sent from the Module Assembly

3 R- (RA) Receive negative data line Serial data received by the Module Assembly

5 GND Signal ground Ground

7 R+ (RB) Receive positive data line Serial data received by the Module Assembly

8 T+ (TB) Transmit positive data line Serial data sent from the Module Assembly

9 PWR Power Optional power input that is connected internally to the front power connector

1, 4, 6 not used


RF module RS-485/422 connection guidelines

RF module RS-485/422 connection guidelinesThe 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 suitable for cable distances up to 100 feet (30.5 m).

RS-485 offers multi-drop capability in which you can connect up to 32 nodes. Use the RS-422 protocol for point-to-point communications.

To integrate the product model with the RS-485/422 protocol, we suggest the following:

1. When using Ethernet twisted pair cabling: connect T+ and T- to each wire in a twisted pair. Likewise, connect R+ and R- to a twisted pair. For example, tie the green and white/green wires to T+ and T-.

2. For straight-through Ethernet cable (not cross-over cable), the following wiring pattern works well: Pin 3 to T+, Pin 4 to R+, Pin 5 to R-, Pin 6 to T-.

3. The connecting cable only requires 4 wires, even though there are 8 wires.

4. When using phone cabling (RJ-11), Pin 2 in the cable maps to Pin 3 on the opposite end of cable and Pin 1 maps to Pin 4 respectively.


XTend RF Module - Digi Internationalftp1.digi.com/support/documentation/90000958.pdf · 2016. 5....

Documents

Transcript of XTend RF Module - Digi Internationalftp1.digi.com/support/documentation/90000958.pdf · 2016. 5....