follow on Twitter

SparkFun Qwiic Twist Breakout

Python module for the qwiic twist, which is part of the SparkFun Qwiic Twist

This python package is a port of the existing SparkFun Qwiic Twist Arduino Library

This package can be used in conjunction with the overall SparkFun qwiic Python Package

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


This driver package depends on the qwiic I2C driver: Qwiic_I2C_Py


The SparkFun qwiic Twist module documentation is hosted at ReadTheDocs


PyPi Installation

This repository is hosted on PyPi as the sparkfun-qwiic-twist package. On systems that support PyPi installation via pip, this library is installed using the following commands

For all users (note: the user must have sudo privileges):

sudo pip install sparkfun-qwiic-twist

For the current user:

pip install sparkfun-qwiic-twist

Local Installation

To install, make sure the setuptools package is installed on the system.

Direct installation at the command line:

python setup.py install

To build a package for use with pip:

python setup.py sdist

A package file is built and placed in a subdirectory called dist. This package file can be installed using pip.

cd dist
pip install sparkfun_qwiic_twist-<version>.tar.gz

Example Use

See the examples directory for more detailed use examples.

import qwiic_twist
import time
import sys

def runExample():

    print("\nSparkFun qwiic Twist   Example 1\n")
    myTwist = qwiic_twist.QwiicTwist()

    if myTwist.connected == False:
        print("The Qwiic twist device isn't connected to the system. Please check your connection", \


    # Set the knob color to pink
    myTwist.set_color(100, 10, 50)

    while True:

        print("Count: %d, Pressed: %s" % (myTwist.count, \
            "YES" if myTwist.pressed else "NO", \


if __name__ == '__main__':
    except (KeyboardInterrupt, SystemExit) as exErr:
        print("\nEnding Example 1")

SparkFun - Start Something

Indices and tables