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: Utility/XBeeApiCmdAt.hpp

Revision:
31:c144106e55b5
Parent:
29:c6d037cceb02
Child:
32:af4e495afd62
diff -r 9532b01a1ae1 -r c144106e55b5 Utility/XBeeApiCmdAt.hpp
--- a/Utility/XBeeApiCmdAt.hpp	Thu Feb 06 21:26:48 2014 +0000
+++ b/Utility/XBeeApiCmdAt.hpp	Thu Feb 06 22:26:27 2014 +0000
@@ -58,17 +58,18 @@
     
     protected:
         /** Indicates whether or not m_hwVer contains data retrieved from the XBee */
-        bool m_haveHwVer;
+        bool m_have_hwVer;
         /** Indicates whether or not m_fwVer contains data retrieved from the XBee */
-        bool m_haveFwVer;
+        bool m_have_fwVer;
         /** Indicates whether or not m_chan contains data retrieved from the XBee */
-        bool m_haveChan;
+        bool m_have_chan;
         /** Indicates whether or not m_PANId contains data retrieved from the XBee */
-        bool m_havePANId;
+        bool m_have_PANId;
         /** Indicates whether or not m_EDA contains data retrieved from the XBee */
-        bool m_haveEDA;
+        bool m_have_EDA;
         /** Indicates whether or not m_CE contains data retrieved from the XBee */
-        bool m_haveCE;
+        bool m_have_CE;
+        bool m_have_sourceAddress;
         
         uint16_t m_hwVer;
         uint16_t m_fwVer;
@@ -80,6 +81,8 @@
         bool m_EDAPend;
         bool m_CE;
         bool m_CEPend;
+        uint16_t m_sourceAddress;
+        uint16_t m_sourceAddressPend;
 
         /** 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
@@ -126,6 +129,7 @@
         bool requestCoordinatorEnabled( void );
         bool requestEndDeviceAssociationEnabled( void );
         bool requestPanId( void );
+        bool requestSourceAddress( void );
 
         /** Read the XBee's hardware version identifier.  
        
@@ -152,6 +156,10 @@
        
        virtual bool getPanId( panId_t* const p_id );       
        virtual bool setPanId( const panId_t p_id );       
+
+       virtual bool getSourceAddress( uint16_t* const p_addr );       
+       virtual bool setSourceAddress( const uint16_t p_addr );       
+
 };
 
 /** Class to access the configuration interface of the XBee.
@@ -209,6 +217,9 @@
        
        virtual bool getPanId( panId_t* const p_id );       
        virtual bool setPanId( const panId_t p_id );
+
+       virtual bool getSourceAddress( uint16_t* const p_addr );       
+       virtual bool setSourceAddress( const uint16_t p_addr );       
 };
 
 #endif
\ No newline at end of file