WaspXBeeXSC Class Reference

WaspXBeeXSC Class. More...

#include <WaspXBeeXSC.h>

Public Member Functions
	WaspXBeeXSC ()
	class constructor
void	init (uint8_t protocol_used, uint8_t frequency, uint8_t model_used)
	It initializes the necessary variables.
uint8_t	setCommandMode ()
	It sets the module into Command Mode.
uint8_t	exitCommandMode ()
	It exits the module from Command Mode.
uint8_t	setBaudRate (uint8_t brate)
	It sets the Baud Rate used in the module.
uint8_t	getBaudRate ()
	It gets the Baud Rate used in the module.
uint8_t	setVendorID (uint8_t VID_H, uint8_t VID_L)
	It sets the module Vendor ID.
uint8_t	getVendorID ()
	It gets the module Vendor ID.
uint8_t	getRSSI ()
	It gets the dBm level in the most recent packet.
uint8_t	setDestAddress (uint8_t destAD_H, uint8_t destAD_L)
	It sets the networking address of a module.
uint8_t	getDestAddress ()
	It gets the networking address of a module.
uint8_t	setReceiveErrorCount (uint8_t recerror_H, uint8_t recerror_L)
	It sets the receive error count.
uint8_t	getReceiveErrorCount ()
	It gets the receive error count.
uint8_t	forceWakeUP ()
	It forces a Wake-up initializer to be sent on the next transmit.
uint8_t	forceReset ()
	It resets the module through the UART.
uint8_t	setReceiveGoodCount (uint8_t recgood_H, uint8_t recgood_L)
	It sets the receive good count.
uint8_t	getReceiveGoodCount ()
	It gets the receive good count.
uint8_t	setHoppingChannel (uint8_t hchannel)
	It sets the Hopping Channel used in the transmission.
uint8_t	getHoppingChannel ()
	It gets the Hopping Channel used in the transmission.
uint8_t	setTimeBeforeWakeUP (uint8_t timeHT_H, uint8_t timeHT_L)
	It sets the time before send a Wake-up initializer.
uint8_t	getTimeBeforeWakeUP ()
	It gets the time before send a Wake-up initializer.
uint8_t	setTimeWakeUpInit (uint8_t timeLH)
	It sets the amount of time the Wake-Up Init is sent.
uint8_t	getTimeWakeUpInit ()
	It gets the amount of time the Wake-Up Init is sent.
uint8_t	setAddressMask (uint8_t mask_H, uint8_t mask_L)
	It sets the address mask.
uint8_t	getAddressMask ()
	It gets the address mask.
uint8_t	setPinWakeUP (uint8_t pin)
	It sets the pin Wake-UP ON/OFF.
uint8_t	getPinWakeUP ()
	It gets the pin Wake-UP ON/OFF.
uint8_t	restoreDefaults ()
	It restores all configurable parameters to defaults values.
uint8_t	setDelaySlots (uint8_t slot)
	It sets the random delay slots.
uint8_t	getDelaySlots ()
	It gets the random delay slots.
uint8_t	setPacketTimeout (uint8_t pack_H, uint8_t pack_L)
	It sets the packetization timeout.
uint8_t	getPacketTimeout ()
	It gets the packetization timeout.
uint8_t	setRSSItime (uint8_t rssiTime)
	It sets the time the output pin is active with the RSSI value.
uint8_t	getRSSItime ()
	It gets the time the output pin is active with the RSSI value.
uint8_t	setRetries (uint8_t retry)
	It sets the number of retries that can be sent for a given packet RF.
uint8_t	getRetries ()
	It gets the number of retries that can be sent for a given packet RF.
uint8_t	getRSSIvalue ()
	It gets the last received packet RSSI.
uint8_t	setStopBits (uint8_t stop)
	It sets the number of stop bits in the data packets.
uint8_t	getStopBits ()
	It gets the number of stop bits in the data packets.
uint8_t	getSourceMacHigh ()
	It gets the 32b Higher Source Mac.
uint8_t	getSourceMacLow ()
	It gets the 32b Lower Source Mac.
uint8_t	setSleepMode (uint8_t smode)
	It sets the Sleep Mode.
uint8_t	getSleepMode ()
	It gets the Sleep Mode.
uint8_t	setAwakeTime (uint8_t awake_H, uint8_t awake_L)
	It sets the amount of time the module is awake.
uint8_t	getAwakeTime ()
	It gets the amount of time the module is awake.
uint8_t	setTimeBeforeInit (uint8_t timeInit)
	It sets the time before sending again the initializer.
uint8_t	getTimeBeforeInit ()
	It gets the time before sending again the initializer.
uint8_t	setTransmitErrorCount (uint8_t txerror_H, uint8_t txerror_L)
	It sets the transmit error count.
uint8_t	getTransmitErrorCount ()
	It gets the transmit error count.
uint8_t	setTransmitLimit (uint8_t txlim_H, uint8_t txlim_L)
	It sets the max number of bytes a module can send before waiting.
uint8_t	getTransmitLimit ()
	It gets the max number of bytes a module can send before waiting.
uint8_t	getSoftVersion ()
	It gets the Firmware version.
uint8_t	writeValues ()
	It writes the parameters changed into non-volatil memory.
uint8_t	sendData (struct packetXSC *packet)
	It sends data to other modules.
uint8_t	readData (struct packetXSC *packet)
	It reads data from other modules.
uint8_t	sendCommandAT (char *atcommand)
	It is a transparent function. The user introduces an AT command within a string.
uint8_t	ON ()
	It connects XBee, activating switch and opens the UART.
uint8_t	sleep ()
	It sets the XBee to sleep, asserting PIN 9.
uint8_t	wake ()
	It wakes up the XBee, de-asserting PIN 9.
Data Fields
uint8_t	vendorID [2]
	Variable : the module Vendor ID.
uint8_t	baudRate
	Variable : the Baud Rate used in the module.
uint8_t	valueRSSI
	Variable : the dBm level in the most recent packet.
uint8_t	destAddress [2]
	Variable : the networking address of a module.
uint8_t	receiveErrorCount [2]
	Variable : the receive error count.
uint8_t	receiveGoodCount [2]
	Variable : the receive good count.
uint8_t	channel
	Variable : the Hopping Channel used in the transmission.
uint8_t	timeBeforeWakeUP [2]
	Variable : the time before send a Wake-up initializer.
uint8_t	timeWakeUpInit
	Variable : the amount of time the Wake-Up Init is sent.
uint8_t	addressMask [2]
	Variable : the address mask.
uint8_t	pinWakeUP
	Variable : the pin Wake-UP ON/OFF.
uint8_t	delaySlots
	Variable : the random delay slots.
uint8_t	packetTimeout [2]
	Variable : the packetization timeout.
uint8_t	timeRSSI
	Variable : the time the output pin is active with the RSSI value.
uint8_t	retries
	Variable : the number of retries that can be sent for a given packet RF.
uint8_t	RSSI
	Variable : the last received packet RSSI.
uint8_t	stopBits
	Variable : the number of stop bits in the data packets.
uint8_t	sourceMacHigh [2]
	Variable : the 32b Higher Source Mac.
uint8_t	sourceMacLow [2]
	Variable : the 32b Lower Source Mac.
uint8_t	sleepMode
	Variable : the Sleep Mode.
uint8_t	awakeTime [2]
	Variable : the amount of time the module is awake.
uint8_t	timeBeforeInit
	Variable : the time before sending again the initializer.
uint8_t	transmitErrorCount [2]
	Variable : the transmit error count.
uint8_t	transmitLimit [2]
	Variable : the max number of bytes a module can send before waiting.
uint8_t	firmwareVersion [2]
	Variable : the Firmware version.
uint8_t	commandAT [20]
	Variable : the XBee answer to the command.
Private Member Functions
uint8_t	converter (uint8_t conv1)
	It generates a decimal number from an ASCII character which was a number.
uint8_t	converter (uint8_t conv1, uint8_t conv2)
	It generates a decimal number from two ASCII characters which were numbers.
uint8_t	converter (uint8_t conv1, uint8_t conv2, uint8_t conv3)
	It generates a decimal number from three ASCII characters which were numbers.
void	clean ()
	It checks if the XBee module answer a 'OK' message.
uint8_t	check ()
	It cleans the unwanted bytes returned by XBee module.
Private Attributes
uint8_t	it
	Variable : counter used in the library.
uint8_t	protocol
	Variable : protocol used (XBEE_XSC in this case).
uint8_t	freq
	Variable : frequency used (FREQ900M in this case).
uint8_t	model
	Variable : model used (PRO in this case).

---

Detailed Description

WaspXBeeXSC Class.

WaspXBee Class defines all the variables and functions used for managing the XBee XSC modules

Definition at line 94 of file WaspXBeeXSC.h.

---

Constructor & Destructor Documentation

WaspXBeeXSC::WaspXBeeXSC

(

)

[inline]

class constructor

It does nothing

Parameters:

void

Returns:

void

Definition at line 104 of file WaspXBeeXSC.h.

{};

---

Member Function Documentation

void WaspXBeeXSC::init	(	uint8_t	protocol_used,
		uint8_t	frequency,
		uint8_t	model_used
	)

It initializes the necessary variables.

Parameters:

	uint8_t	protocol_used : specifies the protocol used in the XBee module (XBEE_XSC in this case)
	uint8_t	frequency : specifies the frequency used in the XBee module (FREQ900M in this case)
	uint8_t	model_used : specifies the XBee model used (PRO)

Returns:

void

Definition at line 29 of file WaspXBeeXSC.cpp.

References freq, model, and protocol.

{
        protocol=protocol_used;
        freq=frequency;
        model=model_used;
}

uint8_t WaspXBeeXSC::setCommandMode

(

)

It sets the module into Command Mode.

Parameters:

void

Returns:

'0' on success, '1' otherwise

Definition at line 43 of file WaspXBeeXSC.cpp.

References clean(), delay(), WaspXBee::print(), and XBee.

Referenced by sendData().

{
  uint8_t error=0;

        delay(1500);
        XBee.print("+++");
        delay(1000);
        clean();
        error=0;
        return error;
}

Here is the call graph for this function:

Here is the caller graph for this function:

uint8_t WaspXBeeXSC::exitCommandMode

(

)

It exits the module from Command Mode.

Parameters:

void

Returns:

'0' on success, '1' otherwise

Definition at line 62 of file WaspXBeeXSC.cpp.

References check(), clean(), delay(), WaspXBee::println(), and XBee.

Referenced by sendData().

{
        clean();
        XBee.println("atcn");
        delay(1000);
        return check();
}

Here is the call graph for this function:

Here is the caller graph for this function:

uint8_t WaspXBeeXSC::setBaudRate

(

uint8_t

brate

)

It sets the Baud Rate used in the module.

Parameters:

uint8_t

brate : the baud rate (range [0-5])

Returns:

'0' on success, '1' otherwise

Definition at line 131 of file WaspXBeeXSC.cpp.

References baudRate, check(), clean(), DEC, delay(), WaspXBee::print(), WaspXBee::println(), and XBee.

{
  clean();
  XBee.print("atbd");
  XBee.println(brate,DEC);
  delay(1000);
  if(!check())
  {
        baudRate=brate;
        return 0;
  }
  return 1;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::getBaudRate

(

)

It gets the Baud Rate used in the module.

It stores in global 'baudRate' variable the Baud Rate used in the module

Returns:

'0' on success, '1' otherwise

Definition at line 154 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), baudRate, clean(), converter(), delay(), WaspXBee::println(), WaspXBee::read(), and XBee.

{
  uint8_t ByteIN[10];
  uint8_t error=1;
  uint8_t i=0;

  clean();
  XBee.println("atbd");
  delay(1000);
  while(XBee.available() > 0) 
  {
        ByteIN[i]=XBee.read();
        i++;
        error=0;
  }
  baudRate=converter(ByteIN[0]);
  return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::setVendorID	(	uint8_t	VID_H,
		uint8_t	VID_L
	)

It sets the module Vendor ID.

Parameters:

	uint8_t	VID_H : higher module Vendor ID byte (range [0x00-0x7F])
	uint8_t	VID_L : lower module Vendor ID byte (range [0x00-0xFF])

Returns:

'0' on success, '1' otherwise

Definition at line 78 of file WaspXBeeXSC.cpp.

References check(), clean(), delay(), HEX, WaspXBee::print(), WaspXBee::println(), vendorID, and XBee.

{
  clean();
  XBee.print("atid");
  XBee.print(VID_H,HEX);
  XBee.println(VID_L,HEX);
  delay(1000);
  if(!check())
  {
        vendorID[0]=VID_H;
        vendorID[1]=VID_L;
        return 0;
  }
  return 1;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::getVendorID

(

)

It gets the module Vendor ID.

It stores in global 'vendorID' variable the module Vendor ID

Returns:

'0' on success, '1' otherwise

Definition at line 102 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), clean(), converter(), delay(), WaspXBee::println(), WaspXBee::read(), vendorID, and XBee.

{
  uint8_t ByteIN[10];
  uint8_t error=2;
  uint8_t i=0;

  clean();
  XBee.println("atid");
  delay(1000);
  while(XBee.available() > 0) 
  {
        ByteIN[i]=XBee.read();
        i++;
        error=0;
  }
  vendorID[0]=converter(ByteIN[0],ByteIN[1]);
  vendorID[1]=converter(ByteIN[2],ByteIN[3]);
  return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::getRSSI

(

)

It gets the dBm level in the most recent packet.

It stores in global 'valueRSSI' variable the dBm level in the most recent packet

Returns:

'0' on success, '1' otherwise

Definition at line 181 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), clean(), converter(), delay(), WaspXBee::println(), WaspXBee::read(), valueRSSI, and XBee.

{
  uint8_t ByteIN[10];
  uint8_t error=1;
  uint8_t i=0;

  clean();
  XBee.println("atdb");
  delay(1000);
  while(XBee.available() > 0) 
  {
        ByteIN[i]=XBee.read();
        i++;
        error=0;
  }
  valueRSSI=converter(ByteIN[0],ByteIN[1]);
  return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::setDestAddress	(	uint8_t	destAD_H,
		uint8_t	destAD_L
	)

It sets the networking address of a module.

Parameters:

	uint8_t	destAD_H : higher destination address byte (range [0x00-0xFF])
	uint8_t	destAD_L : lower destination address byte (range [0x00-0xFF])

Returns:

'0' on success, '1' otherwise

Definition at line 208 of file WaspXBeeXSC.cpp.

References check(), clean(), delay(), destAddress, HEX, WaspXBee::print(), WaspXBee::println(), and XBee.

{
  clean();
  XBee.print("atdt");
  XBee.print(destAD_H,HEX);
  XBee.println(destAD_L,HEX);
  delay(1000);
  
  if(!check())
  {
        destAddress[0]=destAD_H;
        destAddress[1]=destAD_L;
        return 0;
  }
  return 1;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::getDestAddress

(

)

It gets the networking address of a module.

It stores in global 'destAddress' variable the networking address of a module

Returns:

'0' on success, '1' otherwise

Definition at line 233 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), clean(), converter(), delay(), destAddress, WaspXBee::println(), WaspXBee::read(), and XBee.

{
  uint8_t ByteIN[10];
  uint8_t error=1;
  uint8_t i=0;

  clean();
  XBee.println("atdt");
  delay(1000);
  while(XBee.available() > 0) 
  {
        ByteIN[i]=XBee.read();
        i++;
        error=0;
  }
  destAddress[0]=converter(ByteIN[0],ByteIN[1]);
  destAddress[1]=converter(ByteIN[2],ByteIN[3]);
  return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::setReceiveErrorCount	(	uint8_t	recerror_H,
		uint8_t	recerror_L
	)

It sets the receive error count.

Parameters:

	uint8_t	recerror_H : higher receiver error count byte (range [0x00-0xFF])
	uint8_t	recerror_L : lower receiver error count byte (range [0x00-0xFF])

Returns:

'0' on success, '1' otherwise

Definition at line 261 of file WaspXBeeXSC.cpp.

References check(), clean(), delay(), HEX, WaspXBee::print(), WaspXBee::println(), receiveErrorCount, and XBee.

{
  clean();
  XBee.print("ater");
  XBee.print(recerror_H,HEX);
  XBee.println(recerror_L,HEX);
  delay(1000);
  
  if(!check())
  {
        receiveErrorCount[0]=recerror_H;
        receiveErrorCount[1]=recerror_L;
        return 0;
  }
  return 1;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::getReceiveErrorCount

(

)

It gets the receive error count.

It stores in global 'receiveErrorCount' variable the receive error count

Returns:

'0' on success, '1' otherwise

Definition at line 286 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), clean(), converter(), delay(), WaspXBee::println(), WaspXBee::read(), receiveErrorCount, and XBee.

{
  uint8_t ByteIN[10];
  uint8_t error=1;
  uint8_t i=0;

  clean();
  XBee.println("ater");
  delay(1000);
  while(XBee.available() > 0) 
  {
        ByteIN[i]=XBee.read();
        i++;
        error=0;
  }
  receiveErrorCount[0]=converter(ByteIN[0],ByteIN[1]);
  receiveErrorCount[1]=converter(ByteIN[2],ByteIN[3]);
  return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::forceWakeUP

(

)

It forces a Wake-up initializer to be sent on the next transmit.

Returns:

'0' on success, '1' otherwise

Definition at line 313 of file WaspXBeeXSC.cpp.

References check(), clean(), delay(), WaspXBee::println(), and XBee.

{
  clean();
  XBee.println("atfh");
  delay(1000);
  return check();
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::forceReset

(

)

It resets the module through the UART.

Returns:

'0' on success, '1' otherwise

Definition at line 328 of file WaspXBeeXSC.cpp.

References check(), clean(), delay(), WaspXBee::println(), and XBee.

{
  clean();
  XBee.println("atfr");
  delay(1000);
  return check();
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::setReceiveGoodCount	(	uint8_t	recgood_H,
		uint8_t	recgood_L
	)

It sets the receive good count.

Parameters:

	uint8_t	recgood_H : higher receive good count byte (range [0x00-0xFF])
	uint8_t	recgood_L : lower receive good count byte (range [0x00-0xFF])

Returns:

'0' on success, '1' otherwise

Definition at line 344 of file WaspXBeeXSC.cpp.

References check(), clean(), delay(), HEX, WaspXBee::print(), WaspXBee::println(), receiveGoodCount, and XBee.

{
  clean();
  XBee.print("atgd");
  XBee.print(recgood_H,HEX);
  XBee.println(recgood_L,HEX);
  delay(1000);
  
  if(!check())
  {
        receiveGoodCount[0]=recgood_H;
        receiveGoodCount[1]=recgood_L;
        return 0;
  }
  return 1;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::getReceiveGoodCount

(

)

It gets the receive good count.

It stores in global 'receiveGoodCount' variable the receive good count

Returns:

'0' on success, '1' otherwise

Definition at line 369 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), clean(), converter(), delay(), WaspXBee::println(), WaspXBee::read(), receiveGoodCount, and XBee.

{
  uint8_t ByteIN[10];
  uint8_t error=1;
  uint8_t i=0;

  clean();
  XBee.println("atgd");
  delay(1000);
  while(XBee.available() > 0) 
  {
        ByteIN[i]=XBee.read();
        i++;
        error=0;
  }
  receiveGoodCount[0]=converter(ByteIN[0],ByteIN[1]);
  receiveGoodCount[1]=converter(ByteIN[2],ByteIN[3]);
  return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::setHoppingChannel

(

uint8_t

hchannel

)

It sets the Hopping Channel used in the transmission.

Parameters:

uint8_t

hchannel : hopping channel used in the transmission (range [0-6])

Returns:

'0' on success, '1' otherwise

Definition at line 397 of file WaspXBeeXSC.cpp.

References channel, check(), clean(), DEC, delay(), WaspXBee::print(), WaspXBee::println(), and XBee.

{
  clean();
  XBee.print("athp");
  XBee.println(hchannel,DEC);
  delay(1000);
  
  if(!check())
  {
        channel=hchannel;
        return 0;
  }
  return 1;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::getHoppingChannel

(

)

It gets the Hopping Channel used in the transmission.

It stores in global 'channel' variable the Hopping Channel used in the transmission

Returns:

'0' on success, '1' otherwise

Definition at line 420 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), channel, clean(), converter(), delay(), WaspXBee::println(), WaspXBee::read(), and XBee.

{
  uint8_t ByteIN[10];
  uint8_t error=1;
  uint8_t i=0;

  clean();
  XBee.println("athp");
  delay(1000);
  while(XBee.available() > 0) 
  {
        ByteIN[i]=XBee.read();
        i++;
        error=0;
  }
  channel=converter(ByteIN[0]);
  return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::setTimeBeforeWakeUP	(	uint8_t	timeHT_H,
		uint8_t	timeHT_L
	)

It sets the time before send a Wake-up initializer.

Parameters:

	uint8_t	timeHT_H : higher timer byte (range [0x00-0xFF])
	uint8_t	timeHT_L : lower timer byte (range [0x00-0xFF])

Returns:

'0' on success, '1' otherwise

Definition at line 447 of file WaspXBeeXSC.cpp.

References check(), clean(), delay(), HEX, WaspXBee::print(), WaspXBee::println(), timeBeforeWakeUP, and XBee.

{
  clean();
  XBee.print("atht");
  XBee.print(timeHT_H,HEX);
  XBee.println(timeHT_L,HEX);
  delay(1000);
  
  if(!check())
  {
        timeBeforeWakeUP[0]=timeHT_H;
        timeBeforeWakeUP[1]=timeHT_L;
        return 0;
  }
  return 1;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::getTimeBeforeWakeUP

(

)

It gets the time before send a Wake-up initializer.

It stores in global 'timeBeforeWakeUP' variable the time before sending a Wake-up initializer

Returns:

'0' on success, '1' otherwise

Definition at line 472 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), clean(), converter(), delay(), WaspXBee::println(), WaspXBee::read(), timeBeforeWakeUP, and XBee.

{
  uint8_t ByteIN[10];
  uint8_t error=1;
  uint8_t i=0;

  clean();
  XBee.println("atht");
  delay(1000);
  while(XBee.available() > 0) 
  {
        ByteIN[i]=XBee.read();
        i++;
        error=0;
  }
  timeBeforeWakeUP[0]=converter(ByteIN[0],ByteIN[1]);
  timeBeforeWakeUP[1]=converter(ByteIN[2],ByteIN[3]);
  return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::setTimeWakeUpInit

(

uint8_t

timeLH

)

It sets the amount of time the Wake-Up Init is sent.

Parameters:

uint8_t

timeLH : the amount of time the Wake-Up Init is sent (range [0x00-0xFF])

Returns:

'0' on success, '1' otherwise

Definition at line 500 of file WaspXBeeXSC.cpp.

References check(), clean(), delay(), HEX, WaspXBee::print(), WaspXBee::println(), timeWakeUpInit, and XBee.

{
  clean();
  XBee.print("atlh");
  XBee.println(timeLH,HEX);
  delay(1000);
  
  if(!check())
  {
        timeWakeUpInit=timeLH;
        return 0;
  }
  return 1;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::getTimeWakeUpInit

(

)

It gets the amount of time the Wake-Up Init is sent.

It stores in global 'timeWakeUpInit' variable the time before send a Wake-up initializer

Returns:

'0' on success, '1' otherwise

Definition at line 523 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), clean(), converter(), delay(), WaspXBee::println(), WaspXBee::read(), timeWakeUpInit, and XBee.

{
  uint8_t ByteIN[10];
  uint8_t error=1;
  uint8_t i=0;

  clean();
  XBee.println("atlh");
  delay(1000);
  while(XBee.available() > 0) 
  {
        ByteIN[i]=XBee.read();
        i++;
        error=0;
  }
  timeWakeUpInit=converter(ByteIN[0],ByteIN[1]);
  return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::setAddressMask	(	uint8_t	mask_H,
		uint8_t	mask_L
	)

It sets the address mask.

Parameters:

	uint8_t	mask_H : higher address mask byte (range [0x00-0xFF])
	uint8_t	mask_L : lower address mask byte (range [0x00-0xFF])

Returns:

'0' on success, '1' otherwise

Definition at line 550 of file WaspXBeeXSC.cpp.

References addressMask, check(), clean(), delay(), HEX, WaspXBee::print(), WaspXBee::println(), and XBee.

{
  clean();
  XBee.print("atmk");
  XBee.print(mask_H,HEX);
  XBee.println(mask_L,HEX);
  delay(1000);
  
  if(!check())
  {
        addressMask[0]=mask_H;
        addressMask[1]=mask_L;
        return 0;
  }
  return 1;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::getAddressMask

(

)

It gets the address mask.

It stores in global 'addressMask' variable the address mask

Returns:

'0' on success, '1' otherwise

Definition at line 575 of file WaspXBeeXSC.cpp.

References addressMask, WaspXBee::available(), clean(), converter(), delay(), WaspXBee::println(), WaspXBee::read(), and XBee.

{
  uint8_t ByteIN[10];
  uint8_t error=1;
  uint8_t i=0;

  clean();
  XBee.println("atmk");
  delay(1000);
  while(XBee.available() > 0) 
  {
        ByteIN[i]=XBee.read();
        i++;
        error=0;
  }
  addressMask[0]=converter(ByteIN[0],ByteIN[1]);
  addressMask[1]=converter(ByteIN[2],ByteIN[3]);
  return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::setPinWakeUP

(

uint8_t

pin

)

It sets the pin Wake-UP ON/OFF.

Parameters:

uint8_t

pin : the pin to wake-up (range [0-1])

Returns:

'0' on success, '1' otherwise

Definition at line 603 of file WaspXBeeXSC.cpp.

References check(), clean(), DEC, delay(), pinWakeUP, WaspXBee::print(), WaspXBee::println(), and XBee.

{
  clean();
  XBee.print("atpw");
  XBee.println(pin,DEC);
  delay(1000);
  
  if(!check())
  {
        pinWakeUP=pin;
        return 0;
  }
  return 1;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::getPinWakeUP

(

)

It gets the pin Wake-UP ON/OFF.

It stores in global 'pin' variable the pin Wake-UP ON/OFF

Returns:

'0' on success, '1' otherwise

Definition at line 626 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), clean(), converter(), delay(), pinWakeUP, WaspXBee::println(), WaspXBee::read(), and XBee.

{
  uint8_t ByteIN[10];
  uint8_t error=1;
  uint8_t i=0;

  clean();
  XBee.println("atpw");
  delay(1000);
  while(XBee.available() > 0) 
  {
        ByteIN[i]=XBee.read();
        i++;
        error=0;
  }
  pinWakeUP=converter(ByteIN[0]);
  return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::restoreDefaults

(

)

It restores all configurable parameters to defaults values.

Returns:

'0' on success, '1' otherwise

Definition at line 652 of file WaspXBeeXSC.cpp.

References check(), clean(), delay(), WaspXBee::println(), and XBee.

{
  clean();
  XBee.println("atre");
  delay(1000);
  return check();
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::setDelaySlots

(

uint8_t

slot

)

It sets the random delay slots.

Parameters:

uint8_t

slot : the random delay slots (range [0x00-0xFF])

Returns:

'0' on success, '1' otherwise

Definition at line 668 of file WaspXBeeXSC.cpp.

References check(), clean(), delay(), delaySlots, HEX, WaspXBee::print(), WaspXBee::println(), and XBee.

{
  clean();
  XBee.print("atrn");
  XBee.println(slot,HEX);
  delay(1000);
  
  if(!check())
  {
        delaySlots=slot;
        return 0;
  }
  return 1;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::getDelaySlots

(

)

It gets the random delay slots.

It stores in global 'delaySlots' variable the random delay slots

Returns:

'0' on success, '1' otherwise

Definition at line 691 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), clean(), converter(), delay(), delaySlots, WaspXBee::println(), WaspXBee::read(), and XBee.

{
  uint8_t ByteIN[10];
  uint8_t error=1;
  uint8_t i=0;

  clean();
  XBee.println("atrn");
  delay(1000);
  while(XBee.available() > 0) 
  {
        ByteIN[i]=XBee.read();
        i++;
        error=0;
  }
  delaySlots=converter(ByteIN[0],ByteIN[1]);
  return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::setPacketTimeout	(	uint8_t	pack_H,
		uint8_t	pack_L
	)

It sets the packetization timeout.

Parameters:

	uint8_t	pack_H : higher timeout byte (range [0x00-0xFF])
	uint8_t	pack_L : lower timeout byte (range [0x00-0xFF])

Returns:

'0' on success, '1' otherwise

Definition at line 718 of file WaspXBeeXSC.cpp.

References check(), clean(), delay(), HEX, packetTimeout, WaspXBee::print(), WaspXBee::println(), and XBee.

{
  clean();
  XBee.print("atro");
  XBee.print(pack_H,HEX);
  XBee.println(pack_L,HEX);
  delay(1000);
  
  if(!check())
  {
        packetTimeout[0]=pack_H;
        packetTimeout[1]=pack_L;
        return 0;
  }
  return 1;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::getPacketTimeout

(

)

It gets the packetization timeout.

It stores in global 'packetTimeout' variable the random delay slots

Returns:

'0' on success, '1' otherwise

Definition at line 743 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), clean(), converter(), delay(), packetTimeout, WaspXBee::println(), WaspXBee::read(), and XBee.

{
  uint8_t ByteIN[10];
  uint8_t error=1;
  uint8_t i=0;

  clean();
  XBee.println("atro");
  delay(1000);
  while(XBee.available() > 0) 
  {
        ByteIN[i]=XBee.read();
        i++;
        error=0;
  }
  packetTimeout[0]=converter(ByteIN[0],ByteIN[1]);
  packetTimeout[1]=converter(ByteIN[2],ByteIN[3]);
  return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::setRSSItime

(

uint8_t

rssiTime

)

It sets the time the output pin is active with the RSSI value.

Parameters:

uint8_t

rssiTime : the time the output pin is active with the RSSI value (range [0x00-0x7F])

Returns:

'0' on success, '1' otherwise

Definition at line 771 of file WaspXBeeXSC.cpp.

References check(), clean(), delay(), HEX, WaspXBee::print(), WaspXBee::println(), timeRSSI, and XBee.

{
  clean();
  XBee.print("atrp");
  XBee.println(rssiTime,HEX);
  delay(1000);
  
  if(!check())
  {
        timeRSSI=rssiTime;
        return 0;
  }
  return 1;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::getRSSItime

(

)

It gets the time the output pin is active with the RSSI value.

It stores in global 'timeRSSI' variable the time the output pin is active with the RSSI value

Returns:

'0' on success, '1' otherwise

Definition at line 794 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), clean(), converter(), delay(), WaspXBee::println(), WaspXBee::read(), timeRSSI, and XBee.

{
  uint8_t ByteIN[10];
  uint8_t error=1;
  uint8_t i=0;

  clean();
  XBee.println("atrp");
  delay(1000);
  while(XBee.available() > 0) 
  {
        ByteIN[i]=XBee.read();
        i++;
        error=0;
  }
  timeRSSI=converter(ByteIN[0],ByteIN[1]);
  return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::setRetries

(

uint8_t

retry

)

It sets the number of retries that can be sent for a given packet RF.

Parameters:

uint8_t

retry : the number of retries that can be sent for a given packet RF (range [0x00-0xFF])

Returns:

'0' on success, '1' otherwise

Definition at line 821 of file WaspXBeeXSC.cpp.

References check(), clean(), delay(), HEX, WaspXBee::print(), WaspXBee::println(), retries, and XBee.

{
  clean();
  XBee.print("atrr");
  XBee.println(retry,HEX);
  delay(1000);
  
  if(!check())
  {
        retries=retry;
        return 0;
  }
  return 1;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::getRetries

(

)

It gets the number of retries that can be sent for a given packet RF.

It stores in global 'retries' variable the number of retries that can be sent for a given packet RF

Returns:

'0' on success, '1' otherwise

Definition at line 844 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), clean(), converter(), delay(), WaspXBee::println(), WaspXBee::read(), retries, and XBee.

{
  uint8_t ByteIN[10];
  uint8_t error=1;
  uint8_t i=0;

  clean();
  XBee.println("atrr");
  delay(1000);
  while(XBee.available() > 0) 
  {
        ByteIN[i]=XBee.read();
        i++;
        error=0;
  }
  retries=converter(ByteIN[0],ByteIN[1]);
  return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::getRSSIvalue

(

)

It gets the last received packet RSSI.

It stores in global 'RSSI' variable the last received packet RSSI

Returns:

'0' on success, '1' otherwise

Definition at line 871 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), clean(), converter(), delay(), WaspXBee::println(), WaspXBee::read(), RSSI, and XBee.

{
  uint8_t ByteIN[10];
  uint8_t error=1;
  uint8_t i=0;

  clean();
  XBee.println("atrs");
  delay(1000);
  while(XBee.available() > 0) 
  {
        ByteIN[i]=XBee.read();
        i++;
        error=0;
  }
  RSSI=converter(ByteIN[0],ByteIN[1]);
  return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::setStopBits

(

uint8_t

stop

)

It sets the number of stop bits in the data packets.

Parameters:

uint8_t

stop : the number of stop bits in the data packets (range [0-1])

Returns:

'0' on success, '1' otherwise

Definition at line 898 of file WaspXBeeXSC.cpp.

References check(), clean(), delay(), HEX, WaspXBee::print(), WaspXBee::println(), stopBits, and XBee.

{
  clean();
  XBee.print("atsb");
  XBee.println(stop,HEX);
  delay(1000);
  
  if(!check())
  {
        stopBits=stop;
        return 0;
  }
  return 1;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::getStopBits

(

)

It gets the number of stop bits in the data packets.

It stores in global 'stopBits' variable the number of stop bits in the data packets

Returns:

'0' on success, '1' otherwise

Definition at line 921 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), clean(), converter(), delay(), WaspXBee::println(), WaspXBee::read(), stopBits, and XBee.

{
  uint8_t ByteIN[10];
  uint8_t error=1;
  uint8_t i=0;

  clean();
  XBee.println("atsb");
  delay(1000);
  while(XBee.available() > 0) 
  {
        ByteIN[i]=XBee.read();
        i++;
        error=0;
  }
  stopBits=converter(ByteIN[0],ByteIN[1]);
  return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::getSourceMacHigh

(

)

It gets the 32b Higher Source Mac.

It stores in global 'sourceMacHigh' variable the 32b Higher Source Mac

Returns:

'0' on success, '1' otherwise

Definition at line 948 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), clean(), converter(), delay(), it, WaspXBee::println(), WaspXBee::read(), sourceMacHigh, and XBee.

Referenced by sendData().

{
  uint8_t ByteIN[10];
  uint8_t error=1;
  uint8_t i=0;

  clean();
  XBee.println("atsh");
  delay(1000);
  while(XBee.available() > 0) 
  {
        ByteIN[i]=XBee.read();
        i++;
        error=0;
  }
  if(i<5)
  {
          ByteIN[3]=ByteIN[2];
          ByteIN[2]=ByteIN[1];
          ByteIN[1]=ByteIN[0];
          ByteIN[0]=0;
  }
  it=0; 
  i=0;
  while(i<4)
  {
        sourceMacHigh[it]=converter(ByteIN[i],ByteIN[i+1]);
        i++;
        i++;
        it++;
  }
  return error;
}

Here is the call graph for this function:

Here is the caller graph for this function:

uint8_t WaspXBeeXSC::getSourceMacLow

(

)

It gets the 32b Lower Source Mac.

It stores in global 'sourceMacLow' variable the 32b Lower Source Mac

Returns:

'0' on success, '1' otherwise

Definition at line 990 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), clean(), converter(), delay(), it, WaspXBee::println(), WaspXBee::read(), sourceMacLow, and XBee.

Referenced by sendData().

{
  uint8_t ByteIN[10];
  uint8_t error=1;
  uint8_t i=0;

  clean();
  XBee.println("atsl");
  delay(1000);
  while(XBee.available() > 0) 
  {
        ByteIN[i]=XBee.read();
        i++;
        error=0;
  }
  if(i<5)
  {
          ByteIN[3]=ByteIN[2];
          ByteIN[2]=ByteIN[1];
          ByteIN[1]=ByteIN[0];
          ByteIN[0]=0;
  }
  i=0;
  it=0;
  while(i<4)
  {
        sourceMacLow[it]=converter(ByteIN[i],ByteIN[i+1]);
        i++;
        i++;
        it++;
  }
  return error;
}

Here is the call graph for this function:

Here is the caller graph for this function:

uint8_t WaspXBeeXSC::setSleepMode

(

uint8_t

smode

)

It sets the Sleep Mode.

Parameters:

uint8_t

smode : the Sleep Mode (range [0-8])

Returns:

'0' on success, '1' otherwise

Definition at line 1032 of file WaspXBeeXSC.cpp.

References check(), clean(), DEC, delay(), WaspXBee::print(), WaspXBee::println(), sleepMode, and XBee.

{
  clean();
  XBee.print("atsm");
  XBee.println(smode,DEC);
  delay(1000);
  
  if(!check())
  {
        sleepMode=smode;
        return 0;
  }
  return 1;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::getSleepMode

(

)

It gets the Sleep Mode.

It stores in global 'sleepMode' variable the Sleep Mode

Returns:

'0' on success, '1' otherwise

Definition at line 1055 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), clean(), converter(), delay(), WaspXBee::println(), WaspXBee::read(), sleepMode, and XBee.

{
  uint8_t ByteIN[10];
  uint8_t error=1;
  uint8_t i=0;

  clean();
  XBee.println("atsm");
  delay(1000);
  while(XBee.available() > 0) 
  {
        ByteIN[i]=XBee.read();
        i++;
        error=0;
  }
  sleepMode=converter(ByteIN[0]);
  return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::setAwakeTime	(	uint8_t	awake_H,
		uint8_t	awake_L
	)

It sets the amount of time the module is awake.

Parameters:

	uint8_t	awake_H : higher awake time byte (range [0x00-0xFF])
	uint8_t	awake_L : lower awake time byte (range [0x10-0xFF])

Returns:

'0' on success, '1' otherwise

Definition at line 1083 of file WaspXBeeXSC.cpp.

References awakeTime, check(), clean(), delay(), HEX, WaspXBee::print(), WaspXBee::println(), and XBee.

{
  clean();
  XBee.print("atst");
  XBee.print(awake_H,HEX);
  XBee.println(awake_L,HEX);
  delay(1000);
  
  if(!check())
  {
        awakeTime[0]=awake_H;
        awakeTime[1]=awake_L;
        return 0;
  }
  return 1;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::getAwakeTime

(

)

It gets the amount of time the module is awake.

It stores in global 'awakeTime' variable the amount of time the module is awake

Returns:

'0' on success, '1' otherwise

Definition at line 1109 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), awakeTime, clean(), converter(), delay(), WaspXBee::println(), WaspXBee::read(), and XBee.

{
  uint8_t ByteIN[10];
  uint8_t error=1;
  uint8_t i=0;

  clean();
  XBee.println("atst");
  delay(1000);
  while(XBee.available() > 0) 
  {
        ByteIN[i]=XBee.read();
        i++;
        error=0;
  }
  awakeTime[0]=converter(ByteIN[0],ByteIN[1]);
  awakeTime[1]=converter(ByteIN[2],ByteIN[3]);
  return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::setTimeBeforeInit

(

uint8_t

timeInit

)

It sets the time before sending again the initializer.

Parameters:

uint8_t

timeInit : the time before sending again the initializer (range [0x00-0xFF])

Returns:

'0' on success, '1' otherwise

Definition at line 1137 of file WaspXBeeXSC.cpp.

References check(), clean(), delay(), HEX, WaspXBee::print(), WaspXBee::println(), timeBeforeInit, and XBee.

{
  clean();
  XBee.print("atsy");
  XBee.println(timeInit,HEX);
  delay(1000);
  
  if(!check())
  {
        timeBeforeInit=timeInit;
        return 0;
  }
  return 1;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::getTimeBeforeInit

(

)

It gets the time before sending again the initializer.

It stores in global 'timeBeforeInit' variable the time before sending again the initializer

Returns:

'0' on success, '1' otherwise

Definition at line 1160 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), clean(), converter(), delay(), WaspXBee::println(), WaspXBee::read(), timeBeforeInit, and XBee.

{
  uint8_t ByteIN[10];
  uint8_t error=1;
  uint8_t i=0;

  clean();
  XBee.println("atsy");
  delay(1000);
  while(XBee.available() > 0) 
  {
        ByteIN[i]=XBee.read();
        i++;
        error=0;
  }
  timeBeforeInit=converter(ByteIN[0],ByteIN[1]);
  return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::setTransmitErrorCount	(	uint8_t	txerror_H,
		uint8_t	txerror_L
	)

It sets the transmit error count.

Parameters:

	uint8_t	txerror_H : higher transmit error count byte (range [0x00-0xFF])
	uint8_t	txerror_L : lower transmit error count byte (range [0x00-0xFF])

Returns:

'0' on success, '1' otherwise

Definition at line 1187 of file WaspXBeeXSC.cpp.

References check(), clean(), delay(), HEX, WaspXBee::print(), WaspXBee::println(), transmitErrorCount, and XBee.

{
  clean();
  XBee.print("attr");
  XBee.print(txerror_H,HEX);
  XBee.println(txerror_L,HEX);
  delay(1000);
  
  if(!check())
  {
        transmitErrorCount[0]=txerror_H;
        transmitErrorCount[1]=txerror_L;
        return 0;
  }
  return 1;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::getTransmitErrorCount

(

)

It gets the transmit error count.

It stores in global 'transmitErrorCount' variable the transmit error count

Returns:

'0' on success, '1' otherwise

Definition at line 1212 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), clean(), converter(), delay(), WaspXBee::println(), WaspXBee::read(), transmitErrorCount, and XBee.

{
  uint8_t ByteIN[10];
  uint8_t error=1;
  uint8_t i=0;

  clean();
  XBee.println("attr");
  delay(1000);
  while(XBee.available() > 0) 
  {
        ByteIN[i]=XBee.read();
        i++;
        error=0;
  }
  transmitErrorCount[0]=converter(ByteIN[0],ByteIN[1]);
  transmitErrorCount[1]=converter(ByteIN[2],ByteIN[3]);
  return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::setTransmitLimit	(	uint8_t	txlim_H,
		uint8_t	txlim_L
	)

It sets the max number of bytes a module can send before waiting.

Parameters:

	uint8_t	txlim_H : higher transmit limit byte (range [0x00-0xFF])
	uint8_t	txlim_L : lower transmit limit byte (range [0x00-0xFF])

Returns:

'0' on success, '1' otherwise

Definition at line 1240 of file WaspXBeeXSC.cpp.

References check(), clean(), delay(), HEX, WaspXBee::print(), WaspXBee::println(), transmitLimit, and XBee.

{
  clean();
  XBee.print("attt");
  XBee.print(txlim_H,HEX);
  XBee.println(txlim_L,HEX);
  delay(1000);
  
  if(!check())
  {
        transmitLimit[0]=txlim_H;
        transmitLimit[1]=txlim_L;
        return 0;
  }
  return 1;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::getTransmitLimit

(

)

It gets the max number of bytes a module can send before waiting.

It stores in global 'transmitLimit' variable the max number of bytes a module can send before waiting

Returns:

'0' on success, '1' otherwise

Definition at line 1265 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), clean(), converter(), delay(), WaspXBee::println(), WaspXBee::read(), transmitLimit, and XBee.

{
  uint8_t ByteIN[10];
  uint8_t error=1;
  uint8_t i=0;

  clean();
  XBee.println("attt");
  delay(1000);
  while(XBee.available() > 0) 
  {
        ByteIN[i]=XBee.read();
        i++;
        error=0;
  }
  transmitLimit[0]=converter(ByteIN[0],ByteIN[1]);
  transmitLimit[1]=converter(ByteIN[2],ByteIN[3]);
  return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::getSoftVersion

(

)

It gets the Firmware version.

It stores in global 'firmwareVersion' variable the Firmware version

Returns:

'0' on success, '1' otherwise

Definition at line 1293 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), clean(), converter(), delay(), firmwareVersion, WaspXBee::println(), WaspXBee::read(), and XBee.

{
  uint8_t ByteIN[10];
  uint8_t error=1;
  uint8_t i=0;

  clean();
  XBee.println("atvr");
  delay(1000);
  while(XBee.available() > 0) 
  {
        ByteIN[i]=XBee.read();
        i++;
        error=0;
  }
  firmwareVersion[0]=converter(ByteIN[0],ByteIN[1]);
  firmwareVersion[1]=converter(ByteIN[2],ByteIN[3]);
  return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::writeValues

(

)

It writes the parameters changed into non-volatil memory.

Returns:

'0' on success, '1' otherwise

Definition at line 1320 of file WaspXBeeXSC.cpp.

References check(), clean(), delay(), WaspXBee::println(), and XBee.

{
  uint8_t ByteIN[10];
  uint8_t error=1;
  uint8_t i=0;

  clean();
  XBee.println("atwr");
  delay(1000);
  return check();
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::sendData

(

struct packetXSC *

packet

)

It sends data to other modules.

It sends over the air its own MAC, data length and the data, so the receiver can identify the sender and store the data

Parameters:

struct

packetXSC* packet : a structure where the data to send is stored

Returns:

'0' on success, '1' otherwise

Definition at line 1339 of file WaspXBeeXSC.cpp.

References BYTE, packetXSC::data, packetXSC::data_length, DEC, exitCommandMode(), getSourceMacHigh(), getSourceMacLow(), HEX, it, WaspXBee::print(), setCommandMode(), sourceMacHigh, packetXSC::sourceMacHigh, sourceMacLow, packetXSC::sourceMacLow, and XBee.

{
  uint8_t error=2;

        error=setCommandMode();
        error=getSourceMacHigh();
        error=getSourceMacLow();
        error=exitCommandMode();
        packet->sourceMacHigh[0]=sourceMacHigh[0];
        packet->sourceMacHigh[1]=sourceMacHigh[1];
        packet->sourceMacLow[0]=sourceMacLow[0];
        packet->sourceMacLow[1]=sourceMacLow[1];

        // Enviamos los datos
        XBee.print(packet->sourceMacHigh[0],HEX);
        XBee.print(packet->sourceMacHigh[1],HEX);
        XBee.print(packet->sourceMacLow[0],HEX);
        XBee.print(packet->sourceMacLow[1],HEX);        
        XBee.print("-");
        XBee.print(packet->data_length,DEC);
        XBee.print("-");
        for(it=0;it<packet->data_length;it++)
        {
                XBee.print(packet->data[it],BYTE);
        }
        error=0;
        return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::readData

(

struct packetXSC *

packet

)

It reads data from other modules.

It stores the sender MAC and data into the 'packet' structure

Parameters:

struct

packetXSC* packet : a structure where the received data and node information is stored

Returns:

'0' on success, '1' otherwise

Definition at line 1375 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), converter(), packetXSC::data, packetXSC::data_length, WaspUtils::dec2hex(), WaspXBee::flush(), it, millis(), WaspXBee::read(), packetXSC::sourceMacHigh, packetXSC::sourceMacLow, Utils, and XBee.

{
  uint8_t error=2;
  uint8_t end=0;  
  uint16_t interval=2000;
  long previous=millis();
  uint8_t counter3=0;
  uint8_t trama=0;
  uint8_t length=0;
  uint8_t dataIN[110];

        for(int i=0;i<110;i++) dataIN[i]=0;
        previous=millis();
        while(end==0)
        {
                if(XBee.available()>0)
                {
                        previous=millis();
                        dataIN[counter3]=XBee.read();
                        counter3++;
                }
                
                if( (millis()-previous) > interval )
                {
                        end=1;
                        XBee.flush();
                } 
                
        }
        end=0;
        if(dataIN[0]==10) end=1;
        if( dataIN[8+end]!='-' ) return 1;
        packet->sourceMacHigh[0]=converter(dataIN[0+end],dataIN[1+end]);
        packet->sourceMacHigh[1]=converter(dataIN[2+end],dataIN[3+end]);
        packet->sourceMacLow[0]=converter(dataIN[4+end],dataIN[5+end]);
        packet->sourceMacLow[1]=converter(dataIN[6+end],dataIN[7+end]);
        it=9;
        while(dataIN[it]!='-')
        {
                length++;
                it++;
        }
        switch(length)
        {
                case 1: packet->data_length=converter(dataIN[9]);
                        break;
                case 2: packet->data_length=converter(dataIN[9],dataIN[10]);
                        break;
                case 3: packet->data_length=converter(dataIN[9],dataIN[10],dataIN[11]);
                        break;
        }
        packet->data_length=Utils.dec2hex(packet->data_length);
        it=0;
        for(it=0;it<packet->data_length;it++)
        {
                packet->data[it]=char(dataIN[it+10+length]);
        }
        return 0;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::sendCommandAT

(

char *

atcommand

)

It is a transparent function. The user introduces an AT command within a string.

It stores in the global 'commandAT' variable the XBee answer to the command

Parameters:

char

*atcommand : the AT command to send to the XBee module

Returns:

'0' on success, '1' otherwise

Definition at line 1445 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), BYTE, clean(), commandAT, delay(), WaspXBee::print(), WaspXBee::println(), WaspXBee::read(), and XBee.

{
        uint8_t error=1;
        uint8_t i=0;

        clean();
        XBee.print("at");
        while( *atcommand!='#' )
        {
                XBee.print(*atcommand++,BYTE);
        }
        XBee.println("");
        delay(1000);
        while(XBee.available() > 0) 
        {
                commandAT[i]=XBee.read();
                i++;
                error=0;
        }
        return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::ON

(

void

)

It connects XBee, activating switch and opens the UART.

Returns:

'0' on success, '1' otherwise

Definition at line 1475 of file WaspXBeeXSC.cpp.

References WaspXBee::begin(), clean(), delay(), WaspXBee::setMode(), XBee, and XBEE_ON.

{
        uint8_t error=2;
        XBee.begin();
        XBee.setMode(XBEE_ON);
        delay(50);
        clean();
        error=0;
        return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::sleep

(

)

It sets the XBee to sleep, asserting PIN 9.

Returns:

'0' on success, '1' otherwise

Definition at line 1494 of file WaspXBeeXSC.cpp.

References WaspXBee::close(), digitalWrite(), HIGH, OUTPUT, pinMode(), XBee, and XBEE_SLEEP.

{
        uint8_t error=2;
        pinMode(XBEE_SLEEP, OUTPUT);
        digitalWrite(XBEE_SLEEP,HIGH); 
        XBee.close();
        error=0;
        return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::wake

(

)

It wakes up the XBee, de-asserting PIN 9.

Returns:

'0' on success, '1' otherwise

Definition at line 1512 of file WaspXBeeXSC.cpp.

References WaspXBee::begin(), clean(), delay(), digitalWrite(), LOW, OUTPUT, pinMode(), XBee, and XBEE_SLEEP.

{
        uint8_t error=2;
        pinMode(XBEE_SLEEP, OUTPUT);
        digitalWrite(XBEE_SLEEP,LOW); 
        XBee.begin();
        delay(50);
        clean();
        error=0;
        return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeXSC::converter

(

uint8_t

conv1

)

[private]

It generates a decimal number from an ASCII character which was a number.

Parameters:

uint8_t

conv1 : the ASCII number to convert

Returns:

the converted number

Definition at line 1529 of file WaspXBeeXSC.cpp.

Referenced by getAddressMask(), getAwakeTime(), getBaudRate(), getDelaySlots(), getDestAddress(), getHoppingChannel(), getPacketTimeout(), getPinWakeUP(), getReceiveErrorCount(), getReceiveGoodCount(), getRetries(), getRSSI(), getRSSItime(), getRSSIvalue(), getSleepMode(), getSoftVersion(), getSourceMacHigh(), getSourceMacLow(), getStopBits(), getTimeBeforeInit(), getTimeBeforeWakeUP(), getTimeWakeUpInit(), getTransmitErrorCount(), getTransmitLimit(), getVendorID(), and readData().

{
  uint8_t aux=0;
  uint8_t resul=0;

        switch(conv1)
        {
                case 48: aux=0;
                         break;
                case 49: aux=1;
                         break;
                case 50: aux=2;
                         break;
                case 51: aux=3;
                         break;
                case 52: aux=4;
                         break;
                case 53: aux=5;
                         break;
                case 54: aux=6;
                         break;
                case 55: aux=7;
                         break;
                case 56: aux=8;
                         break;
                case 57: aux=9;
                         break;
        }
        resul=aux;
        return resul;
}

Here is the caller graph for this function:

uint8_t WaspXBeeXSC::converter	(	uint8_t	conv1,
		uint8_t	conv2
	)			[private]

It generates a decimal number from two ASCII characters which were numbers.

Parameters:

	uint8_t	conv1 : the ASCII number first digit to convert
	uint8_t	conv2 : the ASCII number second digit to convert

Returns:

the converted number

Definition at line 1566 of file WaspXBeeXSC.cpp.

{
  uint8_t aux=0;
  uint8_t aux2=0;
  uint8_t resul=0;

        switch(conv1)
        {
                case 48: aux=0;
                         break;
                case 49: aux=1;
                         break;
                case 50: aux=2;
                         break;
                case 51: aux=3;
                         break;
                case 52: aux=4;
                         break;
                case 53: aux=5;
                         break;
                case 54: aux=6;
                         break;
                case 55: aux=7;
                         break;
                case 56: aux=8;
                         break;
                case 57: aux=9;
                         break;
                case 65: aux=10;
                         break;
                case 66: aux=11;
                         break;
                case 67: aux=12;
                         break;
                case 68: aux=13;
                         break;
                case 69: aux=14;
                         break;
                case 70: aux=15;
                         break;
        }
        switch(conv2)
        {
                case 48: aux2=0;
                         break;
                case 49: aux2=1;
                         break;
                case 50: aux2=2;
                         break;
                case 51: aux2=3;
                         break;
                case 52: aux2=4;
                         break;
                case 53: aux2=5;
                         break;
                case 54: aux2=6;
                         break;
                case 55: aux2=7;
                         break;
                case 56: aux2=8;
                         break;
                case 57: aux2=9;
                         break;
                case 65: aux2=10;
                         break;
                case 66: aux2=11;
                         break;
                case 67: aux2=12;
                         break;
                case 68: aux2=13;
                         break;
                case 69: aux2=14;
                         break;
                case 70: aux2=15;
                         break;
                default: aux2=100;
                         break;
        }
        if(aux2==100) // Only one character but we have treated two, so We have to fix it
        {
                resul=aux;
        }
        else
        {
                resul=(aux*16)+aux2;
        }
        return resul;
}

uint8_t WaspXBeeXSC::converter	(	uint8_t	conv1,
		uint8_t	conv2,
		uint8_t	conv3
	)			[private]

It generates a decimal number from three ASCII characters which were numbers.

Parameters:

	uint8_t	conv1 : the ASCII number first digit to convert
	uint8_t	conv2 : the ASCII number second digit to convert
	uint8_t	conv3 : the ASCII number third digit to convert

Returns:

the converted number

Definition at line 1659 of file WaspXBeeXSC.cpp.

{
  uint8_t aux=0;
  uint8_t aux2=0;
  uint8_t aux3=0;
  uint8_t resul=0;

        switch(conv1)
        {
                case 48: aux=0;
                         break;
                case 49: aux=1;
                         break;
                case 50: aux=2;
                         break;
                case 51: aux=3;
                         break;
                case 52: aux=4;
                         break;
                case 53: aux=5;
                         break;
                case 54: aux=6;
                         break;
                case 55: aux=7;
                         break;
                case 56: aux=8;
                         break;
                case 57: aux=9;
                         break;
        }
        switch(conv2)
        {
                case 48: aux2=0;
                         break;
                case 49: aux2=1;
                         break;
                case 50: aux2=2;
                         break;
                case 51: aux2=3;
                         break;
                case 52: aux2=4;
                         break;
                case 53: aux2=5;
                         break;
                case 54: aux2=6;
                         break;
                case 55: aux2=7;
                         break;
                case 56: aux2=8;
                         break;
                case 57: aux2=9;
                         break;
        }
        switch(conv3)
        {
                case 48: aux3=0;
                         break;
                case 49: aux3=1;
                         break;
                case 50: aux3=2;
                         break;
                case 51: aux3=3;
                         break;
                case 52: aux3=4;
                         break;
                case 53: aux3=5;
                         break;
                case 54: aux3=6;
                         break;
                case 55: aux3=7;
                         break;
                case 56: aux3=8;
                         break;
                case 57: aux3=9;
                         break;
        }
        resul=aux3*100+aux2*10+aux;
        return resul;
}

void WaspXBeeXSC::clean

(

)

[private]

It checks if the XBee module answer a 'OK' message.

Returns:

'0' if OK returned, '1' otherwise

Definition at line 1739 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), WaspXBee::read(), and XBee.

Referenced by exitCommandMode(), forceReset(), forceWakeUP(), getAddressMask(), getAwakeTime(), getBaudRate(), getDelaySlots(), getDestAddress(), getHoppingChannel(), getPacketTimeout(), getPinWakeUP(), getReceiveErrorCount(), getReceiveGoodCount(), getRetries(), getRSSI(), getRSSItime(), getRSSIvalue(), getSleepMode(), getSoftVersion(), getSourceMacHigh(), getSourceMacLow(), getStopBits(), getTimeBeforeInit(), getTimeBeforeWakeUP(), getTimeWakeUpInit(), getTransmitErrorCount(), getTransmitLimit(), getVendorID(), ON(), restoreDefaults(), sendCommandAT(), setAddressMask(), setAwakeTime(), setBaudRate(), setCommandMode(), setDelaySlots(), setDestAddress(), setHoppingChannel(), setPacketTimeout(), setPinWakeUP(), setReceiveErrorCount(), setReceiveGoodCount(), setRetries(), setRSSItime(), setSleepMode(), setStopBits(), setTimeBeforeInit(), setTimeBeforeWakeUP(), setTimeWakeUpInit(), setTransmitErrorCount(), setTransmitLimit(), setVendorID(), wake(), and writeValues().

{
        uint8_t ByteIN=0;
        
        while(XBee.available() > 0) 
        {
                ByteIN = XBee.read();
        }
}

Here is the call graph for this function:

Here is the caller graph for this function:

uint8_t WaspXBeeXSC::check

(

void

)

[private]

It cleans the unwanted bytes returned by XBee module.

Returns:

'0' on success, '1' otherwise

Definition at line 1749 of file WaspXBeeXSC.cpp.

References WaspXBee::available(), WaspXBee::flush(), millis(), WaspXBee::read(), and XBee.

Referenced by exitCommandMode(), forceReset(), forceWakeUP(), restoreDefaults(), setAddressMask(), setAwakeTime(), setBaudRate(), setDelaySlots(), setDestAddress(), setHoppingChannel(), setPacketTimeout(), setPinWakeUP(), setReceiveErrorCount(), setReceiveGoodCount(), setRetries(), setRSSItime(), setSleepMode(), setStopBits(), setTimeBeforeInit(), setTimeBeforeWakeUP(), setTimeWakeUpInit(), setTransmitErrorCount(), setTransmitLimit(), setVendorID(), and writeValues().

{
        uint8_t ByteIN[10];
        uint8_t error=0;
        uint8_t i=0;
        uint8_t counter=0;
        long previous=0;
        uint8_t end=0;
        long interval=1000;
        
        previous=millis();
        while(end==0)
        {
                if(XBee.available()>0)
                {
                        ByteIN[i]=XBee.read();
                        i++;
                        previous=millis();
                }
                if( (millis()-previous) > interval )
                {
                        end=1;
                        XBee.flush();
                } 
        }
        counter=i;
        i=0;
        while(counter>i)
        {
                if(ByteIN[i]=='O')
                {
                        if(ByteIN[i+1]=='K')
                        {
                                return 0;
                        }
                }
                i++;            
        }
        return 1;
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

Field Documentation

uint8_t WaspXBeeXSC::vendorID[2]

Variable : the module Vendor ID.

Definition at line 523 of file WaspXBeeXSC.h.

Referenced by getVendorID(), and setVendorID().

uint8_t WaspXBeeXSC::baudRate

Variable : the Baud Rate used in the module.

Definition at line 528 of file WaspXBeeXSC.h.

Referenced by getBaudRate(), and setBaudRate().

uint8_t WaspXBeeXSC::valueRSSI

Variable : the dBm level in the most recent packet.

Definition at line 533 of file WaspXBeeXSC.h.

Referenced by getRSSI().

uint8_t WaspXBeeXSC::destAddress[2]

Variable : the networking address of a module.

Definition at line 538 of file WaspXBeeXSC.h.

Referenced by getDestAddress(), and setDestAddress().

uint8_t WaspXBeeXSC::receiveErrorCount[2]

Variable : the receive error count.

Definition at line 543 of file WaspXBeeXSC.h.

Referenced by getReceiveErrorCount(), and setReceiveErrorCount().

uint8_t WaspXBeeXSC::receiveGoodCount[2]

Variable : the receive good count.

Definition at line 548 of file WaspXBeeXSC.h.

Referenced by getReceiveGoodCount(), and setReceiveGoodCount().

uint8_t WaspXBeeXSC::channel

Variable : the Hopping Channel used in the transmission.

Definition at line 553 of file WaspXBeeXSC.h.

Referenced by getHoppingChannel(), and setHoppingChannel().

uint8_t WaspXBeeXSC::timeBeforeWakeUP[2]

Variable : the time before send a Wake-up initializer.

Definition at line 558 of file WaspXBeeXSC.h.

Referenced by getTimeBeforeWakeUP(), and setTimeBeforeWakeUP().

uint8_t WaspXBeeXSC::timeWakeUpInit

Variable : the amount of time the Wake-Up Init is sent.

Definition at line 563 of file WaspXBeeXSC.h.

Referenced by getTimeWakeUpInit(), and setTimeWakeUpInit().

uint8_t WaspXBeeXSC::addressMask[2]

Variable : the address mask.

Definition at line 568 of file WaspXBeeXSC.h.

Referenced by getAddressMask(), and setAddressMask().

uint8_t WaspXBeeXSC::pinWakeUP

Variable : the pin Wake-UP ON/OFF.

Definition at line 573 of file WaspXBeeXSC.h.

Referenced by getPinWakeUP(), and setPinWakeUP().

uint8_t WaspXBeeXSC::delaySlots

Variable : the random delay slots.

Definition at line 578 of file WaspXBeeXSC.h.

Referenced by getDelaySlots(), and setDelaySlots().

uint8_t WaspXBeeXSC::packetTimeout[2]

Variable : the packetization timeout.

Definition at line 583 of file WaspXBeeXSC.h.

Referenced by getPacketTimeout(), and setPacketTimeout().

uint8_t WaspXBeeXSC::timeRSSI

Variable : the time the output pin is active with the RSSI value.

Definition at line 588 of file WaspXBeeXSC.h.

Referenced by getRSSItime(), and setRSSItime().

uint8_t WaspXBeeXSC::retries

Variable : the number of retries that can be sent for a given packet RF.

Definition at line 593 of file WaspXBeeXSC.h.

Referenced by getRetries(), and setRetries().

uint8_t WaspXBeeXSC::RSSI

Variable : the last received packet RSSI.

Definition at line 598 of file WaspXBeeXSC.h.

Referenced by getRSSIvalue().

uint8_t WaspXBeeXSC::stopBits

Variable : the number of stop bits in the data packets.

Definition at line 603 of file WaspXBeeXSC.h.

Referenced by getStopBits(), and setStopBits().

uint8_t WaspXBeeXSC::sourceMacHigh[2]

Variable : the 32b Higher Source Mac.

Definition at line 608 of file WaspXBeeXSC.h.

Referenced by getSourceMacHigh(), and sendData().

uint8_t WaspXBeeXSC::sourceMacLow[2]

Variable : the 32b Lower Source Mac.

Definition at line 613 of file WaspXBeeXSC.h.

Referenced by getSourceMacLow(), and sendData().

uint8_t WaspXBeeXSC::sleepMode

Variable : the Sleep Mode.

Definition at line 618 of file WaspXBeeXSC.h.

Referenced by getSleepMode(), and setSleepMode().

uint8_t WaspXBeeXSC::awakeTime[2]

Variable : the amount of time the module is awake.

Definition at line 623 of file WaspXBeeXSC.h.

Referenced by getAwakeTime(), and setAwakeTime().

uint8_t WaspXBeeXSC::timeBeforeInit

Variable : the time before sending again the initializer.

Definition at line 628 of file WaspXBeeXSC.h.

Referenced by getTimeBeforeInit(), and setTimeBeforeInit().

uint8_t WaspXBeeXSC::transmitErrorCount[2]

Variable : the transmit error count.

Definition at line 633 of file WaspXBeeXSC.h.

Referenced by getTransmitErrorCount(), and setTransmitErrorCount().

uint8_t WaspXBeeXSC::transmitLimit[2]

Variable : the max number of bytes a module can send before waiting.

Definition at line 638 of file WaspXBeeXSC.h.

Referenced by getTransmitLimit(), and setTransmitLimit().

uint8_t WaspXBeeXSC::firmwareVersion[2]

Variable : the Firmware version.

Definition at line 643 of file WaspXBeeXSC.h.

Referenced by getSoftVersion().

uint8_t WaspXBeeXSC::commandAT[20]

Variable : the XBee answer to the command.

Definition at line 648 of file WaspXBeeXSC.h.

Referenced by sendCommandAT().

uint8_t WaspXBeeXSC::it [private]

Variable : counter used in the library.

Definition at line 692 of file WaspXBeeXSC.h.

Referenced by getSourceMacHigh(), getSourceMacLow(), readData(), and sendData().

uint8_t WaspXBeeXSC::protocol [private]

Variable : protocol used (XBEE_XSC in this case).

Definition at line 697 of file WaspXBeeXSC.h.

Referenced by init().

uint8_t WaspXBeeXSC::freq [private]

Variable : frequency used (FREQ900M in this case).

Definition at line 702 of file WaspXBeeXSC.h.

Referenced by init().

uint8_t WaspXBeeXSC::model [private]

Variable : model used (PRO in this case).

Definition at line 707 of file WaspXBeeXSC.h.

Referenced by init().

---

The documentation for this class was generated from the following files:

• WaspXBeeXSC.h
• WaspXBeeXSC.cpp