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.cpp@16:8095c43a2a6e, 2014-02-04 (annotated)

Committer:
johnb
Date:
Tue Feb 04 23:52:50 2014 +0000
Revision:
16:8095c43a2a6e
Child:
19:85e5bad7f5a9
Flesh out XBeeApiTXFrame and add XBeeApiTxFrameEx

Who changed what in which revision?

UserRevisionLine numberNew contents of line
johnb 16:8095c43a2a6e 1 /**
johnb 16:8095c43a2a6e 2
johnb 16:8095c43a2a6e 3 Copyright 2014 John Bailey
johnb 16:8095c43a2a6e 4
johnb 16:8095c43a2a6e 5 Licensed under the Apache License, Version 2.0 (the "License");
johnb 16:8095c43a2a6e 6 you may not use this file except in compliance with the License.
johnb 16:8095c43a2a6e 7 You may obtain a copy of the License at
johnb 16:8095c43a2a6e 8
johnb 16:8095c43a2a6e 9 http://www.apache.org/licenses/LICENSE-2.0
johnb 16:8095c43a2a6e 10
johnb 16:8095c43a2a6e 11 Unless required by applicable law or agreed to in writing, software
johnb 16:8095c43a2a6e 12 distributed under the License is distributed on an "AS IS" BASIS,
johnb 16:8095c43a2a6e 13 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
johnb 16:8095c43a2a6e 14 See the License for the specific language governing permissions and
johnb 16:8095c43a2a6e 15 limitations under the License.
johnb 16:8095c43a2a6e 16
johnb 16:8095c43a2a6e 17 */
johnb 16:8095c43a2a6e 18
johnb 16:8095c43a2a6e 19 #include "XBeeApiTxFrameEx.hpp"
johnb 16:8095c43a2a6e 20
johnb 16:8095c43a2a6e 21 XBeeApiTxFrameEx::XBeeApiTxFrameEx( XBeeDevice* p_device ) : XBeeApiTxFrame( p_device )
johnb 16:8095c43a2a6e 22 {
johnb 16:8095c43a2a6e 23 uint16_t i;
johnb 16:8095c43a2a6e 24
johnb 16:8095c43a2a6e 25 for( i = 0; i < XBEE_API_TX_STATUS_LAST; ++i )
johnb 16:8095c43a2a6e 26 {
johnb 16:8095c43a2a6e 27 m_statusCounters[ i ] = 0;
johnb 16:8095c43a2a6e 28 }
johnb 16:8095c43a2a6e 29 }
johnb 16:8095c43a2a6e 30
johnb 16:8095c43a2a6e 31
johnb 16:8095c43a2a6e 32 XBeeApiTxFrameEx::~XBeeApiTxFrameEx()
johnb 16:8095c43a2a6e 33 {
johnb 16:8095c43a2a6e 34 }
johnb 16:8095c43a2a6e 35
johnb 16:8095c43a2a6e 36 void XBeeApiTxFrameEx::frameTxCallback( const XBeeApiTxStatus_e p_status )
johnb 16:8095c43a2a6e 37 {
johnb 16:8095c43a2a6e 38 XBeeApiTxFrame::frameTxCallback( p_status );
johnb 16:8095c43a2a6e 39
johnb 16:8095c43a2a6e 40 if( p_status < XBEE_API_TX_STATUS_LAST )
johnb 16:8095c43a2a6e 41 {
johnb 16:8095c43a2a6e 42 m_statusCounters[ p_status ]++;
johnb 16:8095c43a2a6e 43 }
johnb 16:8095c43a2a6e 44 }
johnb 16:8095c43a2a6e 45
johnb 16:8095c43a2a6e 46 uint16_t XBeeApiTxFrameEx::getStatusCount( const XBeeApiTxStatus_e p_status )
johnb 16:8095c43a2a6e 47 {
johnb 16:8095c43a2a6e 48 uint16_t ret_val = 0;
johnb 16:8095c43a2a6e 49
johnb 16:8095c43a2a6e 50 if( p_status < XBEE_API_TX_STATUS_LAST )
johnb 16:8095c43a2a6e 51 {
johnb 16:8095c43a2a6e 52 ret_val = m_statusCounters[ p_status ];
johnb 16:8095c43a2a6e 53 }
johnb 16:8095c43a2a6e 54
johnb 16:8095c43a2a6e 55 return ret_val;
johnb 16:8095c43a2a6e 56 }