CHENGQI YANG / SmartLabXBeeAPI2 Featured

XBee API operation library for mbed

Embed: (wiki syntax)

« Back to documentation index

ExplicitAddress Class Reference
Public Member Functions | Static Public Attributes | Protected Attributes | Friends

ExplicitAddress Class Reference

ZigBeee address class for S2 hardware. More...

#include <ExplicitAddress.h>

Inherits Address.

Public Member Functions

 ExplicitAddress ()
 Create a XBee explicit address, with all the value with defatul 0x00.
 ExplicitAddress (const unsigned char *addressValue, const unsigned char *explicitValue)
 Create explicit address from existing byte aray value.
 ExplicitAddress (long serialNumberHigh, long serialNumberLow, int networkAddress, int sourceEndpoint, int destinationEndpoint, int clusterID, int profileID)
 Create address from existing value.
unsigned char * getExplicitValue ()
 total 6 bytes/ 1 byte of SourceEndpoint + 1 byte of DestinationEndpoint + 2 bytes of ClusterID + 2 bytes of ProfileID
unsigned long getSerialNumberHigh ()
 Get the first 4 bytes of IEEE address.
unsigned long getSerialNumberLow ()
 Get the last 4 bytes of IEEE address.
unsigned int getNetworkAddress ()
 Get the 16 bit network address.
void setSerialNumberHigh (long SerialNumberHigh)
 Set the first 4 bytes of IEEE address.
void setSerialNumberLow (long SerialNumberLow)
 Set the last 4 bytes of IEEE address.
void setNetworkAddress (int NetworkAddress)
 Set the 16 bit network address.
const unsigned char * getAddressValue ()
 Convert the device address to 10 bytes array.

Static Public Attributes

static Address * BROADCAST_ZIGBEE = new Address(0x00000000, 0x0000FFFF, 0xFFFE)
 Get the ZigBee broadcast address.
static Address * BROADCAST_XBEE = new Address(0x00000000, 0x00000000, 0xFFFF)
 Get the XBee broadcast address.

Protected Attributes

unsigned char value [10]
 total 10 bytes (IEEE 64 bits + 16 bits networ address)

Friends

bool operator== (const Address &a, const Address &b)
 Compare two XBee addresses and check if both point to the same device.
bool operator!= (const Address &a, const Address &b)
 Compare two XBee addresses and check if both point to the same device.

Detailed Description

ZigBeee address class for S2 hardware.

Definition at line 7 of file ExplicitAddress.h.

Constructor & Destructor Documentation

ExplicitAddress (  )

Create a XBee explicit address, with all the value with defatul 0x00.

Definition at line 3 of file ExplicitAddress.cpp.

ExplicitAddress ( const unsigned char *  addressValue,
const unsigned char *  explicitValue 
)

Create explicit address from existing byte aray value.

Parameters:
addressValue10 bytes (8 bytes of IEEE address + 2 bytes of network address)
explicitValue6 bytes : 1 byte of SourceEndpoint + 1 byte of DestinationEndpoint + 2 bytes of ClusterID + 2 bytes of ProfileID

Definition at line 6 of file ExplicitAddress.cpp.

ExplicitAddress ( long  serialNumberHigh,
long  serialNumberLow,
int  networkAddress,
int  sourceEndpoint,
int  destinationEndpoint,
int  clusterID,
int  profileID 
)

Create address from existing value.

Parameters:
serialNumberHigh
serialNumberLow
networkAddress
sourceEndpoint
destinationEndpoint
clusterID
profileID

Definition at line 12 of file ExplicitAddress.cpp.

Member Function Documentation

const unsigned char * getAddressValue (  ) [inherited]

Convert the device address to 10 bytes array.

Returns:
IEEE 64 bit address follow by 16 bit network address

Definition at line 69 of file Address.cpp.

unsigned char * getExplicitValue (  )

total 6 bytes/ 1 byte of SourceEndpoint + 1 byte of DestinationEndpoint + 2 bytes of ClusterID + 2 bytes of ProfileID

Definition at line 23 of file ExplicitAddress.cpp.

unsigned int getNetworkAddress (  ) [inherited]

Get the 16 bit network address.

Definition at line 42 of file Address.cpp.

unsigned long getSerialNumberHigh (  ) [inherited]

Get the first 4 bytes of IEEE address.

Definition at line 32 of file Address.cpp.

unsigned long getSerialNumberLow (  ) [inherited]

Get the last 4 bytes of IEEE address.

Definition at line 37 of file Address.cpp.

void setNetworkAddress ( int  NetworkAddress ) [inherited]

Set the 16 bit network address.

Definition at line 63 of file Address.cpp.

void setSerialNumberHigh ( long  SerialNumberHigh ) [inherited]

Set the first 4 bytes of IEEE address.

Definition at line 47 of file Address.cpp.

void setSerialNumberLow ( long  SerialNumberLow ) [inherited]

Set the last 4 bytes of IEEE address.

Definition at line 55 of file Address.cpp.

Friends And Related Function Documentation

bool operator!= ( const Address &  a,
const Address &  b 
) [friend, inherited]

Compare two XBee addresses and check if both point to the same device.

Definition at line 82 of file Address.cpp.

bool operator== ( const Address &  a,
const Address &  b 
) [friend, inherited]

Compare two XBee addresses and check if both point to the same device.

Definition at line 74 of file Address.cpp.

Field Documentation

Address * BROADCAST_XBEE = new Address(0x00000000, 0x00000000, 0xFFFF) [static, inherited]

Get the XBee broadcast address.

Definition at line 17 of file Address.h.

Address * BROADCAST_ZIGBEE = new Address(0x00000000, 0x0000FFFF, 0xFFFE) [static, inherited]

Get the ZigBee broadcast address.

Definition at line 14 of file Address.h.

unsigned char value[10] [protected, inherited]

total 10 bytes (IEEE 64 bits + 16 bits networ address)

Definition at line 11 of file Address.h.

Generated on Tue Jul 12 2022 11:17:05 by  doxygen 1.7.2