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.

Config/XBeeApiCfg.hpp

Committer:
johnb
Date:
2014-08-08
Revision:
56:7fe74b03e6b1
Parent:
42:81c789ba4c08

File content as of revision 56:7fe74b03e6b1:

/**
   @file
   @brief Configuration options for the XBeeApi module
   
   @author John Bailey 

   @copyright Copyright 2014 John Bailey

   @section LICENSE
   
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

*/

#if !defined XBEEAPICFG_HPP
#define      XBEEAPICFG_HPP

/** Set the size of the RX buffer in the XBeeDevice */
#define XBEEAPI_CONFIG_RX_BUFFER_SIZE 512

/** Enable developer options */
#define XBEEAPI_CONFIG_ENABLE_DEVELOPER

/** Maximum number of decoders to be supported.  Attempting to add more
    than the maximum will fail.  Increating this will use slightly more 
    memory */
#define XBEEAPI_CONFIG_DECODER_LIST_SIZE 10

/** Guard period for sending "+++" commands - see XBee documentation */
#define XBEEAPI_CONFIG_GUARDPERIOD_MS 1000

/* You must change '0' to '1' if you're including the mbed-rtos library */
#if 0
/** Use RTOS features to make XBeeApi threadsafe */
#define  XBEEAPI_CONFIG_USING_RTOS

/** Set up a thread to dispatch received data outside of the interrupt context.
    Note that if you don't use this you'll need to implement your own 
    alternative mechanism */
#define  XBEEAPI_CONFIG_RTOS_USE_DISPATCHER

/** Number of XBeeDevice classes that the dispatcher configured by
    XBEEAPI_CONFIG_RTOS_USE_DISPATCHER will be able to support */
#define  XBEEAPI_CONFIG_RTOS_DISPATCHER_LIST_SIZE 1

/** Stack side for the dispatcher thread */
#define XBEEAPI_CONFIG_RTOS_DISPATCHER_TASK_STACK_SIZE DEFAULT_STACK_SIZE

#endif

#if 0
#define XBEE_DEBUG_DEVICE_DUMP_MESSAGE_DECODE
#endif

#endif /* !defined( XBEEAPICFG_HPP ) */