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.hpp
- Revision:
- 52:0950b05d5270
- Parent:
- 51:a7d0d2ef9261
- Child:
- 55:610aa4a2ed3b
diff -r a7d0d2ef9261 -r 0950b05d5270 Utility/XBeeApiCmdAt.hpp --- a/Utility/XBeeApiCmdAt.hpp Mon Jul 28 10:24:16 2014 +0000 +++ b/Utility/XBeeApiCmdAt.hpp Mon Jul 28 12:48:33 2014 +0000 @@ -40,6 +40,7 @@ #define XBEE_API_CMD_REQ_HEADER_LEN 3U #define XBEE_API_DIO_CHANNEL_COUNT 8U +#define XBEE_API_ADC_CHANNEL_COUNT 6U /** Class to access the configuration interface of the XBee. Requests to the XBee are non-blocking meaning that code @@ -141,6 +142,12 @@ uint32_t m_applyCount; uint32_t m_resetCount; uint32_t m_sampleCount; + + time_t m_ioDigitalUpdatedTime[ XBEE_API_DIO_CHANNEL_COUNT ]; + bool m_ioDigitalState[ XBEE_API_DIO_CHANNEL_COUNT ]; + time_t m_ioAnalogueUpdatedTime[ XBEE_API_ADC_CHANNEL_COUNT ]; + uint16_t m_ioAnalogueVal[ XBEE_API_ADC_CHANNEL_COUNT ]; + virtual void SendCmd_uint8_t( const uint8_t p_frameId, const uint8_t* const p_data, @@ -162,6 +169,7 @@ virtual bool processResponseFrame( const uint8_t* const p_data, size_t p_len ); + virtual bool processIOFrame( const uint8_t* const p_data, size_t p_len, const size_t p_start ); public: @@ -173,6 +181,9 @@ /** Destructor */ virtual ~XBeeApiCmdAt( void ) {}; + time_t getDigitalState( const uint8_t p_chanNo, bool& p_state ); + time_t getAnalogueValue( const uint8_t p_chanNo, uint16_t& p_val ); + /** Request the hardware version identifier from the XBee. As the data is retrieved asynchronously to this call, once the response is received it can be accessed via