WaspXBeeDM Class Reference

#include <WaspXBeeDM.h>

Inheritance diagram for WaspXBeeDM:

Collaboration diagram for WaspXBeeDM:


Public Member Functions
	WaspXBeeDM ()
	class constructor
void	init (uint8_t protocol_used, uint8_t frequency, uint8_t model_used)
	It initializes the necessary variables.
uint8_t	getRFerrors ()
	It gets the number of times the RF receiver detected a CRC or length error.
uint8_t	getGoodPackets ()
	It gets the number of good frames with valid MAC headers that are received on the RF interface.
uint8_t	getChannelRSSI (uint8_t channel)
	It gets the DBM level of the designated channel.
uint8_t	getTransmisionErrors ()
	It gets the number of MAC frames that exhaust MAC retries without ever receiving a MAC acknowledgement message from the adjacent node.
uint8_t	setNetworkHops (uint8_t nhops)
	It sets the maximum number of hops expected to be seen in a network route.
uint8_t	getNetworkHops ()
	It gets the maximum number of hops expected to be seen in a network route.
uint8_t	setNetworkDelaySlots (uint8_t dslots)
	It sets the maximum random number of network delay slots before rebroadcasting a network packet.
uint8_t	getNetworkDelaySlots ()
	It gets the maximum random number of network delay slots before rebroadcasting a network packet.
uint8_t	setNetworkRouteRequests (uint8_t route)
	It sets the maximum number of route discovery retries allowed to find a path to the destination node.
uint8_t	getNetworkRouteRequests ()
	It gets the maximum number of route discovery retries allowed to find a path to the destination node.
uint8_t	setMeshNetworkRetries (uint8_t mesh)
	It sets the maximum number of network packet delivery attempts.
uint8_t	getMeshNetworkRetries ()
	It gets the maximum number of network packet delivery attempts.
uint8_t	getTemperature ()
	It gets module temperature in Celsius. Negatives temperatures can be returned.
uint8_t	getSupplyVoltage ()
	It gets the voltage on the Vcc pin.
uint8_t	restoreCompiled ()
	It restores module parameters to compiled defaults.
Data Fields
uint8_t	errorsRF [2]
	Variable : the number of times the RF receiver detected a CRC or length error.
uint8_t	goodPackets [2]
	Variable : the number of good frames with valid MAC headers that are received on the RF interface.
uint8_t	channelRSSI
	Variable : the DBM level of the designated channel.
uint8_t	transmisionErrors [2]
	Variable : the number of MAC frames that exhaust MAC retries without ever receiving a MAC acknowledgement message from the adjacent node.
uint8_t	networkHops
	Variable : the maximum number of hops expected to be seen in a network route (range [1-0xFF]).
uint8_t	netDelaySlots
	Variable : the maximum random number of network delay slots before rebroadcasting a network packet (range [0-0x0A]).
uint8_t	netRouteRequest
	Variable : the maximum number of route discovery retries allowed to find a path to the destination node (range [0-0x0A]).
uint8_t	meshNetRetries
	Variable : the maximum number of network packet delivery attempts (range [0-7]).
uint8_t	temperature [2]
	Variable : module temperature in Celsius.
uint8_t	supplyVoltage [2]
	Variable : the voltage on the Vcc pin.

Detailed Description

WaspXBeeDM Class.

WaspXBeeDM Class defines all the variables and functions used to manage XBee DigiMesh and 900MHz modules. It inherits from 'WaspXBeeCore' class the necessary functions, variables and definitions

Definition at line 60 of file WaspXBeeDM.h.

Constructor & Destructor Documentation

WaspXBeeDM::WaspXBeeDM ( ) [inline]

class constructor

It does nothing

Parameters:

void

Returns:: void

Definition at line 70 of file WaspXBeeDM.h.

00070 {};

Member Function Documentation

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

It initializes the necessary variables.

It initalizes all the necessary variables including its father's variables

Parameters:

	uint8_t	protocol_used : specifies the protocol used in the XBee module (DIGIMESH or XBEE_900)
	uint8_t	frequency : specifies the frequency used in the XBee module (FREQ2_4G or FREQ900M)
	uint8_t	model_used : specifies the XBee model used (NORMAL or PRO)

Returns:: void

Reimplemented from WaspXBeeCore.

Definition at line 29 of file WaspXBeeDM.cpp.

References WaspXBeeCore::add_type, AWAKE_TIME_DIGIMESH_H, AWAKE_TIME_DIGIMESH_L, AWAKE_TIME_DIGIMESH_M, WaspXBeeCore::awakeTime, WaspXBeeCore::clearCommand(), WaspXBeeCore::clearFinishArray(), WaspXBeeCore::data_length, WaspXBeeCore::discoveryOptions, ENCRYPT_MODE_DIGIMESH, WaspXBeeCore::encryptMode, WaspXBeeCore::error_AT, WaspXBeeCore::error_RX, WaspXBeeCore::error_TX, WaspXBeeCore::finish, WaspXBeeCore::frag_length, WaspXBeeCore::frameNext, WaspXBeeCore::freq, WaspXBeeCore::indexNotModified, WaspXBeeCore::it, meshNetRetries, WaspXBeeCore::mode, WaspXBeeCore::model, netDelaySlots, netRouteRequest, networkHops, WaspXBeeCore::nextIndex1, WaspXBeeCore::pendingPackets, WaspXBeeCore::pos, POWER_LEVEL_DIGIMESH, WaspXBeeCore::powerLevel, WaspXBeeCore::protocol, WaspXBeeCore::replacementPolicy, SCAN_TIME_DIGIMESH_H, SCAN_TIME_DIGIMESH_L, WaspXBeeCore::scanTime, SLEEP_OPTIONS_DIGIMESH, SLEEP_TIME_DIGIMESH_H, SLEEP_TIME_DIGIMESH_L, SLEEP_TIME_DIGIMESH_M, WaspXBeeCore::sleepOptions, WaspXBeeCore::sleepTime, WaspXBeeCore::start, WaspXBeeCore::TIME1, TIME_RSSI_DIGIMESH, WaspXBeeCore::timeRSSI, WaspXBeeCore::totalFragmentsReceived, XBEE_900, and XBEE_OUT.

00030 {
00031         protocol=protocol_used;
00032         freq=frequency;
00033         model=model_used;
00034         
00035         data_length=0;
00036         it=0;
00037         start=0;
00038         finish=0;
00039         add_type=0;
00040         mode=0;
00041         frag_length=0;
00042         TIME1=0;
00043         
00044         totalFragmentsReceived=0;
00045         pendingPackets=0;
00046         pos=0;
00047         discoveryOptions=0x00;
00048         
00049         scanTime[0]=SCAN_TIME_DIGIMESH_H;
00050         scanTime[1]=SCAN_TIME_DIGIMESH_L;
00051         encryptMode=ENCRYPT_MODE_DIGIMESH;
00052         timeRSSI=TIME_RSSI_DIGIMESH;
00053         
00054         if( protocol!=XBEE_900 )
00055         {       
00056                 awakeTime[0]=AWAKE_TIME_DIGIMESH_H;
00057                 awakeTime[1]=AWAKE_TIME_DIGIMESH_M;
00058                 awakeTime[2]=AWAKE_TIME_DIGIMESH_L;
00059                 sleepTime[0]=SLEEP_TIME_DIGIMESH_H;
00060                 sleepTime[1]=SLEEP_TIME_DIGIMESH_M;
00061                 sleepTime[2]=SLEEP_TIME_DIGIMESH_L;
00062                 
00063                 sleepOptions=SLEEP_OPTIONS_DIGIMESH;
00064                 powerLevel=POWER_LEVEL_DIGIMESH;
00065                         
00066                 networkHops=7;
00067                 netDelaySlots=3;
00068                 netRouteRequest=3;
00069                 meshNetRetries=1;
00070         }
00071         nextIndex1=0;
00072         frameNext=0;
00073         replacementPolicy=XBEE_OUT;
00074         indexNotModified=1;
00075         error_AT=2;
00076         error_RX=2;
00077         error_TX=2;
00078         clearFinishArray();
00079         clearCommand();
00080 }

Here is the call graph for this function:

uint8_t WaspXBeeDM::getRFerrors ( )

It gets the number of times the RF receiver detected a CRC or length error.

It stores in global 'errorsRF' variable the number of times the RF receiver detected a CRC or length error

Returns:: '0' on success, '1' otherwise

Definition at line 90 of file WaspXBeeDM.cpp.

References WaspXBeeCore::data, delay(), WaspXBeeCore::error_AT, errorsRF, WaspXBeeCore::gen_data(), WaspXBeeCore::gen_send(), and get_RF_errors_DM.

00091 {
00092     int8_t error=2;
00093      
00094     error_AT=2;
00095     gen_data(get_RF_errors_DM);
00096     error=gen_send(get_RF_errors_DM);
00097     
00098     if(!error)
00099     {
00100         errorsRF[0]=data[0];
00101         delay(20);
00102         errorsRF[1]=data[1];
00103         delay(20);       
00104     } 
00105     return error;
00106 }

Here is the call graph for this function:

uint8_t WaspXBeeDM::getGoodPackets ( )

It gets the number of good frames with valid MAC headers that are received on the RF interface.

It stores in global 'goodPackets' variable the number of good frames with valid MAC headers that are received on the RF interface

Returns:: '0' on success, '1' otherwise

Definition at line 116 of file WaspXBeeDM.cpp.

References WaspXBeeCore::data, delay(), WaspXBeeCore::error_AT, WaspXBeeCore::gen_data(), WaspXBeeCore::gen_send(), get_good_pack_DM, and goodPackets.

00117 {
00118     int8_t error=2;
00119      
00120     error_AT=2;
00121     gen_data(get_good_pack_DM);
00122     error=gen_send(get_good_pack_DM);
00123     
00124     if(!error)
00125     {
00126         goodPackets[0]=data[0];
00127         delay(20);
00128         goodPackets[1]=data[1];
00129         delay(20);       
00130     } 
00131     return error;
00132 }

Here is the call graph for this function:

uint8_t WaspXBeeDM::getChannelRSSI ( uint8_t channel )

It gets the DBM level of the designated channel.

It stores in global 'channelRSSI' variable the number of retries

Parameters:

uint8_t

channel : the channel where to get the DBM level (depends on the XBee module)

Returns:: '0' on success, '1' otherwise

Definition at line 144 of file WaspXBeeDM.cpp.

References channelRSSI, WaspXBeeCore::data, delay(), WaspXBeeCore::error_AT, WaspXBeeCore::gen_checksum(), WaspXBeeCore::gen_data(), WaspXBeeCore::gen_send(), and get_channel_RSSI_DM.

00145 {
00146     int8_t error=2;
00147      
00148     error_AT=2;
00149     gen_data(get_channel_RSSI_DM,channel);
00150     gen_checksum(get_channel_RSSI_DM);
00151     error=gen_send(get_channel_RSSI_DM);
00152     
00153     if(!error)
00154     {
00155         channelRSSI=data[1];
00156         delay(20);
00157     } 
00158     return error;
00159 }

Here is the call graph for this function:

uint8_t WaspXBeeDM::getTransmisionErrors ( )

It gets the number of MAC frames that exhaust MAC retries without ever receiving a MAC acknowledgement message from the adjacent node.

It stores in global 'transmisionErrors' variable the number of MAC frames that exhaust MAC retries without ever receiving a MAC acknowledgement message from the adjacent node

Returns:: '0' on success, '1' otherwise

Definition at line 170 of file WaspXBeeDM.cpp.

References WaspXBeeCore::data, delay(), WaspXBeeCore::error_AT, WaspXBeeCore::gen_data(), WaspXBeeCore::gen_send(), get_trans_errors_DM, and transmisionErrors.

00171 {
00172     int8_t error=2;
00173      
00174     error_AT=2;
00175     gen_data(get_trans_errors_DM);
00176     error=gen_send(get_trans_errors_DM);
00177     
00178     if(!error)
00179     {
00180         transmisionErrors[0]=data[0];
00181         delay(20);
00182         transmisionErrors[1]=data[1];
00183         delay(20);       
00184     } 
00185     return error;
00186 }

Here is the call graph for this function:

uint8_t WaspXBeeDM::setNetworkHops ( uint8_t nhops )

It sets the maximum number of hops expected to be seen in a network route.

Parameters:

uint8_t

nhops : the maximum number of hops expected to be seen in a network route (range [1-0xFF])

Returns:: '0' on success, '1' otherwise

Definition at line 198 of file WaspXBeeDM.cpp.

References WaspXBeeCore::error_AT, WaspXBeeCore::gen_checksum(), WaspXBeeCore::gen_data(), WaspXBeeCore::gen_send(), networkHops, WaspXBeeCore::protocol, set_network_hops_DM, and XBEE_900.

00199 {
00200     int8_t error=2;
00201     
00202     if( protocol!=XBEE_900 )
00203     {
00204             error_AT=2;
00205             gen_data(set_network_hops_DM,nhops);
00206             gen_checksum(set_network_hops_DM);
00207             error=gen_send(set_network_hops_DM);
00208     }
00209     else {
00210             error=-1;
00211             error_AT=-1;
00212     }
00213     if(!error)
00214     {
00215         networkHops=nhops;
00216     }
00217     return error;
00218 }

Here is the call graph for this function:

uint8_t WaspXBeeDM::getNetworkHops ( )

It gets the maximum number of hops expected to be seen in a network route.

It stores in global 'networkHops' variable the maximum number of hops expected to be seen in a network route receiving a MAC acknowledgement message from the adjacent node

Returns:: '0' on success, '1' otherwise

Definition at line 228 of file WaspXBeeDM.cpp.

References WaspXBeeCore::data, delay(), WaspXBeeCore::error_AT, WaspXBeeCore::gen_data(), WaspXBeeCore::gen_send(), get_network_hops_DM, networkHops, WaspXBeeCore::protocol, and XBEE_900.

00229 {
00230     int8_t error=2;
00231         
00232     if( protocol!=XBEE_900 )
00233     {
00234             error_AT=2;
00235             gen_data(get_network_hops_DM);
00236             error=gen_send(get_network_hops_DM);
00237     }
00238     else {
00239             error=-1;
00240             error_AT=-1;
00241     }
00242     if(error==0)
00243     {
00244         networkHops=data[0];
00245         delay(20);
00246     } 
00247     return error;
00248 }

Here is the call graph for this function:

uint8_t WaspXBeeDM::setNetworkDelaySlots ( uint8_t dslots )

It sets the maximum random number of network delay slots before rebroadcasting a network packet.

Parameters:

uint8_t

dslots : the maximum random number of network delay slots before rebroadcasting a network packet (range [0-0x0A])

Returns:: '0' on success, '1' otherwise

Definition at line 260 of file WaspXBeeDM.cpp.

References WaspXBeeCore::error_AT, WaspXBeeCore::gen_checksum(), WaspXBeeCore::gen_data(), WaspXBeeCore::gen_send(), netDelaySlots, WaspXBeeCore::protocol, set_network_delay_DM, and XBEE_900.

00261 {
00262     int8_t error=2; 
00263     
00264     if( protocol!=XBEE_900 )
00265     {
00266             error_AT=2;
00267             gen_data(set_network_delay_DM,dslots);
00268             gen_checksum(set_network_delay_DM);
00269             error=gen_send(set_network_delay_DM);
00270     }
00271     else {
00272             error=-1;
00273             error_AT=-1;
00274     }
00275     if(error==0)
00276     {
00277         netDelaySlots=dslots;
00278     }
00279     return error;
00280 }

Here is the call graph for this function:

uint8_t WaspXBeeDM::getNetworkDelaySlots ( )

It gets the maximum random number of network delay slots before rebroadcasting a network packet.

It stores in global 'netDelaySlots' variable the maximum random number of network delay slots before rebroadcasting a network packet

Returns:: '0' on success, '1' otherwise

Definition at line 290 of file WaspXBeeDM.cpp.

References WaspXBeeCore::data, delay(), WaspXBeeCore::error_AT, WaspXBeeCore::gen_data(), WaspXBeeCore::gen_send(), get_network_delay_DM, netDelaySlots, WaspXBeeCore::protocol, and XBEE_900.

00291 {
00292     int8_t error=2;
00293         
00294     if( protocol!=XBEE_900 )
00295     {
00296             error_AT=2;
00297             gen_data(get_network_delay_DM);
00298             error=gen_send(get_network_delay_DM);
00299     }
00300     else {
00301             error=-1;
00302             error_AT=-1;
00303     }
00304     if(error==0)
00305     {
00306         netDelaySlots=data[0];
00307         delay(20);
00308     } 
00309     return error;
00310 }

Here is the call graph for this function:

uint8_t WaspXBeeDM::setNetworkRouteRequests ( uint8_t route )

It sets the maximum number of route discovery retries allowed to find a path to the destination node.

Parameters:

uint8_t

route : the maximum number of route discovery retries allowed to find a path to the destination node (range [0-0x0A])

Returns:: '0' on success, '1' otherwise

Definition at line 322 of file WaspXBeeDM.cpp.

References WaspXBeeCore::error_AT, WaspXBeeCore::gen_checksum(), WaspXBeeCore::gen_data(), WaspXBeeCore::gen_send(), netRouteRequest, WaspXBeeCore::protocol, set_network_route_DM, and XBEE_900.

00323 {
00324     int8_t error=2;
00325      
00326     
00327     if( protocol!=XBEE_900 )
00328     {
00329             error_AT=2;
00330             gen_data(set_network_route_DM,route);
00331             gen_checksum(set_network_route_DM);
00332             error=gen_send(set_network_route_DM);
00333     }
00334     else {
00335             error=-1;
00336             error_AT=-1;
00337     }
00338     if(error==0)
00339     {
00340         netRouteRequest=route;
00341     }
00342     return error;
00343 }

Here is the call graph for this function:

uint8_t WaspXBeeDM::getNetworkRouteRequests ( )

It gets the maximum number of route discovery retries allowed to find a path to the destination node.

It stores in global 'netRouteRequest' variable the maximum number of route discovery retries allowed to find a path to the destination node

Returns:: '0' on success, '1' otherwise

Definition at line 353 of file WaspXBeeDM.cpp.

References WaspXBeeCore::data, delay(), WaspXBeeCore::error_AT, WaspXBeeCore::gen_data(), WaspXBeeCore::gen_send(), get_network_route_DM, netRouteRequest, WaspXBeeCore::protocol, and XBEE_900.

00354 {
00355     int8_t error=2;
00356         
00357     if( protocol!=XBEE_900 )
00358     {
00359             error_AT=2;
00360             gen_data(get_network_route_DM);
00361             error=gen_send(get_network_route_DM);
00362     }
00363     else {
00364             error=-1;
00365             error_AT=-1;
00366     }
00367     if(error==0)
00368     {
00369         netRouteRequest=data[0];
00370         delay(20);
00371     } 
00372     return error;
00373 }

Here is the call graph for this function:

uint8_t WaspXBeeDM::setMeshNetworkRetries ( uint8_t mesh )

It sets the maximum number of network packet delivery attempts.

Parameters:

uint8_t

mesh : the maximum number of network packet delivery attempts (range [0-7])

Returns:: '0' on success, '1' otherwise

Definition at line 385 of file WaspXBeeDM.cpp.

References WaspXBeeCore::error_AT, WaspXBeeCore::gen_checksum(), WaspXBeeCore::gen_data(), WaspXBeeCore::gen_send(), meshNetRetries, WaspXBeeCore::protocol, set_network_retries_DM, and XBEE_900.

00386 {
00387     int8_t error=2; 
00388     
00389     if( protocol!=XBEE_900 )
00390     {
00391             error_AT=2;
00392             gen_data(set_network_retries_DM,mesh);
00393             gen_checksum(set_network_retries_DM);
00394             error=gen_send(set_network_retries_DM);
00395     }
00396     else {
00397             error=-1;
00398             error_AT=-1;
00399     }
00400     if(error==0)
00401     {
00402         meshNetRetries=mesh;
00403     }
00404     return error;
00405 }

Here is the call graph for this function:

uint8_t WaspXBeeDM::getMeshNetworkRetries ( )

It gets the maximum number of network packet delivery attempts.

It stores in global 'meshNetRetries' variable the maximum number of network packet delivery attempts

Returns:: '0' on success, '1' otherwise

Definition at line 415 of file WaspXBeeDM.cpp.

References WaspXBeeCore::data, delay(), WaspXBeeCore::error_AT, WaspXBeeCore::gen_data(), WaspXBeeCore::gen_send(), get_network_retries_DM, meshNetRetries, WaspXBeeCore::protocol, and XBEE_900.

00416 {
00417     int8_t error=2;
00418         
00419     if( protocol!=XBEE_900 )
00420     {
00421             error_AT=2;
00422             gen_data(get_network_retries_DM);
00423             error=gen_send(get_network_retries_DM);
00424     }
00425     else {
00426             error=-1;
00427             error_AT=-1;
00428     }
00429     if(error==0)
00430     {
00431         meshNetRetries=data[0];
00432         delay(20);
00433     } 
00434     return error;
00435 }

Here is the call graph for this function:

uint8_t WaspXBeeDM::getTemperature ( )

It gets module temperature in Celsius. Negatives temperatures can be returned.

It stores in global 'temperature' variable module temperature in Celsius

Returns:: '0' on success, '1' otherwise

Definition at line 445 of file WaspXBeeDM.cpp.

References WaspXBeeCore::data, delay(), DIGIMESH, WaspXBeeCore::error_AT, WaspXBeeCore::freq, FREQ900M, WaspXBeeCore::gen_data(), WaspXBeeCore::gen_send(), get_temperature_DM, WaspXBeeCore::protocol, temperature, and XBEE_900.

00446 {
00447     int8_t error=2;
00448         
00449     if( (protocol==XBEE_900) || ( (protocol==DIGIMESH) && (freq==FREQ900M) ) )
00450     {
00451             error_AT=2;
00452             gen_data(get_temperature_DM);
00453             error=gen_send(get_temperature_DM);
00454     }
00455     else {
00456             error=-1;
00457             error_AT=-1;
00458     }
00459     if(error==0)
00460     {
00461             temperature[0]=data[0];
00462             delay(20);
00463             temperature[1]=data[1];    
00464             delay(20);
00465     }
00466     return error;
00467 }

Here is the call graph for this function:

uint8_t WaspXBeeDM::getSupplyVoltage ( )

It gets the voltage on the Vcc pin.

It stores in global 'supplyVoltage' variable the voltage on the Vcc pin

Returns:: '0' on success, '1' otherwise

Definition at line 477 of file WaspXBeeDM.cpp.

References WaspXBeeCore::data, delay(), DIGIMESH, WaspXBeeCore::error_AT, WaspXBeeCore::freq, FREQ900M, WaspXBeeCore::gen_data(), WaspXBeeCore::gen_send(), get_supply_Volt_DM, WaspXBeeCore::protocol, supplyVoltage, and XBEE_900.

00478 {
00479     int8_t error=2;
00480         
00481     if( (protocol==XBEE_900) || ( (protocol==DIGIMESH) && (freq==FREQ900M) ) )
00482     {
00483             error_AT=2;
00484             gen_data(get_supply_Volt_DM);
00485             error=gen_send(get_supply_Volt_DM);
00486     }
00487     else {
00488             error=-1;
00489             error_AT=-1;
00490     }
00491     if(error==0)
00492     {
00493             supplyVoltage[0]=data[0];
00494             delay(20);
00495             supplyVoltage[1]=data[1];    
00496             delay(20);
00497     }
00498     return error;
00499 }

Here is the call graph for this function:

uint8_t WaspXBeeDM::restoreCompiled ( )

It restores module parameters to compiled defaults.

Returns:: '0' on success, '1' otherwise

Definition at line 509 of file WaspXBeeDM.cpp.

References DIGIMESH, WaspXBeeCore::error_AT, WaspXBeeCore::freq, FREQ900M, WaspXBeeCore::gen_data(), WaspXBeeCore::gen_send(), WaspXBeeCore::protocol, restore_compiled_DM, and XBEE_900.

00510 {
00511     int8_t error=2;
00512         
00513     if( (protocol==XBEE_900) || ( (protocol==DIGIMESH) && (freq==FREQ900M) ) )
00514     {
00515             error_AT=2;
00516             gen_data(restore_compiled_DM);
00517             error=gen_send(restore_compiled_DM);
00518     }
00519     else {
00520             error=-1;
00521             error_AT=-1;
00522     }
00523     return error;
00524 }