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: Base/XBeeDevice.hpp

Revision:
33:eccf4725930c
Parent:
29:c6d037cceb02
Child:
41:07cb97b44e81
diff -r af4e495afd62 -r eccf4725930c Base/XBeeDevice.hpp
--- a/Base/XBeeDevice.hpp	Fri Feb 07 21:17:32 2014 +0000
+++ b/Base/XBeeDevice.hpp	Tue Mar 25 18:38:42 2014 +0000
@@ -56,6 +56,9 @@
 
    private:
  
+     /** Common class initialisation, shared between constructors */
+     void init( void );
+ 
 #if defined  XBEEAPI_CONFIG_USING_RTOS
      /** Mutex for accessing the serial interface */
      rtos::Mutex  m_ifMutex;
@@ -72,7 +75,11 @@
      uint16_t m_rxMsgLastWasEsc;
    
      /** Serial interface for the XBee comms */
-     Serial m_if;
+     Serial* m_if;
+     
+     /** Flag to indicate if the Serial object m_if was created by this class and
+         hence needs deleting in the destructor */
+     bool m_serialNeedsDelete;
      
      /** Call-back function from MBED triggered when data is
          received on the XBee's serial interface */
@@ -134,6 +141,17 @@
      */
      XBeeDevice( PinName p_tx, PinName p_rx, PinName p_rts, PinName p_cts );  
 
+     /** 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_serialIf Pointer to the serial interface to be used to communicate with the XBee.
+                           The referenced object must remain valid for as long as the XBeeDevice object is
+                           being used.  Must not be NULL.
+     */
+     XBeeDevice( Serial* p_serialIf );
+
      /** Destructor */
      virtual ~XBeeDevice( void );