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/XBeeApiRxFrameCircularBuffer.cpp@38:291aee9eb900, 2014-04-02 (annotated)

Committer:
johnb
Date:
Wed Apr 02 21:32:25 2014 +0000
Revision:
38:291aee9eb900
Child:
46:a1abbc66f157
Sync from https://github.com/bright-tools/xbeeapi/commit/10fb465f9b314dcf88e007bd3f33af856ab70c8f

Who changed what in which revision?

UserRevisionLine numberNew contents of line
johnb 38:291aee9eb900 1 /**
johnb 38:291aee9eb900 2
johnb 38:291aee9eb900 3 Copyright 2014 John Bailey
johnb 38:291aee9eb900 4
johnb 38:291aee9eb900 5 Licensed under the Apache License, Version 2.0 (the "License");
johnb 38:291aee9eb900 6 you may not use this file except in compliance with the License.
johnb 38:291aee9eb900 7 You may obtain a copy of the License at
johnb 38:291aee9eb900 8
johnb 38:291aee9eb900 9 http://www.apache.org/licenses/LICENSE-2.0
johnb 38:291aee9eb900 10
johnb 38:291aee9eb900 11 Unless required by applicable law or agreed to in writing, software
johnb 38:291aee9eb900 12 distributed under the License is distributed on an "AS IS" BASIS,
johnb 38:291aee9eb900 13 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
johnb 38:291aee9eb900 14 See the License for the specific language governing permissions and
johnb 38:291aee9eb900 15 limitations under the License.
johnb 38:291aee9eb900 16
johnb 38:291aee9eb900 17 */
johnb 38:291aee9eb900 18
johnb 38:291aee9eb900 19 #include "XBeeApiRxFrameCircularBuffer.hpp"
johnb 38:291aee9eb900 20
johnb 38:291aee9eb900 21 XBeeApiRxFrameCircularBuffer::XBeeApiRxFrameCircularBuffer( size_t p_bufferSize, XBeeDevice* p_device ) : XBeeApiRxFrameDecoder( p_device ),
johnb 38:291aee9eb900 22 m_bufferSize( p_bufferSize ),
johnb 38:291aee9eb900 23 m_head( 0 ),
johnb 38:291aee9eb900 24 m_tail( 0 ),
johnb 38:291aee9eb900 25 m_count( 0 )
johnb 38:291aee9eb900 26 {
johnb 38:291aee9eb900 27 m_framesBuffer = new( XBeeApiRxFrame[ m_bufferSize ] );
johnb 38:291aee9eb900 28 }
johnb 38:291aee9eb900 29
johnb 38:291aee9eb900 30 XBeeApiRxFrameCircularBuffer::~XBeeApiRxFrameCircularBuffer( void )
johnb 38:291aee9eb900 31 {
johnb 38:291aee9eb900 32 }
johnb 38:291aee9eb900 33
johnb 38:291aee9eb900 34 void XBeeApiRxFrameCircularBuffer::frameRxCallback( const XBeeApiRxFrame* const p_frame )
johnb 38:291aee9eb900 35 {
johnb 38:291aee9eb900 36 if( m_count < m_bufferSize )
johnb 38:291aee9eb900 37 {
johnb 38:291aee9eb900 38 size_t insertPoint = m_head;
johnb 38:291aee9eb900 39 m_count++;
johnb 38:291aee9eb900 40 m_head = (m_head + 1) % m_bufferSize;
johnb 38:291aee9eb900 41 m_framesBuffer[ insertPoint ].deepCopyFrom( *p_frame );
johnb 38:291aee9eb900 42 }
johnb 38:291aee9eb900 43 }
johnb 38:291aee9eb900 44
johnb 38:291aee9eb900 45 size_t XBeeApiRxFrameCircularBuffer::getFrameCount() const
johnb 38:291aee9eb900 46 {
johnb 38:291aee9eb900 47 return( m_count );
johnb 38:291aee9eb900 48 }
johnb 38:291aee9eb900 49
johnb 38:291aee9eb900 50 void XBeeApiRxFrameCircularBuffer::clear()
johnb 38:291aee9eb900 51 {
johnb 38:291aee9eb900 52 m_count = 0;
johnb 38:291aee9eb900 53 }
johnb 38:291aee9eb900 54
johnb 38:291aee9eb900 55 void XBeeApiRxFrameCircularBuffer::pop()
johnb 38:291aee9eb900 56 {
johnb 38:291aee9eb900 57 if( m_count )
johnb 38:291aee9eb900 58 {
johnb 38:291aee9eb900 59 m_tail = (m_tail + 1) % m_bufferSize;
johnb 38:291aee9eb900 60 m_count--;
johnb 38:291aee9eb900 61 }
johnb 38:291aee9eb900 62 }
johnb 38:291aee9eb900 63
johnb 38:291aee9eb900 64 const XBeeApiRxFrame* XBeeApiRxFrameCircularBuffer::getTailPtr( void ) const
johnb 38:291aee9eb900 65 {
johnb 38:291aee9eb900 66 XBeeApiRxFrame* ret_val = NULL;
johnb 38:291aee9eb900 67 if( m_count )
johnb 38:291aee9eb900 68 {
johnb 38:291aee9eb900 69 ret_val = &( m_framesBuffer[ m_tail ] );
johnb 38:291aee9eb900 70 }
johnb 38:291aee9eb900 71 return ret_val;
johnb 38:291aee9eb900 72 }