XBee Firmware Library  1.6.0
Files | Typedefs | Functions | Variables
Glue layer between XBee Device driver and WPAN

Files

file  wpan.h
 
file  xbee_wpan.c
 

Typedefs

typedef PACKED_STRUCT xbee_frame_receive_explicit_t
 XBEE_FRAME_RECEIVE_EXPLICIT (0x91) More...
 
typedef PACKED_STRUCT xbee_header_transmit_explicit_t
 XBEE_FRAME_TRANSMIT_EXPLICIT (0x11) More...
 
typedef PACKED_STRUCT xbee_header_transmit_t
 XBEE_FRAME_TRANSMIT (0x10) More...
 

Functions

int _xbee_endpoint_send (const wpan_envelope_t FAR *envelope, uint16_t flags)
 
int _xbee_handle_receive_explicit (xbee_dev_t *xbee, const void FAR *raw, uint16_t length, void FAR *context)
 
xbee_wpan_debug int _xbee_handle_transmit_status (xbee_dev_t *xbee, const void FAR *payload, uint16_t length, void FAR *context)
 
xbee_wpan_debug int _xbee_wpan_tick (wpan_dev_t *dev)
 
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...
 

Variables

uint8_t broadcast_radius
 set to 0 for maximum hop value More...
 
uint16_t cluster_id_be
 
uint8_t dest_endpoint
 
uint8_t frame_id
 
addr64 ieee_address
 
uint16_t network_address_be
 
uint8_t options
 bitfield, see XBEE_RX_OPT_xxx macros More...
 
uint8_t payload [1]
 multi-byte payload More...
 
uint16_t profile_id_be
 
uint8_t source_endpoint
 
XBEE_BEGIN_DECLS typedef PACKED_STRUCT xbee_frame_receive_t
 XBEE_FRAME_RECEIVE (0x90) More...
 

Detailed Description

network stack.

Typedef Documentation

Initial value:
{
uint8_t frame_type
unsigned char uint8_t
A unsigned char variable 8 bits.
Definition: types.h:43

XBEE_FRAME_RECEIVE_EXPLICIT (0x91)

Format of XBee API frame type 0x91 (XBEE_FRAME_RECEIVE_EXPLICIT); received from XBee by host.

Initial value:
{
uint8_t frame_type
unsigned char uint8_t
A unsigned char variable 8 bits.
Definition: types.h:43

XBEE_FRAME_TRANSMIT_EXPLICIT (0x11)

Format of XBee API frame type 0x11 (XBEE_FRAME_TRANSMIT_EXPLICIT); sent from host to XBee.

Initial value:
{
uint8_t frame_type
unsigned char uint8_t
A unsigned char variable 8 bits.
Definition: types.h:43

XBEE_FRAME_TRANSMIT (0x10)

Format of XBee API frame type 0x10 (XBEE_FRAME_TRANSMIT); sent from host to XBee. Note that the network stack does not include a function for sending this frame type – use an explicit transmit frame instead (type 0x11) with WPAN_ENDPOINT_DIGI_DATA as the source and destination endpoint, DIGI_CLUST_SERIAL as the cluster ID and WPAN_PROFILE_DIGI as the profile ID. Or, use the xbee_transparent_serial() function from xbee_transparent_serial.c to fill in those fields and send the data.

Function Documentation

xbee_wpan_debug int _xbee_endpoint_send ( const wpan_envelope_t FAR *  envelope,
uint16_t  flags 
)
xbee_wpan_debug 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.

Please view the function help for xbee_frame_handler_fn() for details on this function's parameters and possible return values.

xbee_wpan_debug int _xbee_handle_transmit_status ( xbee_dev_t xbee,
const void FAR *  payload,
uint16_t  length,
void FAR *  context 
)
xbee_wpan_debug int _xbee_wpan_tick ( wpan_dev_t dev)
xbee_wpan_debug 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.

If using this layer, be sure to call wpan_tick (instead of xbee_dev_tick) so it can manage the APS layers of the network stack.

Parameters
[in,out]xbeedevice to configure
[in]ep_tablepointer to an endpoint table to use with device
Return values
0success
-EINVALinvalid parameter passed to function

Variable Documentation

uint8_t broadcast_radius

set to 0 for maximum hop value

uint16_t cluster_id_be
uint8_t dest_endpoint
uint8_t frame_id
addr64 ieee_address
uint16_t network_address_be
uint8_t options

bitfield, see XBEE_RX_OPT_xxx macros

combination of XBEE_TX_OPT_* macros

uint8_t payload

multi-byte payload

uint16_t profile_id_be
uint8_t source_endpoint
xbee_frame_receive_t
Initial value:
{
uint8_t frame_type
unsigned char uint8_t
A unsigned char variable 8 bits.
Definition: types.h:43

XBEE_FRAME_RECEIVE (0x90)

Format of XBee API frame type 0x90 (XBEE_FRAME_RECEIVE); received from XBee by host.