Qwiic_Soil_Moisture_Sensor_Py

Python module for the SparkFun Qwiic Soil Moisture Sensor

This python package is a port of the existing SparkFun Soil Moisture Sensor Arduino Examples

This package can be used in conjunction with the overall SparkFun qwiic Python Package

New to qwiic? Take a look at the entire SparkFun qwiic ecosystem.

Contents

• Supported Platforms
• Dependencies
• Installation
• Documentation
• Example Use

Supported Platforms

The qwiic Soil Moisture Sensor Python package current supports the following platforms:

• Raspberry Pi
• NVidia Jetson Nano
• Google Coral Development Board

Dependencies

This driver package depends on the qwiic I2C driver: Qwiic_I2C_Py

Documentation

The SparkFun qwiic Soil Moisture Sensor module documentation is hosted at ReadTheDocs

Installation

PyPi Installation

This repository is hosted on PyPi as the sparkfun-qwiic-soil-moisture-sensor package. On systems that support PyPi installation via pip, this library is installed using the following commands

For all users (note: the user must have sudo privileges):

sudo pip install sparkfun-qwiic-soil-moisture-sensor

For the current user:

pip install sparkfun-qwiic-soil-moisture-sensor

To install, make sure the setuptools package is installed on the system.

Direct installation at the command line:

python setup.py install

To build a package for use with pip:

python setup.py sdist

A package file is built and placed in a subdirectory called dist. This package file can be installed using pip.

cd dist
pip install sparkfun-qwiic-soil-moisture-sensor-<version>.tar.gz

Example Use

See the examples directory for more detailed use examples.

from __future__ import print_function
import qwiic_soil_moisture_sensor
 
 
def runExample():
 
    print("\nSparkFun qwiic soil moisture sensor Example 1\n")
    mySoilSensor = qwiic_soil_moisture_sensor.QwiicSoilMoistureSensor()
 
    if mySoilSensor.connected == False:
        print("The Qwiic Soil Moisture Sensor device isn't connected to the system. Please check your connection", \
            file=sys.stderr)
        return
 
    mySoilSensor.begin()
 
    print("Initialized.")
 
    while True:
        mySoilSensor.read_moisture_level()
        print (mySoilSensor.level)
        mySoilSensor.led_on()
        time.sleep(1)
        mySoilSensor.led_off()
        time.sleep(1)
 
if __name__ == '__main__':
    try:
        runExample()
    except (KeyboardInterrupt, SystemExit) as exErr:
        print("\nEnding Example 1")
        sys.exit(0)