change error code on no-bus condition; formatter

Author: gigapod

src/SparkFun_Soil_Moisture_Sensor.h

@@ -9,30 +9,37 @@
  *---------------------------------------------------------------------------------
  */
 
- // A simple wrapper around the SparkFun Soil Moisture Sensor - based on the original example driver /example from Zio 
- // from here https://github.com/sparkfun/Zio-Qwiic-Soil-Moisture-Sensor
+// A simple wrapper around the SparkFun Soil Moisture Sensor - based on the original example driver /example from Zio
+// from here https://github.com/sparkfun/Zio-Qwiic-Soil-Moisture-Sensor
 
 #pragma once
 
 // To make the Arduino machine happy, include the toolkit header before the core implementation for this device
 #include <SparkFun_Toolkit.h>
 #include "sfeTk/sfeDevSoilMoisture.h"
 
+
 // Note:
 // The core of the implementation for this device library is in the SparkFun Toolkit object sfeDevSoilMoisture,
 // contained in the directory sfeTk. This object implements all functionality independent of the bus type, I2C or SPI.
-// The SparkFunSoilMoistureSensorI2C and SparkFunSoilMoistureSensorSPI classes below are the Arduino-specific, bus-specific
-// implementations that inherit from the core toolkit class. 
+// The SparkFunSoilMoistureSensorI2C and SparkFunSoilMoistureSensorSPI classes below are the Arduino-specific,
+// bus-specific implementations that inherit from the core toolkit class.
 //
 //-----------------------------------------------------------------------------------------------
 // Define our Arduino Object - I2C version
 class SparkFunSoilMoistureSensorI2C : public sfeDevSoilMoisture
 {
   public:
-    /// @brief Begins the Device
-    /// @param address I2C device address to use for the sensor
-    /// @param wirePort Wire port to use for I2C communication
-    /// @return True if successful, false otherwise
+    /**
+     * @brief Begins the Device
+     *
+     * Initializes the soil moisture sensor for I2C communication using the specified
+     * I2C address and wire port.
+     *
+     * @param address I2C device address to use for the sensor (default is SFE_SOIL_MOISTURE_DEFAULT_I2C_ADDRESS)
+     * @param wirePort Wire port to use for I2C communication (default is Wire)
+     * @return true if successful, false otherwise
+     */
     bool begin(const uint8_t address = SFE_SOIL_MOISTURE_DEFAULT_I2C_ADDRESS, TwoWire &wirePort = Wire)
     {
         // Setup Arduino I2C bus
@@ -42,8 +49,14 @@ class SparkFunSoilMoistureSensorI2C : public sfeDevSoilMoisture
         return sfeDevSoilMoisture::begin(&_theI2CBus) == kSTkErrOk ? isConnected() : false;
     }
 
-    /// @brief Checks if the Device is connected
-    /// @return True if the sensor is connected, false otherwise
+    /**
+     * @brief Checks if the device is connected and responding
+     *
+     * Tests communication with the sensor by attempting to ping it over I2C.
+     * A successful ping indicates the sensor is properly connected and responding.
+     *
+     * @return true if the sensor responds to communication attempts, false otherwise
+     */
     bool isConnected()
     {
         return _theI2CBus.ping() == kSTkErrOk;
@@ -58,19 +71,27 @@ class SparkFunSoilMoistureSensorI2C : public sfeDevSoilMoisture
 class SparkFunSoilMoistureSensorSPI : public sfeDevSoilMoisture
 {
   public:
-    /// @brief Begins the Device with SPI as the communication bus
-    /// @param csPin The chip select pin for the sensor
-    /// @param spiPort The SPI port to use for communication
-    /// @param spiSettings The SPI settings to use for communication
-    /// @return True if successful, false otherwise
-    bool begin(const uint8_t csPin, SPIClass &spiPort = SPI, SPISettings spiSettings = SPISettings(100000, MSBFIRST, SPI_MODE0))
+    /**
+     * @brief Begins the Device with SPI as the communication bus
+     *
+     * Initializes the soil moisture sensor for SPI communication using the specified
+     * chip select pin, SPI port, and SPI settings.
+     *
+     * @param csPin The chip select pin for the sensor
+     * @param spiPort The SPI port to use for communication (default is SPI)
+     * @param spiSettings The SPI settings to use for communication (default is SPISettings(100000, MSBFIRST,
+     * SPI_MODE0))
+     * @return true if successful, false otherwise
+     */
+    bool begin(const uint8_t csPin, SPIClass &spiPort = SPI,
+               SPISettings spiSettings = SPISettings(100000, MSBFIRST, SPI_MODE0))
     {
 
         // Setup Arduino SPI bus
         _theSPIBus.init(spiPort, spiSettings, csPin, true);
 
         // Begin the sensor with the SPI bus connection
-        return (sfeDevSoilMoisture::begin(&_theSPIBus) == kSTkErrOk );
+        return (sfeDevSoilMoisture::begin(&_theSPIBus) == kSTkErrOk);
     }
 
   private:

src/sfeTk/sfeDevSoilMoisture.cpp

@@ -27,7 +27,7 @@ sfeTkError_t sfeDevSoilMoisture::begin(sfeTkIBus *theBus)
 {
     // Nullptr check
     if (theBus == nullptr)
-        return kSTkErrFail;
+        return kSTkErrBusNotInit;
 
     // Set bus pointer
     _theBus = theBus;
@@ -40,7 +40,7 @@ sfeTkError_t sfeDevSoilMoisture::begin(sfeTkIBus *theBus)
 sfeTkError_t sfeDevSoilMoisture::LEDOff(void)
 {
     if (_theBus == nullptr)
-        return kSTkErrFail;
+        return kSTkErrBusNotInit;
 
     // Send the command to turn the LED off
     return _theBus->writeByte(kCommandLEDOff);
@@ -50,7 +50,7 @@ sfeTkError_t sfeDevSoilMoisture::LEDOff(void)
 sfeTkError_t sfeDevSoilMoisture::LEDOn(void)
 {
     if (_theBus == nullptr)
-        return kSTkErrFail;
+        return kSTkErrBusNotInit;
 
     // Send the command to turn the LED on
     return _theBus->writeByte(kCommandLEDOn);
@@ -91,7 +91,7 @@ float sfeDevSoilMoisture::readMoisturePercentage(void)
 sfeTkError_t sfeDevSoilMoisture::setI2CAddress(uint8_t newAddress)
 {
     if (_theBus == nullptr)
-        return kSTkErrFail;
+        return kSTkErrBusNotInit;
 
     // Validate the new address
     if (newAddress < 0x07 || newAddress > 0x78)
@@ -101,9 +101,9 @@ sfeTkError_t sfeDevSoilMoisture::setI2CAddress(uint8_t newAddress)
     if (_theBus->type() == kBusTypeI2C && ((sfeTkII2C *)_theBus)->address() == newAddress)
         return kSTkErrOk;
 
-    // Send the command to change the address. NOTE: Because of how the sensor works, 
+    // Send the command to change the address. NOTE: Because of how the sensor works,
     // the following will return an error (since the sensor side resets the bus)
-    (void) _theBus->writeRegisterByte(kCommandChangeAddress, newAddress);
+    (void)_theBus->writeRegisterByte(kCommandChangeAddress, newAddress);
 
     return kSTkErrOk;
 }
@@ -119,6 +119,6 @@ uint8_t sfeDevSoilMoisture::address(void)
         return ((sfeTkISPI *)_theBus)->cs();
     else if (_theBus->type() == kBusTypeI2C)
         return ((sfeTkII2C *)_theBus)->address();
-    
+
     return 0;
 }