types.h File Reference

WPAN datatypes and support functions, valid for ZigBee and DigiMesh. More...

#include "xbee/platform.h"

Go to the source code of this file.

Data Structures
union	addr64
	Typedef used to hold a 64-bit IEEE address, represented as 8 bytes, 4 16-bit values or 2 32-bit values. More...
struct	wpan_address_t
	Single structure to hold an 802.15.4 device's 64-bit IEEE/MAC address and 16-bit network address. More...

Macros
#define	ADDR64_FORMAT_SEPARATOR   '-'
	Separator used by addr64_format(), defaults to '-' unless specified at compile time. More...
#define	ADDR64_STRING_LENGTH   (8 * 2 + 7 + 1)
	Size of character buffer to pass to addr64_format() (8 2-character bytes, 7 separators and 1 null). More...

Functions
char FAR *	addr64_format (char FAR *buffer, const addr64 FAR *address)
	Format a 64-bit address as a null-terminated, printable string (e.g., "00-13-A2-01-23-45-67"). More...
bool_t	addr64_equal (const addr64 FAR *addr1, const addr64 FAR *addr2)
	Compare two 64-bit addresses for equality. More...
bool_t	addr64_is_zero (const addr64 FAR *addr)
	Test a 64-bit address for zero. More...
int	addr64_parse (addr64 *address_be, const char FAR *str)
	Parse a text string into a 64-bit IEEE address. More...

Reserved/Special WPAN network (16-bit) addresses
#define	WPAN_NET_ADDR_BCAST_ALL_NODES   0xFFFF
	network broadcast address for all nodes
#define	WPAN_NET_ADDR_BCAST_NOT_ASLEEP   0xFFFD
	network broadcast address for non-sleeping devices
#define	WPAN_NET_ADDR_BCAST_ROUTERS   0xFFFC
	network broadcast address for all routers (and coordinators)
#define	WPAN_NET_ADDR_UNDEFINED   0xFFFE
	used to indicate 64-bit addressing (16-bit address is ignored)
#define	WPAN_NET_ADDR_COORDINATOR   0x0000
	network coordinator always uses network address 0x0000

Reserved/Special WPAN MAC (64-bit) addresses
#define	WPAN_IEEE_ADDR_UNDEFINED   (&_WPAN_IEEE_ADDR_UNDEFINED)
	Pointer to addr64 representing an undefined IEEE address (all ones). More...
#define	WPAN_IEEE_ADDR_BROADCAST   (&_WPAN_IEEE_ADDR_BROADCAST)
	Pointer to addr64 representing the broadcast IEEE address.
#define	WPAN_IEEE_ADDR_COORDINATOR   (&_WPAN_IEEE_ADDR_COORDINATOR)
	Pointer to addr64 representing the coordinator's IEEE adddress (all zeros). More...
#define	WPAN_IEEE_ADDR_ALL_ZEROS   (&_WPAN_IEEE_ADDR_COORDINATOR)
	Pointer to addr64 of all zeros. More...
const addr64	_WPAN_IEEE_ADDR_UNDEFINED
const addr64	_WPAN_IEEE_ADDR_BROADCAST
const addr64	_WPAN_IEEE_ADDR_COORDINATOR

Detailed Description

WPAN datatypes and support functions, valid for ZigBee and DigiMesh.