Types

Data Structures
struct	tsmart_xbee_zb_tx_status_t
	Status transmision structure. More...
struct	tsmart_xbee_zb_data_to_send_t
	Data to send structure. More...
struct	tsmart_xbee_zb_data_received_t
	Data structure to receive. More...
struct	tsmart_xbee_zb_discovered_node_t
	Discovered node structure. More...
struct	tsmart_xbee_zb_config_t
	XBee ZB configuration structure. More...
struct	tsmart_xbee_zb_config_device_t
	Configuration for XBee ZigBee device. More...
struct	tsmart_xbee_zb_t
	XBee ZigBee handler structure. More...

Enumerations
enum	{ TSMART_XBEE_ZB_FC_NONE = USART_HardwareFlowControl_None, TSMART_XBEE_ZB_FC_RTS = USART_HardwareFlowControl_RTS, TSMART_XBEE_ZB_FC_CTS = USART_HardwareFlowControl_CTS, TSMART_XBEE_ZB_FC_RTS_CTS = USART_HardwareFlowControl_RTS_CTS }
	Flow control labels. More...
enum	tsmart_xbee_zb_api_type_frame_t { TSMART_XBEE_ZB_API_CMD_TX_REQ }
	Label to select kind of API frame to build. More...
enum	tsmart_xbee_zb_ai_t {   TSMART_XBEE_ZB_AI_1 = 0x00, TSMART_XBEE_ZB_AI_2 = 0x21, TSMART_XBEE_ZB_AI_3 = 0x22, TSMART_XBEE_ZB_AI_4 = 0x23,   TSMART_XBEE_ZB_AI_5 = 0x24, TSMART_XBEE_ZB_AI_6 = 0x25, TSMART_XBEE_ZB_AI_7 = 0x27, TSMART_XBEE_ZB_AI_8 = 0x2A,   TSMART_XBEE_ZB_AI_9 = 0x2B, TSMART_XBEE_ZB_AI_10 = 0x2C, TSMART_XBEE_ZB_AI_11 = 0xAB, TSMART_XBEE_ZB_AI_12 = 0xAC,   TSMART_XBEE_ZB_AI_13 = 0xAD, TSMART_XBEE_ZB_AI_14 = 0xAF, TSMART_XBEE_ZB_AI_15 = 0xFF, TSMART_XBEE_ZB_AI_16 = -1 }
	Label to report about the association indications. More...
enum	tsmart_xbee_zb_kind_dev_t { TSMART_XBEE_ZB_COORDINATOR, TSMART_XBEE_ZB_ROUTER, TSMART_XBEE_ZB_END_DEVICE }
	Label to configure kind of device in ZigBee protocol. More...
enum	tsmart_xbee_zb_rts_network_type { TSMART_XBEE_ZB_RST_NETWORK_TYPE1, TSMART_XBEE_ZB_RST_NETWORK_TYPE2 }
	Label to select kind of reset for current network. More...
enum	tsmart_xbee_zb_status_message_t {   TSMART_XBEE_ZB_HARDWARE_RESET = 0x00, TSMART_XBEE_ZB_WATCHDOG_TIMER_RESET = 0x01, TSMART_XBEE_ZB_JOINED_NETWORK = 0x02, TSMART_XBEE_ZB_DISASSOCIATED = 0x03,   TSMART_XBEE_ZB_COORDINATOR_STARTED = 0x06, TSMART_XBEE_ZB_NETWORK_SECURITY_KEY_WAS_UPDATED = 0x07, TSMART_XBEE_ZB_VOLTAGE_SUPPLY_LIMIT_EXCEEDED = 0x0D, TSMART_XBEE_ZB_MODEM_CONFIGURATION_CHANGED_WHILE_JOIN_IN_PROGRESS = 0x11,   TSMART_XBEE_ZB_STACK_ERROR = 0x80, TSMART_XBEE_ZB_WRONG_ANSWER = -1 }
	Label to report about status messages. More...
enum	tsmart_xbee_zb_flag_t { TSMART_XBEE_ZB_DISABLE, TSMART_XBEE_ZB_ENABLE }
	Standard label for XBee ZB device. More...
enum	tsmart_xbee_zb_report_t { TSMART_XBEE_ZB_PACKET_LOST, TSMART_XBEE_ZB_OK }
	Label to report about loss packets. More...
enum	tsmart_xbee_zb_flow_control_t { TSMART_XBEE_ZB_FLOW_CONTROL_DISABLE, TSMART_XBEE_ZB_FLOW_CONTROL_CTS, TSMART_XBEE_ZB_FLOW_CONTROL_RTS, TSMART_XBEE_ZB_FLOW_CONTROL_RTS_CTS }
	Enum to select flow control mode. More...
enum	tsmart_xbee_zb_sleep_mode_t { TSMART_XBEE_ZB_OFF = 0, TSMART_XBEE_ZB_PIN = 1, TSMART_XBEE_ZB_CYCLIC = 4, TSMART_XBEE_ZB_CYCLIC_PIN = 5 }
	Sleep modes for XBee ZigBee device. More...

Detailed Description

Enumeration Type Documentation

anonymous enum

Flow control labels.

Enumerator
TSMART_XBEE_ZB_FC_NONE	Disable flow control
TSMART_XBEE_ZB_FC_RTS	Enable RTS flow control
TSMART_XBEE_ZB_FC_CTS	Enable CTS flow control
TSMART_XBEE_ZB_FC_RTS_CTS	Enable complete flow control RTS&CTS

enum tsmart_xbee_zb_ai_t

Label to report about the association indications.

Enumerator
TSMART_XBEE_ZB_AI_1	Successfully formed or joined a network. Coordinators form a network, routers and end devices join a network
TSMART_XBEE_ZB_AI_2	Scan found no PANs
TSMART_XBEE_ZB_AI_3	Scan found no valid PANs based on current SC and ID settings
TSMART_XBEE_ZB_AI_4	Valid coordinator or routers found, but they are not allowing joining (NJ expired)
TSMART_XBEE_ZB_AI_5	No joinable beacons were found
TSMART_XBEE_ZB_AI_6	Unexpected state, node should not be attempting to join at this time
TSMART_XBEE_ZB_AI_7	Node joining attempt failed (typically due to incompatible security settings)
TSMART_XBEE_ZB_AI_8	Coordinator start attempt failed
TSMART_XBEE_ZB_AI_9	Checking for an existing coordinator
TSMART_XBEE_ZB_AI_10	Attempt to leave the network failed
TSMART_XBEE_ZB_AI_11	Attempted to join a device that did not respond
TSMART_XBEE_ZB_AI_12	Secure join error - network security key received unsecured
TSMART_XBEE_ZB_AI_13	Secure join error - network security key not received
TSMART_XBEE_ZB_AI_14	Secure join error - joining device does not have the right preconfigured link key
TSMART_XBEE_ZB_AI_15	Scanning for a ZigBee network (routers and end devices)
TSMART_XBEE_ZB_AI_16	Wrong answer

enum tsmart_xbee_zb_api_type_frame_t

Label to select kind of API frame to build.

Enumerator
TSMART_XBEE_ZB_API_CMD_TX_REQ	Transmit request type

enum tsmart_xbee_zb_flag_t

Standard label for XBee ZB device.

Enumerator
TSMART_XBEE_ZB_DISABLE	Label to select option disable
TSMART_XBEE_ZB_ENABLE	Label to select option enable

enum tsmart_xbee_zb_flow_control_t

Enum to select flow control mode.

Enumerator
TSMART_XBEE_ZB_FLOW_CONTROL_DISABLE	Label to select option disable
TSMART_XBEE_ZB_FLOW_CONTROL_CTS	Label to select option CTS enable
TSMART_XBEE_ZB_FLOW_CONTROL_RTS	Label to select option RTS enable
TSMART_XBEE_ZB_FLOW_CONTROL_RTS_CTS	Label to select option CTS and RTS enables

enum tsmart_xbee_zb_kind_dev_t

Label to configure kind of device in ZigBee protocol.

Enumerator
TSMART_XBEE_ZB_COORDINATOR	Coordinator device
TSMART_XBEE_ZB_ROUTER	Router device
TSMART_XBEE_ZB_END_DEVICE	End device

enum tsmart_xbee_zb_report_t

Label to report about loss packets.

Enumerator
TSMART_XBEE_ZB_PACKET_LOST	There were lost packets.
TSMART_XBEE_ZB_OK	There weren't lost packets, every thing it's OK.

enum tsmart_xbee_zb_rts_network_type

Label to select kind of reset for current network.

Enumerator
TSMART_XBEE_ZB_RST_NETWORK_TYPE1	Resets network layer parameters on the node issuing an order.
TSMART_XBEE_ZB_RST_NETWORK_TYPE2	Sends broadcast transmission to reset network layer parameters on all nodes

enum tsmart_xbee_zb_sleep_mode_t

Sleep modes for XBee ZigBee device.

Enumerator
TSMART_XBEE_ZB_OFF	No sleep mode enabled
TSMART_XBEE_ZB_PIN	Pin sleep enabled
TSMART_XBEE_ZB_CYCLIC	Cyclic sleep enabled
TSMART_XBEE_ZB_CYCLIC_PIN	Cyclic sleep and pin wake

enum tsmart_xbee_zb_status_message_t

Label to report about status messages.

Enumerator
TSMART_XBEE_ZB_HARDWARE_RESET	Hardware reset
TSMART_XBEE_ZB_WATCHDOG_TIMER_RESET	Watchdog timer reset
TSMART_XBEE_ZB_JOINED_NETWORK	Joined network (routers and end devices)
TSMART_XBEE_ZB_DISASSOCIATED	Disassociated
TSMART_XBEE_ZB_COORDINATOR_STARTED	Coordinator started
TSMART_XBEE_ZB_NETWORK_SECURITY_KEY_WAS_UPDATED	Network security key was updated
TSMART_XBEE_ZB_VOLTAGE_SUPPLY_LIMIT_EXCEEDED	Voltage supply limit exceeded (PRO S2B only)
TSMART_XBEE_ZB_MODEM_CONFIGURATION_CHANGED_WHILE_JOIN_IN_PROGRESS	Modem configuration changed while join in progress
TSMART_XBEE_ZB_STACK_ERROR	Stack error
TSMART_XBEE_ZB_WRONG_ANSWER	Wrong answer