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

Data Structures

struct  tsmart_xbee_dm_discovered_node_t
 Discovered node structure. More...
 
struct  tsmart_xbee_dm_data_to_send_t
 Data to send structure. More...
 
struct  tsmart_xbee_dm_data_received_t
 Data structure to receive. More...
 
struct  tsmart_xbee_dm_config_t
 XBee DM configuration structure. More...
 
struct  tsmart_xbee_dm_config_device_t
 Configuration for XBee Digimesh. More...
 
struct  tsmart_xbee_dm_t
 XBee Digimesh handler structure. More...
 

Enumerations

enum  { TSMART_XBEE_DM_FC_NONE = USART_HardwareFlowControl_None, TSMART_XBEE_DM_FC_RTS = USART_HardwareFlowControl_RTS, TSMART_XBEE_DM_FC_CTS = USART_HardwareFlowControl_CTS, TSMART_XBEE_DM_FC_RTS_CTS = USART_HardwareFlowControl_RTS_CTS }
 Flow control labels. More...
 
enum  tsmart_xbee_dm_kind_dev_t { TSMART_XBEE_DM_ROUTER = 0x00, TSMART_XBEE_DM_END_DEVICE = 0x02 }
 Label for kind of device in DM protocol. More...
 
enum  tsmart_xbee_dm_api_type_frame_t { TSMART_XBEE_DM_API_CMD_TX_REQ }
 Label to select kind of API frame to build. More...
 
enum  tsmart_xbee_dm_flag_t { TSMART_XBEE_DM_DISABLE, TSMART_XBEE_DM_ENABLE }
 Standard label for XBee DM device. More...
 
enum  tsmart_xbee_dm_flow_control_t { TSMART_XBEE_DM_FLOW_CONTROL_DISABLE, TSMART_XBEE_DM_FLOW_CONTROL_CTS, TSMART_XBEE_DM_FLOW_CONTROL_RTS, TSMART_XBEE_DM_FLOW_CONTROL_RTS_CTS }
 Enum to select Flow control mode. More...
 
enum  tsmart_xbee_dm_report_t { TSMART_XBEE_DM_PACKET_LOST, TSMART_XBEE_DM_OK }
 Label to report about loss packets. More...
 
enum  tsmart_xbee_dm_sleep_mode_t {
  TSMART_XBEE_DM_OFF, TSMART_XBEE_DM_PIN, TSMART_XBEE_DM_ACYCLIC, TSMART_XBEE_DM_ACYCLIC_PIN,
  TSMART_XBEE_DM_SUPPORT, TSMART_XBEE_DM_SCYCLIC
}
 Sleep modes for XBee DM device. More...
 

Detailed Description

Enumeration Type Documentation

anonymous enum

Flow control labels.

Enumerator
TSMART_XBEE_DM_FC_NONE 

Disable flow control

TSMART_XBEE_DM_FC_RTS 

Enable RTS flow control

TSMART_XBEE_DM_FC_CTS 

Enable CTS flow control

TSMART_XBEE_DM_FC_RTS_CTS 

Enable complete flow control RTS&CTS

Label to select kind of API frame to build.

Enumerator
TSMART_XBEE_DM_API_CMD_TX_REQ 

Transmit request type

Standard label for XBee DM device.

Enumerator
TSMART_XBEE_DM_DISABLE 

Label to select option disable

TSMART_XBEE_DM_ENABLE 

Label to select option enable

Enum to select Flow control mode.

Enumerator
TSMART_XBEE_DM_FLOW_CONTROL_DISABLE 

Label to select option disable

TSMART_XBEE_DM_FLOW_CONTROL_CTS 

Label to select option CTS enable

TSMART_XBEE_DM_FLOW_CONTROL_RTS 

Label to select option RTS enable

TSMART_XBEE_DM_FLOW_CONTROL_RTS_CTS 

Label to select option CTS and RTS enables

Label for kind of device in DM protocol.

Enumerator
TSMART_XBEE_DM_ROUTER 

Router label

TSMART_XBEE_DM_END_DEVICE 

End-device label

Label to report about loss packets.

Enumerator
TSMART_XBEE_DM_PACKET_LOST 

There were lost packets.

TSMART_XBEE_DM_OK 

There weren't lost packets, every thing it's OK.

Sleep modes for XBee DM device.

Enumerator
TSMART_XBEE_DM_OFF 

No sleep mode enabled.

TSMART_XBEE_DM_PIN 

The sleep/wake state of the module is controlled by user.

TSMART_XBEE_DM_ACYCLIC 

The module periodically sleeps and wakes

TSMART_XBEE_DM_ACYCLIC_PIN 

The module acts in the same way as TSMART_XBEE_DM_ACYCLIC with the exception that the module will prematurely terminate a sleep period when user wants to.

TSMART_XBEE_DM_SUPPORT 

Sleep support mode

TSMART_XBEE_DM_SCYCLIC 

Synchronous cyclic sleep mode