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. 42
Data bytes that need to be escaped:
• 0x7E – Frame Delimiter
•0x7D – Escape
• 0x11 – XON
• 0x13 – XOFF
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
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 Types
Frame data of the UART data frame forms an API-specific structure as follows:
Figure3‐03. UARTDataFrame&API‐specificStructure:
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 Status
API Identifier: 0x8A
RF module status messages are sent from the module in response to specific conditions.
Figure3‐04. RFModuleStatusFrames
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
Length
(Bytes 2-3)
Checksum
(Byte n + 1)
MSB LSB 1 Byte
Start Delimiter
(Byte 1)
0x7E
Frame Data
(Bytes 4-n)
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 reset
1 = Watchdog timer reset