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:
32:af4e495afd62
Parent:
31:c144106e55b5
Child:
50:f76b7e7959a2
--- a/Utility/XBeeApiCmdAt.hpp	Thu Feb 06 22:26:27 2014 +0000
+++ b/Utility/XBeeApiCmdAt.hpp	Fri Feb 07 21:17:32 2014 +0000
@@ -55,6 +55,13 @@
         typedef uint16_t panId_t;
         /** Type to represent a wireless channel number */
         typedef uint8_t  channel_t;
+        /** Type to represent the different MAC modes supported by the XBee */
+        typedef enum {
+            XBEE_API_MAC_MODE_DIGI_ACK        = 0,
+            XBEE_API_MAC_MODE_802_15_4_NO_ACK = 1,
+            XBEE_API_MAC_MODE_802_15_4_ACK    = 2,
+            XBEE_API_MAC_MODE_DIGI_NO_ACK     = 3,
+        } XBeeApiMACMode_e;
     
     protected:
         /** Indicates whether or not m_hwVer contains data retrieved from the XBee */
@@ -70,6 +77,11 @@
         /** Indicates whether or not m_CE contains data retrieved from the XBee */
         bool m_have_CE;
         bool m_have_sourceAddress;
+        bool m_have_snLow;
+        bool m_have_snHigh;
+        bool m_have_retries;
+        bool m_have_randomDelaySlots;
+        bool m_have_macMode;
         
         uint16_t m_hwVer;
         uint16_t m_fwVer;
@@ -83,6 +95,14 @@
         bool m_CEPend;
         uint16_t m_sourceAddress;
         uint16_t m_sourceAddressPend;
+        uint32_t m_snLow;
+        uint32_t m_snHigh;
+        uint8_t  m_retries;
+        uint8_t  m_retriesPend;
+        uint8_t  m_randomDelaySlots;
+        uint8_t  m_randomDelaySlotsPend;
+        XBeeApiMACMode_e m_macMode;
+        XBeeApiMACMode_e m_macModePend;
 
         /** Template class to create an XBeeApiFrame which can be used to change
             the value of one of the XBee parameters.  This class is used by the
@@ -130,6 +150,22 @@
         bool requestEndDeviceAssociationEnabled( void );
         bool requestPanId( void );
         bool requestSourceAddress( void );
+        bool requestSerialNumber( 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
+            specifies an additional multiple of 3 retries
+            As the data is retrieved asynchronously to this call,
+            once the response is received it can be accessed via
+            getRetries() 
+        */
+        bool requestRetries( void );
+        
+        /** Request the minimum value of the back-off exponent in the CSMA-CA algorithm
+            used in collision avoidance.
+        */
+        bool requestRandomDelaySlots( void );
+        
+        bool requestMacMode( void );
 
         /** Read the XBee's hardware version identifier.  
        
@@ -144,22 +180,32 @@
             XBee - the identifier must previously have been requested 
             via requestFirmwareVersion().  The method is non-blocking. */
         virtual bool getFirmwareVersion( uint16_t* const p_ver );
+
+        virtual bool getSerialNumber( uint64_t* const p_sn );
        
-       virtual bool getChannel( uint8_t* const p_chan );
-       virtual bool setChannel( uint8_t const p_chan );
+        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 getCoordinatorEnabled( bool* const p_en );
+        virtual bool setCoordinatorEnabled( const bool p_en );
+       
+        virtual bool getEndDeviceAssociationEnabled( bool* const p_en ); 
+        virtual bool setEndDeviceAssociationEnabled( 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 getPanId( panId_t* const p_id );       
+        virtual bool setPanId( const panId_t p_id );       
+
+        virtual bool getSourceAddress( uint16_t* const p_addr );       
+        virtual bool setSourceAddress( const uint16_t p_addr );       
 
-       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 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 );       
 };
 
 /** Class to access the configuration interface of the XBee.
@@ -205,6 +251,7 @@
        
        virtual bool getHardwareVersion( uint16_t* const p_ver );
        virtual bool getFirmwareVersion( uint16_t* const p_ver );
+        virtual bool getSerialNumber( uint64_t* const p_sn );
 
        virtual bool getChannel( uint8_t* const p_chan );
        virtual bool setChannel( uint8_t const p_chan );
@@ -219,7 +266,16 @@
        virtual bool setPanId( const panId_t p_id );
 
        virtual bool getSourceAddress( uint16_t* const p_addr );       
-       virtual bool setSourceAddress( const uint16_t 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 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 );       
 };
 
 #endif
\ No newline at end of file