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:
11:bfcf1356027b
Parent:
8:1b48b619d7f6
Child:
13:302e7c1ea0b3
diff -r 0d084d0253a7 -r bfcf1356027b Utility/XBeeApiCmdAt.hpp
--- a/Utility/XBeeApiCmdAt.hpp	Fri Jan 31 09:29:28 2014 +0000
+++ b/Utility/XBeeApiCmdAt.hpp	Fri Jan 31 23:53:16 2014 +0000
@@ -99,23 +99,6 @@
         uint16_t m_timeout;
         uint16_t m_slice;
 
-       /* The following are "shadow" methods which allow access to the methods in the base class
-          which we're overriding.  We need these as we need to be able to pass a method pointer
-          (e.g. to getHardwareVersion() ) and there's no way to get a method pointer to the parent 
-          class implementation as opposed to the implementation in this class.  The joys of 
-          polymorphism.
-          
-          e.g. We pass a pointer to method getHardwareVersion().  The function receiving the pointer
-               uses it to make a function call.  The actual function that's called is (correctly)
-               the one implemented in this class, however what we actually wanted in this case
-               was to call the implementation in the base class.  Using static_cast<> doesn't have
-               any effect and taking the address of XBeeApiCmdAt::getHardwareVersion ends up with
-               XBeeApiCmdAtBlocking::getHardwareVersion being called due to polymorphism. */
-
-       bool getHardwareVersionS( uint16_t* const p_ver );
-       bool getFirmwareVersionS( uint16_t* const p_ver );
-       bool getChannelS( uint8_t* const p_chan );
-
     public:
        XBeeApiCmdAtBlocking( const uint16_t p_timeout = 1000, const uint16_t p_slice = 100);