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.

Revisions of Utility/XBeeApiCmdAt.cpp

Revision Date Message Actions
52:0950b05d5270 2014-07-28 Add initial support for decoding IO frames. File  Diff  Annotate
51:a7d0d2ef9261 2014-07-28 Additional infrastructure for AT & remote AT commands. File  Diff  Annotate
50:f76b7e7959a2 2014-07-13 Add support for Remote AT commands File  Diff  Annotate
36:cc7e8d1e35dd 2014-03-28 Add missing cast & fix issue with endianism during copy File  Diff  Annotate
32:af4e495afd62 2014-02-07 Add methods to access more XBee parameters. File  Diff  Annotate
31:c144106e55b5 2014-02-06 Add method to set XBee's source address; Macro-ise XBeeApiCmdAt's method generation; Fix bug with timeout on XBeeApiCmdAtBlocking's get/set methods File  Diff  Annotate
30:9532b01a1ae1 2014-02-06 Tidy up File  Diff  Annotate
29:c6d037cceb02 2014-02-06 Infrastructure for supporting different XBee models; Change XBeeApiCmdAt constructor to allown an XBeeDevice to be passed File  Diff  Annotate
25:db6874b7ac4b 2014-02-05 Add XBeeApiCmdAtSet to replace various classes in XBeeApiCmdAt File  Diff  Annotate
24:2cd1094c4fd7 2014-02-05 Remove various classes from XBeeApiCmdAt and extend XBeeApiFrame to allow initialisation of the members so that this class can perform the same task as was previously occupying >3 classes. File  Diff  Annotate
14:edec6cd78ffb 2014-02-03 Fix problems with blocking API File  Diff  Annotate
13:302e7c1ea0b3 2014-02-03 Add implementation for xbeeSetNetworkTypeP2P() and the AT cmds to support it. File  Diff  Annotate
11:bfcf1356027b 2014-01-31 Switch to using macros to implement the access functions in XBeeApiCmdAtBlocking.; Implement XBeeApiCmdAtBlocking::setChannel() File  Diff  Annotate
8:1b48b619d7f6 2014-01-31 Work-in-progress commit. Add blocking version of XBeeApiCmdAt File  Diff  Annotate
6:3cb62daace78 2014-01-29 Document API File  Diff  Annotate
5:b40a6fd3a334 2014-01-29 Documentation update File  Diff  Annotate