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@45:dde04adb8791, 2014-07-06 (annotated)

Committer:
johnb
Date:
Sun Jul 06 21:47:31 2014 +0000
Revision:
45:dde04adb8791
Child:
46:a1abbc66f157
Re-add changes which where committed in http://mbed.org/users/johnb/code/XBeeApi/rev/291aee9eb900 - unsure as to why they don't still seem to be present.

Who changed what in which revision?

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