WaspXBeeCore Class Reference

WaspXBeeCore Class. More...

#include <WaspXBeeCore.h>

Inheritance diagram for WaspXBeeCore:

[legend]

Collaboration diagram for WaspXBeeCore:

[legend]

Public Member Functions
	WaspXBeeCore ()
	class constructor
void	init (uint8_t protocol_used, uint8_t frequency, uint8_t model_used)
	It initializes the necessary variables.
uint8_t	getOwnMacLow ()
	It gets the own lower 32b MAC.
uint8_t	getOwnMacHigh ()
	It gets the own higher 32b MAC.
uint8_t	getOwnMac ()
	It gets the own MAC.
uint8_t	setOwnNetAddress (uint8_t NA_H, uint8_t NA_L)
	It sets the own 16b Network Address.
uint8_t	getOwnNetAddress ()
	It gets the 16b Network Address.
uint8_t	setBaudrate (uint8_t baud_rate)
	It sets the baudrate.
uint8_t	setAPI (uint8_t api_value)
	It sets API enabled or disabled.
uint8_t	setAPIoptions (uint8_t api_options)
	It sets API options.
uint8_t	setPAN (uint8_t *PANID)
	It sets the PAN ID.
uint8_t	getPAN ()
	It gets the PAN ID.
uint8_t	setSleepMode (uint8_t sleep)
	It sets the sleep mode.
uint8_t	getSleepMode ()
	It gets the sleep mode.
uint8_t	setAwakeTime (uint8_t *awake)
	It sets the time awake before sleeping.
uint8_t	setSleepTime (uint8_t *sleep)
	It sets time the module is slept.
uint8_t	setChannel (uint8_t _channel)
	It sets the channel frequency where module is working on.
uint8_t	getChannel ()
	It gets the channel frequency where module is working on.
uint8_t	setNodeIdentifier (char *node)
	It sets the Node Identifier.
uint8_t	getNodeIdentifier ()
	It gets the Node Identifier.
uint8_t	scanNetwork ()
	It scans for brothers in the same channel and same PAN ID.
uint8_t	scanNetwork (char *node)
	It scans for a brother in the same channel and same PAN ID.
uint8_t	setScanningTime (uint8_t *time)
	It sets the time the Node Discovery is scanning.
uint8_t	getScanningTime ()
	It gets the time the Node Discovery is scanning.
uint8_t	setDiscoveryOptions (uint8_t options)
	It sets the options for the network discovery command.
uint8_t	getDiscoveryOptions ()
	It gets the options for the network discovery command.
uint8_t	nodeSearch (char *node, struct packetXBee *paq)
	It performs a quick search of a specific node. Depending on the XBee module it stores different information.
uint8_t	setScanningChannels (uint8_t channel_H, uint8_t channel_L)
	It sets the list of channels to scan when performing an energy scan.
uint8_t	getScanningChannels ()
	It gets the list of channels to scan when performing an energy scan.
uint8_t	setDurationEnergyChannels (uint8_t duration)
	It sets the time the Energy Scan will be performed.
uint8_t	getDurationEnergyChannels ()
	It gets the time the Energy Scan will be performed.
uint8_t	setLinkKey (char *key)
	It sets the link key to use in the 128b AES algorithm.
uint8_t	encryptionMode (uint8_t mode)
	It sets the encryption mode ON/OFF.
uint8_t	setPowerLevel (uint8_t value)
	It sets the power level at which RF module transmits.
uint8_t	getRSSI ()
	It gets the Received Signal Strength Indicator.
uint8_t	getHardVersion ()
	It gets the Hardware Version.
uint8_t	getSoftVersion ()
	It gets the Software Version.
uint8_t	setRSSItime (uint8_t time)
	It sets the RSSI time.
uint8_t	getRSSItime ()
	It gets the RSSI time.
uint8_t	writeValues ()
	It writes the parameters changed into non-volatil memory, being applied when the XBee is set OFF.
uint8_t	applyChanges ()
	It writes the parameters changed into non-volatil memory and applies them immediately.
uint8_t	reset ()
	It resets the XBee firmware.
uint8_t	resetDefaults ()
	It resets the XBee parameters to factory defaults.
uint8_t	setSleepOptions (uint8_t soption)
	It sets the sleep options.
uint8_t	getSleepOptions ()
	It gets the sleep options.
uint8_t	sendXBee (struct packetXBee *packet)
	It sends a packet to others XBee modules.
int8_t	send (uint8_t *address, char *data)
	It sends a packet to others XBee modules.
int8_t	send (char *address, char *data)
	It sends a packet to others XBee modules.
int8_t	treatData ()
	It treats the data from XBee UART.
uint8_t	freeXBee ()
	It frees the outcoming data buffer in the XBee.
uint8_t	synchronization (struct packetXBee *paq)
	It synchronizes two nodes in a PAN.
uint8_t	sendCommandAT (char *atcommand)
	The user introduces an AT command within a string and the function executes it without knowing its meaning.
uint8_t	ON ()
	It connects XBee, activating switch and opens the UART.
uint8_t	OFF ()
	It disconnects XBee, switching it off and closing 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.
uint8_t	setDestinationParams (packetXBee *paq, uint8_t *address, char *data, uint8_t type, uint8_t off_type)
	It sets the destination parameters, such as the receiver address and the data to send.
uint8_t	setDestinationParams (packetXBee *paq, uint8_t *address, int data, uint8_t type, uint8_t off_type)
	It sets the destination parameters, such as the receiver address and the data to send.
uint8_t	setDestinationParams (packetXBee *paq, char *address, char *data, uint8_t type, uint8_t off_type)
	It sets the destination parameters, such as the receiver address and the data to send.
uint8_t	setDestinationParams (packetXBee *paq, char *address, int data, uint8_t type, uint8_t off_type)
	It sets the destination parameters, such as the receiver address and the data to send.
uint8_t	setOriginParams (packetXBee *paq, uint8_t type)
	It sets the origin parameters, such as the sender address.
uint8_t	setOriginParams (packetXBee *paq, char *address, uint8_t type)
	It sets the origin parameters, such as the sender address.
void	clearCommand ()
	It clears the variable 'command'.
Data Fields
uint8_t	XBee_ON
	Variable : it stores if the XBee module is ON or OFF (0-1).
uint8_t	sourceMacLow [4]
	Variable : 32b Lower Mac Source.
uint8_t	sourceMacHigh [4]
	Variable : 32b Higher Mac Source.
uint8_t	sourceNA [2]
	Variable : 16b Network Address.
uint8_t	baudrate
	Variable : Baudrate, speed used to communicate with the XBee module (0-5).
uint8_t	apiValue
	Variable : Api value selected (0-2).
uint8_t	PAN_ID [8]
	Variable : 64b PAN ID.
uint8_t	sleepMode
	Variable : Current Sleep Mode (0-5).
matrix *	packet_fragments [MAX_FINISH_PACKETS][MAX_FRAG_PACKETS]
	Variable : bidimensional array for storing the received fragments.
uint8_t	totalFragmentsReceived
	Variable : the number of fragments received.
index *	pendingFragments [MAX_FINISH_PACKETS]
	Variable : array for storing the information related with each global packet, being able to order the different fragments.
uint8_t	pendingPackets
	Variable : number of packets pending of being treated.
packetXBee *	packet_finished [MAX_FINISH_PACKETS]
	Variable : array for storing the packets received completely.
uint8_t	totalPacketsReceived
	Variable : real number of complete received packets.
uint8_t	pos
	Variable : indicates the position in 'packet_finished' array of each packet.
Node	scannedBrothers [MAX_BROTHERS]
	Variable : array for storing the information answered by the nodes when a Node Discovery is performe.
int8_t	totalScannedBrothers
	Variable : number of brothers found.
uint8_t	awakeTime [3]
	Variable : time to be idle before start sleeping.
uint8_t	sleepTime [3]
	Variable : Cyclic sleeping time.
uint8_t	channel
	Variable : Channel frequency where the module is currently working on.
char	nodeID [20]
	Variable : Node Identifier.
uint8_t	scanTime [2]
	Variable : time meanwhile the Node Discovery is scanning.
uint8_t	discoveryOptions
	Variable : options for the network discovery command.
uint8_t	scanChannels [2]
	Variable : list of channels to scan when performing an energy scan.
uint8_t	energyChannel [20]
	Variable : energy found on each channel.
uint8_t	timeEnergyChannel
	Variable : time the Energy Scan is going to be performed.
char	linkKey [16]
	Variable : 128b AES Link key.
uint8_t	encryptMode
	Variable : encryption mode (ON/OFF) (0-1).
uint8_t	powerLevel
	Variable : power level at which the RF transmits.
uint8_t	timeRSSI
	Variable : time meanwhile the PWM output is active after receiving a packet.
uint8_t	softVersion [2]
	Variable : software Version.
uint8_t	hardVersion [2]
	Variable : hardware Version.
uint8_t	valueRSSI [2]
	Variable : received Signal Strength Indicator.
uint8_t	sleepOptions
	Variable : sleep Options.
uint8_t	hops
	Variable : max number of hops a packet can travel.
uint8_t	commandAT [100]
	Variable : Answer received after executing "sendCommandAT" function.
uint8_t	modem_status
	Variable : It stores the last Modem Status indication received.
uint8_t	replacementPolicy
	Variable : It specifies the replacement ploicty to implement (FIFO, LIFO or OUT).
int8_t	error_AT
	Variable : It stores if the last call to an AT command has generated an error.
int8_t	error_RX
	Variable : It stores if the last received packet has generated an error.
int8_t	error_TX
	Variable : It stores if the last sent packet has generated an error.
Protected Member Functions
int8_t	readXBee (uint8_t *data)
	It reads a packet from other XBee module.
uint8_t	sendXBeePriv (struct packetXBee *packet)
	It sends a packet to other XBee modules.
void	gen_data (const char *data, uint8_t param)
	It generates the API frame to send to the XBee module.
void	gen_data (const char *data)
	It generates the API frame to send to the XBee module.
void	gen_data (const char *data, uint8_t param1, uint8_t param2)
	It generates the API frame to send to the XBee module.
void	gen_data (const char *data, uint8_t *param)
	It generates the API frame to send to the XBee module.
void	gen_data (const char *data, char *param)
	It generates the API frame to send to the XBee module.
uint8_t	gen_checksum (const char *data)
	It generates the checksum API frame to send to the XBee module.
uint8_t	gen_send (const char *data)
	It sends the API frame stored in 'command' variable to the XBee module.
void	gen_frame (struct packetXBee *_packet, uint8_t *TX_array, uint8_t start_pos)
	It generates the API frame when a TX is done.
void	gen_frame_ap2 (struct packetXBee *_packet, uint8_t *TX_array, uint8_t &protect, uint8_t type)
	It generates the frame using eschaped characters.
int8_t	parse_message (uint8_t *frame)
	It parses the answer received by the XBee module, calling the appropriate function.
void	des_esc (uint8_t *data_in, uint16_t end, uint16_t start)
	It generates the correct API frame from an eschaped one.
uint8_t	atCommandResponse (uint8_t *data_in, uint8_t *frame, uint16_t end, uint16_t start)
	It parses the AT command answer received by the XBee module.
uint8_t	modemStatusResponse (uint8_t *data_in, uint16_t end, uint16_t start)
	It parses the Modem Status message received by the XBee module.
uint8_t	txStatusResponse (uint8_t *ByteIN)
	It parses the TX Status message received by the XBee module.
uint8_t	txZBStatusResponse (uint8_t *ByteIN)
	It parses the ZB TX Status message received by the XBee module.
int8_t	rxData (uint8_t *data_in, uint16_t end, uint16_t start)
	It parses the RX Data message received by the XBee module.
void	treatScan ()
	It parses the ND message received by the XBee module.
uint8_t	checkChecksum (uint8_t *data_in, uint16_t end, uint16_t start)
	It checks the checksum is good.
void	freeIndex ()
	It frees a position in index array.
void	freeAll ()
	It frees index array and matrix.
uint8_t	getFinishIndex ()
	It gets the next index where store the finished packet.
void	clearFinishArray ()
	It clears the finished packets array.
uint8_t	getIndexFIFO ()
	It gets the index in 'packet_finished' where store the new packet, according to a FIFO policy.
uint8_t	getIndexLIFO ()
	It gets the index in 'packet_finished' where store the new packet, according to a LIFO policy.
void	freeIndexMatrix (uint8_t position)
	It frees the index array and the matrix row corresponding to the position is sent as an input parameter.
Protected Attributes
uint8_t	protocol
	Variable : protocol used (depends on de the XBee module).
uint8_t	freq
	Variable : frequency used (depends on de the XBee module).
uint8_t	model
	Variable : model used (depends on de the XBee module).
uint16_t	data_length
	Variable : internal variable used to store the data length.
uint8_t	data [50]
	Variable : it stores the data received in each frame.
uint16_t	it
	Variable : internal counter.
uint16_t	start
	Variable : byte for starting getting the data.
uint16_t	finish
	Variable : byte for stopping getting the data.
uint8_t	add_type
	Variable : address type.
uint8_t	mode
	Variable : sending mode.
uint16_t	frag_length
	Variable : fragment length.
long	TIME1
	Variable : time used to manage timeouts.
uint8_t	command [30]
	Variable : array to store the AT commands.
uint16_t	data_ind
	Variable : index data to make a packet from many different data.
uint8_t	delivery_status
	Variable : delivery packet status.
uint8_t	discovery_status
	Variable : discovery process status.
uint8_t	true_naD [2]
	Variable : true 16b Network Address where the packet has been sent.
uint8_t	retries_sending
	Variable : retries done during the sending.
uint8_t	nextIndex1
	Variable : specifies the next index where storing the next received fragment.
uint8_t	frameNext
	Variable : flag to indicate if a frame was truncated.
uint8_t	indexNotModified
	Variable : flag to indicate if the variable 'nextIndex1' has been modified during the last execution of 'readXBee'.
uint8_t	apsEncryption
	Variable : specifies if APS encryption is enabled or disabled.

---

Detailed Description

WaspXBeeCore Class.

WaspXBeeCore Class defines all the variables and functions used for managing the XBee modules. In this library, all the common functions are defined to be used in the other XBee libraries

Definition at line 444 of file WaspXBeeCore.h.

---

Constructor & Destructor Documentation

WaspXBeeCore::WaspXBeeCore

(

)

[inline]

class constructor

It does nothing

Parameters:

void

Returns:

void

Definition at line 454 of file WaspXBeeCore.h.

{};

---

Member Function Documentation

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

It initializes the necessary variables.

It initalizes all the necessary variables

Parameters:

	uint8_t	protocol_used : specifies the protocol used in the XBee module (depends on the XBee module)
	uint8_t	frequency : specifies the frequency used in the XBee module (depends on the XBee module)
	uint8_t	model_used : specifies the XBee model used (depends on the XBee module)

Returns:

void

Reimplemented in WaspXBee802, WaspXBee868, WaspXBeeDM, and WaspXBeeZB.

Definition at line 37 of file WaspXBeeCore.cpp.

References add_type, apsEncryption, AWAKE_TIME_802_15_4_H, AWAKE_TIME_802_15_4_L, AWAKE_TIME_DIGIMESH_H, AWAKE_TIME_DIGIMESH_L, AWAKE_TIME_DIGIMESH_M, AWAKE_TIME_ZIGBEE_H, AWAKE_TIME_ZIGBEE_L, awakeTime, clearCommand(), clearFinishArray(), data_length, DIGIMESH, discoveryOptions, ENCRYPT_MODE_802_15_4, ENCRYPT_MODE_DIGIMESH, ENCRYPT_MODE_ZIGBEE, encryptMode, error_AT, error_RX, error_TX, finish, frag_length, frameNext, freq, indexNotModified, it, mode, model, nextIndex1, pendingPackets, pos, POWER_LEVEL_802_15_4, POWER_LEVEL_DIGIMESH, POWER_LEVEL_ZIGBEE, powerLevel, protocol, replacementPolicy, SCAN_CHANNELS_802_15_4_H, SCAN_CHANNELS_802_15_4_L, SCAN_CHANNELS_ZIGBEE_H, SCAN_CHANNELS_ZIGBEE_L, SCAN_TIME_802_15_4, SCAN_TIME_DIGIMESH_H, SCAN_TIME_DIGIMESH_L, SCAN_TIME_ZIGBEE, scanChannels, scanTime, SLEEP_OPTIONS_802_15_4, SLEEP_OPTIONS_DIGIMESH, SLEEP_OPTIONS_ZIGBEE, SLEEP_TIME_802_15_4_H, SLEEP_TIME_802_15_4_L, SLEEP_TIME_DIGIMESH_H, SLEEP_TIME_DIGIMESH_L, SLEEP_TIME_DIGIMESH_M, SLEEP_TIME_ZIGBEE_H, SLEEP_TIME_ZIGBEE_L, sleepOptions, sleepTime, start, TIME1, TIME_ENERGY_CHANNEL_ZIGBEE, TIME_RSSI_802_15_4, TIME_RSSI_DIGIMESH, TIME_RSSI_ZIGBEE, timeEnergyChannel, timeRSSI, totalFragmentsReceived, XBEE_802_15_4, XBEE_OUT, and ZIGBEE.

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

        totalFragmentsReceived=0;
        pendingPackets=0;
        pos=0;
        discoveryOptions=0x00;
        if(protocol==XBEE_802_15_4)
        {
                awakeTime[0]=AWAKE_TIME_802_15_4_H;
                awakeTime[1]=AWAKE_TIME_802_15_4_L;
                sleepTime[0]=SLEEP_TIME_802_15_4_H;
                sleepTime[1]=SLEEP_TIME_802_15_4_L;
                scanTime[0]=SCAN_TIME_802_15_4;
                scanChannels[0]=SCAN_CHANNELS_802_15_4_H;
                scanChannels[1]=SCAN_CHANNELS_802_15_4_L;
                encryptMode=ENCRYPT_MODE_802_15_4;
                powerLevel=POWER_LEVEL_802_15_4;
                timeRSSI=TIME_RSSI_802_15_4;
                sleepOptions=SLEEP_OPTIONS_802_15_4;
        }
        if(protocol==ZIGBEE)
        {
                awakeTime[0]=AWAKE_TIME_ZIGBEE_H;
                awakeTime[1]=AWAKE_TIME_ZIGBEE_L;
                sleepTime[0]=SLEEP_TIME_ZIGBEE_H;
                sleepTime[1]=SLEEP_TIME_ZIGBEE_L;
                scanTime[0]=SCAN_TIME_ZIGBEE;
                scanChannels[0]=SCAN_CHANNELS_ZIGBEE_H;
                scanChannels[1]=SCAN_CHANNELS_ZIGBEE_L;
                timeEnergyChannel=TIME_ENERGY_CHANNEL_ZIGBEE;
                encryptMode=ENCRYPT_MODE_ZIGBEE;
                powerLevel=POWER_LEVEL_ZIGBEE;
                timeRSSI=TIME_RSSI_ZIGBEE;
                sleepOptions=SLEEP_OPTIONS_ZIGBEE;
        }
        if(protocol==DIGIMESH)
        {
                awakeTime[0]=AWAKE_TIME_DIGIMESH_H;
                awakeTime[1]=AWAKE_TIME_DIGIMESH_M;
                awakeTime[2]=AWAKE_TIME_DIGIMESH_L;
                sleepTime[0]=SLEEP_TIME_DIGIMESH_H;
                sleepTime[1]=SLEEP_TIME_DIGIMESH_M;
                sleepTime[2]=SLEEP_TIME_DIGIMESH_L;
                scanTime[0]=SCAN_TIME_DIGIMESH_H;
                scanTime[1]=SCAN_TIME_DIGIMESH_L;
                encryptMode=ENCRYPT_MODE_DIGIMESH;
                powerLevel=POWER_LEVEL_DIGIMESH;
                timeRSSI=TIME_RSSI_DIGIMESH;
                sleepOptions=SLEEP_OPTIONS_DIGIMESH;
        }
        
        data_length=0;
        it=0;
        start=0;
        finish=0;
        add_type=0;
        mode=0;
        frag_length=0;
        TIME1=0;
        nextIndex1=0;
        frameNext=0;
        replacementPolicy=XBEE_OUT;
        indexNotModified=1;
        error_AT=2;
        error_RX=2;
        error_TX=2;
        clearFinishArray();
        clearCommand();
        apsEncryption=0;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::getOwnMacLow

(

)

It gets the own lower 32b MAC.

It stores in global 'sourceMacLow' variable the own lower 32b MAC

Returns:

'0' on success, '1' otherwise

Definition at line 121 of file WaspXBeeCore.cpp.

References data, error_AT, gen_data(), gen_send(), get_own_mac_low, it, and sourceMacLow.

Referenced by getOwnMac().

{
    int8_t error=2;
     
    error_AT=2;
    gen_data(get_own_mac_low);
    error=gen_send(get_own_mac_low);
    
    if(error==0)
    {
        for(it=0;it<4;it++)
        {
        sourceMacLow[it]=data[it];
        }
    }
    return error; 
}

Here is the call graph for this function:

Here is the caller graph for this function:

uint8_t WaspXBeeCore::getOwnMacHigh

(

)

It gets the own higher 32b MAC.

It stores in global 'sourceMacHigh' variable the own higher 32b MAC

Returns:

'0' on success, '1' otherwise

Definition at line 148 of file WaspXBeeCore.cpp.

References data, error_AT, gen_data(), gen_send(), get_own_mac_high, it, and sourceMacHigh.

Referenced by getOwnMac().

{
    int8_t error=2;
     
    error_AT=2;
    gen_data(get_own_mac_high);
    error=gen_send(get_own_mac_high);
    
    if(error==0)
    {
        for(it=0;it<4;it++)
        {
        sourceMacHigh[it]=data[it];
        }
    }
    return error;
}

Here is the call graph for this function:

Here is the caller graph for this function:

uint8_t WaspXBeeCore::getOwnMac

(

)

It gets the own MAC.

It stores in global 'sourceMacHigh' and 'sourceMacLow' variables the 64b MAC

Returns:

'0' on success, '1' otherwise

Definition at line 174 of file WaspXBeeCore.cpp.

References getOwnMacHigh(), and getOwnMacLow().

Referenced by setOriginParams().

{
  int8_t error=2;
  error=getOwnMacLow();
  if(error==0)
  {
    error=getOwnMacHigh();  
  }
  return error;
}

Here is the call graph for this function:

Here is the caller graph for this function:

uint8_t WaspXBeeCore::setOwnNetAddress	(	uint8_t	NA_H,
		uint8_t	NA_L
	)

It sets the own 16b Network Address.

Parameters:

	uint8_t	NA_H : higher Network Address byte (range [0x00-0xFF])
	uint8_t	NA_L : lower Network Address byte (range [0x00-0xFF])

Returns:

'0' on success, '1' otherwise

Definition at line 197 of file WaspXBeeCore.cpp.

References error_AT, gen_checksum(), gen_data(), gen_send(), protocol, set_own_net_address, sourceNA, and XBEE_802_15_4.

Referenced by sendXBeePriv().

{
    int8_t error=2;

    if(protocol==XBEE_802_15_4)
    {
                error_AT=2;
                gen_data(set_own_net_address,NA_H,NA_L);
                gen_checksum(set_own_net_address);
                error=gen_send(set_own_net_address);
    }
    else
    {
                error_AT=-1;
                error=-1;
    }
    
    if(!error)
    {
                sourceNA[0]=NA_H;
                sourceNA[1]=NA_L;
    }
    return error;
}

Here is the call graph for this function:

Here is the caller graph for this function:

uint8_t WaspXBeeCore::getOwnNetAddress

(

)

It gets the 16b Network Address.

It stores in global 'sourceNA' the 16b Network Address

Returns:

'0' on success, '1' otherwise

Definition at line 232 of file WaspXBeeCore.cpp.

References data, error_AT, gen_data(), gen_send(), get_own_net_address, protocol, sourceNA, XBEE_802_15_4, and ZIGBEE.

Referenced by setOriginParams().

{
  int8_t error=2;
     

  if( (protocol==XBEE_802_15_4) || (protocol==ZIGBEE) ) 
  {
          error_AT=2;
          gen_data(get_own_net_address);
          error=gen_send(get_own_net_address);
  } 
  else
  {
          error_AT=-1;
          error=-1;
  }
  
  if(!error)
  {
          sourceNA[0]=data[0];
          sourceNA[1]=data[1];
  }
  return error;
}

Here is the call graph for this function:

Here is the caller graph for this function:

uint8_t WaspXBeeCore::setBaudrate

(

uint8_t

baud_rate

)

It sets the baudrate.

Parameters:

uint8_t

baud_rate : the baudrate to set the XBee to (range [0-5])

Returns:

'0' on success, '1' otherwise

Definition at line 268 of file WaspXBeeCore.cpp.

References baudrate, error_AT, gen_checksum(), gen_data(), gen_send(), and set_baudrate.

{
    int8_t error=2;
     
    error_AT=2;
    gen_data(set_baudrate,baud_rate);
    gen_checksum(set_baudrate);
    error=gen_send(set_baudrate);
    
    if(!error)
    {
        baudrate=baud_rate;
    }
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::setAPI

(

uint8_t

api_value

)

It sets API enabled or disabled.

Parameters:

uint8_t

api_value : the API mode (range [0-2])

Returns:

'0' on success, '1' otherwise

Definition at line 295 of file WaspXBeeCore.cpp.

References apiValue, error_AT, gen_checksum(), gen_data(), gen_send(), and set_api_mode.

{
    int8_t error=2;
     
    error_AT=2;
    gen_data(set_api_mode,api_value);
    gen_checksum(set_api_mode);
    error=gen_send(set_api_mode);
    
    if(!error)
    {
        apiValue=api_value;
    }
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::setAPIoptions

(

uint8_t

api_options

)

It sets API options.

Parameters:

uint8_t

api_options : the API options (range [0-1])

Returns:

'0' on success, '1' otherwise

Definition at line 321 of file WaspXBeeCore.cpp.

References error_AT, gen_checksum(), gen_data(), gen_send(), protocol, set_api_options, and XBEE_802_15_4.

{
    int8_t error=2;
        
    if( (protocol!=XBEE_802_15_4) )
    {
            error_AT=2;
            gen_data(set_api_options,api_options);
            gen_checksum(set_api_options);
            error=gen_send(set_api_options);
    }
    else
    {
        error_AT=-1;
        error=-1;
    }
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::setPAN

(

uint8_t *

PANID

)

It sets the PAN ID.

Parameters:

uint8_t*

PANID : the PAN ID (64b - ZigBee ; 16b - Other protocols)

Returns:

'0' on success, '1' otherwise

Definition at line 350 of file WaspXBeeCore.cpp.

References DIGIMESH, error_AT, gen_checksum(), gen_data(), gen_send(), it, PAN_ID, protocol, set_pan, set_pan_zb, XBEE_802_15_4, XBEE_868, XBEE_900, and ZIGBEE.

{
    int8_t error=2;
        
    if( (protocol==XBEE_802_15_4) || (protocol==DIGIMESH) || (protocol==XBEE_900) || (protocol==XBEE_868) ) 
    {
            error_AT=2;
            gen_data(set_pan,PANID);
            gen_checksum(set_pan);
            error=gen_send(set_pan);
    }
    
    if(protocol==ZIGBEE) 
    {   
            error_AT=2;
            gen_data(set_pan_zb,PANID);
            gen_checksum(set_pan_zb);
            error=gen_send(set_pan_zb);
    }

    if(!error)
    {
        if( (protocol==XBEE_802_15_4) || (protocol==DIGIMESH) || (protocol==XBEE_900) || (protocol==XBEE_868) ) 
        {
                for(it=0;it<2;it++)
                {
                        PAN_ID[it]=PANID[it];
                }
        }
        if(protocol==ZIGBEE) 
        {
                for(it=0;it<8;it++)
                {
                        PAN_ID[it]=PANID[it];
                }
        }
    } 
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::getPAN

(

)

It gets the PAN ID.

It stores in global 'PAN_ID' the PAN ID

Returns:

'0' on success, '1' otherwise

Definition at line 399 of file WaspXBeeCore.cpp.

References data, delay(), DIGIMESH, error_AT, gen_data(), gen_send(), get_pan, it, PAN_ID, protocol, XBEE_802_15_4, XBEE_868, XBEE_900, and ZIGBEE.

{
    int8_t error=2;
     
    error_AT=2;
    gen_data(get_pan);
    if( protocol==ZIGBEE ) error=gen_send(get_pan);
    else error=gen_send(get_pan);
    
    if(!error)
    {
        if( (protocol==XBEE_802_15_4) || (protocol==DIGIMESH) || (protocol==XBEE_900) || (protocol==XBEE_868) ) 
        {
                for(it=0;it<2;it++)
                {
                        PAN_ID[it]=data[it];
                        delay(20);
                }
        }
        if(protocol==ZIGBEE) 
        {
                for(it=0;it<8;it++)
                {
                        PAN_ID[it]=data[it];
                        delay(20);
                }
        }
    } 
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::setSleepMode

(

uint8_t

sleep

)

It sets the sleep mode.

Parameters:

uint8_t

sleep : the sleep mode (range [0-5])

Returns:

'0' on success, '1' otherwise

Definition at line 440 of file WaspXBeeCore.cpp.

References error_AT, gen_checksum(), gen_data(), gen_send(), set_sleep_mode_xbee, and sleepMode.

Referenced by WaspXBee::setMode().

{
    int8_t error=2;
     
    error_AT=2;
    gen_data(set_sleep_mode_xbee,sleep);
    gen_checksum(set_sleep_mode_xbee);
    error=gen_send(set_sleep_mode_xbee);
    
    if(!error)
    {
        sleepMode=sleep;
    }
    return error;
}

Here is the call graph for this function:

Here is the caller graph for this function:

uint8_t WaspXBeeCore::getSleepMode

(

)

It gets the sleep mode.

It stores in global 'sleepMode' the sleep mode

Returns:

'0' on success, '1' otherwise

Definition at line 464 of file WaspXBeeCore.cpp.

References data, error_AT, gen_data(), gen_send(), get_sleep_mode_xbee, and sleepMode.

{
    int8_t error=2;
     
    error_AT=2;
    gen_data(get_sleep_mode_xbee);
    error=gen_send(get_sleep_mode_xbee);
    
    if(error==0)
    {
        sleepMode=data[0];
    } 
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::setAwakeTime

(

uint8_t *

awake

)

It sets the time awake before sleeping.

Parameters:

uint8_t*

awake : the time awake before sleeping (range depends on the XBee module)

Returns:

'0' on success, '1' otherwise

Definition at line 490 of file WaspXBeeCore.cpp.

References awakeTime, DIGIMESH, error_AT, gen_checksum(), gen_data(), gen_send(), protocol, set_awake_time, set_awake_time_DM, XBEE_802_15_4, XBEE_868, XBEE_900, and ZIGBEE.

{
        int8_t error=2;
        
    if( (protocol==XBEE_802_15_4) || (protocol==ZIGBEE) || (protocol==XBEE_868) )
    {
            error_AT=2;
            gen_data(set_awake_time,awake);
            gen_checksum(set_awake_time);
            error=gen_send(set_awake_time);
    }
    
    if( (protocol==DIGIMESH) || (protocol==XBEE_900) )
    {
            error_AT=2;
            gen_data(set_awake_time_DM,awake);
            gen_checksum(set_awake_time_DM);
            error=gen_send(set_awake_time_DM);
    }
    
    if(!error)
    {
        if( (protocol==XBEE_802_15_4) || (protocol==ZIGBEE) || (protocol==XBEE_868) )
        {
            awakeTime[0]=awake[0];
            awakeTime[1]=awake[1];
        }
        if( (protocol==DIGIMESH) || (protocol==XBEE_900) )
        {
            awakeTime[0]=awake[0];
            awakeTime[1]=awake[1];
            awakeTime[2]=awake[2];
        }
    }
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::setSleepTime

(

uint8_t *

sleep

)

It sets time the module is slept.

Parameters:

uint8_t*

sleep : the module is slept (range depends on the XBee module)

Returns:

'0' on success, '1' otherwise

Definition at line 538 of file WaspXBeeCore.cpp.

References DIGIMESH, error_AT, gen_checksum(), gen_data(), gen_send(), protocol, set_sleep_time, set_sleep_time_DM, sleepTime, XBEE_802_15_4, XBEE_868, XBEE_900, and ZIGBEE.

{
    int8_t error=2;
    
    if( (protocol==XBEE_802_15_4) || (protocol==ZIGBEE) || (protocol==XBEE_868) )
    {
            error_AT=2;
            gen_data(set_sleep_time,sleep);
            gen_checksum(set_sleep_time);
            error=gen_send(set_sleep_time);
    }
    
    if( (protocol==DIGIMESH) || (protocol==XBEE_900) )
    {
            error_AT=2;
            gen_data(set_sleep_time_DM,sleep);
            gen_checksum(set_sleep_time_DM);
            error=gen_send(set_sleep_time_DM);
    }
    
    if(!error)
    {
        if( (protocol==XBEE_802_15_4) || (protocol==ZIGBEE) || (protocol==XBEE_868) )
        {
            sleepTime[0]=sleep[0];
            sleepTime[1]=sleep[1];
        }
        if( (protocol==DIGIMESH) || (protocol==XBEE_900) )
        {
            sleepTime[0]=sleep[0];
            sleepTime[1]=sleep[1];
            sleepTime[2]=sleep[2];
        }
    }
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::setChannel

(

uint8_t

_channel

)

It sets the channel frequency where module is working on.

Parameters:

uint8_t

_channel : the channel frequency where module is working on (range depends on the XBee module)

Returns:

'0' on success, '1' otherwise

Definition at line 586 of file WaspXBeeCore.cpp.

References channel, DIGIMESH, error_AT, gen_checksum(), gen_data(), gen_send(), protocol, set_channel, XBEE_802_15_4, and XBEE_900.

{
    int8_t error=2;
     

    if( (protocol==XBEE_802_15_4) || (protocol==DIGIMESH) || (protocol==XBEE_900) )
    {
            error_AT=2;
            gen_data(set_channel,_channel);
            gen_checksum(set_channel);
            error=gen_send(set_channel);
    }
    else
    {
         error_AT=-1;
         error=-1;
    }
    if(!error)
    {
            channel=_channel;
    }

    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::getChannel

(

)

It gets the channel frequency where module is working on.

It stores in global 'channel' the channel frequency where module is working on

Returns:

'0' on success, '1' otherwise

Definition at line 619 of file WaspXBeeCore.cpp.

References channel, data, error_AT, gen_data(), gen_send(), and get_channel.

{
    int8_t error=2;
     
    error_AT=2;
    gen_data(get_channel);
    error=gen_send(get_channel);
    
    if(!error)
    {
        channel=data[0];
    }
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::setNodeIdentifier

(

char *

node

)

It sets the Node Identifier.

Parameters:

char*

node : the NI must be a 20 character max string

Returns:

'0' on success, '1' otherwise

Definition at line 646 of file WaspXBeeCore.cpp.

References BYTE, clearCommand(), command, error_AT, it, nodeID, parse_message(), WaspXBee::print(), WAIT_TIME, and XBee.

{
    uint8_t* NI = (uint8_t*) calloc(30,sizeof(uint8_t)); //{0x7E, 0x00, 0x00, 0x08, 0x52, 0x4E, 0x49, 0x02};
    NI[0]=0x7E;
    NI[1]=0x00;
    NI[3]=0x08;
    NI[4]=0x52;
    NI[5]=0x4E;
    NI[6]=0x49;
    uint8_t num_NI;
    int8_t error=2;
    uint8_t* ByteIN = (uint8_t*) calloc(20,sizeof(uint8_t));
    
    uint8_t counter=0;
    uint8_t counter3=0;
    uint8_t est=1;
    uint8_t frame_ID=NI[4];
    uint8_t end=0;
    uint16_t interval=WAIT_TIME;
    uint8_t checksum=0; 
    uint8_t numberBytes=9;
    uint8_t status=0;
    uint8_t undesired=0;


    it=0;
    error_AT=2;
    while( (node[it]!='\0') )
    {
        NI[it+7]=uint8_t(node[it]);
        it++;
    }
    NI[2]=4+it;
    for(it=3;it<(7+(NI[2]-4));it++)
    {
        checksum=checksum+NI[it];
    }
    while( (checksum>255))
    {
        checksum=checksum-256;
    }
    checksum=255-checksum;
    NI[7+NI[2]-4]=checksum;
    while(counter<(8+NI[2]-4))
    {
    XBee.print(NI[counter], BYTE); 
    counter++;
    }
    counter=0;
    clearCommand();
    command[5]=0x4E;
    command[6]=0x49;
    error=parse_message(command);

    if(error==0)
    {
        for(it=0;it<NI[2]-4;it++)
        {
        nodeID[it]=node[it];
        }
    }
    free(NI);
    free(ByteIN);
    NI=NULL;
    ByteIN=NULL;
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::getNodeIdentifier

(

)

It gets the Node Identifier.

It stores in global 'nodeID' the Node Identifier

Returns:

'0' on success, '1' otherwise

Definition at line 722 of file WaspXBeeCore.cpp.

References data, data_length, error_AT, gen_data(), gen_send(), get_NI, it, and nodeID.

{
    int8_t error=2; 

    error_AT=2;
    gen_data(get_NI);
    error=gen_send(get_NI);
    
    if(!error)
    {
        for(it=0;it<data_length;it++)
        {
        nodeID[it]=char(data[it]);
        }
    }
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::scanNetwork

(

)

It scans for brothers in the same channel and same PAN ID.

It stores the given info (SH,SL,MY,RSSI,NI) in global array "scannedBrothers" variable It stores in global "totalScannedBrothers" the number of found brothers

Returns:

'0' on success, '1' otherwise

Definition at line 749 of file WaspXBeeCore.cpp.

References error_AT, gen_data(), gen_send(), scan_network, and totalScannedBrothers.

{
        uint8_t error=2;
        
        error_AT=2;
        totalScannedBrothers=0;
        gen_data(scan_network);
        error=gen_send(scan_network);

        return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::scanNetwork

(

char *

node

)

It scans for a brother in the same channel and same PAN ID.

It stores the given info (SH,SL,MY,RSSI,NI) in global array "scannedBrothers" variable It stores in global "totalScannedBrothers" the number of found brothers

Parameters:

char*

node : 20-byte max string containing NI of the node to search

Returns:

'0' on success, '1' otherwise

Definition at line 772 of file WaspXBeeCore.cpp.

References BYTE, clearCommand(), command, DIGIMESH, error_AT, finish, it, parse_message(), WaspXBee::print(), protocol, totalScannedBrothers, WAIT_TIME2, XBee, XBEE_868, and XBEE_900.

{
    uint8_t* ND = (uint8_t*) calloc(30,sizeof(uint8_t)); //{0x7E, 0x00, 0x04, 0x08, 0x52, 0x4E, 0x44, 0x13};
    ND[0]=0x7E;
    ND[1]=0x00;
    ND[3]=0x08;
    ND[4]=0x52;
    ND[5]=0x4E;
    ND[6]=0x44;
    uint8_t num_ND;
    int8_t error=2;
    uint8_t* ByteIN = (uint8_t*) calloc(20,sizeof(uint8_t));
    
    uint8_t cont=1;
    uint8_t cont2=0;
    uint8_t counter=0;
    uint8_t counter3=0;
    uint8_t est=1;
    uint8_t frame_ID=ND[4];
    uint8_t end=0;
    uint16_t interval=WAIT_TIME2;
    uint16_t length=0;
    uint16_t aux=0;
    uint8_t existsNI=0;
    uint8_t length_NI=0;
    uint16_t checksum=0;
    uint8_t finish=0;
    
    error_AT=2;
    totalScannedBrothers=0;
    if( (protocol==DIGIMESH) || (protocol==XBEE_900) || (protocol==XBEE_868) )
    {
        interval=14000;
    }
    it=0;
    while( (node[it]!='\0') )
    {
        ND[it+7]=uint8_t(node[it]);
        it++;
    }
    ND[2]=4+it;
    for(it=3;it<(7+(ND[2]-4));it++)
    {
        checksum=checksum+ND[it];
    }
    while( (checksum>255))
    {
        checksum=checksum-256;
    }
    checksum=255-checksum;
    ND[7+ND[2]-4]=checksum;
    while(counter<(8+ND[2]-4))
    {
        XBee.print(ND[counter], BYTE); 
        counter++;
    }
    counter=0;
    clearCommand();
    command[5]=ND[5];
    command[6]=ND[6];
    error=parse_message(command);
    
    free(ND);
    free(ByteIN);
    ND=NULL;
    ByteIN=NULL;
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::setScanningTime

(

uint8_t *

time

)

It sets the time the Node Discovery is scanning.

Parameters:

uint8_t*

time : the time the Node Discovery is scanning (range [0x01-0xFC])

Returns:

'0' on success, '1' otherwise

Definition at line 853 of file WaspXBeeCore.cpp.

References DIGIMESH, error_AT, gen_checksum(), gen_data(), gen_send(), protocol, scanTime, set_scanning_time, set_scanning_time_DM, XBEE_802_15_4, XBEE_868, XBEE_900, and ZIGBEE.

{
    int8_t error=2;
     
    if( (protocol==XBEE_802_15_4) || (protocol==ZIGBEE) || (protocol==XBEE_900) )
    {
            error_AT=2;
            gen_data(set_scanning_time,time);
            gen_checksum(set_scanning_time);
            error=gen_send(set_scanning_time);
    }
    
    if( (protocol==DIGIMESH) || (protocol==XBEE_868) )
    {
            error_AT=2;
            gen_data(set_scanning_time_DM,time);
            gen_checksum(set_scanning_time_DM);
            error=gen_send(set_scanning_time_DM);
    }
        
    
    if(!error)
    {
        if( (protocol==XBEE_802_15_4) || (protocol==ZIGBEE) || (protocol==XBEE_900) )
        {
            scanTime[0]=time[0];
        }
        if( (protocol==DIGIMESH) || (protocol==XBEE_868) )
        {
            scanTime[0]=time[0];
            scanTime[1]=time[1];
        }
    }
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::getScanningTime

(

)

It gets the time the Node Discovery is scanning.

It stores in global 'scanTime' the time the Node Discovery is scanning

Returns:

'0' on success, '1' otherwise

Definition at line 898 of file WaspXBeeCore.cpp.

References data, DIGIMESH, error_AT, gen_data(), gen_send(), get_scanning_time, protocol, scanTime, XBEE_802_15_4, XBEE_868, XBEE_900, and ZIGBEE.

{
    int8_t error=2;
     
    error_AT=2;
    gen_data(get_scanning_time);
    if( (protocol==DIGIMESH) || (protocol==XBEE_868) || (protocol==ZIGBEE) || (protocol==XBEE_900) ) error=gen_send(get_scanning_time);
    else error=gen_send(get_scanning_time);
    
    if(!error)
    {
        if( (protocol==XBEE_802_15_4) )
        {
            scanTime[0]=data[0];
        }
        if( (protocol==ZIGBEE) || (protocol==XBEE_900) )
        {
            scanTime[0]=data[1]; 
        }
        if( (protocol==DIGIMESH) || (protocol==XBEE_868) )
        {
            scanTime[0]=data[0];
            scanTime[1]=data[1];
        }
    }
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::setDiscoveryOptions

(

uint8_t

options

)

It sets the options for the network discovery command.

Parameters:

uint8_t

options : the options for the network discovery command (range [0x00-0x03])

Returns:

'0' on success, '1' otherwise

Definition at line 936 of file WaspXBeeCore.cpp.

References discoveryOptions, error_AT, gen_checksum(), gen_data(), gen_send(), protocol, set_discov_options, XBEE_802_15_4, and ZIGBEE.

{
    int8_t error=2;
    
    if( (protocol==XBEE_802_15_4) || (protocol==ZIGBEE) )
    {
            error_AT=2;
            gen_data(set_discov_options,options);
            gen_checksum(set_discov_options);
            error=gen_send(set_discov_options);
    }
    else
    {
        error_AT=-1;
        error=-1;
    }
    if(!error)
    {
        discoveryOptions=options;
    }
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::getDiscoveryOptions

(

)

It gets the options for the network discovery command.

It stores in global 'discoveryOptions' the options for the network discovery command

Returns:

'0' on success, '1' otherwise

Definition at line 967 of file WaspXBeeCore.cpp.

References data, discoveryOptions, error_AT, gen_data(), gen_send(), get_discov_options, protocol, XBEE_802_15_4, and ZIGBEE.

{
    int8_t error=2;
    
    if( (protocol==XBEE_802_15_4) || (protocol==ZIGBEE) )
    {
            error_AT=2;
            gen_data(get_discov_options);
            error=gen_send(get_discov_options);
    }
    else
    {
        error_AT=-1;
        error=-1;
    }
    if(error==0)
    {
        discoveryOptions=data[0];
    }
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::nodeSearch	(	char *	node,
		struct packetXBee *	paq
	)

It performs a quick search of a specific node. Depending on the XBee module it stores different information.

It stores the given info (SH,SL,MY,RSSI,NI) in global array "scannedBrothers" variable It stores in global "totalScannedBrothers" the number of found brothers

Parameters:

	char*	node : 20-byte max string containing NI of the node to search
	struct	packetXBee* paq : a packetXBee structure to store the node information

Returns:

'0' on success, '1' otherwise

Definition at line 1003 of file WaspXBeeCore.cpp.

References BYTE, clearCommand(), command, data, DIGIMESH, error_AT, it, packetXBee::macDH, packetXBee::macDL, packetXBee::naD, parse_message(), WaspXBee::print(), protocol, XBee, XBEE_868, XBEE_900, and ZIGBEE.

{
    uint8_t* DN = (uint8_t*) calloc(30,sizeof(uint8_t)); //{0x7E, 0x00, 0x00, 0x08, 0x52, 0x44, 0x4E, 0xE3};
    DN[0]=0x7E;
    DN[1]=0x00;
    DN[3]=0x08;
    DN[4]=0x52;
    DN[5]=0x44;
    DN[6]=0x4E;
    uint8_t num_DN;
    int8_t error=2;
    uint8_t* ByteIN = (uint8_t*) calloc(25,sizeof(uint8_t));
    
    uint8_t counter=0;
    uint8_t counter3=0;
    uint8_t est=1;
    uint8_t frame_ID=DN[4];
    uint8_t end=0;
    uint16_t interval=2000;
    uint8_t checksum=0; 
    uint8_t status=0;
    uint8_t undesired=0;


    error_AT=2;
    if(protocol==DIGIMESH)
    {
        interval=14000;
    }    
    it=0;
    while( (node[it]!='\0') )
    {
            DN[it+7]=uint8_t(node[it]);
            it++;
    }
    DN[2]=4+it;
    for(it=3;it<(7+(DN[2]-4));it++)
    {
            checksum=checksum+DN[it];
    }
    while( (checksum>255))
    {
            checksum=checksum-256;
    }
    checksum=255-checksum;
    DN[7+DN[2]-4]=checksum;
    while(counter<(8+DN[2]-4))
    {
            XBee.print(DN[counter], BYTE); 
            counter++;
    }
    
    counter=0;
    clearCommand();
    command[5]=0x44;
    command[6]=0x4E;
    error=parse_message(command);
    
    if(error==0)
    {
        if( (protocol==ZIGBEE) || (protocol==XBEE_900) || (protocol==XBEE_868) )
        {
            for(it=0;it<2;it++)
            {
                paq->naD[it]=data[it];
            }
            for(it=0;it<4;it++)
            {
                paq->macDH[it]=data[it+2];
            }
            for(it=0;it<4;it++)
            {
                paq->macDL[it]=data[it+6];
            }
        }
        if(protocol==DIGIMESH)
        {
            for(it=0;it<4;it++)
            {
                paq->macDH[it]=data[it];
            }
            for(it=0;it<4;it++)
            {
                paq->macDL[it]=data[it+4];
            }
        }
    }
    free(DN);
    free(ByteIN);
    DN=NULL;
    ByteIN=NULL;
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::setScanningChannels	(	uint8_t	channel_H,
		uint8_t	channel_L
	)

It sets the list of channels to scan when performing an energy scan.

Parameters:

	uint8_t	channel_H : higher channel list byte (range [0x00-0xFF])
	uint8_t	channel_L : lower channel list byte (range [0x00-0xFF])

Returns:

'0' on success, '1' otherwise

Definition at line 1128 of file WaspXBeeCore.cpp.

References error_AT, gen_checksum(), gen_data(), gen_send(), protocol, scanChannels, set_scanning_channel, XBEE_802_15_4, and ZIGBEE.

{
    int8_t error=2;
    
    if( (protocol==XBEE_802_15_4) || (protocol==ZIGBEE) )
    {
            error_AT=2;
            gen_data(set_scanning_channel,channel_H,channel_L);
            gen_checksum(set_scanning_channel);
            error=gen_send(set_scanning_channel);
    }
    else
    {
        error_AT=-1;
        error=-1;
    }
    if(error==0)
    {
        scanChannels[0]=channel_H;
        scanChannels[1]=channel_L;
    }
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::getScanningChannels

(

)

It gets the list of channels to scan when performing an energy scan.

It stores in global 'scanChannels' the list of channels to scan when performing an energy scan

Returns:

'0' on success, '1' otherwise

Definition at line 1161 of file WaspXBeeCore.cpp.

References data, error_AT, gen_data(), gen_send(), get_scanning_channel, it, protocol, scanChannels, XBEE_802_15_4, and ZIGBEE.

{
    int8_t error=2;
    
    if( (protocol==XBEE_802_15_4) || (protocol==ZIGBEE) )
    {
            error_AT=2;
            gen_data(get_scanning_channel);
            error=gen_send(get_scanning_channel);
    }
    else
    {
        error_AT=-1;
        error=-1;
    }
    if(error==0)
    {
        for(it=0;it<2;it++)
        {
            scanChannels[it]=data[it];
        }
    }
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::setDurationEnergyChannels

(

uint8_t

duration

)

It sets the time the Energy Scan will be performed.

It stores the energy on each channel in global 'energyChannel' variable

Parameters:

uint8_t

duration : time the energy scan will be performed (range [0-6])

Returns:

'0' on success, '1' otherwise

Definition at line 1197 of file WaspXBeeCore.cpp.

References data, data_length, energyChannel, error_AT, gen_checksum(), gen_data(), gen_send(), it, protocol, set_duration_energy, set_duration_energy_ZB, timeEnergyChannel, XBEE_802_15_4, and ZIGBEE.

{
        int8_t error=2;
    
        if( (protocol==XBEE_802_15_4) )
        {
                error_AT=2;
                gen_data(set_duration_energy,duration);
                gen_checksum(set_duration_energy);
                error=gen_send(set_duration_energy);
        }
        else if( (protocol==ZIGBEE) )
        {
                error_AT=2;
                gen_data(set_duration_energy_ZB,duration);
                gen_checksum(set_duration_energy_ZB);
                error=gen_send(set_duration_energy_ZB);
        }
        else
        {
                error_AT=-1;
                error=-1;
        }
        
        if(error==0)
        {
                if(protocol==XBEE_802_15_4)
                {
                        for(it=0;it<data_length;it++)
                        {
                                energyChannel[it]=data[it];
                        }
                }
                if(protocol==ZIGBEE)
                {
                        timeEnergyChannel=data[0];
                }
        }
        return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::getDurationEnergyChannels

(

)

It gets the time the Energy Scan will be performed.

It stores in global 'timeEnergyChannel' the time the Energy Scan will be performed

Returns:

'0' on success, '1' otherwise

Definition at line 1248 of file WaspXBeeCore.cpp.

References data, error_AT, gen_data(), gen_send(), get_duration_energy, protocol, timeEnergyChannel, XBEE_802_15_4, and ZIGBEE.

{
    int8_t error=2;
    
    if( (protocol==XBEE_802_15_4) || (protocol==ZIGBEE) )
    {
            error_AT=2;
            gen_data(get_duration_energy);
            error=gen_send(get_duration_energy);
    }
    else
    {
        error_AT=-1;
        error=-1;
    }
    if(!error)
    {
        timeEnergyChannel=data[0];
    }
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::setLinkKey

(

char *

key

)

It sets the link key to use in the 128b AES algorithm.

Parameters:

char*

key : the 128-bit AES encryption key (range [0-0xFFFFFFFFFFFFFFFF])

Returns:

'0' on success, '1' otherwise

Definition at line 1280 of file WaspXBeeCore.cpp.

References error_AT, gen_checksum(), gen_data(), gen_send(), it, linkKey, and set_link_key.

{
    int8_t error=2;
    
    error_AT=2;
    gen_data(set_link_key,key);
    gen_checksum(set_link_key);
    error=gen_send(set_link_key);
    
    if(!error)
    {
        for(it=0;it<16;it++)
        {
            linkKey[it]=char(key[it]);
        }
    }
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::encryptionMode

(

uint8_t

mode

)

It sets the encryption mode ON/OFF.

Parameters:

uint8_t

mode : the encryption mode (range [0-1])

Returns:

'0' on success, '1' otherwise

Definition at line 1309 of file WaspXBeeCore.cpp.

References encryptMode, error_AT, gen_checksum(), gen_data(), gen_send(), and set_encryption.

{
    int8_t error=2;
    
    error_AT=2;
    gen_data(set_encryption,mode);
    gen_checksum(set_encryption);
    error=gen_send(set_encryption);
    if(!error)
    {
        encryptMode=mode;
    }
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::setPowerLevel

(

uint8_t

value

)

It sets the power level at which RF module transmits.

Parameters:

uint8_t

mode : power level at which RF module transmits (depends on the XBee module - range [0-4])

Returns:

'0' on success, '1' otherwise

Definition at line 1334 of file WaspXBeeCore.cpp.

References error_AT, gen_checksum(), gen_data(), gen_send(), powerLevel, protocol, set_power_level, and XBEE_900.

{
    int8_t error=2;
    
    if(protocol!=XBEE_900)
    {
            error_AT=2;
            gen_data(set_power_level,value);
            gen_checksum(set_power_level);
            error=gen_send(set_power_level);
    }
    if(!error)
    {
        powerLevel=value;
    }
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::getRSSI

(

)

It gets the Received Signal Strength Indicator.

It stores in global 'valueRSSI' the Received Signal Strength Indicator

Returns:

'0' on success, '1' otherwise

Definition at line 1360 of file WaspXBeeCore.cpp.

References WaspXBee::available(), data, delay(), DIGIMESH, error_AT, WaspXBee::flush(), gen_data(), gen_send(), get_RSSI, WaspXBee::print(), WaspXBee::println(), protocol, WaspXBee::read(), WaspUtils::str2hex(), Utils, valueRSSI, XBee, XBEE_802_15_4, XBEE_868, XBEE_900, and ZIGBEE.

{
    int8_t error=2;
    uint8_t* ByteIN = (uint8_t*) calloc(40,sizeof(uint8_t));
    uint8_t i=0;

    if( (protocol == XBEE_802_15_4 ) || (protocol==ZIGBEE) )
    {
            error_AT=2;
            gen_data(get_RSSI);
            error=gen_send(get_RSSI);
    }
    else if( (protocol== DIGIMESH) || (protocol==XBEE_868) || (protocol==XBEE_900) )
    {
            delay(2000);        
            XBee.print("+++");
            delay(2000);
            XBee.flush();
            XBee.println("atdb");
            delay(1000);
            error_AT=2;
            while(XBee.available()>0)
            {
                    ByteIN[i]=XBee.read();
                    error=0;
                    i++;
                    error_AT=0;
            }
            i=0;
            XBee.println("atcn");
            delay(1000);
            valueRSSI[0]=Utils.str2hex(ByteIN);
    }
    if(error==0)
    {
            if( (protocol==XBEE_802_15_4) || (protocol==ZIGBEE) )
            {
                    valueRSSI[0]=data[0];
            }
    }
    free(ByteIN);
    ByteIN=NULL;
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::getHardVersion

(

)

It gets the Hardware Version.

It stores in global 'hardVersion' the Hardware Version

Returns:

'0' on success, '1' otherwise

Definition at line 1413 of file WaspXBeeCore.cpp.

References data, error_AT, gen_data(), gen_send(), get_hard_version, and hardVersion.

{
    int8_t error=2;
    
    error_AT=2;
    gen_data(get_hard_version);
    error=gen_send(get_hard_version);
    if(!error)
    {
        hardVersion[0]=data[0];
        hardVersion[1]=data[1];
    } 
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::getSoftVersion

(

)

It gets the Software Version.

It stores in global 'softVersion' the Software Version

Returns:

'0' on success, '1' otherwise

Definition at line 1436 of file WaspXBeeCore.cpp.

References data, error_AT, gen_data(), gen_send(), get_soft_version, and softVersion.

{
    int8_t error=2;
    
    error_AT=2;
    gen_data(get_soft_version);
    error=gen_send(get_soft_version);
    if(error==0)
    {
        softVersion[0]=data[0];
        softVersion[1]=data[1];
    } 
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::setRSSItime

(

uint8_t

time

)

It sets the RSSI time.

Parameters:

uint8_t

time : amount of time to do the PWM (range [0x00-0xFF])

Returns:

'0' on success, '1' otherwise

Definition at line 1462 of file WaspXBeeCore.cpp.

References error_AT, gen_checksum(), gen_data(), gen_send(), set_RSSI_time, and timeRSSI.

{
    int8_t error=2;
    
    error_AT=2;
    gen_data(set_RSSI_time,time);
    gen_checksum(set_RSSI_time);
    error=gen_send(set_RSSI_time);
    if(!error)
    {
        timeRSSI=time;
    }
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::getRSSItime

(

)

It gets the RSSI time.

It stores in global 'timeRSSI' the RSSI time

Returns:

'0' on success, '1' otherwise

Definition at line 1485 of file WaspXBeeCore.cpp.

References data, error_AT, gen_data(), gen_send(), get_RSSI_time, and timeRSSI.

{
    int8_t error=2;
    
    error_AT=2;
    gen_data(get_RSSI_time);
    error=gen_send(get_RSSI_time);
    if(!error)
    {
        timeRSSI=data[0];
    } 
    return error;
}

Here is the call graph for this function:

uint8_t WaspXBeeCore::writeValues

(

)

It writes the parameters changed into non-volatil memory, being applied when the XBee is s