User's Manual

9XTend™ OEM RF Module - Product Manual v2.x6x

API Operation

API operation requires that communication with the module be done through a structured inter-

face (data is communicated in frames in a defined order). The API specifies how commands, com-

mand 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 cor-

rectly or if the checksum fails, the data is silent

ly discarded.

API Operation (AP parameter = 1)

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

Figure 5-01. UART Data Frame Structure

Packetization Timeout. Set/Read the

number of character times with no UART data

before a packet is created for RF output

(assuming UART data was received prior to

the idle time). If RO = 0, it is ignored and no

data will be transmitted until RB characters

are in the DO buffer.

0 - 0xFFFF 

[x UART character time]

Serial

Interfacing

GPI1 Configuration. Set/Read the behavior

f the GPI1 pin (pin 10).

0 – 2

0 = No RTS flow control 2 = RTS

flow control

Serial

Interfacing

Stop Bits. Set/Read the number of stop bits in

the data packet.

0 – 1

0 = 1 stop bit 

1 = 2 stop bits

Serial

Interfacing