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 29:c6d037cceb02, committed 2014-02-06

Comitter:
johnb
Date:
Thu Feb 06 21:25:17 2014 +0000
Parent:
28:e22f61badee3
Child:
30:9532b01a1ae1
Commit message:
Infrastructure for supporting different XBee models; Change XBeeApiCmdAt constructor to allown an XBeeDevice to be passed

Changed in this revision

Base/XBeeDevice.cpp 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
Utility/XBeeApiCmdAt.cpp Show annotated file Show diff for this revision Revisions of this file
Utility/XBeeApiCmdAt.hpp Show annotated file Show diff for this revision Revisions of this file 
--- a/Base/XBeeDevice.cpp	Thu Feb 06 20:40:33 2014 +0000
+++ b/Base/XBeeDevice.cpp	Thu Feb 06 21:25:17 2014 +0000
@@ -39,7 +39,7 @@
 /** ASCII command to the XBee to request that it exit command mode */
 const char exit_cmd_mode_cmd[] = { 'A', 'T', 'C', 'N', '\r' };
 
-XBeeDevice::XBeeDevice( PinName p_tx, PinName p_rx, PinName p_rts, PinName p_cts ): m_if( p_tx, p_rx )
+XBeeDevice::XBeeDevice( PinName p_tx, PinName p_rx, PinName p_rts, PinName p_cts ): m_model( XBeeDevice::XBEEDEVICE_S1 ), m_if( p_tx, p_rx )
 {
     m_escape = true;
     m_inAtCmdMode = false;
@@ -65,6 +65,16 @@
     }
 }
 
+XBeeDevice::XBeeDeviceModel_t XBeeDevice::getXBeeModel() const
+{
+    return m_model;
+}
+     
+void XBeeDevice::setXBeeModel( const XBeeDevice::XBeeDeviceModel_t p_model )
+{
+    m_model = p_model;
+}
+
 void XBeeDevice::if_rx( void )
 {
     /* Keep going while there are bytes to be read */

--- a/Base/XBeeDevice.hpp	Thu Feb 06 20:40:33 2014 +0000
+++ b/Base/XBeeDevice.hpp	Thu Feb 06 21:25:17 2014 +0000
@@ -45,6 +45,15 @@
          a message is received */
 class XBeeDevice
 {
+   public:
+     /** Represent the different XBee models */
+     typedef enum {
+         /* XBee S1 (aka XBee 802.15.4) - see http://www.digi.com/products/wireless-wired-embedded-solutions/zigbee-rf-modules/point-multipoint-rfmodules/xbee-series1-module */
+         XBEEDEVICE_S1,
+         /* XBee S1 Pro (aka XBee 802.15.4 Pro) */
+         XBEEDEVICE_S1_PRO
+     } XBeeDeviceModel_t;
+
    private:
  
 #if defined  XBEEAPI_CONFIG_USING_RTOS
@@ -52,6 +61,9 @@
      rtos::Mutex  m_ifMutex;
 #endif
    
+     /** The model of XBee that this XBeeDevice is associated with */
+     XBeeDeviceModel_t m_model;
+   
      /** Track whether the XBee is in CMD mode or API mode */
      bool m_inAtCmdMode;
    
@@ -112,6 +124,9 @@
 
      /** Constructor.  Parameters are used to specify the particulars of the connection to the XBee
      
+         Objects using this constructor will default to be associated with an XBee S1 (see XBeeDeviceModel_t).  
+         This should be altered via setXBeeModel() if required
+     
          @param p_tx Serial interface TX pin
          @param p_rx Serial interface RX pin
          @param p_rts Pin to use for RTS (flow control).  Will only be used if supported.  Can specify NC to disable.
@@ -119,8 +134,15 @@
      */
      XBeeDevice( PinName p_tx, PinName p_rx, PinName p_rts, PinName p_cts );  
 
+     /** Destructor */
      virtual ~XBeeDevice( void );  
      
+     /** Determine what type of XBee model this object is associated with */
+     XBeeDeviceModel_t getXBeeModel() const;
+     
+     /** Set the type of XBee model this object is associated with */
+     void setXBeeModel( const XBeeDeviceModel_t p_model );
+     
      /** Transmit the specified frame to the XBee.  This method does not block waiting for a response, but returns and
          expects that any response will be dealt with by an appropriately registered decoder
      

--- a/Utility/XBeeApiCmdAt.cpp	Thu Feb 06 20:40:33 2014 +0000
+++ b/Utility/XBeeApiCmdAt.cpp	Thu Feb 06 21:25:17 2014 +0000
@@ -57,7 +57,8 @@
 
 #define XBEE_CMD_RESPONS_HAS_DATA( _p_len ) ((_p_len > ( XBEE_CMD_POSN_PARAM_START + 1 ))
 
-XBeeApiCmdAt::XBeeApiCmdAt() : XBeeApiFrameDecoder( ) , m_haveHwVer( false ),
+XBeeApiCmdAt::XBeeApiCmdAt( XBeeDevice* const p_device ) : XBeeApiFrameDecoder( p_device ) , 
+    m_haveHwVer( false ),
     m_haveFwVer( false ),
     m_haveChan( false ),
     m_havePANId( false ),
@@ -193,13 +194,31 @@
     return ret_val;
 }
 
+#define XBEE_CHAN_MIN 0x0b
+#define XBEE_CHAN_MAX 0x1a
+
+/* TODO - support XBee Pro */
+#define XBEE_PRO_CHAN_MIN 0x0c
+#define XBEE_PRO_CHAN_MAX 0x17
+
 bool XBeeApiCmdAt::setChannel( uint8_t const p_chan )
 {
-    XBeeApiCmdAtSet<uint8_t> req( cmd_set_ch, p_chan );
-
-    m_chanPend = p_chan;
-    m_device->SendFrame( &req );
-    return true;
+    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 )))
+    {
+        XBeeApiCmdAtSet<uint8_t> req( cmd_set_ch, p_chan );
+    
+        m_chanPend = p_chan;
+        m_device->SendFrame( &req );
+        ret_val = true;
+    }
+    return ret_val;
 }
 
 bool XBeeApiCmdAt::requestHardwareVersion( void )
@@ -329,8 +348,8 @@
 }
 
 
-XBeeApiCmdAtBlocking::XBeeApiCmdAtBlocking( const uint16_t p_timeout, const uint16_t p_slice ) :
-    XBeeApiCmdAt( ),
+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 )
 {

--- a/Utility/XBeeApiCmdAt.hpp	Thu Feb 06 20:40:33 2014 +0000
+++ b/Utility/XBeeApiCmdAt.hpp	Thu Feb 06 21:25:17 2014 +0000
@@ -108,8 +108,10 @@
 
     public:
 
-        /** Constructor */
-        XBeeApiCmdAt( );
+        /** Constructor 
+        
+            \param p_device XBee device with which this object should be associated */
+        XBeeApiCmdAt( XBeeDevice* const p_device = NULL );
        
         /** Destructor */
         virtual ~XBeeApiCmdAt( void ) {};
@@ -176,13 +178,17 @@
     public:
        /** Constructor 
        
+            \param p_device XBee device with which this object should 
+                            be associated 
             \param p_timeout Timeout to be used when waiting for 
                              data from the XBee, specified in
                              milliseconds
             \param p_slice While waiting for data, blocking methods
                            will call the OS wait_ms() function, using
                            the value specified by p_slice */
-       XBeeApiCmdAtBlocking( const uint16_t p_timeout = 1000, const uint16_t p_slice = 100);
+       XBeeApiCmdAtBlocking( XBeeDevice* const p_device = NULL,
+                            const uint16_t p_timeout = 1000, 
+                            const uint16_t p_slice = 100);
        
        /** Destructor */
        virtual ~XBeeApiCmdAtBlocking( void ) {};