XBee Packet Types
[XBee]

The different types of packet that can be used with the XBee subsystem. More...


Data Structures

struct  XBee_ATCommand
 The structure used for a standard AT Command packet. More...
struct  XBee_ATCommandResponse
 The structure used for a response to a standard AT Command packet. More...
struct  XBee_TX64
 The structure used to transmit a data packet with a 64-bit destination address. More...
struct  XBee_TX16
 The structure used to transmit a data packet with a 16-bit destination address. More...
struct  XBee_TXStatus
 When a transmit request is completed, the module sends a transmit status message. More...
struct  XBee_RX64
 An incoming data packet with a 64-bit address. More...
struct  XBee_RX16
 An incoming data packet with a 16-bit address. More...
struct  XBee_IO64
 An incoming packet with IO data from a 64-bit address. More...
struct  XBee_IO16
 An incoming packet with IO data from a 16-bit address. More...

Enumerations

enum  XBeeApiId {
  XBEE_TX64 = 0x00, XBEE_TX16 = 0x01, XBEE_TXSTATUS = 0x89, XBEE_RX64 = 0x80,
  XBEE_RX16 = 0x81, XBEE_ATCOMMAND = 0x08, XBEE_ATCOMMANDQ = 0x09, XBEE_ATCOMMANDRESPONSE = 0x88,
  XBEE_IO64 = 0x82, XBEE_IO16 = 0x83
}
 Possible API IDs for different kinds of packets. More...

Detailed Description

The different types of packet that can be used with the XBee subsystem.

These structures are to be used when the module has already been set into packet (API) mode with a call to XBee_SetPacketApiMode( )


Enumeration Type Documentation

enum XBeeApiId

Possible API IDs for different kinds of packets.

In the main XBeePacket structure, its apiId member will be set to one of these values, indicating which kind of packet it is.

Example

  XBeePacket* xbp;
  if( xbp->apiId == XBEE_IO16 )
  {
    // then we have an XBee_IO16 packet,
    // accessible at xbp->io16
  }
Enumerator:
XBEE_TX64  An outgoing data packet with a 64-bit address.

XBEE_TX16  An outgoing data packet with a 16-bit address.

XBEE_TXSTATUS  TX status packet.

XBEE_RX64  An incoming data packet with a 64-bit address.

XBEE_RX16  An incoming data packet with a 16-bit address.

XBEE_ATCOMMAND  An AT command packet.

XBEE_ATCOMMANDQ  An AT command queue packet.

XBEE_ATCOMMANDRESPONSE  A response to an AT command query.

XBEE_IO64  An incoming IO packet with a 64-bit address.

XBEE_IO16  An incoming IO packet with a 16-bit address.

Definition at line 176 of file xbee.h.