Fabio Durigon / SRF02

Based on Robinson Lopez Monzon library: This library contains all the functions necesary to perform an application using the SRF02 sensor. Modified by Dury: replaced wait() functions that are not usefull for program performance. Esta librería contiene los métodos necesarios para poder configurar todos los parámetros del sensor SRF02.

Fork of SRF02 by Fabio Durigon

Diff: SRF02.h

Revision:
1:d624771f0bd3
Parent:
0:559a18121e83
--- a/SRF02.h	Fri Feb 25 17:23:42 2011 +0000
+++ b/SRF02.h	Sat Feb 09 22:26:47 2013 +0000
@@ -4,34 +4,38 @@
 #include "mbed.h"
 
 
-
+/** Library to control SRF02 ultrasonic sensor */
 class SRF02
 {
-public:
-  //!Creates an instance of the class.
-  /*!
-  Connect module at I2C address addr using I2C port pins sda and scl.
-  SRF08
-  */
-  SRF02(PinName sda, PinName scl, int addr);
+ public:
+    /** Creates an instance of the class
+    *
+    * @param sda I2C sda Pin
+    * @param scl I2C scl Pin
+    */
+    SRF02(PinName sda, PinName scl, int addr);
   
-  /*!
-  Destroys instance.
-  */ 
-  ~SRF02();
+    /** Destroys instance */
+    ~SRF02();
   
-  
-  int readcm();     //Read the range data in centimeters
- 
-  int readinch();   //Read the range data in inches
+    /** Read the range data in centimeters */
+    int readcm();     
+
+    /** Read the range data in inches */
+    int readinch();
   
-  void change_addr(char new_addr);      //Change the adress of the device. This is very usefull when there are more sensors.
-                                        //This function must be executed with only one sensor conected.
-  
+    /** Change the adress of the device. This is very usefull when there are more sensors.
+    * This function must be executed with only one sensor conected.
+    */
+    void change_addr(char new_addr);
   
-private:
-  I2C m_i2c;
-  int m_addr;
+ private:
+    /** wait for ranging to complete
+    * This function is for internal use
+    */
+    void wait_ranging(void);                                        
+    I2C m_i2c;
+    int m_addr;
 
 };