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.

Utility/xbeeapi.hpp@56:7fe74b03e6b1, 2014-08-08 (annotated)

Committer:
johnb
Date:
Fri Aug 08 11:59:52 2014 +0000
Revision:
56:7fe74b03e6b1
Parent:
51:a7d0d2ef9261 
Add support for setting up encrypted communications; Re-jig XBeeApiCmdAt virtual functions to make inheritance by XBeeDeviceRemoteAt cleaner.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
johnb 28:e22f61badee3 1 /**
johnb 28:e22f61badee3 2 @file
johnb 28:e22f61badee3 3 @brief XBeeAPI single header - include this to get all of the XBeeApi headers.
johnb 28:e22f61badee3 4
johnb 28:e22f61badee3 5 @author John Bailey
johnb 28:e22f61badee3 6
johnb 28:e22f61badee3 7 @copyright Copyright 2014 John Bailey
johnb 28:e22f61badee3 8
johnb 28:e22f61badee3 9 @section LICENSE
johnb 28:e22f61badee3 10
johnb 28:e22f61badee3 11 Licensed under the Apache License, Version 2.0 (the "License");
johnb 28:e22f61badee3 12 you may not use this file except in compliance with the License.
johnb 28:e22f61badee3 13 You may obtain a copy of the License at
johnb 28:e22f61badee3 14
johnb 28:e22f61badee3 15 http://www.apache.org/licenses/LICENSE-2.0
johnb 28:e22f61badee3 16
johnb 28:e22f61badee3 17 Unless required by applicable law or agreed to in writing, software
johnb 28:e22f61badee3 18 distributed under the License is distributed on an "AS IS" BASIS,
johnb 28:e22f61badee3 19 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
johnb 28:e22f61badee3 20 See the License for the specific language governing permissions and
johnb 28:e22f61badee3 21 limitations under the License.
johnb 28:e22f61badee3 22
johnb 28:e22f61badee3 23 */
johnb 28:e22f61badee3 24
johnb 28:e22f61badee3 25 #if !defined XBEEAPI_HPP
johnb 28:e22f61badee3 26 #define XBEEAPI_HPP
johnb 28:e22f61badee3 27
johnb 23:0e92813b5a50 28 #include "XBeeDevice.hpp"
johnb 23:0e92813b5a50 29 #include "XBeeApiFrame.hpp"
johnb 23:0e92813b5a50 30 #include "XBeeApiRxFrame.hpp"
johnb 38:291aee9eb900 31 #include "XBeeApiRxFrameDecoder.hpp"
johnb 38:291aee9eb900 32 #include "XBeeApiRxFrameCircularBuffer.hpp"
johnb 23:0e92813b5a50 33 #include "XBeeApiTxFrame.hpp"
johnb 23:0e92813b5a50 34 #include "XBeeApiTxFrameEx.hpp"
johnb 23:0e92813b5a50 35 #include "XBeeApiCmdAt.hpp"
johnb 51:a7d0d2ef9261 36 #include "XBeeApiCmdAtBlocking.hpp"
johnb 28:e22f61badee3 37 #include "XBeeApiSetupHelper.hpp"
johnb 45:dde04adb8791 38 #include "XBeeApiRxFrameDecoder.hpp"
johnb 50:f76b7e7959a2 39 #include "XBeeDeviceRemoteAt.hpp"
johnb 28:e22f61badee3 40
johnb 28:e22f61badee3 41 #endif