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.
Diff: Utility/XBeeApiCmdAt.cpp
- Revision:
- 30:9532b01a1ae1
- Parent:
- 29:c6d037cceb02
- Child:
- 31:c144106e55b5
diff -r c6d037cceb02 -r 9532b01a1ae1 Utility/XBeeApiCmdAt.cpp --- a/Utility/XBeeApiCmdAt.cpp Thu Feb 06 21:25:17 2014 +0000 +++ b/Utility/XBeeApiCmdAt.cpp Thu Feb 06 21:26:48 2014 +0000 @@ -31,8 +31,15 @@ #define CMD_RESPONSE_SET_PID '9' #define CMD_RESPONSE_GET_PID '0' -extern Serial pc; +/** Lowest channel supported by the XBee S1 */ +#define XBEE_CHAN_MIN 0x0b +/** Highest channel supported by the XBee S1 */ +#define XBEE_CHAN_MAX 0x1a +/** Lowest channel supported by the XBee S1 Pro */ +#define XBEE_PRO_CHAN_MIN 0x0c +/** Highest channel supported by the XBee S1 Pro */ +#define XBEE_PRO_CHAN_MAX 0x17 /* Content for the various commands - value of 0 indicates a value to be populated (i.e. variable) */ @@ -194,13 +201,6 @@ return ret_val; } -#define XBEE_CHAN_MIN 0x0b -#define XBEE_CHAN_MAX 0x1a - -/* TODO - support XBee Pro */ -#define XBEE_PRO_CHAN_MIN 0x0c -#define XBEE_PRO_CHAN_MAX 0x17 - bool XBeeApiCmdAt::setChannel( uint8_t const p_chan ) { bool ret_val = false;