The SparkFun Qwiic Air Velocity Sensing FS3000 Module provides a simple and cost effective solution for adding Air Velocity Sensing capabilities 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 FS3000. This package works with Python, MicroPython and CircuitPython.
This python package enables the user to access the features of the FS3000 via a single Qwiic cable. This includes reading air velocity and more. The capabilities of the FS3000 are each demonstrated in the included examples.
New to qwiic? Take a look at the entire SparkFun qwiic ecosystem.
This Python package supports the following SparkFun qwiic products on Python, MicroPython and Circuit python.
- SparkFun Air Velocity Sensor Breakout - FS3000-1005
- SparkFun Air Velocity Sensor Breakout - FS3000-1015
| Python | Platform | Boards |
|---|---|---|
| Python | Linux | Raspberry Pi , NVIDIA Jetson Orin Nano via the SparkFun Qwiic SHIM |
| MicroPython | Raspberry Pi - RP2, ESP32 | SparkFun Pro Micro RP2350, SparkFun IoT RedBoard ESP32, SparkFun IoT RedBoard RP2350 |
| CircuitPython | Raspberry Pi - RP2, ESP32 | SparkFun Pro Micro RP2350, SparkFun IoT RedBoard ESP32, SparkFun IoT RedBoard RP2350 |
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.
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.
The package is primarily installed using the pip3 command, downloading the package from the Python Index - "PyPi".
Note - the below instructions outline installation on a Linux-based (Raspberry Pi) system.
First, setup a virtual environment from a specific directory using venv:
python3 -m venv path/to/venvYou 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.
Next, install the qwiic package with:
path/to/venv/bin/pip3 install sparkfun-qwiic-fs3000Now you should be able to run any example or custom python scripts that have import qwiic_fs3000 by running e.g.:
path/to/venv/bin/python3 example_script.pyIf not already installed, follow the instructions here 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.
mpremote mip install github:sparkfun/qwiic_fs3000_pyIf you would also like to install the examples for this repository, issue the following mip command as well:
mpremote mip install --target "" github:sparkfun/qwiic_fs3000_py@examplesIf not already installed, follow the instructions here to install CircUp on your computer.
Ensure that you have the latest version of the SparkFun Qwiic CircuitPython bundle.
circup bundle-add sparkfun/Qwiic_PyFinally, connect a device with CircuitPython installed to your computer and then install the package directly to your device with circup.
circup install --py qwiic_fs3000If 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. See the CircUp "example" command documentation for more information)
circup example qwiic_fs3000\qwiic_fs3000_ex1_basicBelow is a quickstart program to print readings from the FS3000.
See the examples directory for more detailed use examples and examples/README.md for a summary of the available examples.
import qwiic_fs3000
import sys
import time
def runExample():
print("\nQwiic Template Example 1 - Basic\n")
myFS3000 = qwiic_fs3000.QwiicFS3000()
if myFS3000.is_connected() == False:
print("The device isn't connected to the system. Please check your connection", \
file=sys.stderr)
return
myFS3000.begin()
myFS3000.set_range(myFS3000.kAirflowRange7Mps)
while True:
print("FS3000 Readings \tRaw: ", end="")
print(myFS3000.read_raw(), end="") # note, this returns an int from 0-3686
print("\tm/s: ", end="")
print(myFS3000.read_meters_per_second(), end="") # note, this returns a float from 0-7.23 for the FS3000-1005, and 0-15 for the FS3000-1015
print("\tmph: ", end="")
print(myFS3000.read_miles_per_hour()) # note, this returns a float from 0-16.17 for the FS3000-1005, and 0-33.55 for the FS3000-1015
time.sleep(1) # note, response time on the sensor is 125ms
if __name__ == '__main__':
try:
runExample()
except (KeyboardInterrupt, SystemExit) as exErr:
print("\nEnding Example 1")
sys.exit(0)
