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.

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.

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"

Settings/Status

Import programXBeeApiSimpleATCmdsExample

Simple example of using XBeeApi to send AT-style commands to the XBee

Import programXBeeApiRemoteATCmdsExample

Example of using the XBeeApi library to send AT commands to remote XBee devices in order to read/write settings

Receive

Import programXBeeApiSimpleReceiveExample

Simple example of using XBeeApi to receive data packets via wireless

Import programXBeeApiReceiveCallbackExample

Example of using the XBeeApi library to receive a message via a callback method

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

Remote I/O

Import programXBeeApiRemoteIOExample

Example of using the XBeeApi library to read inputs on a remote XBee

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.

Committer:
johnb
Date:
Fri Aug 08 11:59:52 2014 +0000
Revision:
56:7fe74b03e6b1
Parent:
42:81c789ba4c08
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 0:9f44c388ca00 1 /**
johnb 0:9f44c388ca00 2 @file
johnb 0:9f44c388ca00 3 @brief Configuration options for the XBeeApi module
johnb 0:9f44c388ca00 4
johnb 0:9f44c388ca00 5 @author John Bailey
johnb 0:9f44c388ca00 6
johnb 4:e5e152b3930f 7 @copyright Copyright 2014 John Bailey
johnb 0:9f44c388ca00 8
johnb 0:9f44c388ca00 9 @section LICENSE
johnb 0:9f44c388ca00 10
johnb 0:9f44c388ca00 11 Licensed under the Apache License, Version 2.0 (the "License");
johnb 0:9f44c388ca00 12 you may not use this file except in compliance with the License.
johnb 0:9f44c388ca00 13 You may obtain a copy of the License at
johnb 0:9f44c388ca00 14
johnb 0:9f44c388ca00 15 http://www.apache.org/licenses/LICENSE-2.0
johnb 0:9f44c388ca00 16
johnb 0:9f44c388ca00 17 Unless required by applicable law or agreed to in writing, software
johnb 0:9f44c388ca00 18 distributed under the License is distributed on an "AS IS" BASIS,
johnb 0:9f44c388ca00 19 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
johnb 0:9f44c388ca00 20 See the License for the specific language governing permissions and
johnb 0:9f44c388ca00 21 limitations under the License.
johnb 0:9f44c388ca00 22
johnb 0:9f44c388ca00 23 */
johnb 0:9f44c388ca00 24
johnb 0:9f44c388ca00 25 #if !defined XBEEAPICFG_HPP
johnb 0:9f44c388ca00 26 #define XBEEAPICFG_HPP
johnb 0:9f44c388ca00 27
johnb 4:e5e152b3930f 28 /** Set the size of the RX buffer in the XBeeDevice */
johnb 0:9f44c388ca00 29 #define XBEEAPI_CONFIG_RX_BUFFER_SIZE 512
johnb 4:e5e152b3930f 30
johnb 4:e5e152b3930f 31 /** Enable developer options */
johnb 0:9f44c388ca00 32 #define XBEEAPI_CONFIG_ENABLE_DEVELOPER
johnb 4:e5e152b3930f 33
johnb 4:e5e152b3930f 34 /** Maximum number of decoders to be supported. Attempting to add more
johnb 4:e5e152b3930f 35 than the maximum will fail. Increating this will use slightly more
johnb 4:e5e152b3930f 36 memory */
johnb 2:7196461129e9 37 #define XBEEAPI_CONFIG_DECODER_LIST_SIZE 10
johnb 0:9f44c388ca00 38
johnb 4:e5e152b3930f 39 /** Guard period for sending "+++" commands - see XBee documentation */
johnb 4:e5e152b3930f 40 #define XBEEAPI_CONFIG_GUARDPERIOD_MS 1000
johnb 4:e5e152b3930f 41
johnb 42:81c789ba4c08 42 /* You must change '0' to '1' if you're including the mbed-rtos library */
johnb 0:9f44c388ca00 43 #if 0
johnb 0:9f44c388ca00 44 /** Use RTOS features to make XBeeApi threadsafe */
johnb 0:9f44c388ca00 45 #define XBEEAPI_CONFIG_USING_RTOS
johnb 42:81c789ba4c08 46
johnb 42:81c789ba4c08 47 /** Set up a thread to dispatch received data outside of the interrupt context.
johnb 42:81c789ba4c08 48 Note that if you don't use this you'll need to implement your own
johnb 42:81c789ba4c08 49 alternative mechanism */
johnb 42:81c789ba4c08 50 #define XBEEAPI_CONFIG_RTOS_USE_DISPATCHER
johnb 42:81c789ba4c08 51
johnb 42:81c789ba4c08 52 /** Number of XBeeDevice classes that the dispatcher configured by
johnb 42:81c789ba4c08 53 XBEEAPI_CONFIG_RTOS_USE_DISPATCHER will be able to support */
johnb 42:81c789ba4c08 54 #define XBEEAPI_CONFIG_RTOS_DISPATCHER_LIST_SIZE 1
johnb 42:81c789ba4c08 55
johnb 42:81c789ba4c08 56 /** Stack side for the dispatcher thread */
johnb 42:81c789ba4c08 57 #define XBEEAPI_CONFIG_RTOS_DISPATCHER_TASK_STACK_SIZE DEFAULT_STACK_SIZE
johnb 42:81c789ba4c08 58
johnb 0:9f44c388ca00 59 #endif
johnb 0:9f44c388ca00 60
johnb 18:e19505ed8fcb 61 #if 0
johnb 16:8095c43a2a6e 62 #define XBEE_DEBUG_DEVICE_DUMP_MESSAGE_DECODE
johnb 16:8095c43a2a6e 63 #endif
johnb 16:8095c43a2a6e 64
johnb 0:9f44c388ca00 65 #endif /* !defined( XBEEAPICFG_HPP ) */