User's Manual
Table Of Contents
- 1. XTend RF Module
- 2. RF Module Operation
- 3. RF Module Configuration
- Programming Examples
- Command Reference Table
- Command Descriptions
- %V (Board Voltage) Command
- AM (Auto-set MY) Command
- AP (API Enable) Command
- AT (Guard Time After) Command
- BD (Interface Data Rate) Command
- BR (RF Data Rate) Command
- BT (Guard Time Before) Command
- CC (Command Sequence Character) Command
- CD (GPO2 Configuration) Command
- CF (Number Base) Command
- CN (Exit AT Command Mode) Command
- CS (GPO1 Configuration) Command
- CT (Command Mode Timeout) Command
- DB (Received Signal Strength) Command
- DT (Destination Address) Command
- E0 (Echo Off) Command
- E1 (Echo On) Command
- ER (Receive Error Count) Command
- FH (Force Wake-up Initializer) Command
- FL (Software Flow Control) Command
- FS (Forced Synch Time) Command
- FT (Flow Control Threshold) Command
- GD (Receive Good Count) Command
- HP (Hopping Channel) Command
- HT (Time before Wake-up Initializer) Command
- HV (Hardware Version) Command
- ID (Modem VID) Command
- KY (AES Encryption Key) Command
- LH (Wake-up Initializer Timer) Command
- MD (RF Mode) Command
- MK (Address Mask) Command
- MT (Multi-transmit) Command
- MY (Source Address) Command
- NB (Parity) Command
- PB (Polling Begin Address) Command
- PD (Minimum Polling Delay) Command
- PE (Polling End Address) Command
- PK (Maximum RF Packet Size) Command
- PL (TX Power Level) Command
- PW (Pin Wake-up) Command
- RB (Packetization Threshold) Command
- RC (Ambient Power - Single Channel) Command
- RE (Restore Defaults) Command
- RM (Ambient Power - All Channels) Command
- RN (Delay Slots) Command
- RO (Packetization Timeout) Command
- RP (RSSI PWM Timer) Command
- RR (Retries) Command
- RT (GPI1 Configuration) Command
- SB (Stop Bits) Command
- SH (Serial Number High) Command
- SL (Serial Number Low) Command
- SM (Sleep Mode) Command
- ST (Time before Sleep) Command
- TP (Board Temperature) Command
- TR (Transmit Error Count) Command
- TT (Streaming Limit) Command
- TX (Transmit Only) Command
- VL (Firmware Version - Verbose)
- VR (Firmware Version - Short) Command
- WA (Active Warning Numbers) Command
- WN (Warning Data) Command
- WR (Write) Command
- WS (Sticky Warning Numbers) Command
- API Operation
- 4. RF Communication Modes
- Appendix A: Agency Certifications
- Appendix B: Development Guide
- Appendix C: Additional Information
XTend™RFModule‐ProductManual
©2013DigiInternatonal,Inc. 29
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.
The main purpose of this command is to prevent the Long Header from being sent with every data
packet.
HV (Hardware Version) Command
<Diagnostics> The HV command is used to read
the hardware version of the RF module.
ID (Modem VID) Command
<Networking & 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 & 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
AT Command: ATHT
Binary Command: 0x03 (3 decimal)
Parameter Range:0 - 0xFFFF
[x 100 milliseconds]
Default Parameter Value: 0xFFFF (wake-up
initializer will not be sent)
Number of bytes returned: 2
Related Commands: LH (Wake-up Initializer
Timer), SM (Sleep Mode), ST (Time before
Sleep)
AT Command: ATHV
Parameter Range:0 - 0xFFFF [Read-only]
Minimum Firmware Version Required: v1.x80
AT Command: ATID
Binary Command: 0x27 (39 decimal)
Parameter Range:
0x11 - 0x7FFF (user-settable)
0 - 0x10 & 0x8000 - 0xFFFF (factory-set)
Default Parameter Value: 0x3332 (13106d)
Number of bytes returned: 2
AT Command: ATKY
Binary Command: 0x3C (60 decimal)
Parameter Range:
0 - (64 hex digits all set to 'F')
Default Parameter Value: 0 (disabled)
Number of bytes returned: 2
Number Base: Always Hexadecimal