updates to a) provide some level of backward compatablity with lib v1.0; b) update example 2

Author: gigapod

examples/Example2_changeSettings/Example2_changeSettings.ino

@@ -5,88 +5,88 @@
  * Paul Clark
  * SparkFun Electronics
  * November 4th 2021
- * 
+ *
  * This example demonstrates how to change the VEML7700's sensitivity (gain) and integration time settings.
- * 
+ *
  * Want to support open source hardware? Buy a board from SparkFun!
  * <br>SparkX smôl Environmental Peripheral Board (SPX-18976): https://www.sparkfun.com/products/18976
- * 
+ *
  * Please see LICENSE.md for the license information
- * 
+ *
  */
 
 #include <SparkFun_VEML7700_Arduino_Library.h> // Click here to get the library: http://librarymanager/All#SparkFun_VEML7700
 
-VEML7700 mySensor; // Create a VEML7700 object
+SparkFunVEML7700 mySensor; // Create a VEML7700 object
 
 void setup()
 {
-  Serial.begin(115200);
-  Serial.println(F("SparkFun VEML7700 Example"));
+    Serial.begin(115200);
+    Serial.println(F("SparkFun VEML7700 Example"));
 
-  Wire.begin();
+    Wire.begin();
 
-  //mySensor.enableDebugging(); // Uncomment this line to enable helpful debug messages on Serial
+    // mySensor.enableDebugging(); // Uncomment this line to enable helpful debug messages on Serial
 
-  // Begin the VEML7700 using the Wire I2C port
-  // .begin will return true on success, or false on failure to communicate
-  if (mySensor.begin() == false)
-  {
-    Serial.println("Unable to communicate with the VEML7700. Please check the wiring. Freezing...");
-    while (1)
-      ;
-  }
+    // Begin the VEML7700 using the Wire I2C port
+    // .begin will return true on success, or false on failure to communicate
+    if (mySensor.begin() == false)
+    {
+        Serial.println("Unable to communicate with the VEML7700. Please check the wiring. Freezing...");
+        while (1)
+            ;
+    }
 
-  //The default integration time is 100ms.
-  //Possible values are:
-  //VEML7700_INTEGRATION_25ms
-  //VEML7700_INTEGRATION_50ms
-  //VEML7700_INTEGRATION_100ms
-  //VEML7700_INTEGRATION_200ms
-  //VEML7700_INTEGRATION_400ms
-  //VEML7700_INTEGRATION_800ms
-  //Let's change the integration time to 50ms:
-  mySensor.setIntegrationTime(VEML7700_INTEGRATION_50ms);
+    // The default integration time is 100ms.
+    // Possible values are:
+    // VEML7700_INTEGRATION_25ms
+    // VEML7700_INTEGRATION_50ms
+    // VEML7700_INTEGRATION_100ms
+    // VEML7700_INTEGRATION_200ms
+    // VEML7700_INTEGRATION_400ms
+    // VEML7700_INTEGRATION_800ms
+    // Let's change the integration time to 50ms:
+    mySensor.setIntegrationTime(VEML7700_INTEGRATION_50ms);
 
-  //Confirm the integration time was set correctly
-  Serial.print(F("The sensor integration time is: "));
-  Serial.println(mySensor.getIntegrationTimeStr());
+    // Confirm the integration time was set correctly
+    Serial.print(F("The sensor integration time is: "));
+    Serial.println(mySensor.integrationTimeString());
 
-  //The default gain (sensitivity mode) is x1
-  //Possible values are:
-  //VEML7700_SENSITIVITY_x1
-  //VEML7700_SENSITIVITY_x2
-  //VEML7700_SENSITIVITY_x1_8
-  //VEML7700_SENSITIVITY_x1_4
-  //Let's change the sensitivity to x2:
-  mySensor.setSensitivityMode(VEML7700_SENSITIVITY_x2);
+    // The default gain (sensitivity mode) is x1
+    // Possible values are:
+    // VEML7700_SENSITIVITY_x1
+    // VEML7700_SENSITIVITY_x2
+    // VEML7700_SENSITIVITY_x1_8
+    // VEML7700_SENSITIVITY_x1_4
+    // Let's change the sensitivity to x2:
+    mySensor.setSensitivityMode(VEML7700_SENSITIVITY_x2);
 
-  //Confirm that the sensitivity mode was set correctly
-  Serial.print(F("The sensor gain (sensitivity mode) is: "));
-  Serial.println(mySensor.getSensitivityModeStr());
+    // Confirm that the sensitivity mode was set correctly
+    Serial.print(F("The sensor gain (sensitivity mode) is: "));
+    Serial.println(mySensor.sensitivityModeString());
 
-  //We can also change the persistence ptotect number. Default is 1.
-  //Possible values are:
-  //VEML7700_PERSISTENCE_1
-  //VEML7700_PERSISTENCE_2
-  //VEML7700_PERSISTENCE_4
-  //VEML7700_PERSISTENCE_8
-  //Let's change the persistence protect to 4:
-  mySensor.setPersistenceProtect(VEML7700_PERSISTENCE_4);
+    // We can also change the persistence ptotect number. Default is 1.
+    // Possible values are:
+    // VEML7700_PERSISTENCE_1
+    // VEML7700_PERSISTENCE_2
+    // VEML7700_PERSISTENCE_4
+    // VEML7700_PERSISTENCE_8
+    // Let's change the persistence protect to 4:
+    mySensor.setPersistenceProtect(VEML7700_PERSISTENCE_4);
 
-  //Confirm that the persistence protect was set correctly
-  Serial.print(F("The sensor persistence protect setting is: "));
-  Serial.println(mySensor.getPersistenceProtectStr());  
+    // Confirm that the persistence protect was set correctly
+    Serial.print(F("The sensor persistence protect setting is: "));
+    Serial.println(mySensor.persistenceProtectString());
 
-  Serial.println(F("Lux:\tAmbient:\tWhite Level:"));
+    Serial.println(F("Lux:\tAmbient:\tWhite Level:"));
 }
 
 void loop()
 {
-  Serial.print(mySensor.getLux(), 4); // Read the lux from the sensor and print it
-  Serial.print("\t");
-  Serial.print(mySensor.getAmbientLight()); // Read the ambient light level
-  Serial.print("\t");
-  Serial.println(mySensor.getWhiteLevel()); // Read the white channel level
-  delay(250);
+    Serial.print(mySensor.getLux(), 4); // Read the lux from the sensor and print it
+    Serial.print("\t");
+    Serial.print(mySensor.getAmbientLight()); // Read the ambient light level
+    Serial.print("\t");
+    Serial.println(mySensor.getWhiteLevel()); // Read the white channel level
+    delay(250);
 }

src/SparkFun_VEML7700_Arduino_Library.h

@@ -22,6 +22,17 @@
 #include "sfTk/sfDevVEML7700.h"
 // clang-format on
 
+// For backwards compatibility - with the SparkX (v1.0.0) library, remap error codes
+// to the toolkit error codes
+typedef enum : sfTkError_t
+{
+    VEML7700_ERROR_READ = ksfTkErrFail,
+    VEML7700_ERROR_WRITE = ksfTkErrFail,
+    VEML7700_ERROR_INVALID_ADDRESS = ksfTkErrInvalidParam,
+    VEML7700_ERROR_UNDEFINED = ksfTkErrInvalidParam,
+    VEML7700_ERROR_SUCCESS = ksfTkErrOk
+} VEML7700_error_t;
+const VEML7700_error_t VEML7700_SUCCESS = VEML7700_ERROR_SUCCESS;
 /**
  * @brief Class for interfacing with the VMEL7700 sensor using I2C communication
  *
@@ -58,3 +69,8 @@ class SparkFunVEML7700 : public sfDevVEML7700
   private:
     sfTkArdI2C _theI2CBus;
 };
+
+// for backwards compatibility
+class VEML7700 : public SparkFunVEML7700
+{
+};

src/sfTk/sfDevVEML7700.cpp

@@ -205,7 +205,7 @@ sfTkError_t sfDevVEML7700::enableInterrupt(bool bEnable)
 // Get the interrupt enable setting.
 //
 
-bool sfDevVEML7700::interruptEnabled(void)
+bool sfDevVEML7700::isInterruptEnabled(void)
 {
 
     sfDevVEML7700Config_t config;

src/sfTk/sfDevVEML7700.h

@@ -189,12 +189,13 @@ class sfDevVEML7700
      * @return sfTkError_t Error code indicating success or failure of the operation.
      */
     sfTkError_t enableInterrupt(bool);
+
     /**
      * @brief Checks if the interrupt feature is enabled on the VEML7700 device.
      *
      * @return true if the interrupt is enabled, false otherwise.
      */
-    bool interruptEnabled(void);
+    bool isInterruptEnabled(void);
 
     /**
      * @brief Sets the persistence protection mode for the VEML7700 sensor.
@@ -243,6 +244,17 @@ class sfDevVEML7700
      */
     const char *persistenceProtectString(void);
 
+    /**
+     * @brief Get the Persistence Protect object - this is for backward compatibility.
+     *
+     * @deprecated since version 2.0.0, use persistenceProtect() instead.
+     * @return VEML7700_persistence_protect_t
+     */
+    const char *getPersistenceProtectStr(void)
+    {
+        return persistenceProtectString();
+    }
+
     /**
      * @brief Sets the integration time for the VEML7700 sensor.
      *
@@ -275,6 +287,17 @@ class sfDevVEML7700
      */
     VEML7700_integration_time_t integrationTime(void);
 
+    /**
+     * @brief Get the Integration Time object -  this is for backward compatibility.
+     *
+     * @deprecated since version 2.0.0, use integrationTime() instead.
+     * @return VEML7700_integration_time_t
+     */
+
+    VEML7700_integration_time_t getIntegrationTime(void)
+    {
+        return integrationTime();
+    }
     /**
      * @brief Returns a string representation of the current integration time setting.
      *
@@ -284,6 +307,17 @@ class sfDevVEML7700
      */
     const char *integrationTimeString(void);
 
+    /**
+     * @brief Get the Integration Time string - this is for backward compatibility.
+     *
+     * @deprecated since version 2.0.0, use integrationTimeString() instead.
+     * @return const char* A string representing the integration time setting.
+     */
+    const char *getIntegrationTimeStr(void)
+    {
+        return integrationTimeString();
+    }
+
     /**
      * @brief Sets the sensitivity mode for the VEML7700 sensor.
      *
@@ -315,6 +349,17 @@ class sfDevVEML7700
      */
     VEML7700_sensitivity_mode_t sensitivityMode(void);
 
+    /**
+     * @brief Get the Sensitivity Mode object - this is for backward compatibility.
+     *
+     * @deprecated since version 2.0.0, use sensitivityMode() instead.
+     * @return VEML7700_sensitivity_mode_t
+     */
+    VEML7700_sensitivity_mode_t getSensitivityMode(void)
+    {
+        return sensitivityMode();
+    }
+
     /**
      * @brief Returns a string representation of the current sensitivity mode setting.
      *
@@ -324,6 +369,17 @@ class sfDevVEML7700
      */
     const char *sensitivityModeString(void);
 
+    /**
+     * @brief Get the Sensitivity Mode string - this is for backward compatibility.
+     *
+     * @deprecated since version 2.0.0, use sensitivityModeString() instead.
+     * @return const char* A string representing the sensitivity mode setting.
+     */
+    const char *getSensitivityModeStr(void)
+    {
+        return sensitivityModeString();
+    }
+
     /**
      * @brief Sets the high threshold value for the VEML7700 sensor.
      *
@@ -354,6 +410,17 @@ class sfDevVEML7700
      */
     uint16_t highThreshold(void);
 
+    /**
+     * @brief Get the High Threshold object - this is for backward compatibility.
+     *
+     * @deprecated since version 2.0.0, use highThreshold() instead.
+     * @return uint16_t The current high threshold value (16-bit unsigned integer): 0x0000 to 0xFFFF
+     */
+    uint16_t getHighThreshold(void)
+    {
+        return highThreshold();
+    }
+
     /**
      * @brief Sets the low threshold value for the VEML7700 sensor.
      *
@@ -384,6 +451,17 @@ class sfDevVEML7700
      */
     uint16_t lowThreshold(void);
 
+    /**
+     * @brief Get the Low Threshold object - this is for backward compatibility.
+     *
+     * @deprecated since version 2.0.0, use lowThreshold() instead.
+     * @return uint16_t The current low threshold value (16-bit unsigned integer): 0x0000 to 0xFFFF
+     */
+    uint16_t getLowThreshold(void)
+    {
+        return lowThreshold();
+    } // Get the Low Threshold object - this is for backward compatibility
+
     /** Read the sensor data */
 
     /**