sfeDevSoilMoisture.h

Go to the documentation of this file.

/*
 *---------------------------------------------------------------------------------
 *
 * Copyright (c) 2025, SparkFun Electronics Inc.
 *
 * SPDX-License-Identifier: MIT
 *
 *---------------------------------------------------------------------------------
 */
// Actual implementation of the soil moisture sensor - this is a platform "independent" implementation
 
#pragma once
 
#include <cstdint>
 
// include the sparkfun toolkit headers
#include <sfeTk/sfeToolKit.h>
 
// Default I2C address for the sensor
#define SFE_SOIL_MOISTURE_DEFAULT_I2C_ADDRESS 0x28
 
// Max value for  the sensor value (10-bit ADC) 2^10  = 1024-1
#define SFE_SOIL_MOISTURE_MAX_VALUE 1023
 
class sfeDevSoilMoisture
{
 
  public:
    // ctor
    sfeDevSoilMoisture() : _theBus{nullptr}
    {
    }
 
    sfeTkError_t begin(sfeTkIBus *theBus = nullptr);
 
    sfeTkError_t LEDOff(void);
 
    sfeTkError_t LEDOn(void);
 
    uint16_t readMoistureValue(void);
 
    float readMoistureRatio(void);
 
    float readMoisturePercentage(void);
 
    sfeTkError_t changeSensorAddress(uint8_t newAddress);
 
  protected:
    // The toolkit bus the sensor is connected to
    sfeTkIBus *_theBus;
 
}; // class sfeDevSoilMoisture