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.

Utility/XBeeApiSetupHelper.hpp@8:1b48b619d7f6, 2014-01-31 (annotated)

Committer:
johnb
Date:
Fri Jan 31 01:16:56 2014 +0000
Revision:
8:1b48b619d7f6
Child:
38:291aee9eb900
Work-in-progress commit.  Add blocking version of XBeeApiCmdAt

Who changed what in which revision?

UserRevisionLine numberNew contents of line
johnb 8:1b48b619d7f6 1 /**
johnb 8:1b48b619d7f6 2 @file
johnb 8:1b48b619d7f6 3 @brief Functions to help with XBee configuration
johnb 8:1b48b619d7f6 4
johnb 8:1b48b619d7f6 5 @author John Bailey
johnb 8:1b48b619d7f6 6
johnb 8:1b48b619d7f6 7 @copyright Copyright 2014 John Bailey
johnb 8:1b48b619d7f6 8
johnb 8:1b48b619d7f6 9 @section LICENSE
johnb 8:1b48b619d7f6 10
johnb 8:1b48b619d7f6 11 Licensed under the Apache License, Version 2.0 (the "License");
johnb 8:1b48b619d7f6 12 you may not use this file except in compliance with the License.
johnb 8:1b48b619d7f6 13 You may obtain a copy of the License at
johnb 8:1b48b619d7f6 14
johnb 8:1b48b619d7f6 15 http://www.apache.org/licenses/LICENSE-2.0
johnb 8:1b48b619d7f6 16
johnb 8:1b48b619d7f6 17 Unless required by applicable law or agreed to in writing, software
johnb 8:1b48b619d7f6 18 distributed under the License is distributed on an "AS IS" BASIS,
johnb 8:1b48b619d7f6 19 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
johnb 8:1b48b619d7f6 20 See the License for the specific language governing permissions and
johnb 8:1b48b619d7f6 21 limitations under the License.
johnb 8:1b48b619d7f6 22
johnb 8:1b48b619d7f6 23 */
johnb 8:1b48b619d7f6 24
johnb 8:1b48b619d7f6 25 #if !defined XBEEAPISETUPHELPER_HPP
johnb 8:1b48b619d7f6 26 #define XBEEAPISETUPHELPER_HPP
johnb 8:1b48b619d7f6 27
johnb 8:1b48b619d7f6 28 #include "XBeeDevice.hpp"
johnb 8:1b48b619d7f6 29 #include "XBeeApiCmdAt.hpp"
johnb 8:1b48b619d7f6 30
johnb 8:1b48b619d7f6 31 typedef enum {
johnb 8:1b48b619d7f6 32 XBEE_NETWORK_TYPE_P2P,
johnb 8:1b48b619d7f6 33 XBEE_NETWORK_TYPE_NON_BEACON,
johnb 8:1b48b619d7f6 34 XBEE_NETWORK_TYPE_UNKNOWN
johnb 8:1b48b619d7f6 35 } XBeeNetworkType_e;
johnb 8:1b48b619d7f6 36
johnb 8:1b48b619d7f6 37 /** Set the XBee to use the P2P networking model. Thie helper function
johnb 8:1b48b619d7f6 38 assumes that the XBee device and the passed XBeeApiCmdAt-type object have already
johnb 8:1b48b619d7f6 39 been configured.
johnb 8:1b48b619d7f6 40
johnb 8:1b48b619d7f6 41 This function will block until the settings have been successfully applied or a failure
johnb 8:1b48b619d7f6 42 has been encountered.
johnb 8:1b48b619d7f6 43
johnb 8:1b48b619d7f6 44 \param p_xbeeCmd Pointer to an XBeeApiCmdAt object which has already been registered
johnb 8:1b48b619d7f6 45 as a decoder with an XBee device.
johnb 8:1b48b619d7f6 46 \param p_id Network ID to use
johnb 8:1b48b619d7f6 47 \param p_chan Channel to use
johnb 8:1b48b619d7f6 48 */
johnb 8:1b48b619d7f6 49 extern void xbeeSetNetworkTypeP2P( XBeeApiCmdAt* const p_xbeeCmd,
johnb 8:1b48b619d7f6 50 const XBeeApiCmdAt::panId_t p_id,
johnb 8:1b48b619d7f6 51 const XBeeApiCmdAt::channel_t p_chan );
johnb 8:1b48b619d7f6 52
johnb 8:1b48b619d7f6 53 #endif /* !defined( XBEEAPISETUPHELPER_HPP ) */