Updated example numbers; updated keywords

Added the new keywords that were needed during testing and to remove magic numbers within the code; changed the example numbers in the arduino file to reflect the naming change

Author: MadisonC-SparkFun

examples/Example01_PresenceBasicReadings/Example01_PresenceBasicReadings.ino

@@ -1,5 +1,5 @@
 /*
-  Example 4: Presence Basic Readings
+  Example 1: Presence Basic Readings
 
   Using the Acconeer XM125 A121 60GHz Pulsed Coherent Radar Sensor.
 
@@ -45,7 +45,7 @@ void setup()
 {
     // Start serial
     Serial.begin(115200);
-    Serial.println("XM125 Example 4: Basic Presence Readings");
+    Serial.println("XM125 Example 1: Basic Presence Readings");
     Serial.println("");
 
     Wire.begin();

examples/Example02_PresenceGPIO0Usage/Example02_PresenceGPIO0Usage.ino

@@ -1,5 +1,5 @@
 /*
-  Example 5: Presence Subsweeps - Power Consumption Optimization
+  Example 2: Presence Subsweeps - Power Consumption Optimization
 
   Using the Acconeer XM125 A121 60GHz Pulsed Coherent Radar Sensor.
 
@@ -45,7 +45,7 @@ void setup()
 {
     // Start serial
     Serial.begin(115200);
-    Serial.println("XM125 Example 5: Presence GPIO0 Pin Usage");    
+    Serial.println("XM125 Example 2: Presence GPIO0 Pin Usage");    
     Serial.println("");
 
     Wire.begin();

examples/Example03_PresenceSerialPlotter/Example03_PresenceSerialPlotter.ino

@@ -1,11 +1,11 @@
 /*
-  Example 4: Presence Basic Readings
+  Example 3: Presence Serial Plotter
 
   Using the Acconeer XM125 A121 60GHz Pulsed Coherent Radar Sensor.
 
   This example shows how operate the XM125 when the device is in Presence Reading Mode.
-  The sensor is initialized, then the presence values will print out to the terminal.
-  For full algorithm for 
+  The sensor is initialized, then the presence values will print out to the terminal and
+  the serial monitor.
 
   By: Madison Chodikov
   SparkFun Electronics
@@ -44,7 +44,7 @@ void setup()
 {
     // Start serial
     Serial.begin(115200);
-    Serial.println("XM125 Example 4: Basic Presence Readings");
+    Serial.println("XM125 Example 3: Serial Plotter Presence Readings");
     Serial.println("");
 
     Wire.begin();

examples/Example04_DistanceBasicReadings/Example04_DistanceBasicReadings.ino

@@ -1,5 +1,5 @@
 /*
-  Example 1: Distance Basic Readings
+  Example 4: Distance Basic Readings
 
   Using the Acconeer XM125 A121 60GHz Pulsed Coherent Radar Sensor.
 
@@ -66,7 +66,7 @@ void setup()
 {
     // Start serial
     Serial.begin(115200);
-    Serial.println("XM125 Example 1: Basic Distance Readings");
+    Serial.println("XM125 Example 4: Basic Distance Readings");
     Serial.println("");
 
     Wire.begin();

examples/Example05_DistanceThresholdSettings/Example05_DistanceThresholdSettings.ino

@@ -1,5 +1,5 @@
 /*
-  Example 2: Distance Threshold Settings 
+  Example 5: Distance Threshold Settings 
   
   Using the Acconeer XM125 A121 60GHz Pulsed Coherent Radar Sensor.
 
@@ -32,7 +32,7 @@ void setup()
 {
     // Start serial
     Serial.begin(115200);
-    Serial.println("XM125 Example 2: Distance Threshold Settings");
+    Serial.println("XM125 Example 5: Distance Threshold Settings");
     Serial.println("");
 
     Wire.begin();

examples/Example06_DistanceSubsweeps/Example06_DistanceSubsweeps.ino

@@ -1,5 +1,5 @@
 /*
-  Example 3: Distance Subsweeps - Power Consumption Optimization
+  Example 6: Distance Subsweeps - Power Consumption Optimization
 
   Using the Acconeer XM125 A121 60GHz Pulsed Coherent Radar Sensor.
 
@@ -36,7 +36,7 @@ void setup()
 {
     // Start serial
     Serial.begin(115200);
-    Serial.println("XM125 Example 3: Distance Subsweeps - Power Consumption Optimization");
+    Serial.println("XM125 Example 6: Distance Subsweeps - Power Consumption Optimization");
     Serial.println("");
 
     Wire.begin();

keywords.txt

@@ -20,6 +20,7 @@ begin KEYWORD2
 getDistanceDetectorVersion KEYWORD2
 getDistanceDetectorError KEYWORD2
 getDistanceMeasureCounter KEYWORD2
+getDistanceDetectorErrorStatus KEYWORD2
 getDistanceDetectorStatus KEYWORD2
 getDistanceNumberDistances KEYWORD2
 getDistanceNearStartEdge KEYWORD2
@@ -75,12 +76,14 @@ setDistanceFixedStrengthThresholdValue KEYWORD2
 getDistanceMeasureOneWakeup KEYWORD2
 setDistanceMeasureOneWakeup KEYWORD2
 setDistanceCommand KEYWORD2
+distanceBusyWait KEYWORD2
 getPresenceDetectorVersion KEYWORD2
 getPresenceDetectorError KEYWORD2
 getPresenceMeasureCounter KEYWORD2
 getPresenceDetectorStatus KEYWORD2
-getPresenceDistanceResult KEYWORD2
-getPresenceNearStartEdge KEYWORD2
+getPresenceDetectorErrorStatus KEYWORD2
+getPresenceDetectorPresenceDetected KEYWORD2
+getPresenceDetectorPresenceStickyDetected KEYWORD2
 getPresenceDetectorRegError KEYWORD2
 getPresenceTemperature KEYWORD2
 getPresenceDistance KEYWORD2
@@ -131,6 +134,9 @@ setPresenceHWAAS KEYWORD2
 getPresenceDetectionOnGPIO KEYWORD2
 setPresenceDetectionOnGPIO KEYWORD2
 setPresenceCommand KEYWORD2
+presenceReset KEYWORD2
+getPresenceBusy KEYWORD2
+presenceBusyWait KEYWORD2
 
 #########################################################
 # Structs
@@ -150,6 +156,36 @@ sfe_xm125_presence_result_t KEYWORD3
 #########################################################
 
 SFE_XM125_I2C_ADDRESS LITERAL1
+SFE_XM125_DISTANCE_MAJOR_VERSION_MASK LITERAL1
+SFE_XM125_DISTANCE_MINOR_VERSION_MASK LITERAL1
+SFE_XM125_DISTANCE_PATCH_VERSION_MASK LITERAL1
+SFE_XM125_DISTANCE_NUMBER_DISTANCES_MASK LITERAL1
+SFE_XM125_DISTANCE_NEAR_START_EDGE_MASK LITERAL1
+SFE_XM125_DISTANCE_MEASURE_DISTANCE_ERROR_MASK LITERAL1
+SFE_XM125_DISTANCE_TEMPERATURE_MASK LITERAL1
+SFE_XM125_DISTANCE_RSS_REGISTER_OK_MASK LITERAL1
+SFE_XM125_DISTANCE_CONFIG_CREATE_OK_MASK LITERAL1
+SFE_XM125_DISTANCE_SENSOR_CREATE_OK_MASK LITERAL1
+SFE_XM125_DISTANCE_DETECTOR_CREATE_OK_MASK LITERAL1
+SFE_XM125_DISTANCE_DETECTOR_BUFFER_OK_MASK LITERAL1
+SFE_XM125_DISTANCE_SENSOR_BUFFER_OK_MASK LITERAL1
+SFE_XM125_DISTANCE_CALIBRATION_BUFFER_OK_MASK LITERAL1
+SFE_XM125_DISTANCE_CONFIG_APPLY_OK_MASK LITERAL1
+SFE_XM125_DISTANCE_SENSOR_CALIBRATE_OK_MASK LITERAL1
+SFE_XM125_DISTANCE_DETECTOR_CALIBRATE_OK_MASK LITERAL1
+SFE_XM125_DISTANCE_RSS_REGISTER_ERROR_MASK LITERAL1
+SFE_XM125_DISTANCE_CONFIG_CREATE_ERROR_MASK LITERAL1
+SFE_XM125_DISTANCE_SENSOR_CREATE_ERROR_MASK LITERAL1
+SFE_XM125_DISTANCE_DETECTOR_CREATE_ERROR_MASK LITERAL1
+SFE_XM125_DISTANCE_DETECTOR_BUFFER_ERROR_MASK LITERAL1
+SFE_XM125_DISTANCE_SENSOR_BUFFER_ERROR_MASK LITERAL1
+SFE_XM125_DISTANCE_CALIBRATION_BUFFER_ERROR_MASK LITERAL1
+SFE_XM125_DISTANCE_CONFIG_APPLY_ERROR_MASK LITERAL1
+SFE_XM125_DISTANCE_SENSOR_CALIBRATE_ERROR_MASK LITERAL1
+SFE_XM125_DISTANCE_DETECTOR_CALIBRATE_ERROR_MASK LITERAL1
+SFE_XM125_DISTANCE_DETECTOR_ERROR_MASK LITERAL1
+SFE_XM125_DISTANCE_BUSY_MASK LITERAL1
+SFE_XM125_DISTANCE_DETECTOR_STATUS_MASK LITERAL1
 SFE_XM125_DISTANCE_VERSION LITERAL1
 SFE_XM125_DISTANCE_PROTOCOL_STATUS LITERAL1
 SFE_XM125_DISTANCE_MEASURE_COUNTER LITERAL1
@@ -179,7 +215,42 @@ SFE_XM125_DISTANCE_FIXED_STRENGTH_THRESHOLD_VAL LITERAL1
 sfe_xm125_distance_fixed_strength_threshold_val_default LITERAL1
 SFE_XM125_DISTANCE_MEASURE_ON_WAKEUP LITERAL1
 sfe_xm125_distance_measure_on_wakup LITERAL1
-SFE_XM125_DISTANCE_COMMAND LITERAL1
+SFE_XM125_DISTANCE_COMMAND LITERAL1 
+SFE_XM125_DISTANCE_APPLY_CONFIGURATION LITERAL1
+SFE_XM125_DISTANCE_START_DETECTOR LITERAL1
+SFE_XM125_DISTANCE_STOP_DETECTOR LITERAL1
+SFE_XM125_DISTANCE_CALIBRATE LITERAL1
+SFE_XM125_DISTANCE_RECALIBRATE LITERAL1
+SFE_XM125_DISTANCE_ENABLE_UART_LOGS LITERAL1
+SFE_XM125_DISTANCE_DISABLE_UART_LOGS LITERAL1
+SFE_XM125_DISTANCE_LOG_CONFIGURATION LITERAL1
+SFE_XM125_DISTANCE_RESET_MODULE LITERAL1
+SFE_XM125_PRESENCE_DETECTOR_STATUS_MASK LITERAL1
+SFE_XM125_PRESENCE_DETECTED_MASK LITERAL1
+SFE_XM125_PRESENCE_DETECTED_STICKY_MASK LITERAL1
+SFE_XM125_PRESENCE_DETECTOR_ERROR_MASK LITERAL1
+SFE_XM125_PRESENCE_TEMPERATURE_MASK LITERAL1
+SFE_XM125_PRESENCE_MAJOR_VERSION_MASK LITERAL1
+SFE_XM125_PRESENCE_MINOR_VERSION_MASK LITERAL1
+SFE_XM125_PRESENCE_PATCH_VERSION_MASK LITERAL1
+SFE_XM125_PRESENCE_RSS_REGISTER_OK_MASK LITERAL1
+SFE_XM125_PRESENCE_CONFIG_CREATE_OK_MASK LITERAL1
+SFE_XM125_PRESENCE_SENSOR_CREATE_OK_MASK LITERAL1
+SFE_XM125_PRESENCE_SENSOR_CALIBRATE_OK_MASK LITERAL1
+SFE_XM125_PRESENCE_DETECTOR_CREATE_OK_MASK LITERAL1
+SFE_XM125_PRESENCE_DETECTOR_BUFFER_OK_MASK LITERAL1
+SFE_XM125_PRESENCE_SENSOR_BUFFER_OK_MASK LITERAL1
+SFE_XM125_PRESENCE_CONFIG_APPLY_OK_MASK LITERAL1
+SFE_XM125_PRESENCE_RSS_REGISTER_ERROR_MASK LITERAL1
+SFE_XM125_PRESENCE_CONFIG_CREATE_ERROR_MASK LITERAL1
+SFE_XM125_PRESENCE_SENSOR_CREATE_ERROR_MASK LITERAL1
+SFE_XM125_PRESENCE_SENSOR_CALIBRATE_ERROR_MASK LITERAL1
+SFE_XM125_PRESENCE_DETECTOR_CREATE_ERROR_MASK LITERAL1
+SFE_XM125_PRESENCE_DETECTOR_BUFFER_ERROR_MASK LITERAL1
+SFE_XM125_PRESENCE_SENSOR_BUFFER_ERROR_MASK LITERAL1
+SFE_XM125_PRESENCE_CONFIG_APPLY_ERROR_MASK LITERAL1
+SFE_XM125_PRESENCE_DETECTOR_REG_ERROR_MASK LITERAL1
+SFE_XM125_PRESENCE_BUSY_MASK LITERAL1
 SFE_XM125_PRESENCE_VERSION LITERAL1
 SFE_XM125_PRESENCE_PROTOCOL_STATUS LITERAL1
 SFE_XM125_PRESENCE_MEASURE_COUNTER LITERAL1
@@ -234,3 +305,7 @@ sfe_xm125_presence_hwaas_default LITERAL1
 SFE_XM125_PRESENCE_DETECTION_ON_GPIO LITERAL1
 sfe_xm125_presence_detection_on_gpio_default LITERAL1
 SFE_XM125_PRESENCE_COMMAND LITERAL1
+SFE_XM125_PRESENCE_APPLY_CONFIGURATION LITERAL1
+SFE_XM125_PRESENCE_START_DETECTOR LITERAL1
+SFE_XM125_PRESENCE_STOP_DETECTOR LITERAL1
+SFE_XM125_PRESENCE_RESET_MODULE LITERAL1

src/sfeQwiicXM125.cpp

@@ -644,13 +644,6 @@ int32_t QwDevXM125::distanceBusyWait()
     return 0; // 0 on success
 }
 
-int32_t QwDevXM125::getDistanceReg(uint32_t &regVal)
-{
-    int32_t retVal = _theBus->readRegister16Region(SFE_XM125_DISTANCE_DETECTOR_STATUS, (uint8_t*)&regVal, 4);
-    flipBytes(regVal);
-    return retVal;
-}
-
 // --------------------- I2C Presence Detector Functions ---------------------
 
 int32_t QwDevXM125::presenceDetectorStart(uint32_t start, uint32_t stop)
@@ -1183,16 +1176,6 @@ int32_t QwDevXM125::presenceBusyWait()
     return 0; // 0 on success
 }
 
-int32_t QwDevXM125::getPresenceRegisterVal(uint32_t &regVal)
-{
-    int32_t retVal = 0;
-
-    retVal = _theBus->writeRegister16Region(SFE_XM125_PRESENCE_DETECTOR_STATUS, (uint8_t*)&regVal, 4);
-    
-    flipBytes(regVal);
-    return retVal;
-}
-
 int32_t QwDevXM125::flipBytes(uint32_t &data)
 {
     uint32_t data1 = (data & 0x000000ff) << 24;

src/sfeQwiicXM125.h

@@ -364,9 +364,6 @@ class QwDevXM125
         /// @return Error code (0 no error) 
         int32_t distanceBusyWait();
 
-        // Test function
-        int32_t getDistanceReg(uint32_t &regVal);
-
         // --------------------- I2C Presence Detector Functions ---------------------
 
         /// @brief This function sets all the beginning values for a basic I2C
@@ -795,8 +792,10 @@ class QwDevXM125
         /// @return Error code (0 no error) 
         int32_t presenceBusyWait();
 
-        int32_t getPresenceRegisterVal(uint32_t &regVal);
-
+        /// @brief This function flips the bytes to be in big-endian order,
+        ///  as the XM125 I2C functions require. 
+        /// @param data Data to be flipped 
+        /// @return Error code (0 no error)
         int32_t flipBytes(uint32_t &data);
         int32_t flipBytesInt(int32_t &data);
 

src/sfeXM125Regs.h

@@ -56,7 +56,7 @@ const uint32_t SFE_XM125_DISTANCE_CONFIG_CREATE_OK_MASK = 0x00000002;
 const uint32_t SFE_XM125_DISTANCE_SENSOR_CREATE_OK_MASK = 0x00000004;
 const uint32_t SFE_XM125_DISTANCE_DETECTOR_CREATE_OK_MASK = 0x00000008;
 const uint32_t SFE_XM125_DISTANCE_DETECTOR_BUFFER_OK_MASK = 0x00000010;
-const uint32_t SFE_XM125_DISTANCE_SENSOR_BFUFER_OK_MASK = 0x00000020;
+const uint32_t SFE_XM125_DISTANCE_SENSOR_BUFFER_OK_MASK = 0x00000020;
 const uint32_t SFE_XM125_DISTANCE_CALIBRATION_BUFFER_OK_MASK = 0x00000040;
 const uint32_t SFE_XM125_DISTANCE_CONFIG_APPLY_OK_MASK = 0x00000080;
 const uint32_t SFE_XM125_DISTANCE_SENSOR_CALIBRATE_OK_MASK = 0x00000100;