Mustafa Kanli / MaxSonar

Class to read range measurements from a MaxBotix MaxSonar ranging device.

Dependents:   BETAGO CleaningMachine_Betago clean_V1 CleaningM-Palm ... more

Files at this revision

API Documentation at this revision

Revision 1:b439ab68c8d9, committed 2010-12-14

Comitter:
mkanli
Date:
Tue Dec 14 12:13:42 2010 +0000
Parent:
0:18790852a055
Commit message:
Some comment fixes.

Changed in this revision

MaxSonar.h Show annotated file Show diff for this revision Revisions of this file 
diff -r 18790852a055 -r b439ab68c8d9 MaxSonar.h
--- a/MaxSonar.h	Tue Dec 14 12:08:17 2010 +0000
+++ b/MaxSonar.h	Tue Dec 14 12:13:42 2010 +0000
@@ -28,11 +28,9 @@
  * Supported devices:
  * 1) LV-MaxSonar: -EZ0 MB1000, -EZ1 MB1010, -EZ2 MB1020,
  *                 -EZ3 MB1030, -EZ4 MB1040
- * 2) @todo add more?
  *
  * Supported modes:
  * 1) Analog.
- * 2) @todo add more?
  */
 #ifndef MAXSONAR_H_
 #define MAXSONAR_H_
@@ -41,7 +39,7 @@
 
 //! Define types of MaxSonar devices.
 enum MSType {
-    MS_LV = 0,
+    MS_LV = 0,      //!< Supported.
     MS_WR,          //!< Not supported yet.
     MS_WRC,         //!< Not supported yet.
     MS_XL,          //!< Not supported yet.
@@ -56,7 +54,7 @@
 
 //! Define access mode for obtaining range measurement.
 enum MSMode {
-    MS_ANALOG = 0,
+    MS_ANALOG = 0,  //!< Supported.
     MS_SERIAL,      //!< Not supported yet.
     MS_PWM          //!< Not supported yet.
 };
@@ -91,6 +89,7 @@
  *         printf("Range: %.3f cm\n", r);
  *         wait(0.5);
  *     }
+ * }
  * @endcode 
  */
 class MaxSonar {