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/XBeeApiTxFrame.cpp@12:58319a467943, 2014-02-01 (annotated)

Committer:
johnb
Date:
Sat Feb 01 00:04:42 2014 +0000
Revision:
12:58319a467943
Parent:
9:ba90e9efd68b
Child:
13:302e7c1ea0b3
Add XBeeApiAddrType_t

Who changed what in which revision?

UserRevisionLine numberNew contents of line
johnb 9:ba90e9efd68b 1 /**
johnb 9:ba90e9efd68b 2
johnb 9:ba90e9efd68b 3 Copyright 2014 John Bailey
johnb 9:ba90e9efd68b 4
johnb 9:ba90e9efd68b 5 Licensed under the Apache License, Version 2.0 (the "License");
johnb 9:ba90e9efd68b 6 you may not use this file except in compliance with the License.
johnb 9:ba90e9efd68b 7 You may obtain a copy of the License at
johnb 9:ba90e9efd68b 8
johnb 9:ba90e9efd68b 9 http://www.apache.org/licenses/LICENSE-2.0
johnb 9:ba90e9efd68b 10
johnb 9:ba90e9efd68b 11 Unless required by applicable law or agreed to in writing, software
johnb 9:ba90e9efd68b 12 distributed under the License is distributed on an "AS IS" BASIS,
johnb 9:ba90e9efd68b 13 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
johnb 9:ba90e9efd68b 14 See the License for the specific language governing permissions and
johnb 9:ba90e9efd68b 15 limitations under the License.
johnb 9:ba90e9efd68b 16
johnb 9:ba90e9efd68b 17 */
johnb 9:ba90e9efd68b 18
johnb 9:ba90e9efd68b 19 #include "XBeeApiTxFrame.hpp"
johnb 9:ba90e9efd68b 20
johnb 9:ba90e9efd68b 21 #define BROADCAST_ADDR (0xFFFFU)
johnb 9:ba90e9efd68b 22
johnb 9:ba90e9efd68b 23 XBeeApiTxFrame::XBeeApiTxFrame( XBeeDevice* p_device ) : XBeeApiFrame(), XBeeApiFrameDecoder(),
johnb 12:58319a467943 24 m_addr( BROADCAST_ADDR ),
johnb 12:58319a467943 25 m_ack( true ),
johnb 12:58319a467943 26 m_panBroadcast( false )
johnb 9:ba90e9efd68b 27 {
johnb 9:ba90e9efd68b 28 if( p_device != NULL )
johnb 9:ba90e9efd68b 29 {
johnb 9:ba90e9efd68b 30 p_device->registerDecoder( this );
johnb 9:ba90e9efd68b 31 }
johnb 9:ba90e9efd68b 32
johnb 12:58319a467943 33 m_apiId = XBEE_CMD_TX_16B_ADDR;
johnb 9:ba90e9efd68b 34 m_buffer[0] = 1; // Frame ID
johnb 9:ba90e9efd68b 35 m_buffer[1] = 0; // 64-bit add
johnb 9:ba90e9efd68b 36 m_buffer[2] = 0;
johnb 9:ba90e9efd68b 37 m_buffer[3] = 0;
johnb 9:ba90e9efd68b 38 m_buffer[4] = 0;
johnb 9:ba90e9efd68b 39 m_buffer[5] = 0;
johnb 9:ba90e9efd68b 40 m_buffer[6] = 0;
johnb 9:ba90e9efd68b 41 m_buffer[7] = 0;
johnb 9:ba90e9efd68b 42 m_buffer[8] = 0;
johnb 9:ba90e9efd68b 43 m_buffer[9] = 0;
johnb 9:ba90e9efd68b 44 m_buffer[10] = 0;
johnb 9:ba90e9efd68b 45 m_data = m_buffer;
johnb 9:ba90e9efd68b 46 m_dataLen = sizeof( m_buffer );
johnb 9:ba90e9efd68b 47 }
johnb 12:58319a467943 48
johnb 12:58319a467943 49
johnb 12:58319a467943 50 XBeeApiTxFrame::~XBeeApiTxFrame( void )
johnb 12:58319a467943 51 {
johnb 12:58319a467943 52 }
johnb 12:58319a467943 53
johnb 12:58319a467943 54 void XBeeApiTxFrame::getDataPtr( const uint16_t p_start, const uint8_t** p_buff, uint16_t* const p_len ) const
johnb 12:58319a467943 55 {
johnb 12:58319a467943 56 /* TODO */
johnb 12:58319a467943 57 }
johnb 12:58319a467943 58
johnb 12:58319a467943 59
johnb 12:58319a467943 60 void XBeeApiTxFrame::setDestAddrType( const XBeeDevice::XBeeApiAddrType_t p_type )
johnb 12:58319a467943 61 {
johnb 12:58319a467943 62 if( p_type == XBeeDevice::XBEE_API_ADDR_TYPE_16BIT )
johnb 12:58319a467943 63 {
johnb 12:58319a467943 64 m_apiId = XBEE_CMD_TX_16B_ADDR;
johnb 12:58319a467943 65 }
johnb 12:58319a467943 66 else
johnb 12:58319a467943 67 {
johnb 12:58319a467943 68 m_apiId = XBEE_CMD_TX_64B_ADDR;
johnb 12:58319a467943 69 }
johnb 12:58319a467943 70 }
johnb 9:ba90e9efd68b 71
johnb 9:ba90e9efd68b 72 void XBeeApiTxFrame::setDestAddr( uint64_t p_addr )
johnb 9:ba90e9efd68b 73 {
johnb 9:ba90e9efd68b 74 m_addr = p_addr;
johnb 9:ba90e9efd68b 75 }
johnb 9:ba90e9efd68b 76
johnb 9:ba90e9efd68b 77 void XBeeApiTxFrame::setDestAddrBroadcast( void )
johnb 9:ba90e9efd68b 78 {
johnb 9:ba90e9efd68b 79 m_addr = BROADCAST_ADDR;
johnb 9:ba90e9efd68b 80 }
johnb 9:ba90e9efd68b 81
johnb 9:ba90e9efd68b 82 void XBeeApiTxFrame::setPanBroadcast( const bool p_bc )
johnb 9:ba90e9efd68b 83 {
johnb 9:ba90e9efd68b 84 m_panBroadcast = p_bc;
johnb 9:ba90e9efd68b 85 }
johnb 9:ba90e9efd68b 86
johnb 9:ba90e9efd68b 87 bool XBeeApiTxFrame::decodeCallback( const uint8_t* const p_data, size_t p_len )
johnb 9:ba90e9efd68b 88 {
johnb 9:ba90e9efd68b 89 bool ret_val = false;
johnb 9:ba90e9efd68b 90
johnb 9:ba90e9efd68b 91 if( XBEE_CMD_TX_STATUS == p_data[ XBEE_CMD_POSN_API_ID ] )
johnb 9:ba90e9efd68b 92 {
johnb 9:ba90e9efd68b 93 ret_val = true;
johnb 9:ba90e9efd68b 94 }
johnb 9:ba90e9efd68b 95
johnb 9:ba90e9efd68b 96 return ret_val;
johnb 9:ba90e9efd68b 97 }