Digi XBee(R) ANSI C Host Library
Data Structures | Macros | Functions
#include "xbee/device.h"
#include "wpan/types.h"
#include "xbee/delivery_status.h"

Go to the source code of this file.

Data Structures

struct  xbee_frame_receive_t
 Format of XBee API frame type 0x90 (XBEE_FRAME_RECEIVE); received from XBee by host. More...
 
struct  xbee_frame_receive_explicit_t
 Format of XBee API frame type 0x91 (XBEE_FRAME_RECEIVE_EXPLICIT); received from XBee by host. More...
 
struct  xbee_header_transmit_t
 Format of XBee API frame type 0x10 (XBEE_FRAME_TRANSMIT); sent from host to XBee. More...
 
struct  xbee_header_transmit_explicit_t
 Format of XBee API frame type 0x11 (XBEE_FRAME_TRANSMIT_EXPLICIT); sent from host to XBee. More...
 
struct  xbee_frame_transmit_status_t
 < XBEE_FRAME_TRANSMIT_STATUS (0x8B) More...
 

Macros

#define XBEE_FRAME_HANDLE_RX_EXPLICIT   { XBEE_FRAME_RECEIVE_EXPLICIT, 0, _xbee_handle_receive_explicit, NULL }
 
#define XBEE_FRAME_HANDLE_TRANSMIT_STATUS   { XBEE_FRAME_TRANSMIT_STATUS, 0, _xbee_handle_transmit_status, NULL }
 
#define XBEE_FRAME_TRANSMIT_STATUS_DEBUG   { XBEE_FRAME_TRANSMIT_STATUS, 0, xbee_frame_dump_transmit_status, NULL }
 Add this macro to the list of XBee frame handlers to have transmit status frames dumped to STDOUT.
 

Functions

int xbee_wpan_init (xbee_dev_t *xbee, const wpan_endpoint_table_entry_t *ep_table)
 Configure xbee_dev_t for APS-layer (endpoint/cluster) networking. More...
 
int _xbee_handle_receive_explicit (xbee_dev_t *xbee, const void FAR *raw, uint16_t length, void FAR *context)
 Process XBee "Receive Explicit" frames (type 0x91) and hand off to wpan_envelope_dispatch() for further processing. More...
 
int _xbee_handle_transmit_status (xbee_dev_t *xbee, const void FAR *frame, uint16_t length, void FAR *context)
 
int xbee_frame_dump_transmit_status (xbee_dev_t *xbee, const void FAR *frame, uint16_t length, void FAR *context)
 Frame handler for 0x8B (XBEE_FRAME_TRANSMIT_STATUS) frames – dumps transmit status to STDOUT for debugging purposes. More...
 

XBEE_TX_OPT_*

Options for options field of xbee_header_transmit_t and xbee_header_transmit_explicit_t.

#define XBEE_TX_OPT_DISABLE_ACK   (1<<0)
 XBee Transmit Option: Disable ACK [ZigBee and DigiMesh].
 
#define XBEE_TX_OPT_DISABLE_ROUTE_DISC   (1<<1)
 XBee Transmit Option: Disable Route Discovery [DigiMesh].
 
#define XBEE_TX_OPT_ENABLE_UNICAST_NACK   (1<<2)
 XBee Transmit Option: Enable Unicast NACK messages [DigiMesh].
 
#define XBEE_TX_OPT_ENABLE_UNICAST_TRACE   (1<<3)
 XBee Transmit Option: Enable Unicast Trace Route messages [DigiMesh].
 
#define XBEE_TX_OPT_SEND_ENCRYPTED   (1<<4)
 XBee Transmit Option: Send encrypted (over Secure Session) [XBee3].
 
#define XBEE_TX_OPT_APS_ENCRYPT   (1<<5)
 XBee Transmit Option: Enable APS encryption (if EE=1) [ZigBee].
 
#define XBEE_TX_OPT_EXTENDED_TIMEOUT   (1<<6)
 XBee Transmit Option: Use extended timeout for this destination. [ZigBee].
 
#define XBEE_TX_OPT_MODE_POINT_MULTIPOINT   (1<<6)
 XBee Transmit Option: Point-Multipoint [DigiMesh].
 
#define XBEE_TX_OPT_MODE_REPEATER   (2<<6)
 XBee Transmit Option: Repeater mode (directed broadcast) [DigiMesh].
 
#define XBEE_TX_OPT_MODE_DIGIMESH   (3<<6)
 XBee Transmit Option: DigiMesh (not available on 10k product) [DigiMesh].
 

XBEE_TX_DISCOVERY_*

Values for discovery member of xbee_frame_transmit_status_t.

#define XBEE_TX_DISCOVERY_NONE   0x00
 XBee Transmit Discovery Status: No Discovery Overhead [ZigBee, DigiMesh].
 
#define XBEE_TX_DISCOVERY_ADDRESS   0x01
 XBee Transmit Discovery Status: Address Discovery [ZigBee].
 
#define XBEE_TX_DISCOVERY_ROUTE   0x02
 XBee Transmit Discovery Status: Route Discovery [ZigBee, DigiMesh].
 
#define XBEE_TX_DISCOVERY_EXTENDED_TIMEOUT   0x40
 XBee Transmit Discovery Status: Extended Timeout Discovery [ZigBee].