Create Example 2

Also add possible integration time values to set_integ_time() docstring

Author: sfe-SparkFro

examples/qwiic_ex2.py renamed to examples/qwiic_veml6030_ex2_settings.py

@@ -1,22 +1,18 @@
 #!/usr/bin/env python
-#-----------------------------------------------------------------------------
-# qwiic_env_bme280_ex4.py
+#-------------------------------------------------------------------------------
+# qwiic_veml6030_ex2_settings.py
 #
-# Simple Example for the Qwiic BME280 Device
-#------------------------------------------------------------------------
+# Demonstrates how to change basic settings of the Qwiic Ambient Light Sensor
+#-------------------------------------------------------------------------------
+# Written by SparkFun Electronics, November 2023
 #
-# Written by SparkFun Electronics, May 2019
-# 
-# This python library supports the SparkFun Electroncis qwiic 
-# qwiic sensor/board ecosystem on a Raspberry Pi (and compatable) single
-# board computers. 
+# This python library supports the SparkFun Electroncis Qwiic ecosystem
 #
-# More information on qwiic is at https:# www.sparkfun.com/qwiic
+# More information on Qwiic is at https://www.sparkfun.com/qwiic
 #
 # Do you like this library? Help support SparkFun. Buy a board!
-#
-#==================================================================================
-# Copyright (c) 2019 SparkFun Electronics
+#===============================================================================
+# Copyright (c) 2023 SparkFun Electronics
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy 
 # of this software and associated documentation files (the "Software"), to deal 
@@ -35,51 +31,60 @@
 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 
 # SOFTWARE.
-#==================================================================================
-# Example 4 - port of the Arduino example 4
-#
+#===============================================================================
 
-from __future__ import print_function
-import qwiic_bme280
+import qwiic_veml6030
 import time
 import sys
 
 def runExample():
+print("\nQwiic Ambient Light Sensor Example 2 - Settings\n")
 
-print("\nSparkFun BME280 Sensor Example 4\n")
-mySensor = qwiic_bme280.QwiicBme280()
+# Create instance of device
+light_sensor = qwiic_veml6030.QwiicVEML6030()
 
-if mySensor.connected == False:
-print("The Qwiic BME280 device isn't connected to the system. Please check your connection", \
+# Check if it's connected
+if light_sensor.is_connected() == False:
+print("The device isn't connected to the system. Please check your connection", \
 file=sys.stderr)
 return
 
-mySensor.begin()
+# Initialize the device
+light_sensor.begin()
 
-# setup the sensor
-mySensor.filter = 1 # 0 to 4 is valid. Filter coefficient. See 3.4.4
-mySensor.standby_time = 0 # 0 to 7 valid. Time between readings. See table 27.
-
-mySensor.over_sample = 1# 0 to 16 are valid. 0 disables temp sensing. See table 24.
-mySensor.pressure_oversample = 1# 0 to 16 are valid. 0 disables pressure sensing. See table 23.
-mySensor.humidity_oversample = 1# 0 to 16 are valid. 0 disables humidity sensing. See table 19.
-mySensor.mode = mySensor.MODE_NORMAL # MODE_SLEEP, MODE_FORCED, MODE_NORMAL is valid. See 3.3
-
-while True:
-print("Humidity:\t%.3f" % mySensor.humidity)
+# Set the gain. Can be any of the following:
+# 1/8, 1/4, 1, and 2
+gain = 0.125
+light_sensor.set_gain(gain)
 
-print("Pressure:\t%.3f" % mySensor.pressure)
+# Set the integration time in ms. Can be any of the following:
+# 25, 50, 100, 200, 400, and 800
+integ_time = 100
+light_sensor.set_integ_time(integ_time)
 
-print("Altitude:\t%.3f" % mySensor.altitude_feet)
-
-print("Temperature:\t%.2f\n" % mySensor.temperature_fahrenheit)
+# Read back the settings and print to confirm they were set correctly
+gain = light_sensor.read_gain()
+integ_time = light_sensor.read_integ_time()
+print("Gain set:", gain)
+print("Integration time set:", integ_time)
+
+# Extra space for some visual separation
+print()
 
+# Loop forever
+while True:
+# Give some delay between prints
 time.sleep(1)
 
+# Get light measured by sensor in Lux
+ambient_light = light_sensor.read_light()
+
+# Print measurement
+print("Lux:\t%.3f" % ambient_light)
 
 if __name__ == '__main__':
 try:
 runExample()
 except (KeyboardInterrupt, SystemExit) as exErr:
-print("\nEnding Example 4")
+print("\nEnding Example")
 sys.exit(0)

qwiic_veml6030.py

@@ -240,7 +240,8 @@ def set_integ_time(self, time):
  """
  Sets the integration time
  
- :param time: Integration time, ms
+ :param time: Integration time in ms, possible values:
+ 25, 50, 100, 200, 400, and 800
  :type time: int
  """
  # Determine integration time bits