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: Utility/XBeeApiCmdAt.hpp

Revision:
13:302e7c1ea0b3
Parent:
11:bfcf1356027b
Child:
24:2cd1094c4fd7
diff -r 58319a467943 -r 302e7c1ea0b3 Utility/XBeeApiCmdAt.hpp
--- a/Utility/XBeeApiCmdAt.hpp	Sat Feb 01 00:04:42 2014 +0000
+++ b/Utility/XBeeApiCmdAt.hpp	Mon Feb 03 23:26:27 2014 +0000
@@ -38,14 +38,28 @@
 
 class XBeeApiCmdAt : public XBeeApiFrameDecoder
 {
+    public:
+       typedef uint16_t panId_t;
+       typedef uint8_t  channel_t;
+    
     protected:
         bool m_haveHwVer;
         bool m_haveFwVer;
         bool m_haveChan;
+        bool m_havePANId;
+        bool m_haveEDA;
+        bool m_haveCE;
+        
         uint16_t m_hwVer;
         uint16_t m_fwVer;
-        uint8_t m_chan;
-        uint8_t m_chanPend;
+        channel_t m_chan;
+        channel_t m_chanPend;
+        panId_t m_PANId;
+        panId_t m_PANIdPend;
+        bool m_EDA;
+        bool m_EDAPend;
+        bool m_CE;
+        bool m_CEPend;
     
         class XBeeApiCmdAtFirmwareVersionRequest : public XBeeApiFrame
         {
@@ -72,25 +86,78 @@
                 XBeeApiCmdAtChannelSet( const uint8_t p_chan );
         };
 
+        class XBeeApiCmdAtCERequest : public XBeeApiFrame
+        {
+            public:
+                XBeeApiCmdAtCERequest( void );
+        };
+
+        class XBeeApiCmdAtCESet : public XBeeApiFrame
+        {
+            /* TODO: Magic number */
+            uint8_t m_buffer[ 10 ];
+            public:
+                XBeeApiCmdAtCESet( const bool p_en );
+        };
+
+        class XBeeApiCmdAtPANIdRequest : public XBeeApiFrame
+        {
+            public:
+                XBeeApiCmdAtPANIdRequest( void );
+        };
+
+        class XBeeApiCmdAtPANIdSet : public XBeeApiFrame
+        {
+            /* TODO: Magic number */
+            uint8_t m_buffer[ 10 ];
+            public:
+                XBeeApiCmdAtPANIdSet( const panId_t p_chan );
+        };
+
+        class XBeeApiCmdAtEDARequest : public XBeeApiFrame
+        {
+            public:
+                XBeeApiCmdAtEDARequest( void );
+        };
+
+        class XBeeApiCmdAtEDASet : public XBeeApiFrame
+        {
+            /* TODO: Magic number */
+            uint8_t m_buffer[ 10 ];
+            public:
+                XBeeApiCmdAtEDASet( const bool p_en );
+        };
+
     public:
+
        XBeeApiCmdAt( );
        virtual ~XBeeApiCmdAt( void ) {};
        
        bool requestHardwareVersion( void );
        bool requestFirmwareVersion( void );
        bool requestChannel( void );
+       bool requestCoordinatorEnabled( void );
+       bool requestEndDeviceAssociationEnabled( void );
+       bool requestPanId( void );
 
        virtual bool getHardwareVersion( uint16_t* const p_ver );
        virtual bool getFirmwareVersion( uint16_t* const p_ver );
+       
        virtual bool getChannel( uint8_t* const p_chan );
+       virtual bool setChannel( uint8_t const p_chan );
        
-       virtual bool setChannel( uint8_t const p_chan );
+       virtual bool getCoordinatorEnabled( bool* constp_en );
+       virtual bool setCoordinatorEnabled( const bool p_en );
+       
+       virtual bool getEndDeviceAssociationEnabled( bool* const p_en ); 
+       virtual bool setEndDeviceAssociationEnabled( const bool p_en  );
+       
+       virtual bool getPanId( panId_t* const p_id );       
+       virtual bool setPanId( const panId_t p_id );       
        
        /* Implement XBeeApiCmdDecoder interface */
        virtual bool decodeCallback( const uint8_t* const p_data, size_t p_len );
 
-       typedef uint16_t panId_t;
-       typedef uint8_t  channel_t;
 };
 
 class XBeeApiCmdAtBlocking : public XBeeApiCmdAt
@@ -106,9 +173,19 @@
        /* Implement XBeeApiCmdAt's virtual methods */
        virtual bool getHardwareVersion( uint16_t* const p_ver );
        virtual bool getFirmwareVersion( uint16_t* const p_ver );
+
        virtual bool getChannel( uint8_t* const p_chan );
+       virtual bool setChannel( uint8_t const p_chan );
+        
+       virtual bool getCoordinatorEnabled( bool* constp_en );
+       virtual bool setCoordinatorEnabled( const bool p_en );
        
-       virtual bool setChannel( uint8_t const p_chan );
+       virtual bool getEndDeviceAssociationEnabled( bool* const p_en ); 
+       virtual bool setEndDeviceAssociationEnabled( const bool p_en  );
+       
+       virtual bool getPanId( panId_t* const p_id );       
+       virtual bool setPanId( const panId_t p_id );       
+
 };
 
 #endif
\ No newline at end of file