Black Box MDR3903A Wireless Data Extender Manual Documentation
Anúncio
Anúncio
Wireless Data Extenders
Model Number: MDR3903A
Documentation Number: MDR3903A-807
Manual Documentation Number: MDR3903A-807 Table of Contents
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
Table of Contents
Chapter 1 – Introduction……………………………………………….1
Chapter 2 – Check Package Contents………………………………1
Chapter 3 – Dip Switch Settings…………………………………….. 1
Chapter 4 – Product Installation… …………………………………. 2
Chapter 5 – Software…………………………………………………..3
Chapter 6 – Basic Software Configuration…………………………4
Chapter 7 – LED Status………………………………………………..5
Chapter 8 – Range Selection/Antenna Selection…………………. 6
Chapter 9 – Table of Specifications………………………………….6
Chapter 10 – Programming Examples……………………………...9
Manual Documentation Number: MDR3903A-807 Table of Contents
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
1) Introduction
Easy to install, up to 14 mile range No wires, no cables! Wireless Data Extenders get your data moving farther, easier, and at less cost than running cable. Plug-n-play, Modbus compatible, signal strength indicator, space saving DIN rail mounting. Heavy-duty, wide temperature design handles most industrial power configurations and tough indoor/outdoor environments.
Table 1
Model # Frequency Radio
Power
RF Data Rate
2) Check Package Contents
Wireless Data Extender
Antenna
Software CD
Will require separate 18-30VAC or 10-48VDC Power
Supply
3) Dip switch Settings
Table 2
MDR3903A = 5.0W max
Dipswitch OFF
1 4-wire
2 4-wire
ON
2-wire
2-wire
4 RS-422 RS-485
Install on properly grounded DIN rail
Operating Temperature is -40 to 85
Operating Humidity is 10-90% non-condensing
Connect Power Supply
Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
1
Power supply is 10-48 VDC or 18-30 VAC
10-48 VDC or
18-30 VAC
Determine RS-232, RS-422, RS-485 communication
RS-232 always present on DB9
Direction DB9F Pin Signal Name
Data
3 Transmit Data
Out
In
6
7
8
Data Set Ready
Request To Send
Clear To Send
---
Out
In
Out
---
2
RS-232 RS-485 (2Wire) RS-422/485 (4Wire)
Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
Note: The DTR input is used to put the radio into sleep mode. The radio sleep option must be enabled first using the configuration software. Once enabled, lowering the DTR signal will put the radio in sleep mode and raising the DTR signal will put the radio in idle mode, ready to receive or transmit data.
Wireless Link Failure Output
Wireless Data Extenders offer a source
(PNP)transistor output when the wireless signal strength drops below a critical level (link failure or miss packets)
40 mA max current
6) Basic Software Configuration
Under PC Settings
Setup your COM port
♦ Baud Rate (Default is…9600)
♦ Flow Control (Default is…none)
♦ Data Bits (Default is…8)
♦ Parity (Default is…none)
♦ Stop Bits (Default is…1)
Note: For the RSSI LED to work correctly the “RP” command (RSSI
PWM Timer) must be set to “FF”.
5) Software Installation
Insert CD and it will autostart
Follow screen instructions to install software
Connect to PC with straight through serial cable
Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
3
Test Connection with Test/Query button
Under Modem Configuration Tab
Select Appropriate Modem Part Number or use the
“Read” button to automatically detect the Modem type.
Model # Frequency Radio
Power
RF Data
Rate
MDR3903A 900MHz 1mW to 1W 115Kbps
(selectable)
Follow on-screen help files and refer to section 10 for advanced operations.
4 Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
7) LED Status
Table 3
Status Front Panel LED
= ON
OFF = No Power
RSSI (Signal Strength) Green = Strong
Yellow = OK
Red = Weak
OFF = No Signal
Wireless Data Green = Blink ON with data
Note: For the RSSI LED to work correctly the “RP” command (RSSI
PWM Timer) must be set to “FF”.
Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
5
8) Range Selection/Antenna Selection
The Wireless Data Extender Product is shipped with an antenna with the following expected ranges (see table 4)
• These ranges are for reference only with Line of
•
Sight
The antenna connector on the Wireless Data
Extender product is a reverse polarity SMA female plug
Table 4
Model #
MDR3903A
Indoor
Range
up to 3000 feet
Outdoor
Range
up to 14 miles
9) Table of Specifications
RF Properties
Physical Standard Proprietary radio
Range up to 3000 feet indoor or 14 miles outdoor
Frequency 900MHz
Transmit Power 1W (selectable)
Software
Wireless Data Extender
Support Win 98, ME, 2K, XP
Features AT Command
Terminal emulation
RSSI signal range test
Modem emulation
Antenna Options External Reverse Polarity SMA male jack connector, omni directional (included with product)
Radio Address
Defaulted at factory, set by software otherwise
Serial settings
Baud 1200, 2400, 4800, 9600, 19200, 38400, 57600,
115200, 230400
Data bit 7, 8
Parity None, even, odd, mark, space
Stop bit 1, 2
6 Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
RS-232
Lines TX, RX, RTS, CTS, DTR, DSR, DCD, RI, GND
Lines TX, RX, GND
RS-422
Connector Removable terminal block
Lines 2 or 4 wire – TX+, TX-, RX+, RX-, GND (2 or 4 wire dipswitch selectable)
Termination 120 Ohm Dipswitch selectable
RS-485
Connector Removable terminal block
Lines 2 or 4 wire with SD control – TX+, TX-, RX+,
RX-, GND (2 or 4 wire dipswitch selectable)
SD control Bit wise
Termination 120 Ohm Dipswitch selectable
Transistor link failure
No wireless signal or RSSI LED off
Connector Removable terminal block with RS-422/485
Output type Open collector, dry contact, 40mA
Power Supply
Input Voltage 10–48VDC, 18-30VAC
Power 5.0W max
Consumption
Dimensions
Environmental
Operating
Temperature
Storage
Temperature
1.2W x 3.3D x 4.7H
Intended for indoor use only
-40 to 85ºC (-40 to 185ºF)
-40 to 85ºC (-40 to 185ºF)
Enclosure
Rating
Operating
Humidity
10 to 90% non-condensing
Rating IP30
Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
7
Mounting DIN rail mount, 35mm
LED Status
RoHS directive
(lead free)
Front Panel LED
Power
RSSI (Signal
Strength)
Wireless Data
Status
Red = On
OFF = No Power
Green = Strong
Yellow = OK
Red = Weak
OFF = No Signal
Green = Blink on with data
Note: For the RSSI LED to work correctly the
“RP” command (RSSI PWM Timer), must be set to “FF”
Certifications
FCC
FCC Part 15 Class B
CE CISPR (EN55022) Class B
EN61000-6-1 Generic Standards for Residential,
Commercial, & Light Industrial
EN61000-4-2 ESD
EN61000-4-3 RFI
EN61000-4-4 EFT
EN61000-4-5 Surge
EN61000-4-6 CI
EN61000-4-8 Power Frequency Magnetic
EN61000-4-11 Voltage Dips & Interruptions
Yes
8 Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
10) Advanced Programming
To Send AT Commands (Using the ‘Terminal’ tab of the Wireless Data Extender
Software)
Example: Utilize the 'Terminal' tab of the X-CTU Software to change the module's DT
(Destination Address) parameter and save the new address to non-volatile memory.
This example requires the installation of MaxStream’s X-CTU Software and a serial connection to a PC.
Select the ‘Terminal’ tab of the X-CTU Software and enter the following command lines:
Method 1 (One line per command)
Send AT Command
+++
ATDT <Enter>
ATDT1A0D <Enter>
ATWR <Enter>
ATCN <Enter>
System Response
OK <CR> (Enter into Command Mode)_
{current value} <CR> (Read Destination Address)_
OK <CR> (Modify Destination Address)_
OK <CR> (Write to non-volatile memory)_
OK <CR> (Exit Command Mode)
Method 2 (Multiple commands on one line)
Send AT Command
+++
ATDT <Enter>
ATDT1A0D,WR,CN
<Enter>
System Response
OK <CR> (Enter into Command Mode)
{current value} <CR> (Read Destination Address)
OK <CR> (Execute commands)
Note: When using X-CTU Software to program a module, PC com port settings must match the baud (interface data rate), parity & stop bits parameter settings of the module. Use the 'Com Port Setup' section of the “PC Settings” tab to configure PC com port settings to match those of the module.
Note: Do not send commands to the module during flash programming (when parameters are being written to the module registry).
Wait for the OK sys tem response that follows the ATWR command before entering the next command or use flow control.
Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
9
Binary Commands
To 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
1A
(Least significant byte of parameter bytes)
(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 Table
Wireless Data Extender Commands (The 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
%V 0x3B (59d)
Board
Voltage
0x2CCCA -
0x5BFFA
[read-only]
Diagnostics 4
AM 0x40 (64d)
AP v2.x20* --
Auto-set MY --
API Enable 0 - 2
Networking &
Security
Serial
Interfacing
Factory
Default
-- --
1
--
0
AT
BD
0x05 (5d)
0x15 (21d)
Guard Time
After
Interface
Data Rate
2 - (ATST-
3)
[x 100 msec]
0 - 8
(standard rates)
0x39 -
0x1C9C38
(nonstandard rates)
Command Mode
Options
Serial
Interfacing
2
4
0x0A
(10d)
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)
10 Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
CC
CD
CF
CN
CS
CT
DB
DT
E0
E1
ER
FH
FL
FS
FT
GD
HP
HT
HV
ID
KY
0x13 (19d)
0x28 (40d)
--
0x09 (9d)
0x1F (31d)
0x06 (6d)
0x36 (54d)
0x00 (0d)
0x0A (10d)
0x0B (11d)
0x0F (15d)
0x0D (13d)
0x07 (7d)
0x3E (62d)
0x24 (36d)
0x10 (16d)
0x11 (17d)
0x03 (3d)
--
0x27 (39d)
0x3C (60d)
Command
Sequence
Character
GPO2
Configuratio n
Number
Base
Exit
Command
Mode
GPO1
Configuratio n
Command
Mode
Timeout
Received
Signal
Strength
Destination
Address
Echo Off
0x20 - 0x7F
0 - 4
0 - 2
--
0 - 4
2 - 0xFFFF
[x 100 ms]
Command Mode
Options
Serial
Interfacing
Command Mode
Options
Command Mode
Options
Serial
Interfacing
Command Mode
Options
0x6E - 0x28
[read-only]
Diagnostics
0 - 0xFFFF
--
--
Networking &
Security
Command Mode
Options
Command Mode
Options
0 - 0xFFFF Diagnostics
Echo On
Receive
Error Count
Force
Wake-up
Initializer
Software
Flow
Control
Forced
Sync Time
Flow
Control
Threshold
Receive
Good Count
Hopping
Channel
Time before
Wake-up
Initializer
Hardware
Version
Modem VID
AES
Encryption
Key
--
Sleep (Low
Power)
0 - 1
0 - 0xFFFF
Serial
Interfacing
[x 10 msec]
RF
Interfacing
0 - (DI buffer size -
0x11)
[Bytes]
Serial
Interfacing
0 - 0xFFFF Diagnostics
0 - 9
0 - 0xFFFF
Networking &
Security
Sleep
[x 100 msec]
(Low
Power
)
Diagnostics
0 - 0xFFFF
[read-only]
0x11 -
0x7FFF
(usersettable)
0x8000 -
0xFFFF
(factory-set, read-only)
0 - (Any other 64digit hex
Networking &
Security
Networking &
Security
1
1
1
2
1
-- --
1
2
2
2
2
1
2
2
2
1
2
2
2
2
0x2B
["+"]
(43d)
0
0xC8
(200d)
--
0
-- --
-- --
0
-- --
0
0
DI buffer size minus
0x11
0
0
0xFFFF
(65535d)
--
0x3332
(13106d)
0
Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
11 valid key)
LH 0x0C (12d)
Wake-up
Initializer
Timer
RF Mode
0 - 0xFF
[x 100 msec]
0 - 6
Sleep (Low
Power)
1
MD v2.x20* 0x31 (49d)
MK
MT
MY
0x12 (18d)
0x3D (61d)
0x2A (42d)
Address
Mask
Multi-
Transmit
Source
Address
0 - 0xFFFF
0 - 0xFF
0 - 0xFFFF
Networking &
Security
Networking &
Security
Networking &
Security
Networking &
Security
1
2
1
2
NB 0x23 (35d) Parity 0 - 4
Serial
Interfacing
1
PB v2.x20* 0x45 (69d)
Polling
Begin
Address
0 - 0xFFFF
Networking &
Security
2
Minimum
0 - 0xFFFF
_ (Base: (x
PD v2.x20* 0x47 (71d) Polling
Delay
1 ms),
Remote: [x
10 ms])
Networking &
Security
2
XTend Commands (The 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
PE v2.x20*
PK
PL
Binary _
Command
0x46 (70d)
0x29 (41d)
0x3A (58d)
AT
Command
Name
Polling
End
Address
Maximum
RF Packet
Size
TX Power
Level
Parameter
Range
0 - 0xFFFF
1 - 0x800
[Bytes]
0 - 4
Command _
Category
Networking &
Security
# Bytes
Returned
2
RF Interfacing 2
RF Interfacing 1
PW 0 - 1
Sleep (Low
Power)
1
RB 0x20 (32d)
Packetizati on
Threshold
1 -
Current value of
PK
Serial
Interfacing
2
RC
RE
RM
RN
--
0x0E (14d)
--
0x19 (25d)
Ambient
Power -
Single
Channel
Restore
Defaults
Ambient
Power - All
Channels
Delay
Slots
0 - 0x31
[dBm, read-only]
No parameter
- 0x7D0
0 - 0xFF
[slots]
Diagnostics
Diagnostics
Networking &
Security
1
2
1
1
0
0xFFFF
(65535d)
0
0xFFFF
(65535d)
0
0
0
Factory
Default
0 varies
4 (1
Watt)
0
0x800
(2048d)
--
--
0
12 Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
RO
RP
RR
0x21 (33d)
0x22 (34d)
Packetizati on
Timeout
RSSI PWM
Timer
0x18 (24d) Retries
0 - 0xFFFF
[x UART character time]
0 - 0xFF
[x 100 msec]
Serial
Interfacing
Diagnostics
0 - 0xFF
Networking &
Security
2
1
1
RT 0x16 (22d)
GPI1
Configurati on
0 - 2
Serial
Interfacing
1
SB 0x37 (55d) Stop Bits 0 - 1
Serial
Interfacing
1
SH
SL
SM
ST
TP
TR
TT
0x25 (37d)
0x26 (38d)
0x01 (1d)
0x02 (2d)
0x38 (56d)
0x1B (27d)
0x1A (26d)
Serial
Number
High
Serial
Number
Low
Sleep
Mode
Time before
Sleep
Board
Temperatu re
Delivery
Failure
Count
Streaming
Limit
0 - 0xFFFF
[readonly]
0 - 0xFFFF
[readonly]
0 - 8 (3 is reserved)
(ATAT+3)
- 0x7FFF
[x 100 msec]
0 - 0x7F
[readonly]
0 - 0xFFFF
[readonly]
0 - 0xFFFF
[0 = disabled]
Diagnostics
Diagnostics
Sleep (Low
Power)
Sleep (Low
Power)
Diagnostics
Diagnostics
Networking &
Security
2
2
1
2
1
2
2
TX
VL
0x3F (63d)
--
Transmit
Only
Firmware
Version - verbose
0 - 1
Returns string
RF Interfacing 1
Diagnostics --
VR 0x14 (20d)
Firmware
Version
0 - 0xFFFF
[readonly]
Diagnostics 2
WA
WN
--
--
Active
Warning
Numbers
Warning
Data
Returns string
Returns string
Diagnostics
Diagnostics
--
--
WR 0x08 (8d) Write -- (Special) --
WS --
Sticky
Warning
Numbers
Returns string
Diagnostics --
* Firmware version in which command and parameter options were first supported
3
0x20
(32d)
0x0A
(10d)
0
0 varies varies
0
0x64
(100d)
--
0
0
0
--
--
--
--
--
--
Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
13
Command Descriptions
Commands 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
AT Command: AT%V
Binary Command: 0x3B (59 decimal) of the module circuit board.
Sample Output:
5.02 V (when ATCF = 0)
Parameter Range (read-only): 0x2CCCA -
0x5BFFA (2.80 - 5.75 decimal)
5051F (when ATCF = 1) *
5.02 (when ATCF = 2)
Number of bytes returned: 4
* When CF = 1 (default), a hex integer is shown that is equal to (voltage * 65536d).
AM (Auto-set MY) Command
<Networking & Security> AM
AT Command: ATAM
Command is used to
Binary Command: 0x40 (64 decimal) 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
AT Command: ATAP
Parameter Range: 0 - 2 command is used to enable the module to operate using the
Parameter Configuration framebased API operation.
0
1
2
Default Parameter Value:0
API Disabled
(Transparent
Operation)
API enabled (w/out escaped characters)
API enabled (with escaped characters)
Number of Bytes Returned:1
Minimum Firmware Version Required: 2.x20
14 Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
AT (Guard Time After)
Command
AT Command: ATAT
Binary Command: 0x05 (5 decimal)
<Command Mode Options> AT
Command is used to set/read the time-of-silence that follows the command sequence
Parameter Range: 2 - (ATST-3), up to 0x7FFC
[x 100 milliseconds] character (CC Command) of the
AT Command Mode Sequence
(BT + CC + AT). By default, 1 second must elapse before and
Default Parameter Value: 0x0A (10 decimal)
Number of bytes returned: 2
Related Commands: BT (Guard Time Before),
CC (Command Sequence Character) after the command sequence character.
The times-of-silence surrounding the command sequence character are used to prevent inadvertent entrance into AT Command Mode. Refer to the ‘AT Command
Mode’ section for more information regarding the AT Command Mode Sequence.
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
AT Command: ATBD
Binary Command: 0x15 (21 decimal)
Parameter Ranges: 0 - 8 (standard rates)_ 0x39 -
0x1C9C38 (non-standard rates)
0
1
1200
2400 not take effect until the CN
(Exit AT Command Mode) command is issued and the
2
3
4800
9600 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.
4
5
6
7
8
Default Parameter Value: 3
Non-standard baud rates supported as of firmware v2.x20
Number of bytes returned: 4
19200
38400
57600
115200
230400
The range between standard and non-standard baud rates (0x09 - 0x38) is invalid.
Non-standard Interface Data Rates:
Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
15
Any value above 0x38 will be interpreted as an actual baud rate. When a value above
0x38 is sent, the closest interface data rate represented by the number is stored in the BD register. For example, a rate of 19200 bps can be set by sending the following command line "ATBD4B00". NOTE: When using MaxStream’s X-CTU Software, nonstandard interface data rates can only be set and read using the X-CTU ‘Terminal’ tab. Non-standard rates are not accessible through the ‘Modem Configuration’ tab.
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 (refer to the table below). Reading the BD command (send "ATBD" command without an associated parameter value) will return the value actually stored in the module’s BD register.
Parameters Sent Versus Parameters Stored
BD Parameter Sent
(HEX)
Interface Data Rate (bps) BD Parameter Stored (HEX)
0 1200 0
4 19,200 4
7
12C
115,200
300
7
12B
1C200 115,200 1B207
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-
AT Command: ATBR
Binary Command: 0x39 (57 decimal)
Parameter Range: 0 - 1 air) of the module.
0
1
Parameter
Default Parameter Value:1
Baud (bps)
Configuration
Number of bytes returned: 1
9600
115200
BT (Guard Time Before)
Command
AT Command: ATCC
<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
Binary Command: 0x13 (19 decimal)
Parameter Range: 0x20 - 0x7F
Default Parameter Value: 0x2B (ASCII “+”)
Number of bytes returned: 1
Related Commands: AT (Guard Time After), BT
(Guard Time Before)
Mode so that data entering the module (from the host) is recognized as commands instead of payload.
16 Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
Refer to the ‘AT Command Mode’ section for more information regarding the AT
Command Mode Sequence.
CC (Command Sequence
AT Command: ATCC
Character) Command
<AT Command Mode Options>
The CC command is used to set/read the ASCII character
Binary Command: 0x13 (19 decimal)
Parameter Range: 0x20 - 0x7F used between guard times of the AT Command Mode
Default Parameter Value: 0x2B (ASCII “+”)
Number of bytes returned: 1
Sequence (BT + CC + AT).
This sequence enters the
Related Commands: AT (Guard Time After), BT module into AT Command
(Guard Time Before)
Mode so that data entering the module (from the host) is recognized as commands instead of payload.
Refer to the ‘AT Command Mode’ section for more information regarding the AT
Command Mode Sequence.
CD (GPO2 Configuration)
Command
<Serial Interfacing> CD
Command is used to select/read the behavior of the
GPO2 line (pin 3).
AT Command: ATCD
Binary Command: 0x28 (40 decimal)
Parameter Range: 0 - 8 (standard rates)
Parameter Configuration
0
1
RX LED
Default High
2 Default Low
3
4
Default Parameter Value: 2
Number of bytes returned: 1
(reserved)
RX LED (valid address only)
Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
17
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:
AT Command: ATCF
Parameter Range: 0 – 2
Parameter Configuration
0
Commands utilize default number base; decimal commands may output units
VR (Firmware Version)
HV (Hardware Version)
KY (AES Encryption Key)
1
2
All commands forced to unsigned, unit-less hex
Commands utilize their default number base; no units are output
Default Parameter Value: 1
Number of bytes returned: 1
CN (Exit AT Command Mode)
Command
AT Command: ATCN
Binary Command: 0x09 (9 decimal)
<Command Mode Options> The
CN command is used to explicitly exit the module from AT Command Mode. control.
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
AT Command: ATCS
Binary Command: 0x1F (31 decimal)
Parameter Range: 0 - 4
Parameter Configuration
0
1
RS-232 CTS flow control
RS-485 TX enable low
2 High
3 RS-485 TX enable high
4 Low
Default Parameter Value: 0
Number of bytes returned: 1
Related Commands: RT (GPI1 Configuration),
TO (GP01 Timeout)
18 Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
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
AT Command: ATCT
Binary Command: 0x06 (6 decimal)
Parameter Range: 2 - 0xFFFF [x 100 milliseconds]
Default Parameter Value: 0xC8 (200d)
Number of bytes returned: 2
Idle Mode.
Use the CN (Exit AT Command
Mode) command to exit AT
Command Mode manually.
Related Command: CN (Exit AT Command
Mode)
DB (Received Signal Strength)
Command
AT Command: ATDB
<Diagnostics> DB Command is used to read the receive signal
Binary Command: 0x36 (54 decimal)
Parameter Range (read-only): 0x6E - 0x28 (-110 strength (in decibels relative to milliWatts) of the last received to -40 Decimal) packet. This parameter is useful
Number of bytes returned: 2 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).
DT (Destination Address)
Command
<Networking & Security> DT
AT Command: ATDT
Binary Command: 0x00
Command is used to set/read the networking address of an RF
Parameter Range: 0 - 0xFFFF module. The modules utilize three filtration layers: Vendor
Default Parameter Value: 0
ID Number (ATID), Channel
(ATHP), and Destination
Number of bytes returned: 2
Address (ATDT). The DT command assigns an address to
Related Commands: HP (Hopping Channel), ID
(Modem VID), MK (Address Mask), MY (Source
Address) 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.
Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
19
E0 (Echo Off) Command
<Command Mode Options> E0
Command turns off character echo in AT Command Mode.
AT Command: ATE0
Binary Command: 0x0A (10 decimal)
By default, echo is off.
E1 (Echo On) Command
<Command Mode Options> E1
Command enables character
AT Command: ATE1
Binary Command: 0x0B (11 decimal) 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
AT Command: ATER
Binary Command: 0x0F (15 decimal)
Parameter Range: 0 - 0xFFFF error count records the number of packets partially received then aborted on a reception error. This value returns to 0
Default Parameter Value: 0
Number of bytes returned: 2
Related Commands: GD (Receive Good Count) after a reset and is not nonvolatile (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
AT Command: ATFH modes.
FH (Force Wake-up Initializer)
Binary Command: 0x0D (13 decimal)
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
AT Command: ATFL
Binary Command: 0x07 (7 decimal)
Parameter Range: 0 - 1 software flow control. Hardware flow control is implemented with
Parameter Configuration the module as the GP01 pin
(CTS pin of the OEM RF
0
Disable software flow control module), which regulates when serial data can be transferred to the module.
1
Enable software flow control
FL Command can be used to allow software flow control to
Default Parameter Value: 0
Number of bytes returned: 1 also be enabled. The XON character used is 0x11 (17 decimal). The XOFF character used is 0x13 (19 decimal)
20 Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
FS (Forced Synch Time)
Command
AT Command: ATFS
<RF Interfacing> The FS command only applies to
Binary Command: 0x3E (62 decimal)
Parameter Range: 0 - 0xFFFF [x 10 streaming data. Normally, only the first packet of a continuous milliseconds] stream contains the full RF initializer. The RF modules then
Default Parameter Value: 0
Number of bytes returned: 2 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 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)
AT Command: ATFT
Command
<Serial Interfacing> The FT Binary Command: 0x24 (36 decimal) 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.
Parameter Range: 0 - (DI buffer size minus
0x11) [Bytes]
Default Parameter Value: DI Buffer size minus
0x11 (17 decimal)
Number of bytes returned: 2
GD (Receive Good Count)
Command
<Diagnostics> The GD command is used to set/
AT Command: ATGD
Binary Command: 0x10 (16 decimal)
Parameter Range: 0 - 0xFFFF read the count of good received
RF packets. Its parameter value is reset to 0 after every reset
Default Parameter Value: 0
Number of bytes returned: 2 and is not non-volatile (The parameter value does not
Related Commands: ER (Receive Error Count) 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.
Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
21
HP (Hopping Channel)
Command
<Networking & Security> The
HP command is used to
AT Command: ATHP
Binary Command: 0x11 (17 decimal)
Parameter Range: 0 - 9 set/read the RF module's hopping channel number. A channel is one of three layers of filtration available to the
Default Parameter Value: 0
Number of bytes returned: 1 module.
Related Commands: ID (Modem VID), DT
(Destination Address), MK (Address Mask)
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
AT Command: ATHT
<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.
Binary Command: 0x03 (3 decimal)
Parameter Range: 0 - 0xFFFF [x 100 milliseconds]
Default Parameter Value: 0xFFFF (wake-up initializer will not be sent)
The HT parameter should be set shorter than inactivity timeout
[ST Command] time of any RX
(receiving) modules operating in
Number of bytes returned: 2
Related Commands: LH (Wake-up Initializer
Timer), SM (Sleep Mode), ST (Time before
Cyclic Sleep (SM=4-8). The wake-up initializer sent by the
Sleep)
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)
AT Command: ATHV
Command
<Diagnostics> The HV command
Parameter Range: 0 - 0xFFFF [Read-only] is used to read the hardware version of the RF module.
22 Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
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.
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
KY (AES Encryption Key)
Command
<Networking & Security> The KY command is used to set the 256bit AES (Advanced Encryption
AT Command: ATKY
Binary Command: 0x3C (60 decimal)
Parameter Range: 0 - (any other 64-digit hex valid key)
Standard) key for encrypting/decrypting data.
Once set, the key cannot be read out of the module by any
Default Parameter Value: 0 (disabled)
Number of bytes returned: 2 means. The entire payload of the packet is encrypted using the
Number Base: Always Hexadecimal 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.
Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
23
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-
AT Command: ATLH
Binary Command: 0x0C (12 decimal)
Parameter Range: 0 - 0xFF [x 100 milliseconds]
Default Parameter Value: 1
Number of bytes returned: 1 down after a period of inactivity
(as specified by the ST parameter) and will periodically wake and listen for transmitted
Related Commands: HT (Time before Wake-up
Initializer), SM (Sleep Mode), ST (Time before
Sleep) 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 & 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
AT
Command:
ATMD
Binary Command: 0x31 (49 decimal)
Parameter
Range:
Parameter
0
1
2
3
4
5
6
0 - 6
Transparent Operation
(Repeater Base)
[reserved - not used]
[reserved - not used]
Polling Remote
Repeater End Node
Default Parameter Value: 0
Number of bytes returned: 1
Configuration
Polling Base
Repeater
Minimum Firmware Version Required: 2.x20 the ‘RF Communication Modes’ chapter for more information.
24 Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
MK (Address Mask) Command
<Networking & 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
AT Command: ATMK
Binary Command: 0x12 (18 decimal)
Parameter Range: 0 - 0xFFFF
Default Parameter Value: 0xFFFF (65535d)
Number of bytes returned: 2 packet is received, the TX module Destination Address is logically "ANDed" (bitwise) with the Address Mask of the RX
Related Commands: DT (Destination Address),
HP (Hopping Channel), ID (Modem VID), MY
(Source Address)
(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 & Security> The
AT Command: ATMT
MT command is used to enabled multiple transmissions of RF data packets. When Multi-
Binary Command: 0x3D (61 decimal)
Parameter Range: 0 - 0xFF transmit Mode is enabled (MT >
0), packets do not request an
ACK (acknowledgement) from
Default Parameter Value:0 (no forced retransmissions) 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
Number of bytes returned: 1
Related Commands: Networking (DT, MK, MY,
RN, TT), Serial Interfacing (BR, PK, RB, RO),
RF Interfacing (FS)
(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.
Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
25
MY (Source Address)
Command
<Networking & 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: ATMY
Binary Command: 0x2A (42 decimal)
Parameter Range: 0 - 0xFFFF
Default Parameter Value: 0xFFFF (Disabled -
DT (Destination Address) parameter serves as both source and destination address.)
Number of bytes returned: 2
Related Commands: DT (Destination Address),
HP (Hopping Channel), ID (Modem VID), MK
(Address Mask)
AT
Command:
Binary Command: 0x23 (35 decimal)
Parameter
Range:
Parameter
0
1
2
3
4
ATNB
0 - 4
8-bit (no parity or 7-bit
(any parity)
Number of bytes returned: 1
Configuration
8-bit even
Default Parameter Value: 0
8-bit odd
8-bit mark
8-bit space
PB (Polling Begin Address)
Command
<Networking & Security> PB command is used to set/read the module’s Polling Begin Address
– the first address polled Polling
Mode is enabled.
AT Command: ATPB
Binary Command: 0x45 (69 decimal)
Parameter Range: 0 - 0xFFFF
Default Parameter Value: 0
Number of bytes returned: 2
Polling Operations: The ‘Polling
Minimum Firmware Version Required: 2.x20
Base’ (MD = 3) cycles through a sequential range of addresses,
Related Commands: MD (RF Mode), PE
(Polling End Address), PD (Minimum Polling polling each ‘Polling Remote’
Delay)
(MD = 4). The base then waits for a response & proceeds to the next ‘Polling
Remote’. Each ‘Polling Remote’ responds by sending the data from the Data In buffer following the RB & 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.
26 Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
PD (Minimum Polling Delay)
Command
<Networking & Security> The PD command is used to set/read
Polling Delay (Base, MD=3) or
Polling Timeout (Remote,
AT Command: ATPD
Binary Command: 0x47 (71 decimal)
Parameter Range: 0 - 0xFFFF_ (Base: [x 1ms],
Remote: [x 10ms])
MD=4).
Polling Delay (Base) is the time
Default Parameter Value: 0
Number of bytes returned: 2
Minimum Firmware Version Required: 2.x20 between polling cycles. The
Polling Base will start the polling cycle after sending the first poll.
After the polling cycle has
Related Commands: MD (RF Mode), PB
(Polling Begin Address), PE (Polling End
Address) 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)
AT Command: ATPE
Command
<Networking & Security> PE command is used to set/read the module’s Polling End Address –
Binary Command: 0x46 (70 decimal)
Parameter Range: 0 - 0xFFFF the last address polled when
Polling Mode is enabled.
Default Parameter Value: 0
Number of bytes returned: 2
Polling Operations: The ‘Polling
Minimum Firmware Version Required: 2.x20
Base’ (MD = 3) cycles through a sequential range of addresses,
Related Commands: MD (RF Mode), PB
(Polling Begin Address), PD (Minimum Polling polling each ‘Polling Remote’
Delay)
(MD = 4). The base then waits for a response & proceeds to the next ‘Polling
Remote’. Each ‘Polling Remote’ responds by sending data from the DI buffer following the RB & 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
AT Command: ATPK
Binary Command: 0x29 (41 decimal)
Parameter Range: 1 - 0x800 [Bytes]
Default Parameter Value:0x100* or 0x800* (256 or 2048 decimal)
Number of bytes returned: 2
RO parameters to implicitly set the channel dwell time.
If PK is set above 256 and BR is
Related Commands: BR (RF Data Rate) RB
(Packetization Threshold), RO (Packetization
Timeout), WN (Warning Data) 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).
Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
27
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).
PL (TX Power Level)
Command
<RF Interfacing> The PL command is used to set/ read the power level at which the
AT Command: ATPL
Binary Command: 0x3A (58 decimal)
Parameter
Range:
0 - 4
RF module transmits data
Parameter
0
1
2
3
4
Default Parameter Value: 4
Number of bytes returned: 1
Configuration
1 mW
10 mW
100 mW
500 mW
1000 mW (1 Watt)
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
AT
Command:
Parameter
Range:
ATPW
Binary Command: 0x1D (29 decimal)
Parameter
0
0 - 1
Configuration
Disabled to awaken the module from
Cyclic Sleep. When the SLEEP
Pin is de-asserted (low), the module will be fully operational
1
Default Parameter Value: 0
Enabled and will not go into Cyclic Sleep.
Once the SLEEP pin is asserted, the module will remain active for
Number of bytes returned: 1
Related Commands: SM (Sleep Mode), ST
(Time before Sleep) 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.
28 Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
RB (Packetization Threshold)
AT Command: ATRB
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:
Binary Command: 0x20 (32 decimal)
Parameter Range: 0 - PK parameter value (up to 0x800 Bytes)
Default Parameter Value: 0x800 Bytes
Number of bytes returned: 2
• RB characters received by
the UART
Related Commands: BR (RF Data Rate), PK
(RF Packet Size), RO (Packetization Timeout)
• 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
AT Command: ATRC
Channel) Command
<Diagnostics> The RC command is used to examine and report the power level on a
Parameter Range (read-only): 0 - 0x31 [dBm]
Number of bytes returned: 1 given channel.
Related Commands: RM (Ambient Power - All
Channels)
Sample output: -78 dBm [when CF = 0]
4e [when CF = 1]
-78 [when CF = 2]
RE (Restore Defaults)
AT Command: ATRE
Command
<Diagnostics> The RE command
Binary Command: 0x0E (14 decimal) 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 nonvolatile 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.
RM (Ambient Power - All
AT Command: ATRM
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
Parameter Range: no parameter - 0x7D0)
Number of bytes returned: 2
Related Commands: RC (Ambient Power -
Single channel)
Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
29 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]: 64
67
...
63
Sample output [when CF = 2]: 100
-103
…
-99
RN (Delay Slots) Command
<Networking & Security> The
AT Command: ATRN
RN command is used to set/read the time delay that the transmitting RF module inserts
Binary Command: 0x19 (25 decimal)
Parameter Range: 0 - 0xFF [38 ms slots] before attempting to resend a packet. If the transmitting module fails to receive an
Default Parameter Value: 0 (no delay slots inserted) acknowledgement after sending a packet, it inserts a random number of delay slots (ranging from 0 to (RN minus 1)) before
Number of bytes returned: 1
Related Commands: RR (Retries), TT
(Streaming Limit) 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].
30 Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
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:
AT Command: ATRO
Binary Command: 0x21 (33 decimal)
Parameter Range: 0 - 0xFFFF [ x UART character times ]
Default Parameter Value: 3
Number of bytes returned: 2
• RO character times of silence on the UART receive lines (after receiving at least 1 byte)
Related Commands: RB (Packetization
Threshold)
• 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)
AT Command: ATRP
Command
<Diagnostics> RP Command is used to enable a PWM ("Pulse
Width Modulation") output on the
Binary Command: 0x22 (34 decimal)
Parameter Range: 0 - 0xFF [x 100 milliseconds]
Config/RSSI pin (pin 11 of the
OEM RF Module). The pin is calibrated to show the difference between received signal strength
Default Parameter Value: 0x20 (32d)
Number of bytes returned: 1 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.):
PWM Values
dBm above sensitivity PWM percentage (high period / total period)
10 20%
Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
31
20 35%
30 50%
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 & Security> The
RR command is used to set/read
AT Command: ATRR
Binary Command: 0x18 (24 decimal)
Parameter Range: 0 - 0xFF the maximum number of retries sent for a given RF packet.
When RR Command is enabled
(RR>0), RF packet retries and
Default Parameter Value: 0x0A (10 decimal)
Number of bytes returned: 1
ACKs (acknowledgements) 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 acknowledgement from a receiving module. If the acknowledgement 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 acknowledgement is received or until the packet is sent RR times.
RT (GPI1 Configuration)
Command
AT
Command:
ATRT
<Serial Interfacing> The RT command is used to set/read the behavior of the GPI1 pin (pin 10) of the OEM RF Module. The pin
Binary Command: 0x16 (22 decimal)
Parameter
Range:
0 - 2 can be configured to enable binary programming or RTS flow control.
Parameter
0
Configuration
Disabled
1
Enable Binary
Programming
2
Enable RTS Flow
Control
Default Parameter Value: 0
Number of bytes returned: 1
32 Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
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.
SL (Serial Number Low)
Command
<Diagnostics> SL Command is used to set/read the serial number low word of the RF module.
AT
Command:
ATSB
Binary Command: 0x37 (55 decimal)
Parameter
Range:
Parameter
0 - 1
Configuration
0 1 stop bit
1 2 stop bits
Default Parameter Value: 0
Number of bytes returned: 1
AT Command: ATSH
Binary Command: 0x25 (37 decimal)
Parameter Range (read-only): 0 - 0xFFFF
Default Parameter Value: varies
Number of bytes returned: 2
Related Commands: SL (Serial Number Low)
AT Command: ATSL
Binary Command: 0x26 (38 decimal)
Parameter Range (read-only): 0 - 0xFFFF
Default Parameter Value: varies
Number of bytes returned: 2
Related Commands: SH (Serial Number High)
Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
33
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
AT
Command:
ATSM
Binary Command: 0x01
Parameter Range: 0 - 8 (3 is reserved)
Parameter Configuration consumption.
0 Disabled
1 Pin Sleep
2
4
5
6
7
8
Serial Port Sleep
3 [reserved]
Cyclic 1.0 second sleep
(RF module wakes every
1.0 seconds)
Cyclic 2.0 second sleep
Cyclic 4.0 second sleep
Cyclic 8.0 second sleep
Cyclic 16.0 second sleep
Default Parameter Value:
Number of bytes returned: 1
0
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),
ST (Time before Sleep)
Command
HT (Time Before Wake-up Initializer), PW (Pin
Wake-up)
AT Command: ATST
Binary Command: 0x02 (2 decimal)
<Sleep Mode (Low Power)> The
ST Command is used to set/read the period of time (in milliseconds) in which the RF
Parameter Range: (ATAT+3) - 0x7FFF [x 100 milliseconds] module remains inactive before entering Sleep Mode.
For example, if the ST
Default Parameter Value: 0x64 (100 decimal)
Number of bytes returned: 2
Parameter is set to 0x64
(100 decimal), the module will
Related Commands: SM (Sleep Mode), LH
(Wake-up Initializer Timer), HT (Time before
Wake-up Initializer) 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.
34 Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
TP (Board Temperature)
Command
<Diagnostics> TP Command is used to read the current temperature of the board.
Sample Output:
26 C [when
ATCF = 0]
AT Command: ATTP
Binary Command: 0x38 (56 decimal)
Parameter Range (read-only): 0- 0x7F
Number of bytes returned: 1
Related Command: WN (Warning Data)
1A [when ATCF = 1]
26 [when ATCF = 2].
TR (Transmit Error Count)
Command
<Diagnostics> The TR command is used to report the number of
AT Command: ATTR
Binary Command: 0x1B (27 decimal)
Parameter Range: 0 - 0xFFFF retransmit failures. This number is incremented each time a packet is not acknowledged within the number of retransmits
Default Parameter Value: 0
Number of bytes returned: 2 specified by the RR (Retries) parameter. The number of
Related Commands: RR (Retries) 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
AT Command: ATTT
Binary Command: 0x1A (26 decimal)
<Networking & Security> The TT command is used to set/read the
Parameter Range: 0 - 0xFFFF limit on the number of bytes that can be sent out before a
Default Parameter Value: 0 (disabled) random delay is issued.
Number of bytes returned: 2
Related Commands: RN (Delay Slots)
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 & 'RN + 1' delay slots, where each delay slot lasts 38 ms.
The TT command can be used to simulate full-duplex behavior.
Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
35
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
AT
Command:
ATTX
Binary Command: 0x3F (63 decimal)
Parameter Range:
Parameter
0
0 - 1
Configuration
TX & RX modules.
1
Default Parameter Value: 0
TX-only
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
Number of bytes returned: 1
AT Command: ATVL
Parameter Range: returns string
Default Parameter Value: 0
Number of bytes returned: 2
AT Command: ATVR
Binary Command: 0x14 (20 decimal)
Parameter Range (read-only): 0 - 0xFFFF
Number of bytes returned: 2 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
AT Command: ATWA
Parameter Range: Returns string - one warning number per line. 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): 1
3
OK
WN (Warning Data) Command
<Diagnostics> WN command is used to report the following data for all active and sticky
AT Command: ATWN
Parameter Range: returns string warnings:
• Warning number & description
• Number of occurrences since the last WN or WS command
36 Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
• 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.
Warning # Description
1
2
3
4
5
6
7
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.
Over-voltage. This is caused if the supply voltage exceeds 5.75 V.
Transmission is not allowed while this warning is active.
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.
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.
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.
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.
Default configuration parameters in flash. This is caused if usermodifiable 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
AT Command: ATWR
Binary Command: 0x08
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.
Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
37
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
AT Command: ATWS
<Diagnostics> The WS command reports warning
Parameter Range (read-only): 1 - 8
Number of bytes returned: 1 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 Operation
By 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 [refer to p17].
• 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 Specifications
Two 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)
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)
38 Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
When this API mode is enabled (AP = 1), the UART data frame structure is defined as follows:
UART Data Frame Structure:
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:
UART Data Frame Structure with escape control characters:
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
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.
Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
39
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:
UART Data Frame & API specific Structure:
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.
RF Module Status Frames
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.
TX Packet (16 bit address) Frames
40 Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
Example: TX Packet API Frames
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.
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: 0x81
When the module receives an RF packet, it is sent out the UART using this message type.
RX Packet (16 bit address) Frames
Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
41 42 Manual Documentation Number: MDR3903A-807
Black Box Corporation - 1000 Park Drive - Lawrence, PA 15055-1018
www.blackbox.com -- Tech Support and Ordering: 724-746-5500 - Fax: 724-746-0746
Download
Link público atualizado
O link público para seu chat foi atualizado. Você pode visualizar e gerenciar seus links de chat após o registro aqui.
Link público do documento
Anúncio
