User's Guide
Table Of Contents
- XBee/XBee-PRO S2C 802.15.4 RF Module User Guide
- Technical specifications
- Hardware
- Configure the XBee/XBee-PRO S2C 802.15.4 RF Module
- Modes
- Operation
- AT commands
- Special commands
- Networking and security commands
- C8 (802.15.4 Compatibility)
- CH (Operating Channel)
- ID (Network ID)
- DH (Destination Address High)
- DL (Destination Address Low)
- MY (Source Address)
- SH (Serial Number High)
- SL (Serial Number Low)
- MM (MAC Mode)
- RR (XBee Retries)
- RN (Random Delay Slots)
- ND (Network Discovery)
- NT (Node Discover Timeout)
- NO (Node Discovery Options)
- DN (Discover Node)
- CE (Coordinator Enable)
- SC (Scan Channels)
- SD (Scan Duration)
- A1 (End Device Association)
- A2 (Coordinator Association)
- AI (Association Indication)
- DA (Force Disassociation)
- FP (Force Poll)
- AS (Active Scan)
- ED (Energy Detect)
- EE (Encryption Enable)
- KY (AES Encryption Key)
- NI (Node Identifier)
- NP (Maximum Packet Payload Bytes)
- RF interfacing commands
- Sleep commands
- Serial interfacing commands
- I/O settings commands
- D0 (DIO0/AD0)
- D1 (DIO1/AD1)
- D2 (DIO2/AD2)
- D3 (DIO3/AD3)
- D4 (DIO4)
- D5 (DIO5/ASSOCIATED_INDICATOR)
- D8 (DIO8/SLEEP_REQUEST)
- P0 (RSSI/PWM0 Configuration)
- P1 (PWM1 Configuration)
- P2 (SPI_MISO)
- M0 (PWM0 Duty Cycle)
- M1 (PWM1 Duty Cycle)
- P5 (SPI_MISO)
- P6 (SPI_MOSI Configuration)
- P7 (SPI_SSEL )
- P8 (SPI_SCLK)
- P9 (SPI_ATTN)
- PR (Pull-up/Down Resistor Enable)
- PD (Pull Up/Down Direction)
- IU (I/O Output Enable)
- IT (Samples before TX)
- IS (Force Sample)
- IO (Digital Output Level)
- IC (DIO Change Detect)
- IR (Sample Rate)
- RP (RSSI PWM Timer)
- I/O line passing commands
- Diagnostic commands
- Command mode options
- Operate in API mode
- API mode overview
- API frame specifications
- Escaped characters in API frames
- Frame descriptions
- TX Request: 64-bit address frame - 0x00
- TX Request: 16-bit address - 0x01
- AT Command frame - 0x08
- AT Command - Queue Parameter Value frame - 0x09
- Remote AT Command Request frame - 0x17
- RX Packet: 64-bit Address frame - 0x80
- Receive Packet: 16-bit address frame - 0x81
- RX (Receive) Packet: 64-bit address IO frame- 0x82
- RX Packet: 16-bit address I/O frame - 0x83
- AT Command Response frame - 0x88
- TX Status frame - 0x89
- Modem Status frame - 0x8A
- Remote Command Response frame - 0x97
- Regulatory information
- Load 802.15.4 firmware on ZB devices
- Migrate from XBee through-hole to surface-mount devices
- PCB design and manufacturing
Operate in API mode API mode overview
XBee/XBee-PRO S2C 802.15.4 RF Module User Guide
107
API mode overview
As an alternative to Transparent operating mode, you can use API operating mode. API mode provides
a structured interface where data is communicated through the serial interface in organized packets
and in a determined order. This enables you to establish complex communication between devices
without having to define your own protocol. The API specifies how commands, command responses
and device status messages are sent and received from the device using the serial interface or the
SPIinterface.
We may add new frame types to future versions of firmware, so build the ability to filter out additional
API frames with unknown frame types into your software interface.
API frame specifications
The firmware supports two API operating modes: without escaped characters and with escaped
characters. Use the AP command to enable either mode. To configure a device to one of these modes,
set the following AP parameter values:
AP command
setting Description
AP = 0
Transparent operating mode, UARTserial line replacement with API modes
disabled. This is the default option.
AP = 1
API operation.
AP = 2
API operation with escaped characters (only possible on UART).
The APIdata frame structure differs depending on what mode you choose.
The firmware silently discards any data it receives prior to the start delimiter. If the device does not
receive the frame correctly or if the checksum fails, the device discards the frame.
API operation (AP parameter = 1)
We recommend this API mode for most applications. The following table shows the data frame
structure when you enable this mode:
Frame fields Byte Description
Start delimiter 1 0x7E
Length 2 - 3 Most Significant Byte, Least Significant Byte
Frame data 4 - n API-specific structure
Checksum n + 1 1 byte
API operation-with escaped characters (AP parameter = 2)
Set API to 2 to allow escaped control characters in the API frame. Due to its increased complexity, we
only recommend this API mode in specific circumstances. API 2 may help improve reliability if the
serial interface to the device is unstable or malformed frames are frequently being generated.