Comment examples.

Author: SFE-Brudnerd

examples/Example01_Basic_OneShot/Example01_Basic_OneShot.ino

@@ -1,3 +1,27 @@
+/*
+  Using the AMS AS7331 Spectral UV Sensor in Command/One Shot (CMD) Mode.
+
+  This example shows how operate the AS7331 in the default CMD mode. The start 
+  command is sent, then delays until the conversion time has passed before
+  reading out the UV values.
+
+  By: Alex Brudner
+  SparkFun Electronics
+  Date: 2023/11/17
+  SparkFun code, firmware, and software is released under the MIT License.
+	Please see LICENSE.md for further details.
+
+  Hardware Connections:
+  IoT RedBoard --> AS7331
+  QWIIC --> QWIIC
+
+  Serial.print it out at 115200 baud to serial monitor.
+
+  Feel like supporting our work? Buy a board from SparkFun!
+  https://www.sparkfun.com/products/23517 - Qwiic 1x1
+  https://www.sparkfun.com/products/23518 - Qwiic Mini
+*/
+
 #include "SparkFun_AS7331.h"
 
 SfeAS7331ArdI2C myUVSensor;
@@ -9,6 +33,7 @@ void setup() {
   while(!Serial){delay(100);};
   Serial.println("UV LED Example.");
 
+  // Initialize sensor and run default setup.
   if(myUVSensor.begin() == false) {
     Serial.println("Sensor failed to begin. Please check your wiring!");
     Serial.println("Spinning...");
@@ -17,6 +42,7 @@ void setup() {
 
   Serial.println("Sensor began.");
 
+  // Set measurement mode and change device operating mode to measure.
   if(myUVSensor.startMeasurement(MEAS_MODE_CMD) == false) {
     Serial.println("Sensor did not get set properly.");
     Serial.println("Spinning...");
@@ -29,11 +55,14 @@ void setup() {
 
 void loop() {
 
+  // Send a start measurement command.
   if(SFE_BUS_OK != myUVSensor.setStartStateMode(START_STATE_ENABLED))
     Serial.println("Error starting reading!");
 
+  // Wait for a bit longer than the conversion time.
   delay(2+(1 << myUVSensor.getConfigConversionTime()));
 
+  // Read UV values.
   if(SFE_BUS_OK != myUVSensor.readAllUV())
     Serial.println("Error reading UV.");
 

examples/Example02_CONT_Mode/Example02_CONT_Mode.ino

@@ -1,3 +1,28 @@
+/*
+  Using the AMS AS7331 Spectral UV Sensor in Continuous (CONT) Mode.
+
+  This example shows how operate the AS7331 in CONT mode. The break time
+  register sets the delay between measurements so that the processor can read
+  out the results without interfering with the ADC.
+
+  By: Alex Brudner
+  SparkFun Electronics
+  Date: 2023/11/27
+  SparkFun code, firmware, and software is released under the MIT License.
+	Please see LICENSE.md for further details.
+
+  Hardware Connections:
+  IoT RedBoard --> AS7331
+  QWIIC --> QWIIC
+  26  --> INT
+
+  Serial.print it out at 115200 baud to serial monitor.
+
+  Feel like supporting our work? Buy a board from SparkFun!
+  https://www.sparkfun.com/products/23517 - Qwiic 1x1
+  https://www.sparkfun.com/products/23518 - Qwiic Mini
+*/
+
 #include "SparkFun_AS7331.h"
 
 SfeAS7331ArdI2C myUVSensor;
@@ -49,6 +74,7 @@ void setup() {
 
 void loop() {
 
+  // If an interrupt has been generated...
   if(newDataReady) {
     newDataReady = false;
 

examples/Example03_SYNS_Mode/Example03_SYNS_Mode.ino

@@ -1,3 +1,29 @@
+/*
+  Using the AMS AS7331 Spectral UV Sensor in Synchronous Start (SYNS) Mode.
+
+  This example shows how operate the AS7331 in SYNS mode. This uses the active 
+  low SYN pin to start the conversion and relies on an interrupt to signal the
+  end of conversion.
+
+  By: Alex Brudner
+  SparkFun Electronics
+  Date: 2023/11/27
+  SparkFun code, firmware, and software is released under the MIT License.
+	Please see LICENSE.md for further details.
+
+  Hardware Connections:
+  IoT RedBoard --> AS7331
+  QWIIC --> QWIIC
+  26  --> INT
+  27  --> SYN
+
+  Serial.print it out at 115200 baud to serial monitor.
+
+  Feel like supporting our work? Buy a board from SparkFun!
+  https://www.sparkfun.com/products/23517 - Qwiic 1x1
+  https://www.sparkfun.com/products/23518 - Qwiic Mini
+*/
+
 #include "SparkFun_AS7331.h"
 
 SfeAS7331ArdI2C myUVSensor;
@@ -38,12 +64,13 @@ void setup() {
     while(1);
   }
 
-  Serial.println("Set mode to synchronous. Starting measurement...");
+  Serial.println("Set mode to synchronous start (SYNS). Starting measurement...");
 
-  // Begin measurement.
+  // Set device to be ready to measure.
   if(SFE_BUS_OK != myUVSensor.setStartStateMode(START_STATE_ENABLED))
     Serial.println("Error starting reading!");
 
+  // Send start toggle.
   digitalWrite(synPin, LOW);
   delay(1);
   digitalWrite(synPin, HIGH);
@@ -52,12 +79,14 @@ void setup() {
 
 void loop() {
 
+  // If an interrupt has been generated...
   if(newDataReady) {
     newDataReady = false;
 
     if(SFE_BUS_OK != myUVSensor.readAllUV())
       Serial.println("Error reading UV.");
 
+    // Start next measurement
     digitalWrite(synPin, LOW);
     delay(1);
     digitalWrite(synPin, HIGH);