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.

Diff: RXTX/XBeeApiTxFrame.hpp

Revision:
16:8095c43a2a6e
Parent:
15:ff9f12e38f44
Child:
20:3fa7a0daf1c7
--- a/RXTX/XBeeApiTxFrame.hpp	Mon Feb 03 23:47:33 2014 +0000
+++ b/RXTX/XBeeApiTxFrame.hpp	Tue Feb 04 23:52:50 2014 +0000
@@ -22,28 +22,40 @@
 
 */
 
-#if !defined XBEEAPITX64BADDR_HPP
-#define      XBEEAPITX64BADDR_HPP
+#if !defined XBEEAPITXFRAME_HPP
+#define      XBEEAPITXFRAME_HPP
 
 #include "XBeeApiFrame.hpp"
 #include "XBeeDevice.hpp"
 
 #include <stdint.h>
 
+#define XBEE_API_TX_FRAME_BUFFER_SIZE 11U
+
+#define XBEE_API_MAX_TX_PAYLOAD_LEN 100U
+
+/** Class to represent a frame of data being transmitted by the XBee */
 class XBeeApiTxFrame : public XBeeApiFrame, public XBeeApiFrameDecoder
 {
     protected:
+       /** Destination address of the frame */
        uint64_t          m_addr;
+       /** Whether or not an acknowledgement of the frame is requested */ 
        bool              m_ack;
+       /** Whether or not the frame is a PAN broadcast */
        bool              m_panBroadcast;
-       uint8_t           m_buffer[11];
+       /** Buffer to house data relating to the frame header */
+       uint8_t           m_buffer[XBEE_API_TX_FRAME_BUFFER_SIZE];
     public:
        typedef enum
        {
            XBEE_API_TX_STATUS_OK = 0,
            XBEE_API_TX_STATUS_NO_ACK = 1,
            XBEE_API_TX_STATUS_CCA_FAIL = 2,
-           XBEE_API_TX_STATUS_PURGED = 3  
+           XBEE_API_TX_STATUS_PURGED = 3,
+           /** Not an actual status, used to provide a handle on the numer of 
+               enumeration items */
+           XBEE_API_TX_STATUS_LAST = 4  
        } XBeeApiTxStatus_e;
     
        XBeeApiTxFrame( XBeeDevice* p_device = NULL );
@@ -55,9 +67,26 @@
        void setPanBroadcast( const bool p_bc );
        
        virtual bool decodeCallback( const uint8_t* const p_data, size_t p_len );
-       virtual void getDataPtr( const uint16_t p_start, const uint8_t**  p_buff, uint16_t* const p_len ) const;
+       virtual uint16_t getCmdLen( void ) const;
+       virtual void getDataPtr( const uint16_t p_start, const uint8_t**  p_buff, uint16_t* const p_len );
+       
+       virtual uint8_t getFrameId( void ) const;
        
+       /** Callback function which is invoked when a response to the TX request is received from
+           the XBee.
+           
+           \param p_status Status of the TX attempt */
        virtual void frameTxCallback( const XBeeApiTxStatus_e p_status );
+       
+       /** Set the frame payload
+       
+           \param p_buff Pointer to the buffer containing the data.  Note that this buffer is not copied, so
+                         must retain the appropriate content until transmission is complete
+           \param p_len Length of the data pointed to be p_buff.  Must be 100 or less.
+           \returns true in the case that the operation was successful, false in the case that it was not
+                    (content too long, etc)
+       */
+       bool setDataPtr( const uint8_t* const p_buff, const uint16_t p_len );
 };
 
 #endif
\ No newline at end of file