XBee Firmware Library  1.6.0
Files | Typedefs | Functions | Variables
Xbee_route

Files

file  route.h
 
file  xbee_route.c
 

Typedefs

typedef PACKED_STRUCT xbee_frame_create_source_route_t
 
typedef PACKED_STRUCT xbee_frame_route_many_to_one_req_t
 
typedef PACKED_STRUCT xbee_frame_route_record_indicator_t
 

Functions

int xbee_route_dump_many_to_one_req (xbee_dev_t *xbee, const void FAR *frame, uint16_t length, void FAR *context)
 
int xbee_route_dump_record_indicator (xbee_dev_t *xbee, const void FAR *frame, uint16_t length, void FAR *context)
 

Variables

uint8_t address_count
 
uint8_t frame_id
 ID, always set to 0. More...
 
addr64 ieee_address
 64-bit IEEE address (big-endian) of destination. More...
 
uint16_t network_address_be
 16-bit network address (big-endian) of destination. More...
 
uint8_t receive_options
 Combination of XBEE_RX_OPT_XXX macro values. More...
 
uint8_t reserved
 Reserved field always set to 0. More...
 
uint16_t route_address_be [XBEE_ROUTE_MAX_ADDRESS_COUNT]
 
uint8_t route_options
 Always set to XBEE_ROUTE_OPTIONS_NONE. More...
 

Detailed Description

Typedef Documentation

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

The many-to-one route request indicator frame is sent out the serial port whenever a many-to-one route request is received

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

Function Documentation

int xbee_route_dump_many_to_one_req ( xbee_dev_t xbee,
const void FAR *  frame,
uint16_t  length,
void FAR *  context 
)
int xbee_route_dump_record_indicator ( xbee_dev_t xbee,
const void FAR *  frame,
uint16_t  length,
void FAR *  context 
)

Variable Documentation

uint8_t address_count

Number of addresses in route, excluding source and destination. Must be between 1 and XBEE_ROUTE_MAX_ADDRESS_COUNT.

uint8_t frame_id

ID, always set to 0.

addr64 ieee_address

64-bit IEEE address (big-endian) of destination.

64-bit IEEE address (big-endian) of source.

uint16_t network_address_be

16-bit network address (big-endian) of destination.

16-bit network address (big-endian) of source.

uint8_t receive_options

Combination of XBEE_RX_OPT_XXX macro values.

uint8_t reserved

Reserved field always set to 0.

uint16_t route_address_be

Network addresses of nodes in route, starting next to destination and ending with node next to source (us).

uint8_t route_options

Always set to XBEE_ROUTE_OPTIONS_NONE.