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. 43
TX (Transmit) Request: 16-bit address
API Identifier Value: 0x01
A TX Request message will cause the module to send RF Data as an RF Packet.
Figure3‐5. TXPacket(16‐bitaddress)Frames
Figure3‐6. Example:TXPacketAPIFrames
TX (Transmit) Status
API Identifier Value: 0x89
When 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.
Figure3‐7. TXStatusFrames
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: 0x81
When the module receives an RF packet, it is sent out the UART using this message type.
Figure3‐8. RXPacket(16‐bitaddress)Frames
cmdData0x01
Length ChecksumStart Delimiter Frame Data
Identifier-specific DataAPI Identifier
MSB LSB0x7E 1 ByteAPI-specific Structure
Frame ID (Byte 5)
Identifies the UART data frame for the host to
correlate 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 = Standard
1 = Disable ACK
RF Data (Byte(s) 9-n)
Up to 2048 Bytes per packet
*Length[Bytes] =APIIdentifier+FrameID+Op tion+RFData
**“R ”valuewasarbitrarilyselected
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
Length ChecksumStart Delimiter Frame Data
Identifier-specific DataAPI Identifier
MSB LSB0x7E 1 ByteAPI-specific Structure
Frame ID (Byte 5) Status (Byte 6)
0 = Success
1 = No ACK (Acknowledgement) received
Identifies UART data frame being reported.
Note: If Frame ID = 0 in the TX Request, no
AT Command Response will be given.
cmdData0x81
Length ChecksumStart Delimiter Frame Data
Identifier-specific DataAPI Identifier
MSB LSB0x7E 1 ByteAPI-specific Structure
bit 0 = ACK
bit 1 = Indicate broadcast
bits 2-7 [reserved]
Up to 2048 Bytes per
packet
Received Signal Strength Indicator -
Hexadecimal equivalent of (-dBm) value.
(For example: If RX signal strength = -40
dBm, “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)