Revision 19:c7a9d77d9617, committed 2011-11-16

Comitter:

yamaguch

Date:

Wed Nov 16 03:28:00 2011 +0000

Parent:

18:265de0e55068

Commit message:

Changed in this revision

diff -r 265de0e55068 -r c7a9d77d9617 XBee.h
--- a/XBee.h	Wed Nov 16 03:10:11 2011 +0000
+++ b/XBee.h	Wed Nov 16 03:28:00 2011 +0000
@@ -35,70 +35,130 @@
  */
 class XBee : public Serial {
 public:
-
+    /**
+     * Frame type enumeration for XBee API frames
+     */
     enum FrameType {
         /**
-        * No Data
+        * Empty data
         */
         None = 0,
+        
         /**
-         *  AT Command Response
+         *  AT Command Response API frame
          */
         ATCommandResponse,
+        
         /**
-         * Modem Status
+         * Modem Status API frame
          */
         ModemStatus,
-
-        /** ZigBee Transmit Status */
+        
+        /**
+         * ZigBee Transmit Status API frame
+         */
         ZigBeeTransmitStatus,
+        
 
-        //* ZigBeeReceivePacket
+        /**
+         * ZigBee Receive Packet API frame
+         */
         ZigBeeReceivePacket,
 
         /**
+         *  ZigBee Explicit Rx Indicator API frame
          */
         ZigBeeExplicitRxIndicator,
 
         /**
+         * ZigBee I/O Data Sample Rx Indicator API frame
          */
         ZigBeeIODataSampleRxIndicator,
 
         /**
+         * XBee Sensor Read Indicator API frame
          */
         XBeeSensorReadIndicator,
 
         /**
+         * Node Identification Indicator API frame
          */
         NodeIdentificationIndicator,
 
         /**
+         * Remote Command Response API frame
          */
         RemoteCommandResponse,
 
         /**
-        */
+         * Unknown API frame
+         */
         Other
     };
     
     /**
-    * ValueType declaration for frame data content
-    */
+     * Value type enumeration for frame data contents
+     */
     enum ValueType {
+    
         /**
-        * FrameID
-        */
+         * Frame ID
+         */
         FrameID,
+        
+        /**
+         *AT command name
+         */
         ATCommand,
+        
+        /**
+         * Status
+         */       
         Status,
+        
+        /**
+         * Command data
+         */
         CommandData,
+        
+        /**
+         * 16 bit address
+         */
         Address16,
+        
+        /**
+         * 64 bit address
+         */
         Address64,
+        
+        /**
+         * Retry count
+         */
         RetryCount,
+        
+        /**
+         * Delivery status
+         */
         DeliveryStatus,
+        
+        /**
+         * Discovery status
+         */
         DiscoveryStatus,
+        
+        /**
+         * Receive option
+         */
         ReceiveOptions,
+        
+        /**
+         * Received data
+         */
         ReceivedData,
+        
+        /**
+         * Raw data
+         */
         RawData
     };