packetXBee Struct Reference

Structure : used for storing the information needed to send or receive a packet, such as the addresses and data. More...

#include <WaspXBeeCore.h>


Data Fields

uint8_t macDL [4]
 Structure Variable : 32b Lower Mac Destination.
uint8_t macDH [4]
 Structure Variable : 32b Higher Mac Destination.
uint8_t mode
 Structure Variable : Sending Mode -> 0=unicast ; 1=broadcast ; 2=cluster ; 3=synchronization.
uint8_t address_type
 Structure Variable : Address Type -> 0=16B ; 1=64B.
uint8_t naD [2]
 Structure Variable : 16b Network Address Destination.
char data [MAX_DATA]
 Structure Variable : Data. All the data here, even when it is > payload.
uint16_t data_length
 Structure Variable : Real data length.
uint16_t frag_length
 Structure Variable : Fragment length. Used to send each fragment.
uint8_t SD
 Structure Variable : Source Endpoint (ZigBee).
uint8_t DE
 Structure Variable : Destination Endpoint (ZigBee).
uint8_t CID [2]
 Structure Variable : Cluster Identifier (ZigBee).
uint8_t PID [2]
 Structure Variable : Profile Identifier (ZigBee).
uint8_t MY_known
 Structure Variable : Specifies if Network Address is known -> 0=unknown net address ; 1=known net address.
uint8_t opt
 Structure Variable : Sending options (depends on the XBee module).
uint8_t packetID
 Structure Variable : Application Level ID.
uint8_t macSL [4]
 Structure Variable : 32b Lower Mac Source.
uint8_t macSH [4]
 Structure Variable : 32b Higher Mac Source.
uint8_t naS [2]
 Structure Variable : 16b Network Address Source.
uint8_t macOL [4]
 Structure Variable : 32b Lower Mac Origin Source.
uint8_t macOH [4]
 Structure Variable : 32b Higher Mac Origin Source.
uint8_t naO [2]
 Structure Variable : 16b Network Address origin.
char niO [21]
 Structure Variable : Node Identifier Origin. To use in transmission, it must finish in "#".
uint8_t RSSI
 Structure Variable : Receive Signal Strength Indicator.
uint8_t address_typeS
 Structure Variable : Address Source Type.
uint8_t typeSourceID
 Structure Variable : Source Type ID.
uint8_t numFragment
 Structure Variable : Fragment number for ordering the global packet.
uint8_t endFragment
 Structure Variable : Specifies if it is the last fragment of a packet.
long time
 Structure Variable : Specifies the time when the first fragment of the packet was received.
uint8_t deliv_status
 Structure Variable : Delivery Status.
uint8_t discov_status
 Structure Variable : Discovery Status.
uint8_t true_naD [2]
 Structure Variable : Network Address where the packet has been set.
uint8_t retries
 Structure Variable : Retries needed to send the packet.


Detailed Description

Structure : used for storing the information needed to send or receive a packet, such as the addresses and data.

Definition at line 115 of file WaspXBeeCore.h.


Field Documentation

uint8_t packetXBee::macDL[4]

Structure Variable : 32b Lower Mac Destination.

Definition at line 123 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::nodeSearch(), WaspXBeeCore::sendXBeePriv(), and WaspXBeeCore::setDestinationParams().

uint8_t packetXBee::macDH[4]

Structure Variable : 32b Higher Mac Destination.

Definition at line 128 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::nodeSearch(), WaspXBeeCore::sendXBeePriv(), and WaspXBeeCore::setDestinationParams().

Structure Variable : Sending Mode -> 0=unicast ; 1=broadcast ; 2=cluster ; 3=synchronization.

Definition at line 133 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::readXBee(), WaspXBeeCore::sendXBee(), and WaspXBeeCore::sendXBeePriv().

Structure Variable : Address Type -> 0=16B ; 1=64B.

Definition at line 138 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::sendXBee(), WaspXBeeCore::sendXBeePriv(), and WaspXBeeCore::setDestinationParams().

uint8_t packetXBee::naD[2]

Structure Variable : 16b Network Address Destination.

Definition at line 143 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::nodeSearch(), WaspXBeeCore::sendXBeePriv(), and WaspXBeeCore::setDestinationParams().

char packetXBee::data[MAX_DATA]

Structure Variable : Data. All the data here, even when it is > payload.

Definition at line 148 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::gen_frame(), WaspXBeeCore::readXBee(), WaspXBeeCore::setDestinationParams(), and WaspXBeeCore::synchronization().

Structure Variable : Real data length.

Definition at line 153 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::readXBee(), WaspXBeeCore::sendXBee(), WaspXBeeCore::setDestinationParams(), and WaspXBeeCore::synchronization().

Structure Variable : Fragment length. Used to send each fragment.

Definition at line 158 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::gen_frame_ap2(), WaspXBeeCore::sendXBee(), and WaspXBeeCore::sendXBeePriv().

uint8_t packetXBee::SD

Structure Variable : Source Endpoint (ZigBee).

Definition at line 163 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::readXBee(), and WaspXBeeCore::sendXBeePriv().

uint8_t packetXBee::DE

Structure Variable : Destination Endpoint (ZigBee).

Definition at line 168 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::readXBee(), and WaspXBeeCore::sendXBeePriv().

uint8_t packetXBee::CID[2]

Structure Variable : Cluster Identifier (ZigBee).

Definition at line 173 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::readXBee(), and WaspXBeeCore::sendXBeePriv().

uint8_t packetXBee::PID[2]

Structure Variable : Profile Identifier (ZigBee).

Definition at line 178 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::readXBee(), and WaspXBeeCore::sendXBeePriv().

Structure Variable : Specifies if Network Address is known -> 0=unknown net address ; 1=known net address.

Definition at line 183 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::sendXBeePriv().

uint8_t packetXBee::opt

Structure Variable : Sending options (depends on the XBee module).

Definition at line 188 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::sendXBeePriv().

Structure Variable : Application Level ID.

Definition at line 195 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::readXBee(), and WaspXBeeCore::sendXBeePriv().

uint8_t packetXBee::macSL[4]

Structure Variable : 32b Lower Mac Source.

Definition at line 200 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::readXBee().

uint8_t packetXBee::macSH[4]

Structure Variable : 32b Higher Mac Source.

Definition at line 205 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::readXBee().

uint8_t packetXBee::naS[2]

Structure Variable : 16b Network Address Source.

Definition at line 210 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::readXBee().

uint8_t packetXBee::macOL[4]

Structure Variable : 32b Lower Mac Origin Source.

Definition at line 215 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::gen_frame(), WaspXBeeCore::readXBee(), and WaspXBeeCore::setOriginParams().

uint8_t packetXBee::macOH[4]

Structure Variable : 32b Higher Mac Origin Source.

Definition at line 220 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::gen_frame(), WaspXBeeCore::readXBee(), and WaspXBeeCore::setOriginParams().

uint8_t packetXBee::naO[2]

Structure Variable : 16b Network Address origin.

Definition at line 225 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::gen_frame(), WaspXBeeCore::readXBee(), and WaspXBeeCore::setOriginParams().

char packetXBee::niO[21]

Structure Variable : Node Identifier Origin. To use in transmission, it must finish in "#".

Definition at line 230 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::gen_frame(), WaspXBeeCore::readXBee(), WaspXBeeCore::sendXBee(), and WaspXBeeCore::setOriginParams().

Structure Variable : Receive Signal Strength Indicator.

Definition at line 235 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::readXBee().

Structure Variable : Address Source Type.

Definition at line 240 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::readXBee().

Structure Variable : Source Type ID.

Definition at line 245 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::gen_frame(), WaspXBeeCore::readXBee(), WaspXBeeCore::sendXBee(), and WaspXBeeCore::setOriginParams().

Structure Variable : Fragment number for ordering the global packet.

Definition at line 250 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::sendXBee(), and WaspXBeeCore::sendXBeePriv().

Structure Variable : Specifies if it is the last fragment of a packet.

Definition at line 255 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::gen_frame(), and WaspXBeeCore::sendXBee().

Structure Variable : Specifies the time when the first fragment of the packet was received.

Definition at line 260 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::readXBee().

Structure Variable : Delivery Status.

Definition at line 268 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::sendXBeePriv().

Structure Variable : Discovery Status.

Definition at line 273 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::sendXBeePriv().

Structure Variable : Network Address where the packet has been set.

Definition at line 278 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::sendXBeePriv().

Structure Variable : Retries needed to send the packet.

Definition at line 283 of file WaspXBeeCore.h.

Referenced by WaspXBeeCore::sendXBeePriv().


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

Generated on Tue Jul 20 09:31:01 2010 for WaspmoteAPI by  doxygen 1.5.6