John Bailey / XBeeApi

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.

Files at this revision

API Documentation at this revision

Revision 12:58319a467943, committed 2014-02-01

Comitter:
johnb
Date:
Sat Feb 01 00:04:42 2014 +0000
Parent:
11:bfcf1356027b
Child:
13:302e7c1ea0b3
Commit message:
Add XBeeApiAddrType_t

Changed in this revision

Base/XBeeApiFrame.hpp Show annotated file Show diff for this revision Revisions of this file
Base/XBeeDevice.hpp Show annotated file Show diff for this revision Revisions of this file
RXTX/XBeeApiTxFrame.cpp Show annotated file Show diff for this revision Revisions of this file
RXTX/XBeeApiTxFrame.hpp Show annotated file Show diff for this revision Revisions of this file 
--- a/Base/XBeeApiFrame.hpp	Fri Jan 31 23:53:16 2014 +0000
+++ b/Base/XBeeApiFrame.hpp	Sat Feb 01 00:04:42 2014 +0000
@@ -115,7 +115,7 @@
                                 byte that is required.
             \param[out] p_buff  Pointer to a pointer to receive the buffer pointer 
             \param[out] p_len   Pointer to receive the length of the data pointed to by *p_buff */
-        void getDataPtr( const uint16_t p_start, const uint8_t**  p_buff, uint16_t* const p_len ) const;
+        virtual void getDataPtr( const uint16_t p_start, const uint8_t**  p_buff, uint16_t* const p_len ) const;
 };
 
 /* Forward declare this as XBeeDevice is dependent upon XBeeApiFrameDecoder */

--- a/Base/XBeeDevice.hpp	Fri Jan 31 23:53:16 2014 +0000
+++ b/Base/XBeeDevice.hpp	Sat Feb 01 00:04:42 2014 +0000
@@ -104,6 +104,12 @@
          XBEEDEVICE_WRONG_MODE        = 4,
      } XBeeDeviceReturn_t;
    
+     /** Represents the different types of addressing for XBee devices */
+     typedef enum {
+         XBEE_API_ADDR_TYPE_16BIT = 0,
+         XBEE_API_ADDR_TYPE_64BIT = 1    
+     } XBeeApiAddrType_t;
+
      /** Constructor.  Parameters are used to specify the particulars of the connection to the XBee
      
          @param p_tx Serial interface TX pin

--- a/RXTX/XBeeApiTxFrame.cpp	Fri Jan 31 23:53:16 2014 +0000
+++ b/RXTX/XBeeApiTxFrame.cpp	Sat Feb 01 00:04:42 2014 +0000
@@ -21,14 +21,16 @@
 #define BROADCAST_ADDR (0xFFFFU)
 
 XBeeApiTxFrame::XBeeApiTxFrame( XBeeDevice* p_device ) : XBeeApiFrame(), XBeeApiFrameDecoder(),
-                                                         m_addr( BROADCAST_ADDR ), m_ack( true ), m_panBroadcast( false )
+                                                         m_addr( BROADCAST_ADDR ), 
+                                                         m_ack( true ), 
+                                                         m_panBroadcast( false )
 {
     if( p_device != NULL )
     {
         p_device->registerDecoder( this );
     }
     
-    m_apiId = XBEE_CMD_TX_64B_ADDR;
+    m_apiId = XBEE_CMD_TX_16B_ADDR;
     m_buffer[0] = 1; // Frame ID
     m_buffer[1] = 0; // 64-bit add
     m_buffer[2] = 0;
@@ -43,6 +45,29 @@
     m_data = m_buffer;
     m_dataLen = sizeof( m_buffer );
 }
+
+
+XBeeApiTxFrame::~XBeeApiTxFrame( void ) 
+{
+}
+
+void XBeeApiTxFrame::getDataPtr( const uint16_t p_start, const uint8_t**  p_buff, uint16_t* const p_len ) const
+{
+    /* TODO */
+}
+
+
+void XBeeApiTxFrame::setDestAddrType( const XBeeDevice::XBeeApiAddrType_t p_type )
+{
+    if( p_type == XBeeDevice::XBEE_API_ADDR_TYPE_16BIT )
+    {
+        m_apiId = XBEE_CMD_TX_16B_ADDR;
+    } 
+    else 
+    {
+        m_apiId = XBEE_CMD_TX_64B_ADDR;        
+    }
+}
        
 void XBeeApiTxFrame::setDestAddr( uint64_t p_addr )
 {

--- a/RXTX/XBeeApiTxFrame.hpp	Fri Jan 31 23:53:16 2014 +0000
+++ b/RXTX/XBeeApiTxFrame.hpp	Sat Feb 01 00:04:42 2014 +0000
@@ -1,6 +1,6 @@
 /**
    @file
-   @brief Class to support transmission of data to a 64bit address
+   @brief Class to support transmission of data via the XBee's wireless
       
    @author John Bailey 
 
@@ -33,19 +33,22 @@
 class XBeeApiTxFrame : public XBeeApiFrame, public XBeeApiFrameDecoder
 {
     protected:
-       uint64_t m_addr;
-       bool     m_ack;
-       bool     m_panBroadcast;
-       uint8_t  m_buffer[11];
+       uint64_t          m_addr;
+       bool              m_ack;
+       bool              m_panBroadcast;
+       uint8_t           m_buffer[11];
     public:
        XBeeApiTxFrame( XBeeDevice* p_device = NULL );
-       virtual ~XBeeApiTxFrame( void ) {};
+       virtual ~XBeeApiTxFrame( void );
        
+       void setDestAddrType( const XBeeDevice::XBeeApiAddrType_t p_type );
        void setDestAddr( uint64_t p_addr );
        void setDestAddrBroadcast( void );
        void setPanBroadcast( const bool p_bc );
        
        virtual bool decodeCallback( const uint8_t* const p_data, size_t p_len );
+       virtual void getDataPtr( const uint16_t p_start, const uint8_t**  p_buff, uint16_t* const p_len ) const;
+
 };
 
 #endif
\ No newline at end of file