Merge pull request finitespace#70 from finitespace/absHum

Updating readme. Changing abs hum return to be float consistent with do…
FTTechBrasil · Dec 23, 2017 · 9789292 · 9789292
2 parents 8ba6cb9 + 7c4b937
commit 9789292
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -28,7 +28,7 @@ Provides an Arduino library for reading and interpreting Bosch BME280 data over
 
 9. [Environment Calculations](#environment-calculations)
       - [float Altitude(float pressure, bool metric = true, float seaLevelPressure = 101325)](#environment-calculations)
-      - [float AbsoluteHumidty(float temperature, float humidity,TempUnit tempUnit = TempUnit_Celsius)](#environment-calculations)
+      - [float AbsoluteHumidity(float temperature, float humidity, TempUnit tempUnit = TempUnit_Celsius)](#environment-calculations)
       - [float EquivalentSeaLevelPressure(float altitude, float temp, float pres)](#environment-calculations)
       - [float DewPoint(float temp, float hum, bool metric = true)](#environment-calculations)
       - [int HeatIndex(float temperature, float humidity, TempUnit tempunit = TempUnit_Celsius)](#environment-calculations)
@@ -318,7 +318,7 @@ or
       values: TempUnit_Celsius = return degrees Celsius, TempUnit_Fahrenheit = return degrees Fahrenheit
 ```
 
-#### float AbsoluteHumidty(float temperature, float humidity, TempUnit = TempUnit_Celsius)
+#### float AbsoluteHumidity(float temperature, float humidity, TempUnit = TempUnit_Celsius)
 
   Calculate the absolute humidity based on the temperature and humidity with the specified units.
 ```

diff --git a/examples/Environment_Calculations/Environment_Calculations.ino b/examples/Environment_Calculations/Environment_Calculations.ino
@@ -121,7 +121,7 @@ void printBME280Data
    /// It is necessary to use fixed altitude point e.g. the altitude of barometer read in a map
    float seaLevel = EnvironmentCalculations::EquivalentSeaLevelPressure(barometerAltitude, temp, pres, envAltUnit, envTempUnit);
 
-   double absHum = EnvironmentCalculations::AbsoluteHumidity(temp, hum, envTempUnit);
+   float absHum = EnvironmentCalculations::AbsoluteHumidity(temp, hum, envTempUnit);
 
    client->print("\t\tAltitude: ");
    client->print(altitude);

diff --git a/src/EnvironmentCalculations.cpp b/src/EnvironmentCalculations.cpp
@@ -17,7 +17,7 @@ You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 Written: Dec 30 2015.
-Last Updated: Jan 1 2016. - Happy New year!
+Last Updated: Dec 23 2017. 
 
 This header must be included in any derived code or copies of the code.
 
@@ -55,7 +55,7 @@ float EnvironmentCalculations::Altitude
 
 
 /****************************************************************/
-double EnvironmentCalculations::AbsoluteHumidity
+float EnvironmentCalculations::AbsoluteHumidity
 (
   float temperature, 
   float humidity,
@@ -67,7 +67,7 @@ double EnvironmentCalculations::AbsoluteHumidity
   //August-Roche-Magnus 	6.1094 exp(17.625 x T)/(T + 243.04)
   //Buck (1981) 		6.1121 exp(17.502 x T)/(T + 240.97)
   //reference https://www.eas.ualberta.ca/jdwilson/EAS372_13/Vomel_CIRES_satvpformulae.html
-  double temp = NAN;
+  float temp = NAN;
   const float mw = 18.01534; 	// molar mass of water g/mol
   const float r = 8.31447215; 	// Universal gas constant J/mol/K
 

diff --git a/src/EnvironmentCalculations.h b/src/EnvironmentCalculations.h
@@ -1,6 +1,6 @@
 /*
 
-BME280.h
+EnvironmentCalculations.h
 
 This code records data from the BME280 sensor and provides an API.
 This file is part of the Arduino BME280 library.
@@ -88,7 +88,7 @@ namespace EnvironmentCalculations
   /// @param humidity in percentage
   /// @param tempUnit in °C. default=TempUnit_Celsius
   /// @return Calculated absolute humidity in grams/m³
-  double AbsoluteHumidity
+  float AbsoluteHumidity
   (
     float temperature, 
     float humidity,