added start and end range to begin method; added generic distance and strenght methods

Author: gigapod

src/sfTk/sfDevXM125Distance.cpp

@@ -41,7 +41,7 @@ sfTkError_t sfDevXM125Distance::begin(sfTkII2C *theBus)
     return ksfTkErrOk;
 }
 //------------------------------------------------------------------
-int32_t sfDevXM125Distance::distanceBegin()
+int32_t sfDevXM125Distance::distanceBegin(uint32_t startRange, uint32_t endRange)
 {
     uint32_t errorStatus = 0;
 
@@ -64,20 +64,20 @@ int32_t sfDevXM125Distance::distanceBegin()
     }
 
     // Set Start register
-    if (setDistanceStart(sfe_xm125_distance_start_default) != 0)
+    if (setDistanceStart(startRange) != 0)
     {
         return 3;
     }
     sftk_delay_ms(100); // give time for command to set
 
     // Set End register
-    if (setDistanceEnd(sfe_xm125_distance_end_default) != 0)
+    if (setDistanceEnd(endRange) != 0)
     {
         return 4;
     }
     sftk_delay_ms(100); // give time for command to set
 
-    // Apply configuration
+    // Apply configuration and calibrate.
     if (setDistanceCommand(SFE_XM125_DISTANCE_APPLY_CONFIGURATION) != 0)
     {
         // Check for errors
@@ -363,6 +363,49 @@ sfTkError_t sfDevXM125Distance::getDistanceTemperature(int16_t &temperature)
     return retVal;
 }
 
+//--------------------------------------------------------------------------------
+// Generic distance peak distance method
+sfTkError_t sfDevXM125Distance::getDistancePeakDistance(uint8_t num, uint32_t &peak)
+{
+
+    switch (num)
+    {
+    case 0:
+        return getDistancePeak0Distance(peak);
+        break;
+
+    case 1:
+        return getDistancePeak1Distance(peak);
+        break;
+    case 2:
+        return getDistancePeak2Distance(peak);
+        break;
+    case 3:
+        return getDistancePeak3Distance(peak);
+        break;
+    case 4:
+        return getDistancePeak4Distance(peak);
+        break;
+    case 5:
+        return getDistancePeak5Distance(peak);
+        break;
+    case 6:
+        return getDistancePeak6Distance(peak);
+        break;
+    case 7:
+        return getDistancePeak7Distance(peak);
+        break;
+    case 8:
+        return getDistancePeak8Distance(peak);
+        break;
+    case 9:
+        return getDistancePeak9Distance(peak);
+        break;
+    default:
+        return ksfTkErrFail;
+        break;
+    }
+}
 //--------------------------------------------------------------------------------
 sfTkError_t sfDevXM125Distance::getDistancePeak0Distance(uint32_t &peak)
 {
@@ -462,7 +505,49 @@ sfTkError_t sfDevXM125Distance::getDistancePeak9Distance(uint32_t &peak)
     peak = sftk_byte_swap(peak);
     return retVal;
 }
+//--------------------------------------------------------------------------------
+// Generic distance peak strength method
+sfTkError_t sfDevXM125Distance::getDistancePeakStrength(uint8_t num, int32_t &peak)
+{
 
+    switch (num)
+    {
+    case 0:
+        return getDistancePeak0Strength(peak);
+        break;
+
+    case 1:
+        return getDistancePeak1Strength(peak);
+        break;
+    case 2:
+        return getDistancePeak2Strength(peak);
+        break;
+    case 3:
+        return getDistancePeak3Strength(peak);
+        break;
+    case 4:
+        return getDistancePeak4Strength(peak);
+        break;
+    case 5:
+        return getDistancePeak5Strength(peak);
+        break;
+    case 6:
+        return getDistancePeak6Strength(peak);
+        break;
+    case 7:
+        return getDistancePeak7Strength(peak);
+        break;
+    case 8:
+        return getDistancePeak8Strength(peak);
+        break;
+    case 9:
+        return getDistancePeak9Strength(peak);
+        break;
+    default:
+        return ksfTkErrFail;
+        break;
+    }
+}
 //--------------------------------------------------------------------------------
 sfTkError_t sfDevXM125Distance::getDistancePeak0Strength(int32_t &peak)
 {

src/sfTk/sfDevXM125Distance.h

@@ -163,11 +163,11 @@ const uint16_t SFE_XM125_DISTANCE_PEAK7_STRENGTH = 0x22;
 const uint16_t SFE_XM125_DISTANCE_PEAK8_STRENGTH = 0x23;
 const uint16_t SFE_XM125_DISTANCE_PEAK9_STRENGTH = 0x24;
 
-// Default Value: 250
+// Default Value: 250mm
 const uint16_t SFE_XM125_DISTANCE_START = 0x40;
 const uint16_t sfe_xm125_distance_start_default = 250;
 
-// Default Value: 3000
+// Default Value: 3000mm
 const uint16_t SFE_XM125_DISTANCE_END = 0x41;
 const uint16_t sfe_xm125_distance_end_default = 3000;
 
@@ -283,7 +283,8 @@ class sfDevXM125Distance : public sfDevXM125Core
     /// @brief This function sets all the beginning values for a basic I2C
     ///  example to be run on the device for presence sensing.
     /// @return ksfTkErrOk on success, or error code (value < -1)
-    sfTkError_t distanceBegin();
+    sfTkError_t distanceBegin(uint32_t start = sfe_xm125_distance_start_default,
+                              uint32_t end = sfe_xm125_distance_end_default);
 
     /// @brief This function does all the required checks and busy waits to
     ///  make sure the device is ready for distance readings.
@@ -344,6 +345,15 @@ class sfDevXM125Distance : public sfDevXM125Core
     /// @return ksfTkErrOk on success, or error code (value < -1)
     sfTkError_t getDistanceTemperature(int16_t &temperature);
 
+    //--------------------------------------------------------------------------------
+    // Generic distance peak distance method
+    /// @brief This function returns the distance to peak num
+    ///  Note: This value is a factor 1000 larger than the RSS value
+    /// @param num Peak number to get distance (0-9)
+    /// @param peak Distance to peak num
+    /// @return ksfTkErrOk on success, or error code (value < -1)
+    sfTkError_t getDistancePeakDistance(uint8_t num, uint32_t &peak);
+
     /// @brief This function returns the distance to peak 0
     ///  Note: This value is a factor 1000 larger than the RSS value
     /// @return ksfTkErrOk on success, or error code (value < -1)
@@ -394,6 +404,15 @@ class sfDevXM125Distance : public sfDevXM125Core
     /// @return ksfTkErrOk on success, or error code (value < -1)
     sfTkError_t getDistancePeak9Distance(uint32_t &peak);
 
+    //--------------------------------------------------------------------------------
+    // Generic distance peak strength method
+    /// @brief This function returns the strength to peak num
+    ///  Note: This value is a factor 1000 larger than the RSS value
+    /// @param num Peak number to get strength (0-9)
+    /// @param peak strength to peak num
+    /// @return ksfTkErrOk on success, or error code (value < -1)
+    sfTkError_t getDistancePeakStrength(uint8_t num, int32_t &peak);
+
     /// @brief This function returns the strength of peak 0
     ///  Note: This value is a factor 1000 larger than the RSS value
     /// @return ksfTkErrOk on success, or error code (value < -1)