cleanup code

Author: gigapod

examples/Example_01_BasicReadings/Example_01_BasicReadings.ino

@@ -1,8 +1,14 @@
 /*
+ *---------------------------------------------------------------------------------
+ *
+ * Copyright (c) 2025, SparkFun Electronics Inc.
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ *---------------------------------------------------------------------------------
+ */
 
-*/
-
-#include "SparkFun_Soil_Moisture_Sensor.h" // CTRL+Click here to get the library: http://librarymanager/All#SparkFun_Soil_Moisture
+#include "SparkFun_Soil_Moisture_Sensor.h" // CTRL+Click here to get the library: http://librarymanager/All#SparkFun_Soil_Moisture_Sensor
 #include <Wire.h>
 
 SparkFunSoilMoistureSensor mySoilSensor; // Create an instance of the sensor class
@@ -16,6 +22,7 @@ SparkFunSoilMoistureSensor mySoilSensor; // Create an instance of the sensor cla
 #define wirePort Wire
 #endif
 
+
 void setup()
 {
     Serial.begin(115200);
@@ -27,26 +34,35 @@ void setup()
     // Comment out this while loop, or it will prevent the remaining code from running.
 
     Serial.println();
-    Serial.println("Soil Sensor Example 1 - Basic Readings");
+    Serial.println("------------------------------------------------------------");
+    Serial.println("SparkFun Soil Sensor Example 1");
+    Serial.println("Basic Readings");
+    Serial.println("------------------------------------------------------------");
+    Serial.println();
 
     wirePort.begin();
 
     if (mySoilSensor.begin() == false)
     {
-        Serial.println("Soil Moisture Sensor not detected at default I2C address. Verify the sensor is connected "
-                       "correctly. Freezing...");
+        Serial.println("Soil Moisture Sensor not detected at default I2C address. Verify the sensor is connected. Stopping.");
         while (1)
             ;
     }
     Serial.println("Soil Moisture Sensor found!");
+
+    Serial.println();
+    Serial.println("Reading soil moisture sensor...");
+    Serial.println();
 }
 
+//----------------------------------------------------------------------------------------
 void loop()
 {
     // Let's get some readings
     uint16_t soilMoisture = mySoilSensor.readMoistureValue();
     Serial.print("Soil Moisture: ");
     Serial.println(soilMoisture);
 
+    // loop delay - 2 seconds
     delay(2000);
 }

examples/Example_02_ReadingsAndLED/Example_02_ReadingsAndLED.ino

@@ -1,8 +1,14 @@
 /*
+*---------------------------------------------------------------------------------
+ *
+ * Copyright (c) 2025, SparkFun Electronics Inc.
+ *
+ * SPDX-License-Identifier: MIT
+ *
+ *---------------------------------------------------------------------------------
+ */
 
-*/
-
-#include "SparkFun_Soil_Moisture_Sensor.h" // CTRL+Click here to get the library: http://librarymanager/All#SparkFun_Soil_Moisture
+#include "SparkFun_Soil_Moisture_Sensor.h" // CTRL+Click here to get the library: http://librarymanager/All#SparkFun_Soil_Moisture_Sensor
 #include <Wire.h>
 
 SparkFunSoilMoistureSensor mySoilSensor; // Create an instance of the sensor class
@@ -16,6 +22,8 @@ SparkFunSoilMoistureSensor mySoilSensor; // Create an instance of the sensor cla
 #define wirePort Wire
 #endif
 
+//----------------------------------------------------------------------------------------
+
 void setup()
 {
     Serial.begin(115200);
@@ -27,33 +35,48 @@ void setup()
     // Comment out this while loop, or it will prevent the remaining code from running.
 
     Serial.println();
-    Serial.println("Soil Sensor Example 1 - Basic Readings");
+    Serial.println("------------------------------------------------------------");
+    Serial.println("SparkFun Soil Sensor Example 2");
+    Serial.println("Basic Readings and On-Board LED Control");
+    Serial.println("------------------------------------------------------------");
+    Serial.println();
+
 
     wirePort.begin();
 
     if (mySoilSensor.begin() == false)
     {
-        Serial.println("Soil Moisture Sensor not detected at default I2C address. Verify the sensor is connected "
-                       "correctly. Freezing...");
+        Serial.println("Soil Moisture Sensor not detected at default I2C address. Verify the sensor is connected. Stopping.");
+                       
         while (1)
             ;
     }
     Serial.println("Soil Moisture Sensor found!");
 
     mySoilSensor.LEDOff();
+
+    Serial.println();
+    Serial.println("Reading soil moisture sensor...");
+    Serial.println();
 }
 
+//----------------------------------------------------------------------------------------
+
 void loop()
 {
     // Wink the LED during the reading
     mySoilSensor.LEDOn();
     // Let's get some readings
     uint16_t soilMoisture = mySoilSensor.readMoistureValue();
+
+    // Output the value:
     Serial.print("Soil Moisture: ");
     Serial.println(soilMoisture);
 
+    // small delay for the LED to be seen
     delay(100);
     mySoilSensor.LEDOff();
 
+    // delay our reading.
     delay(2000);
 }