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.

Base/XBeeApiFrame.cpp@3:c3d96b94041a, 2014-01-27 (annotated)

Committer:
johnb
Date:
Mon Jan 27 21:08:06 2014 +0000
Revision:
3:c3d96b94041a
Documentation & misc changes

Who changed what in which revision?

UserRevisionLine numberNew contents of line
johnb 3:c3d96b94041a 1 /**
johnb 3:c3d96b94041a 2
johnb 3:c3d96b94041a 3 Copyright 2013 John Bailey
johnb 3:c3d96b94041a 4
johnb 3:c3d96b94041a 5 Licensed under the Apache License, Version 2.0 (the "License");
johnb 3:c3d96b94041a 6 you may not use this file except in compliance with the License.
johnb 3:c3d96b94041a 7 You may obtain a copy of the License at
johnb 3:c3d96b94041a 8
johnb 3:c3d96b94041a 9 http://www.apache.org/licenses/LICENSE-2.0
johnb 3:c3d96b94041a 10
johnb 3:c3d96b94041a 11 Unless required by applicable law or agreed to in writing, software
johnb 3:c3d96b94041a 12 distributed under the License is distributed on an "AS IS" BASIS,
johnb 3:c3d96b94041a 13 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
johnb 3:c3d96b94041a 14 See the License for the specific language governing permissions and
johnb 3:c3d96b94041a 15 limitations under the License.
johnb 3:c3d96b94041a 16
johnb 3:c3d96b94041a 17 */
johnb 3:c3d96b94041a 18
johnb 3:c3d96b94041a 19 #include "XBeeApiFrame.hpp"
johnb 3:c3d96b94041a 20 #include "XBeeDevice.hpp"
johnb 3:c3d96b94041a 21
johnb 3:c3d96b94041a 22 #include <stdlib.h>
johnb 3:c3d96b94041a 23
johnb 3:c3d96b94041a 24 XBeeApiFrame::XBeeApiFrame( void )
johnb 3:c3d96b94041a 25 {
johnb 3:c3d96b94041a 26 m_cmdId = XBEE_CMD_INVALID;
johnb 3:c3d96b94041a 27 m_dataLen = 0;
johnb 3:c3d96b94041a 28 m_data = NULL;
johnb 3:c3d96b94041a 29 }
johnb 3:c3d96b94041a 30
johnb 3:c3d96b94041a 31 uint16_t XBeeApiFrame::getCmdLen( void ) const
johnb 3:c3d96b94041a 32 {
johnb 3:c3d96b94041a 33 return m_dataLen + m_cmdHeaderLen;
johnb 3:c3d96b94041a 34 }
johnb 3:c3d96b94041a 35
johnb 3:c3d96b94041a 36
johnb 3:c3d96b94041a 37 XBeeApiCmdId_e XBeeApiFrame::getCmdId( void ) const
johnb 3:c3d96b94041a 38 {
johnb 3:c3d96b94041a 39 return m_cmdId;
johnb 3:c3d96b94041a 40 }
johnb 3:c3d96b94041a 41
johnb 3:c3d96b94041a 42 const uint8_t* XBeeApiFrame::getDataPtr( void ) const
johnb 3:c3d96b94041a 43 {
johnb 3:c3d96b94041a 44 return m_data;
johnb 3:c3d96b94041a 45 }
johnb 3:c3d96b94041a 46
johnb 3:c3d96b94041a 47 XBeeApiFrameDecoder::XBeeApiFrameDecoder() : m_device( NULL )
johnb 3:c3d96b94041a 48 {
johnb 3:c3d96b94041a 49
johnb 3:c3d96b94041a 50 }
johnb 3:c3d96b94041a 51
johnb 3:c3d96b94041a 52 XBeeApiFrameDecoder::~XBeeApiFrameDecoder()
johnb 3:c3d96b94041a 53 {
johnb 3:c3d96b94041a 54 if( m_device != NULL )
johnb 3:c3d96b94041a 55 {
johnb 3:c3d96b94041a 56 m_device->unregisterDecoder( this );
johnb 3:c3d96b94041a 57 }
johnb 3:c3d96b94041a 58 }
johnb 3:c3d96b94041a 59
johnb 3:c3d96b94041a 60 void XBeeApiFrameDecoder::registerCallback( XBeeDevice* const p_device )
johnb 3:c3d96b94041a 61 {
johnb 3:c3d96b94041a 62 m_device = p_device;
johnb 3:c3d96b94041a 63 }
johnb 3:c3d96b94041a 64
johnb 3:c3d96b94041a 65 void XBeeApiFrameDecoder::unregisterCallback( void )
johnb 3:c3d96b94041a 66 {
johnb 3:c3d96b94041a 67 m_device = NULL;
johnb 3:c3d96b94041a 68 }