Package com.rapplogic.xbee.api

Interface Summary
CollectTerminator  
IPacketParser  
IXBee XBee interface
NoRequestResponse This filter is used to capture only RX packets that are not a response to a TX packet.
PacketListener Add an implementation of this interface to xbee.addPacketListener to get notifications of new packets

ResponseFilter  
XBeePacketHandler  
 

Class Summary
AtCommand API technique to set/query commands

WARNING: Any changes made will not survive a power cycle unless written to memory with WR command According to the manual, the WR command can only be written so many times..

AtCommandQueue AT Command Queue

API ID: 0x9

AtCommandResponse Sent in response to an AtCommand

API ID: 0x88

Checksum Computes and verifies packet checksums

ErrorResponse Represents a Java error during packet parsing.
GenericResponse Container for unknown response

HardwareVersion Represents a XBee Address.
InputStreamThread Reads data from the input stream and hands off to PacketParser for packet parsing.
ModemStatusResponse RF module status messages are sent from the module in response to specific conditions.
PacketParser Reads a packet from the input stream, verifies checksum and creates an XBeeResponse object

Notes:

Escaped bytes increase packet length but packet stated length only indicates un-escaped bytes.

RemoteAtRequest Supported by both series 1 (10C8 firmware and later) and series 2.
RemoteAtResponse Supported by both series 1 (10C8 firmware and later) and series 2.
XBee This is an API for communicating with Digi XBee 802.15.4 and ZigBee radios via the serial port

XBeeAddress Represents a XBee Address.
XBeeAddress16 Represents a 16-bit XBee Address.
XBeeAddress64 Represents a 64-bit XBee Address

XBeeConfiguration  
XBeeFrameIdResponse Represents all XBee responses that contain a frame id

XBeePacket Packages a frame data array into an XBee packet.
XBeePacketLength Supports a 16-bit XBee packet length

XBeeRequest The super class of all XBee transmit packets.
XBeeResponse The super class of all XBee Receive packets
 

Enum Summary
ApiId  
AtCommandResponse.Status  
HardwareVersion.RadioType  
ModemStatusResponse.Status  
XBeePacket.SpecialByte  
 

Exception Summary
XBeeException I usually detest checked exceptions but given this is a public api, it is reasonable to notify users what they can expect.
XBeeParseException  
XBeeTimeoutException Indicates an operation did not succeed within the alloted time