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 34:2535760d53a6, committed 2014-03-25

Comitter:
johnb
Date:
Tue Mar 25 22:52:36 2014 +0000
Parent:
33:eccf4725930c
Child:
35:0f8910a023a3
Commit message:
Comment update

Changed in this revision

Base/XBeeApiFrame.hpp Show annotated file Show diff for this revision Revisions of this file
RXTX/XBeeApiRxFrame.cpp Show annotated file Show diff for this revision Revisions of this file 
--- a/Base/XBeeApiFrame.hpp	Tue Mar 25 18:38:42 2014 +0000
+++ b/Base/XBeeApiFrame.hpp	Tue Mar 25 22:52:36 2014 +0000
@@ -169,7 +169,9 @@
                   the data was intended for and was decoded by this class.  Returning true in other cases may result in
                   other decoders being denied the opportunity to examine the data
             
-            \param p_data Pointer to the first byte of the data buffer (i.e. XBEE_CMD_POSN_SDELIM)
+            \param p_data Pointer to the first byte of the data buffer (i.e. XBEE_CMD_POSN_SDELIM).  The implementation
+                          of any over-riding function should not expect that the data referenced by this pointer will
+                          remain valid after the call-back has completed.
             \param p_len  Size of the data pointed to by p_data
             \returns true in the case that the data was examined and decoded successfully
                      false in the case that the data was not of interest or was not decoded successfully

--- a/RXTX/XBeeApiRxFrame.cpp	Tue Mar 25 18:38:42 2014 +0000
+++ b/RXTX/XBeeApiRxFrame.cpp	Tue Mar 25 22:52:36 2014 +0000
@@ -66,11 +66,14 @@
         pos++;
         
         m_data = &( p_data[ pos ] );
+        
         /* -1 to account for the checksum */
         m_dataLen = p_len - pos - 1;
         
         frameRxCallback();
         
+        // TODO: m_data pointing to p_data here, which will be going away ..
+        
         ret_val = true;
     }