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/XBeeApiRxFrame.hpp@56:7fe74b03e6b1, 2014-08-08 (annotated)

Committer:
johnb
Date:
Fri Aug 08 11:59:52 2014 +0000
Revision:
56:7fe74b03e6b1
Parent:
53:7b65422d7a32 
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 21:09ddf12a65ed 1 /**
johnb 21:09ddf12a65ed 2 @file
johnb 21:09ddf12a65ed 3 @brief Class to support reception of data via the XBee's wireless
johnb 21:09ddf12a65ed 4
johnb 21:09ddf12a65ed 5 @author John Bailey
johnb 21:09ddf12a65ed 6
johnb 21:09ddf12a65ed 7 @copyright Copyright 2014 John Bailey
johnb 21:09ddf12a65ed 8
johnb 21:09ddf12a65ed 9 @section LICENSE
johnb 21:09ddf12a65ed 10
johnb 21:09ddf12a65ed 11 Licensed under the Apache License, Version 2.0 (the "License");
johnb 21:09ddf12a65ed 12 you may not use this file except in compliance with the License.
johnb 21:09ddf12a65ed 13 You may obtain a copy of the License at
johnb 21:09ddf12a65ed 14
johnb 21:09ddf12a65ed 15 http://www.apache.org/licenses/LICENSE-2.0
johnb 21:09ddf12a65ed 16
johnb 21:09ddf12a65ed 17 Unless required by applicable law or agreed to in writing, software
johnb 21:09ddf12a65ed 18 distributed under the License is distributed on an "AS IS" BASIS,
johnb 21:09ddf12a65ed 19 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
johnb 21:09ddf12a65ed 20 See the License for the specific language governing permissions and
johnb 21:09ddf12a65ed 21 limitations under the License.
johnb 21:09ddf12a65ed 22
johnb 21:09ddf12a65ed 23 */
johnb 21:09ddf12a65ed 24
johnb 21:09ddf12a65ed 25 #if !defined XBEEAPIRXFRAME_HPP
johnb 21:09ddf12a65ed 26 #define XBEEAPIRXFRAME_HPP
johnb 21:09ddf12a65ed 27
johnb 21:09ddf12a65ed 28 #include "XBeeApiFrame.hpp"
johnb 21:09ddf12a65ed 29 #include "XBeeDevice.hpp"
johnb 21:09ddf12a65ed 30
johnb 21:09ddf12a65ed 31 #include <stdint.h>
johnb 21:09ddf12a65ed 32
johnb 27:6356ef5fe39b 33 /** Class to represent a frame of data being received by the XBee.
johnb 27:6356ef5fe39b 34
johnb 27:6356ef5fe39b 35 The message data content is accessed via the inherited m_data
johnb 27:6356ef5fe39b 36 and m_dataLen members
johnb 27:6356ef5fe39b 37 */
johnb 38:291aee9eb900 38 class XBeeApiRxFrame : public XBeeApiFrame
johnb 21:09ddf12a65ed 39 {
johnb 21:09ddf12a65ed 40 protected:
johnb 27:6356ef5fe39b 41 /** The source address of the packet */
johnb 27:6356ef5fe39b 42 uint64_t m_addr;
johnb 27:6356ef5fe39b 43
johnb 27:6356ef5fe39b 44 /** Indicate whether or not the address in m_addr is 16- or 64-bit */
johnb 27:6356ef5fe39b 45 bool m_addrIs16bit;
johnb 27:6356ef5fe39b 46
johnb 27:6356ef5fe39b 47 /** The Received Signal Strength Indicator (RSSI) associated with the
johnb 27:6356ef5fe39b 48 message, in -dBm. i.e. m_rssi == 40 indicates -40dBm */
johnb 27:6356ef5fe39b 49 uint8_t m_rssi;
johnb 27:6356ef5fe39b 50
johnb 27:6356ef5fe39b 51 /** Indicate whether or not the message was address broadcast */
johnb 27:6356ef5fe39b 52 bool m_addressBroadcast;
johnb 27:6356ef5fe39b 53
johnb 27:6356ef5fe39b 54 /** Indicate whether or not the message was PAN broadcase */
johnb 27:6356ef5fe39b 55 bool m_panBroadcast;
johnb 38:291aee9eb900 56
johnb 53:7b65422d7a32 57 /* TODO: doc */
johnb 38:291aee9eb900 58 bool m_dataIsMallocd;
johnb 22:2e5aff1149a2 59
johnb 53:7b65422d7a32 60 /* TODO: doc */
johnb 38:291aee9eb900 61 uint8_t* m_mallocdData;
johnb 21:09ddf12a65ed 62 public:
johnb 27:6356ef5fe39b 63 /** Constructor */
johnb 38:291aee9eb900 64 XBeeApiRxFrame();
johnb 35:0f8910a023a3 65
johnb 53:7b65422d7a32 66 /* TODO: doc */
johnb 53:7b65422d7a32 67 /** Constructor */
johnb 38:291aee9eb900 68 XBeeApiRxFrame( XBeeApiIdentifier_e p_id,
johnb 38:291aee9eb900 69 const uint8_t* const p_data,
johnb 38:291aee9eb900 70 const size_t p_dataLen );
johnb 38:291aee9eb900 71
johnb 53:7b65422d7a32 72 /** Deep copy */
johnb 53:7b65422d7a32 73 /* TODO: doc */
johnb 38:291aee9eb900 74 bool deepCopyFrom( const XBeeApiRxFrame& p_frame );
johnb 38:291aee9eb900 75
johnb 27:6356ef5fe39b 76 /** Destructor */
johnb 27:6356ef5fe39b 77 virtual ~XBeeApiRxFrame( void );
johnb 21:09ddf12a65ed 78 };
johnb 21:09ddf12a65ed 79
johnb 21:09ddf12a65ed 80 #endif