Digi XBee(R) ANSI C Host Library
Data Fields

Structure used by the WPAN/ZigBee layers. More...

#include "wpan/aps.h"

Data Fields

wpan_tick_fn tick
 read and dispatch frames
 
wpan_endpoint_send_fn endpoint_send
 send frame to an endpoint
 
wpan_endpoint_get_next_fn endpoint_get_next
 walk endpoint table
 
wpan_address_t address
 IEEE/MAC and network addresses.
 
uint16_t payload
 max bytes in RF payload, need to refresh if encryption enabled/disabled
 
uint16_t flags
 Bitfield describing the device's capabilities (maybe CAN_SLEEP, nodetype, etc.) and state. More...
 
const wpan_endpoint_table_entry_tendpoint_table
 Pointer to a table of the device's endpoints, ending with WPAN_ENDPOINT_TABLE_END. More...
 

Detailed Description

Structure used by the WPAN/ZigBee layers.

Contains information about the node (addresses, payload limit, capabilities) along with an endpoint list and function pointers to configure, tick and send packets through the underlying network interface.

This is the abstraction layer between a physical XBee (or some other piece of hardware or gateway/router/tunnel device) and the networking layers. Similar to a driver for an Ethernet NIC and the TCP/IP stack that runs on top of it.

Field Documentation

const wpan_endpoint_table_entry_t* endpoint_table

Pointer to a table of the device's endpoints, ending with WPAN_ENDPOINT_TABLE_END.

Do not reference directly! Use wpan_endpoint_get_next() to walk the table.

Referenced by wpan_endpoint_get_next(), and xbee_wpan_init().

uint16_t flags

Bitfield describing the device's capabilities (maybe CAN_SLEEP, nodetype, etc.) and state.

Only valid if xbee_cmd_init_device() is used or ALL Modem Status messages are received from radio. User code should not access this directly, but use WPAN_DEV_IS_* macros instead.

Referenced by _xbee_dev_modem_status().


The documentation for this struct was generated from the following file: