https://github.com/sparkfun/qwiic_soil_moisture_sensor_py
Python module to interface with the Qwiic Soil Moisture Sensor Board
https://github.com/sparkfun/qwiic_soil_moisture_sensor_py
python python3 qwiic sensor sparkfun
Last synced: about 1 month ago
JSON representation
Python module to interface with the Qwiic Soil Moisture Sensor Board
- Host: GitHub
- URL: https://github.com/sparkfun/qwiic_soil_moisture_sensor_py
- Owner: sparkfun
- License: mit
- Created: 2021-02-08T18:45:03.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-01-14T16:36:54.000Z (10 months ago)
- Last Synced: 2025-01-14T18:21:39.168Z (10 months ago)
- Topics: python, python3, qwiic, sensor, sparkfun
- Language: Python
- Homepage: http://docs.sparkfun.com/Qwiic_Soil_Moisture_Sensor_Py/
- Size: 5.62 MB
- Stars: 3
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SparkFun Qwiic Soil Moisture Sensor - Python Package
[](https://docs.sparkfun.com/qwiic_soil_moisture_sensor_py/classqwiic__soil__moisture__sensor_1_1_qwiic_soil_moisture_sensor.html)
The SparkFun Qwiic Soil Moisture Sensor provides a simple and cost effective solution for adding soil moisture sensing to your project. Implementing a SparkFun Qwiic I2C interface, these sensors can be rapidly added to any project with boards that are part of the SparkFun Qwiic ecosystem.
This repository implements a Python package for the SparkFun Qwiic Soil Moisture Sensor. This package works with Python, MicroPython and CircuitPython.
### Contents
* [About](#about-the-package)
* [Installation](#installation)
* [Supported Platforms](#supported-platforms)
* [Documentation](https://docs.sparkfun.com/qwiic_soil_moisture_sensor_py/classqwiic__soil__moisture__sensor_1_1_qwiic_soil_moisture_sensor.html)
* [Examples](#example-use)
## About the Package
This python package enables the user to access the features of the Qwiic Soil Moisture Sensor via a single Qwiic cable. This includes reading the moisture level, turning on and off the LED, and more. The capabilities of the moisture sensor are each demonstrated in the included examples.
New to qwiic? Take a look at the entire [SparkFun qwiic ecosystem](https://www.sparkfun.com/qwiic).
### Supported SparkFun Products
This Python package supports the following SparkFun qwiic products on Python, MicroPython and Circuit python.
* [SparkFun Qwiic Soil Moisture Sensor](https://www.sparkfun.com/sparkfun-qwiic-soil-moisture-sensor.html)
### Supported Platforms
| Python | Platform | Boards |
|--|--|--|
| Python | Linux | [Raspberry Pi](https://www.sparkfun.com/raspberry-pi-5-8gb.html) , [NVIDIA Jetson Orin Nano](https://www.sparkfun.com/nvidia-jetson-orin-nano-developer-kit.html) via the [SparkFun Qwiic SHIM](https://www.sparkfun.com/sparkfun-qwiic-shim-for-raspberry-pi.html) |
| MicroPython | Raspberry Pi - RP2, ESP32 | [SparkFun Pro Micro RP2350](https://www.sparkfun.com/sparkfun-pro-micro-rp2350.html), [SparkFun IoT RedBoard ESP32](https://www.sparkfun.com/sparkfun-iot-redboard-esp32-development-board.html), [SparkFun IoT RedBoard RP2350](https://www.sparkfun.com/sparkfun-iot-redboard-rp2350.html)
|CircuitPython | Raspberry Pi - RP2, ESP32 | [SparkFun Pro Micro RP2350](https://www.sparkfun.com/sparkfun-pro-micro-rp2350.html), [SparkFun IoT RedBoard ESP32](https://www.sparkfun.com/sparkfun-iot-redboard-esp32-development-board.html), [SparkFun IoT RedBoard RP2350](https://www.sparkfun.com/sparkfun-iot-redboard-rp2350.html)
> [!NOTE]
> The listed supported platforms and boards are the primary platform targets tested. It is fully expected that this package will work across a wide variety of Python enabled systems.
## Installation
The first step to using this package is installing it on your system. The install method depends on the python platform. The following sections outline installation on Python, MicroPython and CircuitPython.
### Python
#### PyPi Installation
The package is primarily installed using the `pip3` command, downloading the package from the Python Index - "PyPi".
Note - the below instructions outline installation an Linux-based (Raspberry Pi) system.
First, setup a virtual environment from a specific directory using venv:
```sh
python3 -m venv path/to/venv
```
You can pass any path as path/to/venv, just make sure you use the same one for all future steps. For more information on venv [click here](https://docs.python.org/3/library/venv.html).
Next, install the qwiic package with:
```sh
path/to/venv/bin/pip3 install sparkfun-qwiic-soil-moisture-sensor
```
Now you should be able to run any example or custom python scripts that have `import qwiic_soil_moisture_sensor` by running e.g.:
```sh
path/to/venv/bin/python3 example_script.py
```
### MicroPython Installation
If not already installed, follow the [instructions here](https://docs.micropython.org/en/latest/reference/mpremote.html) to install mpremote on your computer.
Connect a device with MicroPython installed to your computer and then install the package directly to your device with mpremote mip.
```sh
mpremote mip install github:sparkfun/qwiic_soil_moisture_sensor_py
```
If you would also like to install the examples for this repository, issue the following mip command as well:
```sh
mpremote mip install --target "" github:sparkfun/qwiic_soil_moisture_sensor_py@examples
```
### CircuitPython Installation
If not already installed, follow the [instructions here](https://docs.circuitpython.org/projects/circup/en/latest/#installation) to install CircUp on your computer.
Ensure that you have the latest version of the SparkFun Qwiic CircuitPython bundle.
```sh
circup bundle-add sparkfun/Qwiic_Py
```
Finally, connect a device with CircuitPython installed to your computer and then install the package directly to your device with circup.
```sh
circup install --py qwiic_soil_moisture_sensor
```
If you would like to install any of the examples from this repository, issue the corresponding circup command from below. (NOTE: The below syntax assumes you are using CircUp on Windows. Linux and Mac will have different path seperators (i.e. "/" vs. "\"). See the [CircUp "example" command documentation](https://learn.adafruit.com/keep-your-circuitpython-libraries-on-devices-up-to-date-with-circup/example-command) for more information)
```sh
circup example qwiic_soil_moisture_sensor\Example1_GetReadings
circup example qwiic_soil_moisture_sensor\Example2_Change_I2C_Address
```
Example Use
---------------
Below is a quickstart program to print moisture level and toggle the LED on the Soil Moisture Sensor.
See the examples directory for more detailed use examples and [examples/README.md](https://github.com/sparkfun/qwiic_soil_moisture_sensor_py/blob/main/examples/README.md) for a summary of the available examples.
```python
import qwiic_soil_moisture_sensor
import time
import sys
def runExample():
print("\nSparkFun Qwiic Soil Moisture Sensor Example 1\n")
mySoilSensor = qwiic_soil_moisture_sensor.QwiicSoilMoistureSensor()
if mySoilSensor.is_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)
```
