Introduction¶
CircuitPython library for SparkFun Qwiic Quad Solid State Relay Kit (COM-16833).
Dependencies¶
This driver depends on:
Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.
Installing from PyPI¶
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:
pip3 install circuitpython-sparkfun-qwiicquadsolidstaterelay
To install system-wide (this may be required in some cases):
sudo pip3 install circuitpython-sparkfun-qwiicquadsolidstaterelay
To install in a virtual environment in your current project:
mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install circuitpython-sparkfun-qwiicquadsolidstaterelay
Installing to a Connected CircuitPython Device with Circup¶
Make sure that you have circup installed in your Python environment.
Install it with the following command if necessary:
pip3 install circup
With circup installed and your CircuitPython device connected use the
following command to install:
circup install sparkfun_qwiicquadsolidstaterelay
Or the following command to update an existing version:
circup update
Usage Example¶
""" QuadRelayTest """
# QuadRelayTest: Copyright (c) 2022 Graham Beland
#
# SPDX-License-Identifier: MIT
# import the CircuitPython board and busio libraries
import time as tm
# CircuitPython board
import board
# the sparkfun_qwiicquadsolidstaterelay
import sparkfun_qwiicquadsolidstaterelay
# Create bus object using the board's I2C port
i2c = board.I2C()
# Note: default i2c address is 8
theRelay = sparkfun_qwiicquadsolidstaterelay.Sparkfun_QwiicQuadSolidStateRelay(i2c)
print("Opened: Relay Controller")
if theRelay.connected:
print("Relay connected. ")
theRelay.relay_on(1)
tm.sleep(1)
theRelay.relay_off(1)
else:
print("Relay does not appear to be connected. Please check wiring.")
Documentation¶
API documentation for this library can be found on Read the Docs.
For information on building library documentation, please check out this guide.
Contributing¶
Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.
Table of Contents¶
Examples
API Reference