add methods for % and ration; max value macro; change default ID macro to SHOUTING

Author: gigapod

src/sfeTk/sfeDevSoilMoisture.cpp

@@ -65,6 +65,22 @@ uint16_t sfeDevSoilMoisture::readMoistureValue(void)
     return value;
 }
 
+//----------------------------------------------------------------------------------------
+// Returns the moisture ratio from the sensor (0 - 1.0)
+float sfeDevSoilMoisture::readMoistureRatio(void)
+{
+    if (_theBus == nullptr)
+        return 0.0;
+
+    return (((float)SFE_SOIL_MOISTURE_MAX_VALUE - (float)readMoistureValue()) / (float)SFE_SOIL_MOISTURE_MAX_VALUE);
+}
+
+//----------------------------------------------------------------------------------------
+// Returns the moisture percentage from the sensor (0 - 100%)
+float sfeDevSoilMoisture::readMoisturePercentage(void)
+{
+    return readMoistureRatio() * 100.0;
+}
 //----------------------------------------------------------------------------------------
 sfeTkError_t sfeDevSoilMoisture::changeSensorAddress(uint8_t newAddress)
 {

src/sfeTk/sfeDevSoilMoisture.h

@@ -15,7 +15,11 @@
 #include "sfeTk/sfeTkII2C.h"
 #include <sfeTk/sfeToolKit.h>
 
-#define kSfeDevSoilMoistureDefaultI2CAddress 0x28
+// Default I2C address for the sensor
+#define SFE_SOIL_MOISTURE_DEFAULT_I2C_ADDRESS 0x28
+
+// Max value for  the sensor value (10-bit ADC) 2^10  = 1024-1
+#define SFE_SOIL_MOISTURE_MAX_VALUE 1023
 
 class sfeDevSoilMoisture
 {
@@ -43,6 +47,14 @@ class sfeDevSoilMoisture
     /// @return The moisture value - a resistance reading between 0 and 1023
     uint16_t readMoistureValue(void);
 
+    /// @brief Reads the sensor value and returns the moisture ratio from the sensor (0 - 1.0)
+    /// @return The moisture ratio
+    float readMoistureRatio(void);
+
+    /// @brief Reads the sensor value and returns the moisture percentage from the sensor (0 - 100%)
+    /// @return The moisture percentage
+    float readMoisturePercentage(void);
+
     /// @brief Changes the I2C address of the sensor
     /// @param newAddress The new I2C address to assign to the sensor
     /// @return kSTkErrOk if successful, otherwise an error code