README.rst

Introduction

CircuitPython I2C Button à la Sparkfun Qwiic Button/Switch/Arcade

Dependencies

This driver depends on:

• Adafruit CircuitPython
• Bus Device

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 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 i2c_button

Or the following command to update an existing version:

circup update

Usage Example

import board
import busio
from i2c_button import I2C_Button

i2c = board.I2C()
button = I2C_Button(i2c)
print('firmware version is', button.version)

See examples/i2c_button_simpletest.py and other scripts in that folder for more extensive examples.

Credits

This library is based upon the Sparkfun Arduino library and SparkX Switch firmware authored by Nathan Seidle, Fischer Moseley and Priyanka Makin.

• Arduino Library
• Switch Firmware

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Documentation

For information on building library documentation, please check out this guide.