API  2.2
TSmarT Software Library
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
tsmart_xbee_dm_t Struct Reference

XBee Digimesh handler structure. More...

#include <tsmart_xbee_dm.h>

Data Fields

ts_xbee_if_t * xbee_if
 
uint8_t * rx_buf
 
uint32_t rx_buf_sz
 
tsmart_xbee_dm_report_t packet_lost
 
uint8_t n_packet_lost
 
uint8_t api_enable
 
xQueueHandle data_queue
 
xQueueHandle command_queue
 
xQueueHandle status_queue
 
xQueueHandle mode_queue
 
xSemaphoreHandle bitmap_protection
 
xTaskHandle reception_task
 

Detailed Description

XBee Digimesh handler structure.

This is an internal use structure holding the necessary parameters for XBee operation. The user should only read the following parameters: n_packet_lost or packet_lost. This field reports to user about loss packets due to the fast speed of the received packets.

Predefined TSmarT XBee Digimesh Variables can be found in the following link: Variables (Please use them in your TSmarT programming)

Field Documentation

uint8_t api_enable

Enabled/Disabled API reception task

xSemaphoreHandle bitmap_protection

Mutual exclusion to protect the memory for XBee

xQueueHandle command_queue

Queue to store received packets until user task can handle them

xQueueHandle data_queue

Queue to store received packets until user task can handle them

xQueueHandle mode_queue

Queue to change the reception mode

uint8_t n_packet_lost

Indicates how many packets were lost

Indicates if there are lost packets. This field can be:

  • TSMART_XBEE_PACKET_LOST
  • TSMART_XBEE_OK
xTaskHandle reception_task

Task to move received packets from ISR buffer to RxQueue

uint8_t* rx_buf

Pointer to the ISR reception buffer

uint32_t rx_buf_sz

Size of the ISR reception buffer

xQueueHandle status_queue

Queue to store received packets until user task can handle them

ts_xbee_if_t* xbee_if

XBee interface (board dependent)