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

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

Who changed what in which revision?

UserRevisionLine numberNew contents of line
johnb 9:ba90e9efd68b 1 /**
johnb 9:ba90e9efd68b 2 @file
johnb 12:58319a467943 3 @brief Class to support transmission of data via the XBee's wireless
johnb 9:ba90e9efd68b 4
johnb 9:ba90e9efd68b 5 @author John Bailey
johnb 9:ba90e9efd68b 6
johnb 9:ba90e9efd68b 7 @copyright Copyright 2014 John Bailey
johnb 9:ba90e9efd68b 8
johnb 9:ba90e9efd68b 9 @section LICENSE
johnb 9:ba90e9efd68b 10
johnb 9:ba90e9efd68b 11 Licensed under the Apache License, Version 2.0 (the "License");
johnb 9:ba90e9efd68b 12 you may not use this file except in compliance with the License.
johnb 9:ba90e9efd68b 13 You may obtain a copy of the License at
johnb 9:ba90e9efd68b 14
johnb 9:ba90e9efd68b 15 http://www.apache.org/licenses/LICENSE-2.0
johnb 9:ba90e9efd68b 16
johnb 9:ba90e9efd68b 17 Unless required by applicable law or agreed to in writing, software
johnb 9:ba90e9efd68b 18 distributed under the License is distributed on an "AS IS" BASIS,
johnb 9:ba90e9efd68b 19 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
johnb 9:ba90e9efd68b 20 See the License for the specific language governing permissions and
johnb 9:ba90e9efd68b 21 limitations under the License.
johnb 9:ba90e9efd68b 22
johnb 9:ba90e9efd68b 23 */
johnb 9:ba90e9efd68b 24
johnb 9:ba90e9efd68b 25 #if !defined XBEEAPITX64BADDR_HPP
johnb 9:ba90e9efd68b 26 #define XBEEAPITX64BADDR_HPP
johnb 9:ba90e9efd68b 27
johnb 9:ba90e9efd68b 28 #include "XBeeApiFrame.hpp"
johnb 9:ba90e9efd68b 29 #include "XBeeDevice.hpp"
johnb 9:ba90e9efd68b 30
johnb 9:ba90e9efd68b 31 #include <stdint.h>
johnb 9:ba90e9efd68b 32
johnb 9:ba90e9efd68b 33 class XBeeApiTxFrame : public XBeeApiFrame, public XBeeApiFrameDecoder
johnb 9:ba90e9efd68b 34 {
johnb 9:ba90e9efd68b 35 protected:
johnb 12:58319a467943 36 uint64_t m_addr;
johnb 12:58319a467943 37 bool m_ack;
johnb 12:58319a467943 38 bool m_panBroadcast;
johnb 12:58319a467943 39 uint8_t m_buffer[11];
johnb 9:ba90e9efd68b 40 public:
johnb 9:ba90e9efd68b 41 XBeeApiTxFrame( XBeeDevice* p_device = NULL );
johnb 12:58319a467943 42 virtual ~XBeeApiTxFrame( void );
johnb 9:ba90e9efd68b 43
johnb 12:58319a467943 44 void setDestAddrType( const XBeeDevice::XBeeApiAddrType_t p_type );
johnb 9:ba90e9efd68b 45 void setDestAddr( uint64_t p_addr );
johnb 9:ba90e9efd68b 46 void setDestAddrBroadcast( void );
johnb 9:ba90e9efd68b 47 void setPanBroadcast( const bool p_bc );
johnb 9:ba90e9efd68b 48
johnb 9:ba90e9efd68b 49 virtual bool decodeCallback( const uint8_t* const p_data, size_t p_len );
johnb 12:58319a467943 50 virtual void getDataPtr( const uint16_t p_start, const uint8_t** p_buff, uint16_t* const p_len ) const;
johnb 12:58319a467943 51
johnb 9:ba90e9efd68b 52 };
johnb 9:ba90e9efd68b 53
johnb 9:ba90e9efd68b 54 #endif