Skip to content

sparkfun/qwiic_as7265x_py

Repository files navigation

Qwiic AS7265X - Python Package

SparkFun Qwiic AS7265X - Python Package

PyPi Version GitHub issues License X API

The SparkFun Qwiic Triad Spectral Sensing AS7265X Module provides a simple and cost effective solution for adding Triad Spectral 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 AS7265X. This package works with Python, MicroPython and CircuitPython.

Contents

About the Package

This python package enables the user to access the features of the AS7265X via a single Qwiic cable. This includes extracting UV readings, extracting IR readings, toggling LEDs and more. The capabilities of the AS7265X are each demonstrated in the included examples.

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

Supported SparkFun Products

This Python package supports the following SparkFun qwiic products on Python, MicroPython and Circuit python.

Supported Platforms

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.

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 on a Linux-based (Raspberry Pi) system.

First, setup a virtual environment from a specific directory using venv:

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.

Next, install the qwiic package with:

path/to/venv/bin/pip3 install sparkfun-qwiic-as7265x

Now you should be able to run any example or custom python scripts that have import qwiic_as7265x by running e.g.:

path/to/venv/bin/python3 example_script.py

MicroPython Installation

If 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_as7265x_py

If 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_as7265x_py@examples

CircuitPython Installation

If 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_Py

Finally, connect a device with CircuitPython installed to your computer and then install the package directly to your device with circup.

circup install --py qwiic_as7265x

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. See the CircUp "example" command documentation for more information)

circup example qwiic_as7265x\qwiic_as7265x_ex1_basic
circup example qwiic_as7265x\qwiic_as7265x_ex2_leds
circup example qwiic_as7265x\qwiic_as7265x_ex3_settings
circup example qwiic_as7265x\qwiic_as7265x_ex4_read_raw
circup example qwiic_as7265x\qwiic_as7265x_ex5_max_read_rate
circup example qwiic_as7265x\qwiic_as7265x_ex6_read_temp
circup example qwiic_as7265x\qwiic_as7265x_ex7_get_version

Example Use

Below is a quickstart program to print readings from the AS7265X.

See the examples directory for more detailed use examples and examples/README.md for a summary of the available examples.

import qwiic_as7265x
import sys

def runExample():
    print("\nQwiic Spectral Triad Example 1 - Basic\n")

    myAS7265x = qwiic_as7265x.QwiicAS7265x()

    if myAS7265x.is_connected() == False:
        print("The device isn't connected to the system. Please check your connection", \
            file=sys.stderr)
        return

    if myAS7265x.begin() == False:
        print("Unable to initialize the AS7265x. Please check your connection", file = sys.stderr)
        return

    print("A,B,C,D,E,F,G,H,R,I,S,J,T,U,V,W,K,L")

    while True:
        myAS7265x.take_measurements()
        print(str(myAS7265x.get_calibrated_a()) + ",", end="")  # 410nm
        print(str(myAS7265x.get_calibrated_b()) + ",", end="")  # 435nm
        print(str(myAS7265x.get_calibrated_c()) + ",", end="")  # 460nm
        print(str(myAS7265x.get_calibrated_d()) + ",", end="")  # 485nm
        print(str(myAS7265x.get_calibrated_e()) + ",", end="")  # 510nm
        print(str(myAS7265x.get_calibrated_f()) + ",", end="")  # 535nm

        print(str(myAS7265x.get_calibrated_g()) + ",", end="")  # 560nm
        print(str(myAS7265x.get_calibrated_h()) + ",", end="")  # 585nm
        print(str(myAS7265x.get_calibrated_r()) + ",", end="")  # 610nm
        print(str(myAS7265x.get_calibrated_i()) + ",", end="")  # 645nm
        print(str(myAS7265x.get_calibrated_s()) + ",", end="")  # 680nm
        print(str(myAS7265x.get_calibrated_j()) + ",", end="")  # 705nm

        print(str(myAS7265x.get_calibrated_t()) + ",", end="")  # 730nm
        print(str(myAS7265x.get_calibrated_u()) + ",", end="")  # 760nm
        print(str(myAS7265x.get_calibrated_v()) + ",", end="")  # 810nm
        print(str(myAS7265x.get_calibrated_w()) + ",", end="")  # 860nm
        print(str(myAS7265x.get_calibrated_k()) + ",", end="")  # 900nm
        print(str(myAS7265x.get_calibrated_l()))  # 940nm	

if __name__ == '__main__':
    try:
        runExample()
    except (KeyboardInterrupt, SystemExit) as exErr:
        print("\nEnding Example")
        sys.exit(0)

SparkFun - Start Something