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:
56:7fe74b03e6b1
Parent:
55:610aa4a2ed3b
--- a/Utility/XBeeApiCmdAt.hpp	Sat Aug 02 16:41:14 2014 +0000
+++ b/Utility/XBeeApiCmdAt.hpp	Fri Aug 08 11:59:52 2014 +0000
@@ -86,8 +86,8 @@
     FP         |
     AS         |
     ED         |
-    EE         |
-    KY         |
+    EE         | requestEncryptionEnabled, setEncryptionEnabled, getEncryptionEnabled
+    KY         | setEncryptionKey, getEncryptionKeySet
     PL         |
     CA         |
     SM         |
@@ -197,6 +197,8 @@
         bool m_have_sampleRate;
         bool m_have_destHigh;
         bool m_have_destLow;
+        bool m_have_encryptionEnabled;
+        bool m_keySet;
  
         
         uint16_t m_hwVer;
@@ -236,6 +238,8 @@
         uint32_t m_resetCount; 
         uint32_t m_sampleCount;
         uint32_t m_restoreCount;
+        bool     m_encryptionEnabled;
+        bool     m_encryptionEnabledPend;
         
         time_t   m_ioDigitalUpdatedTime[ XBEE_API_DIO_CHANNEL_COUNT ];
         bool     m_ioDigitalState[ XBEE_API_DIO_CHANNEL_COUNT ];
@@ -243,18 +247,24 @@
         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,
-                                      const uint8_t&       p_val );
-        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 );
-
+        void SendCmd_uint8_t( const uint8_t        p_frameId,
+                              const uint8_t* const p_data,
+                              const uint8_t&       p_val );
+        void SendCmd_uint8_t( const uint8_t        p_frameId,
+                              const uint8_t* const p_data,
+                              const uint8_t*       p_val );
+        void SendCmd_uint16_t( const uint8_t        p_frameId,
+                               const uint8_t* const p_data,
+                               const uint16_t&       p_val );
+        void SendCmd_uint32_t( const uint8_t        p_frameId,
+                               const uint8_t* const p_data,
+                               const uint32_t&       p_val );
+                               
+        virtual void SendCmd( const uint8_t p_frameId,
+                              const uint8_t* const p_data,
+                              const uint8_t* const p_val,
+                              const uint8_t        p_len );
+                      
         virtual size_t getResponseStatusPos( void ) const;
 
 
@@ -322,6 +332,7 @@
         bool requestReset( void );
         bool requestForceSample( void );
         bool requestRestoreDefaults( void );
+        bool requestEncryptionEnabled( void );
 
         /** Read the XBee's hardware version identifier.  
        
@@ -389,6 +400,30 @@
         virtual bool getDestinationAddressLow( uint32_t* const p_address );
         virtual bool setDestinationAddressLow( const uint32_t p_address );
 
+        /** Set the encryption key used by the XBee.  This key will only
+            be used if encryption is enabled (see setEncryptionEnable ).
+            Once set the key cannot be read back.
+            
+            \param p_key Pointer to a 16-byte array, with the first array
+                         entry containing the most significant 8 bits of the
+                         128-bit key
+        */
+        virtual bool setEncryptionKey( const uint8_t* p_key );
+        
+        /** Determine whether or not a call to setEncryptionKey has successfully
+            set the key in the XBee.  Note that this will not query the key stored
+            in the XBee and will only evern return true if a call to setEncryptionKey
+            was made
+            
+            \returns true in the case that the XBee has responded to confirm that
+                          a call to setEncryptionKey was successful
+        */
+        virtual bool getEncryptionKeySet( void );
+        
+        virtual bool getEncryptionEnabled( bool* const p_enabled );
+        virtual bool setEncryptionEnabled( const bool  p_enabled );
 };
 
+#define XBEE_CMD_MAX_PARAM_LENGTH (16U)
+
 #endif
\ No newline at end of file