XBee Firmware Library  1.6.0
Data Fields

Data Fields

uint16_t cluster_id
 Cluster ID. More...
 
uint8_t dest_endpoint
 endpoint on recipient (dest) More...
 
struct wpan_dev_tdev
 interface received on/to send to More...
 
addr64 ieee_address
 remote 64-bit address More...
 
uint16_t length
 number of bytes in payload More...
 
uint16_t network_address
 remote 16-bit address More...
 
uint16_t options
 
const void FAR * payload
 contents of message More...
 
uint16_t profile_id
 Profile ID. More...
 
uint8_t source_endpoint
 endpoint on sender (source) More...
 

Detailed Description

The "envelope" is used to gather all necessary information about a given frame on the network. Note that all members of the structure are in host byte order.

The low byte of the options field is a copy of the cluster flags for the cluster that received the data. Use #WPAN_ENVELOPE_CLUSTER_FLAGS to mask off the byte, and then compare to the various WPAN_CLUST_FLAG_* macros.

On a DigiMesh network, the 16-bit network address is always set to WPAN_NET_ADDR_UNDEFINED (0xFFFE).