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.

RXTX/XBeeApiTxFrameEx.hpp@56:7fe74b03e6b1, 2014-08-08 (annotated)

Committer:
johnb
Date:
Fri Aug 08 11:59:52 2014 +0000
Revision:
56:7fe74b03e6b1
Parent:
19:85e5bad7f5a9 
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 16:8095c43a2a6e 1 /**
johnb 16:8095c43a2a6e 2 @file
johnb 16:8095c43a2a6e 3 @brief Class inheriting from XBeeApiTxFrame with some useful but
johnb 16:8095c43a2a6e 4 non-essential function.
johnb 16:8095c43a2a6e 5
johnb 16:8095c43a2a6e 6 @author John Bailey
johnb 16:8095c43a2a6e 7
johnb 16:8095c43a2a6e 8 @copyright Copyright 2014 John Bailey
johnb 16:8095c43a2a6e 9
johnb 16:8095c43a2a6e 10 @section LICENSE
johnb 16:8095c43a2a6e 11
johnb 16:8095c43a2a6e 12 Licensed under the Apache License, Version 2.0 (the "License");
johnb 16:8095c43a2a6e 13 you may not use this file except in compliance with the License.
johnb 16:8095c43a2a6e 14 You may obtain a copy of the License at
johnb 16:8095c43a2a6e 15
johnb 16:8095c43a2a6e 16 http://www.apache.org/licenses/LICENSE-2.0
johnb 16:8095c43a2a6e 17
johnb 16:8095c43a2a6e 18 Unless required by applicable law or agreed to in writing, software
johnb 16:8095c43a2a6e 19 distributed under the License is distributed on an "AS IS" BASIS,
johnb 16:8095c43a2a6e 20 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
johnb 16:8095c43a2a6e 21 See the License for the specific language governing permissions and
johnb 16:8095c43a2a6e 22 limitations under the License.
johnb 16:8095c43a2a6e 23
johnb 16:8095c43a2a6e 24 */
johnb 16:8095c43a2a6e 25
johnb 16:8095c43a2a6e 26 #if !defined XBEEAPITXFRAMEEX_HPP
johnb 16:8095c43a2a6e 27 #define XBEEAPITXFRAMEEX_HPP
johnb 16:8095c43a2a6e 28
johnb 16:8095c43a2a6e 29 #include "XBeeApiTxFrame.hpp"
johnb 16:8095c43a2a6e 30
johnb 16:8095c43a2a6e 31 #include <stdint.h>
johnb 16:8095c43a2a6e 32
johnb 17:023e5355d4c5 33 /** Class which extends XBeeApiTxFrame with a number of additional useful
johnb 17:023e5355d4c5 34 features. These features are partitioned within this sub-class so
johnb 17:023e5355d4c5 35 that other classes can inherit from XBeeApiTxFrame without also aquiring
johnb 17:023e5355d4c5 36 this "baggage".
johnb 17:023e5355d4c5 37 */
johnb 16:8095c43a2a6e 38 class XBeeApiTxFrameEx : public XBeeApiTxFrame
johnb 16:8095c43a2a6e 39 {
johnb 16:8095c43a2a6e 40 protected:
johnb 17:023e5355d4c5 41 /** Keep stats on the various TX confirmations received from the XBee */
johnb 16:8095c43a2a6e 42 uint16_t m_statusCounters[ XBeeApiTxFrame::XBEE_API_TX_STATUS_LAST ];
johnb 16:8095c43a2a6e 43
johnb 19:85e5bad7f5a9 44 /** Status of the most recent TX confirmation */
johnb 19:85e5bad7f5a9 45 XBeeApiTxStatus_e m_recent;
johnb 19:85e5bad7f5a9 46
johnb 16:8095c43a2a6e 47 public:
johnb 17:023e5355d4c5 48 /** Constuctor - see XBeeApiTxFrame constructor */
johnb 16:8095c43a2a6e 49 XBeeApiTxFrameEx( XBeeDevice* p_device = NULL );
johnb 17:023e5355d4c5 50
johnb 17:023e5355d4c5 51 /** Destructor */
johnb 16:8095c43a2a6e 52 virtual ~XBeeApiTxFrameEx();
johnb 17:023e5355d4c5 53
johnb 17:023e5355d4c5 54 /** Callback which is invoked when a response to a TX frame is received.
johnb 17:023e5355d4c5 55 The implementation in this class simply updates m_statusCounters to
johnb 17:023e5355d4c5 56 keep stats on the result of the TX attempts
johnb 17:023e5355d4c5 57
johnb 17:023e5355d4c5 58 \param p_status The status of the TX attempt */
johnb 16:8095c43a2a6e 59 virtual void frameTxCallback( const XBeeApiTxStatus_e p_status );
johnb 17:023e5355d4c5 60
johnb 17:023e5355d4c5 61 /** Method to retrieve the number of TX attempts which have had the
johnb 17:023e5355d4c5 62 specified status result. Simply an accessor to m_statusCounters.
johnb 17:023e5355d4c5 63
johnb 17:023e5355d4c5 64 \param p_status Status to look-up
johnb 17:023e5355d4c5 65 */
johnb 16:8095c43a2a6e 66 uint16_t getStatusCount( const XBeeApiTxStatus_e p_status );
johnb 19:85e5bad7f5a9 67
johnb 19:85e5bad7f5a9 68 /** Return the most recent status, as informed to the object by a
johnb 19:85e5bad7f5a9 69 frameTxCallback invokation.
johnb 19:85e5bad7f5a9 70
johnb 19:85e5bad7f5a9 71 \returns Most recent TX status. Will return
johnb 19:85e5bad7f5a9 72 XBeeApiTxFrame::XBEE_API_TX_STATUS_LAST in the case that
johnb 19:85e5bad7f5a9 73 there have not been any callbacks yet. */
johnb 19:85e5bad7f5a9 74 XBeeApiTxFrame::XBeeApiTxStatus_e getMostRecentStatus( void ) const;
johnb 16:8095c43a2a6e 75 };
johnb 16:8095c43a2a6e 76
johnb 16:8095c43a2a6e 77 #endif