John Bailey
API for communicating with XBee devices.
Dependencies: CircularBuffer FixedLengthList
Dependents: XBeeApiTest XBeeApiSimpleATCmdsExample XBeeApiBroadcastExample XBeeApiBroadcastExampleRTOS ... more
Overview
XBeeApi is intended to be a library for providing a high-level API interface to the XBee - for example getChannel() and setChannel(2) methods rather than needing to send( "ATCH" ) and send( "ATCH 2" ) - and then de-code the responses.
See the notebook page here for a description of how the API works & some details on the various classes.
Features:
- Support for transmission & reception of data packets
- Support for reading & changing settings
- Support for "Remote AT" interface to access settings & I/O channels on remote XBees
- XBeeApi should work if you're using mbed-rtos, though it is not currently threadsafe. Take a look at the XBeeApiBroadcastExampleRTOS example if you're including mbed-rtos.
Example Programs
There are also example programs available:
Transmit
Import programXBeeApiSimpleBroadcastExample
Simple example of how to use XBeeApi - set up the XBee, configure P2P networking then transmit a frame.
Last commit 06 Jul 2014 by 
John Bailey
Import programXBeeApiBroadcastExample
Example for XBeeAPI; a little more involved than XBeeApiSimpleBroadcastExample with report on failure to set up the XBee and on the transmit status of the message.
Last commit 05 Jul 2014 by John Bailey
Import programXBeeApiBroadcastExampleRTOS
Example of using the XBeeApi library to broadcast a message, based on XBeeApiBroadcastExample. This example shows how to use the library when using mbed-rtos. Before compiling you must open "XbeeApi\Config\XBeeApiCfg.hpp" and change the '#if 0' to '#if 1' on the line above the comment reading "Use RTOS features to make XBeeApi threadsafe"
Last commit 06 Jul 2014 by John Bailey
Settings/Status
Import programXBeeApiSimpleATCmdsExample
Simple example of using XBeeApi to send AT-style commands to the XBee
Last commit 31 Mar 2014 by John Bailey
Import programXBeeApiRemoteATCmdsExample
Example of using the XBeeApi library to send AT commands to remote XBee devices in order to read/write settings
Last commit 13 Jul 2014 by John Bailey
Receive
Import programXBeeApiSimpleReceiveExample
Simple example of using XBeeApi to receive data packets via wireless
Last commit 08 Jul 2014 by John Bailey
Import programXBeeApiReceiveCallbackExample
Example of using the XBeeApi library to receive a message via a callback method
Last commit 08 Jul 2014 by John Bailey
Import programXBeeApiReceiveCallbackExampleRTOS
Example of using the XBeeApi library to receive a message via a callback method. This example shows how to use the library when using mbed-rtos. See the comment at the top of main.cpp
Last commit 08 Jul 2014 by John Bailey
Remote I/O
Import programXBeeApiRemoteIOExample
Example of using the XBeeApi library to read inputs on a remote XBee
Last commit 28 Jul 2014 by John Bailey
If you have 2 mbed connected XBees available then you can use XBeeApiSimpleReceiveExample and XBeeApiSimpleBroadcastExample as a pair.
Note that this is still a work in progress! XBeeApiTodoList tracks some of the functionality still to be added.
Utility/XBeeApiCmdAt.cpp
- Committer:
- johnb
- Date:
- 2014-07-13
- Revision:
- 50:f76b7e7959a2
- Parent:
- 36:cc7e8d1e35dd
- Child:
- 51:a7d0d2ef9261
File content as of revision 50:f76b7e7959a2:
/**
Copyright 2014 John Bailey
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#include "XBeeApiCmdAt.hpp"
/* Set of Frame ID codes for the various commands (see XBEE_CMD_POSN_FRAME_ID) */
#define CMD_RESPONSE_GET_VR '1'
#define CMD_RESPONSE_GET_HV '2'
#define CMD_RESPONSE_GET_CH '3'
#define CMD_RESPONSE_SET_CH '4'
#define CMD_RESPONSE_SET_CE '5'
#define CMD_RESPONSE_GET_CE '6'
#define CMD_RESPONSE_SET_EDA '7'
#define CMD_RESPONSE_GET_EDA '8'
#define CMD_RESPONSE_SET_PID '9'
#define CMD_RESPONSE_GET_PID '0'
#define CMD_RESPONSE_SET_MY 'a'
#define CMD_RESPONSE_GET_MY 'b'
#define CMD_RESPONSE_GET_SH 'c'
#define CMD_RESPONSE_GET_SL 'd'
#define CMD_RESPONSE_SET_RR 'e'
#define CMD_RESPONSE_GET_RR 'f'
#define CMD_RESPONSE_SET_RN 'g'
#define CMD_RESPONSE_GET_RN 'h'
#define CMD_RESPONSE_SET_MM 'i'
#define CMD_RESPONSE_GET_MM 'j'
#define CMD_RESPONSE_GET_D0 'k'
#define CMD_RESPONSE_GET_D1 'l'
#define CMD_RESPONSE_GET_D2 'm'
#define CMD_RESPONSE_GET_D3 'n'
#define CMD_RESPONSE_GET_D4 'o'
#define CMD_RESPONSE_GET_D5 'p'
#define CMD_RESPONSE_GET_D6 'q'
#define CMD_RESPONSE_GET_D7 'r'
/** Lowest channel supported by the XBee S1 */
#define XBEE_CHAN_MIN 0x0b
/** Highest channel supported by the XBee S1 */
#define XBEE_CHAN_MAX 0x1a
/** Lowest channel supported by the XBee S1 Pro */
#define XBEE_PRO_CHAN_MIN 0x0c
/** Highest channel supported by the XBee S1 Pro */
#define XBEE_PRO_CHAN_MAX 0x17
/* Content for the various commands - value of 0 indicates a value to be populated (i.e. variable) */
static const uint8_t cmd_vr[] = { 'V', 'R' };
static const uint8_t cmd_vr_get_fid = CMD_RESPONSE_GET_VR;
static const uint8_t cmd_hv[] = { 'H', 'V' };
static const uint8_t cmd_hv_get_fid = CMD_RESPONSE_GET_HV;
static const uint8_t cmd_sh[] = { 'S', 'H' };
static const uint8_t cmd_sh_get_fid = CMD_RESPONSE_GET_SH;
static const uint8_t cmd_sl[] = { 'S', 'L' };
static const uint8_t cmd_sl_get_fid = CMD_RESPONSE_GET_SL;
static const uint8_t cmd_ch[] = { 'C', 'H' };
static const uint8_t cmd_ch_get_fid = CMD_RESPONSE_GET_CH;
static const uint8_t cmd_ch_set[] = { 'C', 'H', 0 };
static const uint8_t cmd_ch_set_fid = CMD_RESPONSE_SET_CH;
static const uint8_t cmd_ce[] = { 'C', 'E' };
static const uint8_t cmd_ce_get_fid = CMD_RESPONSE_GET_CE;
static const uint8_t cmd_ce_set[] = { 'C', 'E', 0 };
static const uint8_t cmd_ce_set_fid = CMD_RESPONSE_SET_CE;
static const uint8_t cmd_eda[] = { 'A', '1' };
static const uint8_t cmd_eda_get_fid = CMD_RESPONSE_GET_EDA;
static const uint8_t cmd_eda_set[] = { 'A', '1', 0 };
static const uint8_t cmd_eda_set_fid = CMD_RESPONSE_SET_EDA;
static const uint8_t cmd_pid[] = { 'I', 'D' };
static const uint8_t cmd_pid_get_fid = CMD_RESPONSE_GET_PID;
static const uint8_t cmd_pid_set[] = { 'I', 'D', 0, 0 };
static const uint8_t cmd_pid_set_fid = CMD_RESPONSE_SET_PID;
static const uint8_t cmd_my[] = { 'M', 'Y' };
static const uint8_t cmd_my_get_fid = CMD_RESPONSE_GET_MY;
static const uint8_t cmd_my_set[] = { 'M', 'Y', 0, 0 };
static const uint8_t cmd_my_set_fid = CMD_RESPONSE_SET_MY;
static const uint8_t cmd_rr[] = { 'R', 'R' };
static const uint8_t cmd_rr_get_fid = CMD_RESPONSE_GET_RR;
static const uint8_t cmd_rr_set[] = { 'R', 'R', 0 };
static const uint8_t cmd_rr_set_fid = CMD_RESPONSE_SET_RR;
static const uint8_t cmd_rn[] = { 'R', 'N' };
static const uint8_t cmd_rn_get_fid = CMD_RESPONSE_GET_RN;
static const uint8_t cmd_rn_set[] = { 'R', 'N', 0 };
static const uint8_t cmd_rn_set_fid = CMD_RESPONSE_SET_RN;
static const uint8_t cmd_mm[] = { 'M', 'M' };
static const uint8_t cmd_mm_get_fid = CMD_RESPONSE_GET_MM;
static const uint8_t cmd_mm_set[] = { 'M', 'M', 0 };
static const uint8_t cmd_mm_set_fid = CMD_RESPONSE_SET_MM;
static const uint8_t cmd_d[ XBEE_API_DIO_CHANNEL_COUNT ][2] = {{ 'D', '0' },
{ 'D', '1' },
{ 'D', '2' },
{ 'D', '3' },
{ 'D', '4' },
{ 'D', '5' },
{ 'D', '6' },
{ 'D', '7' }};
static const uint8_t cmd_d_get_fid[ XBEE_API_DIO_CHANNEL_COUNT ] = { CMD_RESPONSE_GET_D0,
CMD_RESPONSE_GET_D1,
CMD_RESPONSE_GET_D2,
CMD_RESPONSE_GET_D3,
CMD_RESPONSE_GET_D4,
CMD_RESPONSE_GET_D5,
CMD_RESPONSE_GET_D6,
CMD_RESPONSE_GET_D7 };
#define XBEE_CMD_POSN_FRAME_ID XBEE_CMD_POSN_ID_SPECIFIC_DATA
#define XBEE_CMD_POSN_STATUS (7U)
#define XBEE_CMD_POSN_PARAM_START (8U)
#define XBEE_CMD_RESPONS_HAS_DATA( _p_len ) ((_p_len > ( XBEE_CMD_POSN_PARAM_START + 1 ))
/** Template class to create an XBeeApiFrame which can be used to change
the value of one of the XBee parameters. This class is used by the
setXXX methods in XBeeApiCmdAt */
template< typename T >
class XBeeApiCmdAtSet : public XBeeApiFrame {
uint8_t m_buffer[ XBEE_API_CMD_SET_HEADER_LEN + sizeof( T ) ];
public:
/** Constructor
\param p_data Pointer to a buffer of length 2 bytes identifying
the command, e.g. 'V', 'R' would set up a version
request
\param p_val New value for the parameter
*/
XBeeApiCmdAtSet( const uint8_t p_frameId,
const uint8_t* const p_data,
const T p_val );
/** Destructor */
virtual ~XBeeApiCmdAtSet();
};
class XBeeApiCmdAtReq : public XBeeApiFrame {
uint8_t m_buffer[ XBEE_API_CMD_REQ_HEADER_LEN ];
public:
/** Constructor
\param p_data Pointer to a buffer of length 2 bytes identifying
the command, e.g. 'V', 'R' would set up a version
request
\param p_val New value for the parameter
*/
XBeeApiCmdAtReq( const uint8_t p_frameId,
const uint8_t* const p_data );
/** Destructor */
virtual ~XBeeApiCmdAtReq();
};
XBeeApiCmdAt::XBeeApiCmdAt( XBeeDevice* const p_device ) : XBeeApiFrameDecoder( p_device ) ,
m_have_hwVer( false ),
m_have_fwVer( false ),
m_have_chan( false ),
m_have_PANId( false ),
m_have_EDA( false ),
m_have_CE( false ),
m_have_sourceAddress( false ),
m_have_snLow( false ),
m_have_snHigh( false ),
m_have_retries( false ),
m_have_randomDelaySlots( false ),
m_have_macMode( false )
{
}
#define PROCESS_SET_GET_RESPONSE_GENERIC( _type, _var, _src, _t ) \
case CMD_RESPONSE_SET_ ## _type: \
case CMD_RESPONSE_GET_ ## _type: \
if( p_data[ statusPosn ] == 0 ) \
{ \
if( CMD_RESPONSE_GET_ ## _type == p_data[ XBEE_CMD_POSN_FRAME_ID ] ) \
{ \
m_ ##_var = (_t) (_src); \
} \
else \
{ \
m_ ## _var = m_ ## _var ## Pend; \
} \
m_have_ ## _var = true; \
} \
else \
{ \
/* TODO */ \
} \
ret_val = true; \
break;
#define PROCESS_GET_RESPONSE_GENERIC( _type, _var, _src ) \
case CMD_RESPONSE_GET_ ## _type: \
if( p_data[ statusPosn ] == 0 ) \
{ \
m_ ##_var = _src; \
m_have_ ## _var = true; \
} \
else \
{ \
/* TODO */ \
} \
ret_val = true; \
break;
#define PROCESS_SET_GET_RESPONSE_8BIT_WITHCAST( _type, _var, _t ) PROCESS_SET_GET_RESPONSE_GENERIC( _type, _var, p_data[ dataPosn ], _t )
#define PROCESS_SET_GET_RESPONSE_8BIT( _type, _var ) PROCESS_SET_GET_RESPONSE_GENERIC( _type, _var, p_data[ dataPosn ], uint8_t )
#define PROCESS_SET_GET_RESPONSE_16BIT( _type, _var ) PROCESS_SET_GET_RESPONSE_GENERIC( _type, _var, ((uint16_t)p_data[ dataPosn ] << 8) | p_data[ dataPosn + 1 ], uint16_t )
#define PROCESS_GET_RESPONSE_16BIT( _type, _var ) PROCESS_GET_RESPONSE_GENERIC( _type, _var, ((uint16_t)p_data[ dataPosn ] << 8) | p_data[ dataPosn + 1 ] )
#define PROCESS_GET_RESPONSE_32BIT( _type, _var ) PROCESS_GET_RESPONSE_GENERIC( _type, _var, ((uint32_t)p_data[ dataPosn ] << 24) |\
((uint32_t)p_data[ dataPosn + 1 ] << 16) |\
((uint32_t)p_data[ dataPosn + 2 ] << 8) |\
((uint32_t)p_data[ dataPosn + 3 ]))
size_t XBeeApiCmdAt::getResponseStatusPos( void ) const
{
return XBEE_CMD_POSN_STATUS;
}
bool XBeeApiCmdAt::processResponseFrame( const uint8_t* const p_data, size_t p_len )
{
bool ret_val = false;
size_t statusPosn = getResponseStatusPos();
size_t dataPosn = statusPosn + 1;
switch( p_data[ XBEE_CMD_POSN_FRAME_ID ] )
{
PROCESS_GET_RESPONSE_16BIT( HV, hwVer )
PROCESS_GET_RESPONSE_16BIT( VR, fwVer )
PROCESS_SET_GET_RESPONSE_8BIT( CH, chan )
PROCESS_SET_GET_RESPONSE_8BIT( CE, CE )
PROCESS_SET_GET_RESPONSE_16BIT( PID, PANId )
PROCESS_SET_GET_RESPONSE_8BIT( EDA, EDA )
PROCESS_SET_GET_RESPONSE_8BIT( RR, retries )
PROCESS_SET_GET_RESPONSE_16BIT( MY, sourceAddress )
PROCESS_GET_RESPONSE_32BIT( SH, snHigh )
PROCESS_GET_RESPONSE_32BIT( SL, snLow )
PROCESS_SET_GET_RESPONSE_8BIT( RN, randomDelaySlots )
PROCESS_SET_GET_RESPONSE_8BIT_WITHCAST( MM, macMode, XBeeApiMACMode_e )
/* TODO: Add D0, D1, D2 response handling */
}
return ret_val;
}
bool XBeeApiCmdAt::decodeCallback( const uint8_t* const p_data, size_t p_len )
{
bool ret_val = false;
if( XBEE_CMD_AT_RESPONSE == p_data[ XBEE_CMD_POSN_API_ID ] )
{
ret_val = processResponseFrame( p_data, p_len );
}
return ret_val;
}
bool XBeeApiCmdAt::setChannel( uint8_t const p_chan )
{
bool ret_val = false;
if((( m_device->getXBeeModel() == XBeeDevice::XBEEDEVICE_S1 ) &&
( p_chan >= XBEE_CHAN_MIN ) &&
( p_chan <= XBEE_CHAN_MAX )) ||
(( m_device->getXBeeModel() == XBeeDevice::XBEEDEVICE_S1_PRO ) &&
( p_chan >= XBEE_PRO_CHAN_MIN ) &&
( p_chan <= XBEE_PRO_CHAN_MAX )))
{
m_chanPend = p_chan;
SendCmd_uint8_t( cmd_ch_set_fid, cmd_ch_set, p_chan );
ret_val = true;
}
return ret_val;
}
void XBeeApiCmdAt::SendReq( const uint8_t p_frameId,
const uint8_t* p_data )
{
XBeeApiCmdAtReq req( p_frameId, p_data );
m_device->SendFrame( &req );
}
#define MAKE_REQUEST( _name, _mnemonic, _cmd ) \
bool XBeeApiCmdAt::request ## _name( void ) \
{\
m_have_ ## _mnemonic = false; \
SendReq( _cmd ## _get_fid, _cmd ); \
return true;\
}
MAKE_REQUEST( HardwareVersion, hwVer, cmd_hv )
MAKE_REQUEST( FirmwareVersion, fwVer, cmd_vr )
MAKE_REQUEST( Channel, chan, cmd_ch )
MAKE_REQUEST( PanId, PANId, cmd_pid )
MAKE_REQUEST( CoordinatorEnabled, CE, cmd_ce )
MAKE_REQUEST( EndDeviceAssociationEnabled, EDA, cmd_eda )
MAKE_REQUEST( SourceAddress, sourceAddress, cmd_my )
MAKE_REQUEST( Retries, retries, cmd_rr )
MAKE_REQUEST( RandomDelaySlots, randomDelaySlots, cmd_rn )
MAKE_REQUEST( MacMode, macMode, cmd_mm );
MAKE_REQUEST( SerialNumberHigh, snHigh, cmd_sh );
MAKE_REQUEST( SerialNumberLow, snLow, cmd_sl );
bool XBeeApiCmdAt::requestSerialNumber( void )
{
requestSerialNumberHigh();
requestSerialNumberLow();
return true;
}
bool XBeeApiCmdAt::requestDioConfig( const uint8_t p_chanNo )
{
bool ret_val = false;
if( p_chanNo < XBEE_API_DIO_CHANNEL_COUNT )
{
m_have_d[ p_chanNo ] = false;
SendReq( cmd_d_get_fid[ p_chanNo ], cmd_d[ p_chanNo ] );
ret_val = true;
}
return ret_val;
}
#define MAKE_GET(_name, _mnemonic, _type ) \
bool XBeeApiCmdAt::get ## _name( _type* const p_param ) \
{\
if( m_have_ ## _mnemonic ) {\
*p_param = m_ ## _mnemonic;\
} \
return m_have_ ## _mnemonic; \
}
MAKE_GET( FirmwareVersion, fwVer, uint16_t )
MAKE_GET( HardwareVersion, hwVer, uint16_t )
MAKE_GET( Channel, chan, uint8_t )
MAKE_GET( CoordinatorEnabled, CE, bool )
MAKE_GET( EndDeviceAssociationEnabled, EDA, bool )
MAKE_GET( PanId, PANId, panId_t )
MAKE_GET( SourceAddress, sourceAddress, uint16_t )
MAKE_GET( Retries, retries, uint8_t )
MAKE_GET( RandomDelaySlots, randomDelaySlots, uint8_t )
MAKE_GET( MacMode, macMode, XBeeApiMACMode_e )
bool XBeeApiCmdAt::getSerialNumber( uint64_t* const p_sn )
{
/* Need both halves to have the complete serial number */
bool have_sn = m_have_snLow && m_have_snHigh;
if( have_sn )
{
*p_sn = m_snHigh;
*p_sn = *p_sn << 32U;
*p_sn |= m_snLow;
}
return( have_sn );
}
bool XBeeApiCmdAt::getDioConfig( const uint8_t p_chanNo, XBeeApiDioConfig_e* const p_conf )
{
bool ret_val = false;
if( p_chanNo < XBEE_API_DIO_CHANNEL_COUNT )
{
if( m_have_d[ p_chanNo ] )
{
*p_conf = m_d[ p_chanNo ];
ret_val = true;
}
}
return ret_val;
}
#define MAKE_SET( _name, _mnemonic, _cmd, _type, _transmit_type ) \
bool XBeeApiCmdAt::set ## _name( const _type p_param ) \
{\
m_have_ ## _mnemonic = false;\
m_## _mnemonic ## Pend = p_param;\
SendCmd_ ## _transmit_type ( _cmd ## _fid, _cmd, p_param ); \
return true;\
}
MAKE_SET( CoordinatorEnabled, CE, cmd_ce_set, bool, uint8_t )
MAKE_SET( EndDeviceAssociationEnabled, EDA, cmd_eda_set, bool, uint8_t )
MAKE_SET( PanId, PANId, cmd_pid_set, uint16_t, uint16_t )
MAKE_SET( SourceAddress, sourceAddress, cmd_my_set, uint16_t, uint16_t )
MAKE_SET( Retries, retries, cmd_rr_set, uint8_t, uint16_t )
MAKE_SET( RandomDelaySlots, randomDelaySlots, cmd_rn_set, uint8_t, uint16_t )
MAKE_SET( MacMode, macMode, cmd_mm_set, XBeeApiMACMode_e, uint8_t )
bool XBeeApiCmdAt::setDioConfig( const uint8_t p_chanNo, const XBeeApiDioConfig_e p_conf )
{
bool ret_val = false;
if( p_chanNo < XBEE_API_DIO_CHANNEL_COUNT )
{
m_have_d[ p_chanNo ] = false;
m_dPend[ p_chanNo ] = p_conf;
SendCmd_uint8_t( cmd_d_get_fid[ p_chanNo ], cmd_d[ p_chanNo ], p_conf );
}
return ret_val;
}
void XBeeApiCmdAt::SendCmd_uint8_t( const uint8_t p_frameId,
const uint8_t* const p_data,
const uint8_t& p_val )
{
XBeeApiCmdAtSet<uint8_t> req( p_frameId, p_data, p_val );
m_device->SendFrame( &req );
}
void XBeeApiCmdAt::SendCmd_uint16_t( const uint8_t p_frameId,
const uint8_t* const p_data,
const uint16_t& p_val )
{
XBeeApiCmdAtSet<uint16_t> req( p_frameId, p_data, p_val );
m_device->SendFrame( &req );
}
XBeeApiCmdAtBlocking::XBeeApiCmdAtBlocking( XBeeDevice* const p_device, const uint16_t p_timeout, const uint16_t p_slice ) :
XBeeApiCmdAt( p_device ),
m_timeout( p_timeout ),
m_slice( p_slice )
{
}
/**
Macro to wrap around the "requestXXX" & "getXXX" methods and implement a blocking call.
This macro is used as the basis for getXXX functions in XBeeApiCmdAtBlocking.
Originally looked to achieve this using a template function passing method pointers, however
there's no way to get a method pointer to the parent class implementation as opposed to the
implementation in this class, meaning that the result was a recursive method call. The joys of
polymorphism.
e.g. We pass a pointer to method getHardwareVersion(). The function receiving the pointer
uses it to make a function call. The actual function that's called is (correctly)
the one implemented in this class, however what we actually wanted in this case
was to call the implementation in the base class. Using static_cast<> doesn't have
any effect and taking the address of XBeeApiCmdAt::getHardwareVersion ends up with
XBeeApiCmdAtBlocking::getHardwareVersion being called due to polymorphism. */
#define BLOCKING_GET( _REQ_FN, _GET_FN, _VAR ) \
bool ret_val = false; \
\
if( _GET_FN( _VAR ) )\
{\
ret_val = true;\
} \
else if( _REQ_FN() )\
{\
uint16_t counter = m_timeout; \
bool cont;\
\
do{\
cont = false; \
wait_ms( m_slice );\
if( _GET_FN( _VAR ) )\
{\
ret_val = true;\
}\
else if( counter > m_slice ) {\
counter -= m_slice; \
cont = true;\
} \
} while( cont );\
}\
\
return( ret_val );
/**
Macro to wrap around the "setXXX" & "getXXX" methods and implement a blocking call.
This macro is used as the basis for setXXX functions in XBeeApiCmdAtBlocking.
*/
#define BLOCKING_SET( _SET_FN, _GET_FN, _VAR, _TYPE ) \
bool ret_val = false; \
uint16_t counter = m_timeout; \
_TYPE readback; \
\
if( _SET_FN( _VAR ) )\
{\
bool cont;\
\
do{\
cont = false;\
wait_ms( m_slice );\
if( _GET_FN( &readback ) &&\
( readback == _VAR ))\
{\
ret_val = true;\
}\
else if( counter > m_slice ) {\
counter -= m_slice; \
cont = true;\
} \
} while( cont );\
}\
\
return( ret_val );
bool XBeeApiCmdAtBlocking::getHardwareVersion( uint16_t* const p_ver )
{
BLOCKING_GET( XBeeApiCmdAt::requestHardwareVersion,
XBeeApiCmdAt::getHardwareVersion,
p_ver );
}
bool XBeeApiCmdAtBlocking::getFirmwareVersion( uint16_t* const p_ver )
{
BLOCKING_GET( XBeeApiCmdAt::requestFirmwareVersion,
XBeeApiCmdAt::getFirmwareVersion,
p_ver );
}
bool XBeeApiCmdAtBlocking::getSerialNumber( uint64_t* const p_sn )
{
BLOCKING_GET( XBeeApiCmdAt::requestSerialNumber,
XBeeApiCmdAt::getSerialNumber,
p_sn );
}
bool XBeeApiCmdAtBlocking::getChannel( uint8_t* const p_chan )
{
BLOCKING_GET( XBeeApiCmdAt::requestChannel,
XBeeApiCmdAt::getChannel,
p_chan );
}
bool XBeeApiCmdAtBlocking::setChannel( uint8_t const p_chan )
{
BLOCKING_SET( XBeeApiCmdAt::setChannel,
XBeeApiCmdAt::getChannel,
p_chan,
uint8_t );
}
bool XBeeApiCmdAtBlocking::getCoordinatorEnabled( bool* const p_en )
{
BLOCKING_GET( XBeeApiCmdAt::requestCoordinatorEnabled,
XBeeApiCmdAt::getCoordinatorEnabled,
p_en );
}
bool XBeeApiCmdAtBlocking::setCoordinatorEnabled( const bool p_en )
{
BLOCKING_SET( XBeeApiCmdAt::setCoordinatorEnabled,
XBeeApiCmdAt::getCoordinatorEnabled,
p_en,
bool );
}
bool XBeeApiCmdAtBlocking::getEndDeviceAssociationEnabled( bool* const p_en )
{
BLOCKING_GET( XBeeApiCmdAt::requestEndDeviceAssociationEnabled,
XBeeApiCmdAt::getEndDeviceAssociationEnabled,
p_en );
}
bool XBeeApiCmdAtBlocking::setEndDeviceAssociationEnabled( const bool p_en )
{
BLOCKING_SET( XBeeApiCmdAt::setEndDeviceAssociationEnabled,
XBeeApiCmdAt::getEndDeviceAssociationEnabled,
p_en,
bool );
}
bool XBeeApiCmdAtBlocking::getPanId( panId_t* const p_chan )
{
BLOCKING_GET( XBeeApiCmdAt::requestPanId,
XBeeApiCmdAt::getPanId,
p_chan );
}
bool XBeeApiCmdAtBlocking::setPanId( const panId_t p_chan )
{
BLOCKING_SET( XBeeApiCmdAt::setPanId,
XBeeApiCmdAt::getPanId,
p_chan,
panId_t );
}
bool XBeeApiCmdAtBlocking::getSourceAddress( uint16_t* const p_addr )
{
BLOCKING_GET( XBeeApiCmdAt::requestSourceAddress,
XBeeApiCmdAt::getSourceAddress,
p_addr );
}
bool XBeeApiCmdAtBlocking::setSourceAddress( const uint16_t p_addr )
{
BLOCKING_SET( XBeeApiCmdAt::setSourceAddress,
XBeeApiCmdAt::getSourceAddress,
p_addr,
uint16_t );
}
bool XBeeApiCmdAtBlocking::getRetries( uint8_t* const p_addr )
{
BLOCKING_GET( XBeeApiCmdAt::requestRetries,
XBeeApiCmdAt::getRetries,
p_addr );
}
bool XBeeApiCmdAtBlocking::setRetries( const uint8_t p_addr )
{
BLOCKING_SET( XBeeApiCmdAt::setRetries,
XBeeApiCmdAt::getRetries,
p_addr,
uint8_t );
}
bool XBeeApiCmdAtBlocking::getRandomDelaySlots( uint8_t* const p_addr )
{
BLOCKING_GET( XBeeApiCmdAt::requestRandomDelaySlots,
XBeeApiCmdAt::getRandomDelaySlots,
p_addr );
}
bool XBeeApiCmdAtBlocking::setRandomDelaySlots( const uint8_t p_addr )
{
BLOCKING_SET( XBeeApiCmdAt::setRandomDelaySlots,
XBeeApiCmdAt::getRandomDelaySlots,
p_addr,
uint8_t );
}
bool XBeeApiCmdAtBlocking::getMacMode( XBeeApiMACMode_e* const p_mode )
{
BLOCKING_GET( XBeeApiCmdAt::requestMacMode,
XBeeApiCmdAt::getMacMode,
p_mode );
}
bool XBeeApiCmdAtBlocking::setMacMode( const XBeeApiMACMode_e p_mode )
{
BLOCKING_SET( XBeeApiCmdAt::setMacMode,
XBeeApiCmdAt::getMacMode,
p_mode,
XBeeApiMACMode_e );
}
bool XBeeApiCmdAtBlocking::getDioConfig( const uint8_t p_chanNo, XBeeApiDioConfig_e* const p_conf )
{
/* TODO */
return false;
}
bool XBeeApiCmdAtBlocking::setDioConfig( const uint8_t p_chanNo, const XBeeApiDioConfig_e p_conf )
{
/* TODO */
return false;
}
template < typename T >
XBeeApiCmdAtSet<T>::XBeeApiCmdAtSet( const uint8_t p_frameId,
const uint8_t* const p_data,
const T p_val ) : XBeeApiFrame( )
{
size_t s;
uint8_t* dest;
const uint8_t* src = (uint8_t*)(&p_val);
m_apiId = XBEE_CMD_AT_CMD;
m_buffer[0] = p_frameId;
m_buffer[1] = p_data[0];
m_buffer[2] = p_data[1];
m_dataLen = sizeof( m_buffer );
/* TODO: This copy code isn't portable - it's assuming that the data in
* p_data is little endian */
dest = &( m_buffer[ m_dataLen - 1 ] );
for( s = 0;
s < sizeof( T );
s++, dest--, src++ ) {
*dest = *src;
}
m_data = m_buffer;
}
template < typename T >
XBeeApiCmdAtSet<T>::~XBeeApiCmdAtSet()
{
}
XBeeApiCmdAtReq::XBeeApiCmdAtReq( const uint8_t p_frameId,
const uint8_t* const p_data )
{
m_apiId = XBEE_CMD_AT_CMD;
m_buffer[0] = p_frameId;
m_buffer[1] = p_data[0];
m_buffer[2] = p_data[1];
m_dataLen = sizeof( m_buffer );
m_data = m_buffer;
}
XBeeApiCmdAtReq::~XBeeApiCmdAtReq()
{
}