Diff: scp1000.h

Revision:

2:076ba33b1895

Parent:

1:a45810688644

Child:

3:29c98bdee20b

--- a/scp1000.h	Mon Sep 27 08:30:39 2010 +0000
+++ b/scp1000.h	Mon Sep 27 09:13:32 2010 +0000
@@ -22,7 +22,7 @@
 * 
 *
 * @section DESCRIPTION
-*
+*  Library for using the SCP1000-D01 MEMS Pressure sensor
 *
 */
 
@@ -33,7 +33,7 @@
 #include "mbed.h"
 /**
 * Class to allow reading of the SCP1000-D01 mems pressure sensor (SPI mode). The class currently only supports High resolution mode.
-* This means that the snesor can be read at a maximum rate of 1.8Hz.
+* This means that the sensor can be read at a maximum rate of 1.8Hz.
 */
 class SCP1000{
 public:
@@ -44,8 +44,6 @@
                     LOWPOWER,
                     POWERDOWN}SCPMode;
                     
-    
-    //Constructors - to be Overloaded for different read modes - ie different pins connected up
     /**
     *Constructor 
     * 
@@ -55,7 +53,7 @@
     */
     SCP1000(PinName mosi, PinName miso, PinName sck, PinName CSB);
 
-    //Methods
+    
     void SetMode(SCPMode mode);
     
     /**
@@ -77,16 +75,17 @@
 
 private:
     SCPMode _mode;
-
-    int _isReady();
-
-
+    /**
+    * Method which blocks until the sensor is ready to be read.
+    * Returns 1 when successful.
+    */
+    int _waitReady();
     //Interfaces
     SPI _spi;
     DigitalOut _CSB;
-   // DigitalIn _DRDY;        //Interrupt data ready - also need to be able to attach a function to this class
+   // DigitalIn _DRDY;    //Interrupt data ready - also need to be able to attach a function to this class
    // DigitalOut _TRIG;   //Trigger        
-   // DigitalOut _PD;      //Power Down
+   // DigitalOut _PD;     //Power Down
 
 
 };