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

Committer:
johnb
Date:
Fri Aug 08 11:59:52 2014 +0000
Revision:
56:7fe74b03e6b1
Parent:
47:5d3608835668 
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 5:b40a6fd3a334 1 /**
johnb 5:b40a6fd3a334 2
johnb 5:b40a6fd3a334 3 Copyright 2013 John Bailey
johnb 5:b40a6fd3a334 4
johnb 5:b40a6fd3a334 5 Licensed under the Apache License, Version 2.0 (the "License");
johnb 5:b40a6fd3a334 6 you may not use this file except in compliance with the License.
johnb 5:b40a6fd3a334 7 You may obtain a copy of the License at
johnb 5:b40a6fd3a334 8
johnb 5:b40a6fd3a334 9 http://www.apache.org/licenses/LICENSE-2.0
johnb 5:b40a6fd3a334 10
johnb 5:b40a6fd3a334 11 Unless required by applicable law or agreed to in writing, software
johnb 5:b40a6fd3a334 12 distributed under the License is distributed on an "AS IS" BASIS,
johnb 5:b40a6fd3a334 13 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
johnb 5:b40a6fd3a334 14 See the License for the specific language governing permissions and
johnb 5:b40a6fd3a334 15 limitations under the License.
johnb 5:b40a6fd3a334 16
johnb 5:b40a6fd3a334 17 */
johnb 5:b40a6fd3a334 18
johnb 5:b40a6fd3a334 19 #include "XBeeApiFrame.hpp"
johnb 5:b40a6fd3a334 20 #include "XBeeDevice.hpp"
johnb 5:b40a6fd3a334 21
johnb 5:b40a6fd3a334 22 #include <stdlib.h>
johnb 5:b40a6fd3a334 23
johnb 6:3cb62daace78 24 XBeeApiFrame::XBeeApiFrame( void ) : m_apiId ( XBEE_CMD_INVALID ), m_data( NULL ), m_dataLen( 0 )
johnb 5:b40a6fd3a334 25 {
johnb 5:b40a6fd3a334 26 }
johnb 5:b40a6fd3a334 27
johnb 24:2cd1094c4fd7 28 XBeeApiFrame::XBeeApiFrame( XBeeApiIdentifier_e p_id,
johnb 38:291aee9eb900 29 const uint8_t* const p_data,
johnb 38:291aee9eb900 30 const size_t p_dataLen ) : m_apiId( p_id ), m_data( p_data ), m_dataLen( p_dataLen )
johnb 24:2cd1094c4fd7 31 {
johnb 24:2cd1094c4fd7 32 }
johnb 24:2cd1094c4fd7 33
johnb 5:b40a6fd3a334 34 uint16_t XBeeApiFrame::getCmdLen( void ) const
johnb 5:b40a6fd3a334 35 {
johnb 5:b40a6fd3a334 36 return m_dataLen + m_cmdHeaderLen;
johnb 5:b40a6fd3a334 37 }
johnb 5:b40a6fd3a334 38
johnb 5:b40a6fd3a334 39 XBeeApiIdentifier_e XBeeApiFrame::getApiId( void ) const
johnb 5:b40a6fd3a334 40 {
johnb 5:b40a6fd3a334 41 return m_apiId;
johnb 5:b40a6fd3a334 42 }
johnb 5:b40a6fd3a334 43
johnb 47:5d3608835668 44 void XBeeApiFrame::getDataPtr( const uint16_t p_start, const uint8_t** p_buff, uint16_t* const p_len ) const
johnb 5:b40a6fd3a334 45 {
johnb 10:0d084d0253a7 46 *p_len = m_dataLen;
johnb 10:0d084d0253a7 47 (*p_buff) = m_data;
johnb 5:b40a6fd3a334 48 }
johnb 5:b40a6fd3a334 49
johnb 16:8095c43a2a6e 50 XBeeApiFrameDecoder::XBeeApiFrameDecoder( XBeeDevice* const p_device ) : m_device( NULL )
johnb 5:b40a6fd3a334 51 {
johnb 16:8095c43a2a6e 52 if( p_device != NULL )
johnb 16:8095c43a2a6e 53 {
johnb 16:8095c43a2a6e 54 p_device->registerDecoder( this );
johnb 16:8095c43a2a6e 55 }
johnb 5:b40a6fd3a334 56 }
johnb 5:b40a6fd3a334 57
johnb 5:b40a6fd3a334 58 XBeeApiFrameDecoder::~XBeeApiFrameDecoder()
johnb 5:b40a6fd3a334 59 {
johnb 5:b40a6fd3a334 60 if( m_device != NULL )
johnb 5:b40a6fd3a334 61 {
johnb 5:b40a6fd3a334 62 m_device->unregisterDecoder( this );
johnb 5:b40a6fd3a334 63 }
johnb 5:b40a6fd3a334 64 }
johnb 5:b40a6fd3a334 65
johnb 5:b40a6fd3a334 66 void XBeeApiFrameDecoder::registerCallback( XBeeDevice* const p_device )
johnb 5:b40a6fd3a334 67 {
johnb 5:b40a6fd3a334 68 m_device = p_device;
johnb 5:b40a6fd3a334 69 }
johnb 5:b40a6fd3a334 70
johnb 5:b40a6fd3a334 71 void XBeeApiFrameDecoder::unregisterCallback( void )
johnb 5:b40a6fd3a334 72 {
johnb 5:b40a6fd3a334 73 m_device = NULL;
johnb 5:b40a6fd3a334 74 }