SCP1000-D01 MEMS pressure sensor library
Diff: scp1000.h
- Revision:
- 4:d509ab38e2b5
- Parent:
- 3:29c98bdee20b
--- a/scp1000.h Mon Sep 27 11:43:27 2010 +0000 +++ b/scp1000.h Tue Sep 28 08:28:48 2010 +0000 @@ -26,10 +26,11 @@ * */ - #ifndef SCP1000_D01_H_ #define SCP1000_D01_H_ - +/** +* Includes +*/ #include "mbed.h" /** * Class to allow reading of the SCP1000-D01 mems pressure sensor (SPI mode). The class currently only supports High resolution mode. @@ -47,17 +48,17 @@ SCP1000(PinName mosi, PinName miso, PinName sck, PinName CSB); /** - *Read the current Pressure. - *This blocks until the sensor has completed a reading + * Read the current Pressure. + * This blocks until the sensor has completed a reading * - * @returns The pressure in pascals + * @returns The pressure in pascals (N/m2) */ float read(); /** * Reads the temperature as measured by the SCP1000. * This blocks until the sensor has completed a reading * - *returns The temperature in degrees celsius + *@returns The temperature in degrees celsius */ float readTemperature(); @@ -66,7 +67,7 @@ private: /** * Method which blocks until the sensor is ready to be read. - * Returns 1 when successful. + * @returns 1 when successful. */ int _waitReady(); //Interfaces