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:
51:a7d0d2ef9261
Parent:
50:f76b7e7959a2
Child:
52:0950b05d5270
diff -r f76b7e7959a2 -r a7d0d2ef9261 Utility/XBeeApiCmdAt.hpp
--- a/Utility/XBeeApiCmdAt.hpp	Sun Jul 13 15:47:40 2014 +0000
+++ b/Utility/XBeeApiCmdAt.hpp	Mon Jul 28 10:24:16 2014 +0000
@@ -70,6 +70,7 @@
         {
             XBEE_API_DIO_DISABLED             = 0,
             XBEE_API_DIO_SPECIAL              = 1,
+            XBEE_API_DIO_ADC                  = 2,
             XBEE_API_DIO_INPUT                = 3,
             XBEE_API_DIO_OUT_LOW              = 4,
             XBEE_API_DIO_OUT_HIGH             = 5,
@@ -97,6 +98,12 @@
         bool m_have_randomDelaySlots;
         bool m_have_macMode;
         bool m_have_d[ XBEE_API_DIO_CHANNEL_COUNT ];
+        bool m_have_dioChangeDetectMask;
+        bool m_have_dioLevels;
+        bool m_have_sampleRate;
+        bool m_have_destHigh;
+        bool m_have_destLow;
+ 
         
         uint16_t m_hwVer;
         uint16_t m_fwVer;
@@ -120,6 +127,20 @@
         XBeeApiMACMode_e   m_macModePend;
         XBeeApiDioConfig_e m_d[ XBEE_API_DIO_CHANNEL_COUNT ];
         XBeeApiDioConfig_e m_dPend[ XBEE_API_DIO_CHANNEL_COUNT ];
+        uint8_t m_dioChangeDetectMask;
+        uint8_t m_dioChangeDetectMaskPend;
+        uint8_t m_dioLevels;
+        uint8_t m_dioLevelsPend;
+        uint16_t m_sampleRate;
+        uint16_t m_sampleRatePend;
+        uint32_t m_destHigh;
+        uint32_t m_destHighPend;
+        uint32_t m_destLow;
+        uint32_t m_destLowPend;
+        uint32_t m_writeCount;
+        uint32_t m_applyCount;
+        uint32_t m_resetCount; 
+        uint32_t m_sampleCount;
 
         virtual void SendCmd_uint8_t( const uint8_t        p_frameId,
                                       const uint8_t* const p_data,
@@ -127,6 +148,9 @@
         virtual void SendCmd_uint16_t( const uint8_t        p_frameId,
                                        const uint8_t* const p_data,
                                        const uint16_t&       p_val );
+        virtual void SendCmd_uint32_t( const uint8_t        p_frameId,
+                                       const uint8_t* const p_data,
+                                       const uint32_t&       p_val );
         virtual void SendReq( const uint8_t             p_frameId,
                               const uint8_t*            p_data );
 
@@ -164,7 +188,8 @@
         bool requestSerialNumberHigh( void );
         bool requestSerialNumberLow( void );
         bool requestDioConfig( const uint8_t p_chanNo );
-
+        bool requestDioChangeDetectMask( void );
+        bool requestSampleRate( void );
         
         /** Request the number of retries the XBee is configured to make.
             Note that the 802.15.4 MAC already allows 3 retries, so this parameter
@@ -181,6 +206,14 @@
         bool requestRandomDelaySlots( void );
         
         bool requestMacMode( void );
+        bool requestDestinationAddress( void );
+        bool requestDestinationAddressHigh( void );
+        bool requestDestinationAddressLow( void );
+        
+        bool requestWriteSettings( void );
+        bool requestApplyChanges( void );
+        bool requestReset( void );
+        bool requestForceSample( void );
 
         /** Read the XBee's hardware version identifier.  
        
@@ -224,80 +257,30 @@
         
         virtual bool getDioConfig( const uint8_t p_chanNo, XBeeApiDioConfig_e* const p_conf );
         virtual bool setDioConfig( const uint8_t p_chanNo, const XBeeApiDioConfig_e p_conf );
-};
-
-/** Class to access the configuration interface of the XBee.
-    In contrast to XBeeApiCmdAt, the getXXX methods block
-    until the data is received (or a timeout has occurred)
-    which means that the caller doesn't have to deal with the
-    asynchronous nature of the API provided by XBeeApiCmdAt.
-    
-    It's not necessary to use any of the requestXXX methods
-    (as the getXXX methods will take care of this, however
-    calling a requestXXX method will effectively pre-fetch the
-    data meaning that getXXX will not have to block */
-class XBeeApiCmdAtBlocking : public XBeeApiCmdAt
-{
-    protected:
-        /** Timeout used for blocking methods in milliseconds */
-        uint16_t m_timeout;
+        
+        virtual bool getDioChangeDetectMask( uint8_t* const p_mask );
+        virtual bool setDioChangeDetectMask( const uint8_t p_mask );
         
-        /** Wait slice time while blocking.  The function will 
-            wait_ms(m_slice) until the XBee responds with the
-            data or m_timeout elapses */
-        uint16_t m_slice;
+        /** Note that this method will only return a value in the case that the levels have
+            been previously set via the setDioLevels method and that the XBee has 
+            returned a successful response.  There is no ability to simply read what the
+            current digital outputs are set to */
+        virtual bool getDioLevels( uint8_t* const p_mask );
+        virtual bool setDioLevels( const uint8_t p_mask );
 
-    public:
-       /** Constructor 
-       
-            \param p_device XBee device with which this object should 
-                            be associated 
-            \param p_timeout Timeout to be used when waiting for 
-                             data from the XBee, specified in
-                             milliseconds
-            \param p_slice While waiting for data, blocking methods
-                           will call the OS wait_ms() function, using
-                           the value specified by p_slice */
-       XBeeApiCmdAtBlocking( XBeeDevice* const p_device = NULL,
-                            const uint16_t p_timeout = 1000, 
-                            const uint16_t p_slice = 100);
-       
-       /** Destructor */
-       virtual ~XBeeApiCmdAtBlocking( void ) {};
- 
-       /* Implement XBeeApiCmdAt's virtual methods */
-       
-        virtual bool getHardwareVersion( uint16_t* const p_ver );
-        virtual bool getFirmwareVersion( uint16_t* const p_ver );
-        virtual bool getSerialNumber( uint64_t* const p_sn );
+        /* TODO: Add protection to prevent p_interval being too small - see data sheet */
+        virtual bool getSampleRate( uint16_t* const p_interval );
+        virtual bool setSampleRate( const uint16_t p_interval );
+
+        virtual bool getDestinationAddress( uint64_t* const p_address );
+        virtual bool setDestinationAddress( const uint64_t p_address );
 
-        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 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 );
+        virtual bool getDestinationAddressHigh( uint32_t* const p_address );
+        virtual bool setDestinationAddressHigh( const uint32_t p_address );
 
-        virtual bool getSourceAddress( uint16_t* const p_addr );       
-        virtual bool setSourceAddress( const uint16_t p_addr );  
-       
-        virtual bool getRetries( uint8_t* const p_addr );       
-        virtual bool setRetries( const uint8_t p_addr );       
+        virtual bool getDestinationAddressLow( uint32_t* const p_address );
+        virtual bool setDestinationAddressLow( const uint32_t p_address );
 
-        virtual bool getRandomDelaySlots( uint8_t* const p_addr );       
-        virtual bool setRandomDelaySlots( const uint8_t p_addr );       
-
-        virtual bool getMacMode( XBeeApiMACMode_e* const p_mode );       
-        virtual bool setMacMode( const XBeeApiMACMode_e p_mode );  
-        
-        virtual bool getDioConfig( const uint8_t p_chanNo, XBeeApiDioConfig_e* const p_conf );
-        virtual bool setDioConfig( const uint8_t p_chanNo, const XBeeApiDioConfig_e p_conf );
-     
 };
 
 #endif
\ No newline at end of file