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

Revision Date Message Actions
51:a7d0d2ef9261 2014-07-28 Additional infrastructure for AT & remote AT commands. File  Diff  Annotate
49:37bba77ee73f 2014-07-07 Add sanity check to RX'd message length File  Diff  Annotate
48:48397bedf95d 2014-07-07 Add checksum verification on the received frames and the ability to turn it on/off. File  Diff  Annotate
43:975a28e01dac 2014-07-06 Update logic of return for setupDispatchTask() to be in line with other methods File  Diff  Annotate
42:81c789ba4c08 2014-07-06 Changes to support working with mbed-rtos; Use a dispatcher thread to deal with data received from the serial port rather than doing it in the interrupt. Not only is this poor practice, it seems that when using mbed-rtos there's less interrupt stack File  Diff  Annotate
41:07cb97b44e81 2014-07-05 Change from Serial to RawSerial so that the library is RTOS friendly. File  Diff  Annotate
40:b96e8cad93d3 2014-07-05 Fix comma/semi-colon typo in serial interface setup File  Diff  Annotate
33:eccf4725930c 2014-03-25 New constructor to allow Serial object to be passed rather than instantiated by the XBeeDevice 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
16:8095c43a2a6e 2014-02-04 Flesh out XBeeApiTXFrame and add XBeeApiTxFrameEx File  Diff  Annotate
10:0d084d0253a7 2014-01-31 Update getDataPtr() to support fragmented buffers File  Diff  Annotate
8:1b48b619d7f6 2014-01-31 Work-in-progress commit. Add blocking version of XBeeApiCmdAt File  Diff  Annotate
7:2f1e157cdd1c 2014-01-30 Tidy up & overhaul to receive routine to be more robust File  Diff  Annotate
6:3cb62daace78 2014-01-29 Document API File  Diff  Annotate
5:b40a6fd3a334 2014-01-29 Documentation update File  Diff  Annotate
3:c3d96b94041a 2014-01-27 Documentation & misc changes File  Diff  Annotate