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.

Diff: RXTX/XBeeApiTxFrameEx.hpp

Revision:
17:023e5355d4c5
Parent:
16:8095c43a2a6e
Child:
19:85e5bad7f5a9
diff -r 8095c43a2a6e -r 023e5355d4c5 RXTX/XBeeApiTxFrameEx.hpp
--- a/RXTX/XBeeApiTxFrameEx.hpp	Tue Feb 04 23:52:50 2014 +0000
+++ b/RXTX/XBeeApiTxFrameEx.hpp	Wed Feb 05 00:02:31 2014 +0000
@@ -30,15 +30,36 @@
 
 #include <stdint.h>
 
+/** Class which extends XBeeApiTxFrame with a number of additional useful
+    features.  These features are partitioned within this sub-class so
+    that other classes can inherit from XBeeApiTxFrame without also aquiring
+    this "baggage".
+*/
 class XBeeApiTxFrameEx : public XBeeApiTxFrame
 {
     protected:
+        /** Keep stats on the various TX confirmations received from the XBee */
         uint16_t m_statusCounters[ XBeeApiTxFrame::XBEE_API_TX_STATUS_LAST ];
         
     public:
+        /** Constuctor - see XBeeApiTxFrame constructor */
         XBeeApiTxFrameEx( XBeeDevice* p_device = NULL );
+        
+        /** Destructor */
         virtual ~XBeeApiTxFrameEx();
+        
+        /** Callback which is invoked when a response to a TX frame is received.
+            The implementation in this class simply updates m_statusCounters to
+            keep stats on the result of the TX attempts 
+            
+            \param p_status The status of the TX attempt */
         virtual void frameTxCallback( const XBeeApiTxStatus_e p_status );
+        
+        /** Method to retrieve the number of TX attempts which have had the
+            specified status result.  Simply an accessor to m_statusCounters.
+            
+            \param p_status Status to look-up
+        */
         uint16_t getStatusCount( const XBeeApiTxStatus_e p_status );
 };