Begin function completed

Adjusted keywords and associated files for adjusting begin function. General presence and distance detection begin functions have been deleted and there is only one begin function now

Author: MadisonC-SparkFun

keywords.txt

@@ -17,7 +17,6 @@ sfe_xm125_presence_command_t KEYWORD1
 #########################################################
 
 begin KEYWORD2
-distanceBegin KEYWORD2
 getDistanceDetectorVersion KEYWORD2
 getDistanceDetectorError KEYWORD2
 getDistanceMeasureCounter KEYWORD2
@@ -76,7 +75,6 @@ setDistanceFixedStrengthThresholdValue KEYWORD2
 getDistanceMeasureOneWakeup KEYWORD2
 setDistanceMeasureOneWakeup KEYWORD2
 setDistanceCommand KEYWORD2
-presenceBegin KEYWORD2
 getPresenceDetectorVersion KEYWORD2
 getPresenceDetectorError KEYWORD2
 getPresenceMeasureCounter KEYWORD2

src/sfeQwiicXM125.cpp

@@ -22,38 +22,30 @@ bool QwDevXM125::begin(sfeTkII2C *theBus)
     // Sets communication bus 
     _theBus = theBus;
 
-    
-    // TODO: Check if device is connected
-
-    // TODO: Initialize hardware
-
-
-    // Turn the sensor on
-    //acc_hal_integration_sensor_supply_on(SENSOR_ID);
-    
-
-    // Create the sensor
-    //create_sensor(&detector_resources);
-
-
-
-    // Handle GPIO outputs and commands
-
-    // Clear busy bit once the handler is complete 
-    // Set ready pin HIGH when command processing is done
-
-    // TODO: Return whether successful
+    // Check errors from device 
+    uint32_t distanceError = 0;
+    uint32_t presenceError = 0;
+    int32_t distFuncErr = getDistanceDetectorError(&distanceError);
+    int32_t presFuncErr = getDistanceDetectorError(&presenceError);
+    if(distanceError != 0 )
+    {
+        return -1;
+    }
+    if(presenceError != 0)
+    {
+        return -2;
+    }
+    if((distFuncErr != 0)|| (presFuncErr != 0))
+    {
+        return -3;
+    }
 
+    // If no errors, return 0
     return 0;
 }
 
 // --------------------- I2C Disance Detector Functions ---------------------
 
-int32_t QwDevXM125::distanceBegin()
-{
-    return 0;
-}
-
 int32_t QwDevXM125::getDistanceDetectorVersion(uint8_t *major, uint8_t *minor, uint8_t *patch)
 {
     int32_t retVal;
@@ -70,7 +62,7 @@ int32_t QwDevXM125::getDistanceDetectorVersion(uint8_t *major, uint8_t *minor, u
     return retVal;
 }
 
-int32_t QwDevXM125::getDistanceDetectorError(sfe_xm125_distance_protocol_status_t *error)
+int32_t QwDevXM125::getDistanceDetectorError(uint32_t *error)
 {
     // Read from 16-Bit Register
     return _theBus->read16BitRegisterRegion(SFE_XM125_DISTANCE_PROTOCOL_STATUS, (uint8_t*)error, 4);
@@ -318,12 +310,12 @@ int32_t QwDevXM125::setDistanceMaxProfile(sfe_xm125_distance_profile_t profile)
     return _theBus->write16BitRegisterRegion(SFE_XM125_DISTANCE_MAX_PROFILE, (uint8_t*)profile, 4);
 }
 
-int32_t QwDevXM125::getDistanceThresholdMethod(sfe_xm125_threshold_method_t *method)
+int32_t QwDevXM125::getDistanceThresholdMethod(sfe_xm125_distance_threshold_method_t *method)
 {
     return _theBus->read16BitRegisterRegion(SFE_XM125_DISTANCE_THRESHOLD_METHOD, (uint8_t*)method, 4);
 }
 
-int32_t QwDevXM125::setDistanceThresholdMethod(sfe_xm125_threshold_method_t method)
+int32_t QwDevXM125::setDistanceThresholdMethod(sfe_xm125_distance_threshold_method_t method)
 {
     return _theBus->write16BitRegisterRegion(SFE_XM125_DISTANCE_THRESHOLD_METHOD, (uint8_t*)method, 4);
 }
@@ -405,11 +397,6 @@ int32_t QwDevXM125::setDistanceCommand(sfe_xm125_distance_command_t *command)
 
 // --------------------- I2C Presence Detector Functions ---------------------
 
-int32_t QwDevXM125::presenceBegin()
-{
-    return 0;
-}
-
 int32_t QwDevXM125::getPresenceDetectorVersion(uint8_t *major, uint8_t *minor, uint8_t *patch)
 {
     int32_t retVal;

src/sfeQwiicXM125.h

@@ -14,10 +14,6 @@ class QwDevXM125
         bool begin(sfeTkII2C *theBus = nullptr);
 
         // --------------------- I2C Disance Detector Functions ---------------------
-        
-        /// @brief This function begins the distance examples/communication.
-        /// @return Error code (0 no error)
-        int32_t distanceBegin();
 
         /// @brief This function returns the version number of the device 
         ///  structure: major.minor.patch
@@ -27,7 +23,7 @@ class QwDevXM125
         /// @brief This function returns if there was an error from the 
         ///  protocol status register 
         /// @return Error code (0 no error)
-        int32_t getDistanceDetectorError(sfe_xm125_distance_protocol_status_t *error);
+        int32_t getDistanceDetectorError(uint32_t *error);
 
         /// @brief This function returns the measure counter, the number of measurements
         ///   performed since restart. 
@@ -247,12 +243,12 @@ class QwDevXM125
 
         /// @brief This function returns the threshold method 
         /// @return Error code (0 no error)
-        int32_t getDistanceThresholdMethod(sfe_xm125_threshold_method_t *method);
+        int32_t getDistanceThresholdMethod(sfe_xm125_distance_threshold_method_t *method);
 
         /// @brief This function sets the threshold method
         /// @param method Threshold method (enum)
         /// @return Error code (0 no error)
-        int32_t setDistanceThresholdMethod(sfe_xm125_threshold_method_t method);
+        int32_t setDistanceThresholdMethod(sfe_xm125_distance_threshold_method_t method);
 
         /// @brief This function returns the peak sorting method
         /// @param peak Peak sorting method 
@@ -352,10 +348,6 @@ class QwDevXM125
 
         // --------------------- I2C Presence Detector Functions ---------------------
 
-        /// @brief This function begins the presence examples/communication.
-        /// @return Error code (0 no error)
-        int32_t presenceBegin();
-
         /// @brief This function returns the RSS version number     
         /// @param version Version number
         /// @param patch Patch version number 

src/sfeXM125Regs.h

@@ -44,6 +44,8 @@
 /* ****************************** Distance Values ****************************** */
 
 const uint16_t SFE_XM125_I2C_ADDRESS = 0x52;
+const bool SFE_XM125_DISTANCE = false;
+const bool SFE_XM125_PRESENCE = true;
 
 const uint16_t SFE_XM125_DISTANCE_VERSION = 0x00;
 typedef struct