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: Remote/XBeeDeviceRemoteAt.hpp

Revision:
53:7b65422d7a32
Parent:
52:0950b05d5270
Child:
55:610aa4a2ed3b
diff -r 0950b05d5270 -r 7b65422d7a32 Remote/XBeeDeviceRemoteAt.hpp
--- a/Remote/XBeeDeviceRemoteAt.hpp	Mon Jul 28 12:48:33 2014 +0000
+++ b/Remote/XBeeDeviceRemoteAt.hpp	Mon Jul 28 13:27:58 2014 +0000
@@ -30,7 +30,10 @@
 #include "XBeeApiFrame.hpp"
 #include "XBeeApiCmdAt.hpp"
 
-/** */
+/** Class used to provide a command interface to a remove XBee via the Remote AT interface.
+    The class inherits from XBeeApiCmdAt, hence the interface for the local and remote
+    XBees is generally the same.
+*/
 class XBeeDeviceRemoteAt : public XBeeApiCmdAt
 {
     protected:
@@ -42,23 +45,32 @@
         */
         virtual bool decodeCallback( const uint8_t* const p_data, size_t p_len );
 
+        /* TODO: doc */
         virtual void SendCmd_uint8_t( const uint8_t        p_frameId,
                                       const uint8_t* const p_data,
                                       const uint8_t&       p_val );
+        /* TODO: doc */
         virtual void SendCmd_uint16_t( const uint8_t        p_frameId,
                                        const uint8_t* const p_data,
                                        const uint16_t&       p_val );
+        /* TODO: doc */
         virtual void SendCmd_uint32_t( const uint8_t        p_frameId,
                                        const uint8_t* const p_data,
                                        const uint32_t&       p_val );
+        /* TODO: doc */
         virtual void SendReq( const uint8_t             p_frameId,
                               const uint8_t*            p_data );
 
+        /* TODO: doc */
         virtual size_t getResponseStatusPos( void ) const;
 
+        /** Keep track of whether we're applying changes when the AT command is sent
+            or not */
         bool     m_applyChanges;
 
     public:
+    
+        /* TODO: doc */
         /** Constructor */
         XBeeDeviceRemoteAt( XBeeDevice* p_device,
                             const uint16_t& p_addr16Bit,
@@ -68,6 +80,13 @@
         /** Destructor */
         virtual ~XBeeDeviceRemoteAt( void ); 
         
+        /** Control whether or not changes are applied when the command is sent or not.
+            There are three possibilities for appling changes on the remote:
+            1) Use this method, specifying a 'true' parameter so that changes are applied as soon as a command is sent
+            2) Use requestApplyChanges() to apply all pending changes
+            3) Use requestWriteSettings() followed by requestReset() to write the settings to non-volatile memory and reset the device
+        
+            \param Specified whether or not the settings should be applied when the command is sent to the remote device */
         void setApplyChanges( const bool p_apply );
 };