XBee Firmware Library  1.6.0
Data Structures | Data Fields
xbee_dev_t Struct Reference

Data Structures

struct  rx
 Buffer and state variables used for receiving a frame. More...
 

Data Fields

char escape_char
 value of CC (default '+') More...
 
uint32_t firmware_version
 Value of XBee module's VR register (4-bytes on some devices) More...
 
enum xbee_dev_flags flags
 Multi-purpose flags for tracking information about this device. More...
 
uint8_t frame_id
 last frame_id used for sending More...
 
uint16_t guard_time
 value of GT (default 1000) * 1ms More...
 
uint16_t hardware_version
 Value of XBee module's HV register. More...
 
uint16_t idle_timeout
 value of CT (default 100) * 100ms More...
 
xbee_is_awake_fn is_awake
 Optional function to read AWAKE pin. More...
 
enum xbee_dev_mode mode
 Current mode of the XBee device (e.g., boot loader, API, command). More...
 
uint32_t mode_timer
 MS_TIMER value used for timeouts. More...
 
xbee_disc_node_id_fn node_id_handler
 Optional function to receive parsed Node ID messages. More...
 
xbee_reset_fn reset
 Optional function to control reset pin. More...
 
struct xbee_dev_t::rx rx
 
xbee_serial_t serport
 Platform-specific structure required by xbee_serial.c. More...
 
wpan_dev_t wpan_dev
 Generic WPAN device required by the ZigBee Networking layers of the API. More...
 

Detailed Description

Note
  • This structure must start with a wpan_dev_t so that the device can be used with the wpan library.
  • Uses function pointers for setting the reset pin and reading the awake pin on the XBee. User code should not call the reset function directly; use xbee_dev_reset() instead so the various network layers will know about the reset.