Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jaxxzer committed Apr 10, 2017
1 parent 7261741 commit 7da2537
Showing 1 changed file with 4 additions and 7 deletions.
11 changes: 4 additions & 7 deletions README.md
Expand Up @@ -11,7 +11,10 @@ Please see the examples for normal operation. Below are the available functions
``` cpp
MS5837();

void init();
/** Must be called before attempting to operate the sensor.
* Returns true if the sensor was initialized successfully.
*/
bool init();

/** Set model of MS5837 sensor. Valid options are MS5837::MS5837_30BA (default)
* and MS5837::MS5837_02BA.
Expand All @@ -27,12 +30,6 @@ void setFluidDensity(float density);
*/
void read();

/** This function loads the datasheet test case values to verify that
* calculations are working correctly. No example checksum is provided
* so the checksum test may fail.
*/
void readTestCase();

/** Pressure returned in mbar or mbar*conversion rate.
*/
float pressure(float conversion = 1.0f);
Expand Down

0 comments on commit 7da2537

Please sign in to comment.