Skip to content
Python package for the qwiic Micro OLED board
Branch: master
Clone or download
santaimpersonator Adds left horizontal scroll
Adds left horizontal scroll to the library.
Latest commit 933be42 Jul 18, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs fixed typo Jul 4, 2019
examples finished port to pythonic naming/interface scheme Jul 13, 2019
qwiic_micro_oled Adds left horizontal scroll Jul 18, 2019
.readthedocs.yml added docs support Jul 4, 2019
DESCRIPTION.rst initial entry Jun 21, 2019
LICENSE MIT License Jun 25, 2019 initial entry Jun 21, 2019 Update Jul 11, 2019
setup.cfg initial entry Jun 21, 2019 cleanup, version bump Jul 15, 2019


follow on Twitter

SparkFun Qwiic Micro OLED Breakout

Python package for the qwiic Micro OLED board

This package is a port of the SparkFun Micro OLED Breakout 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.


Supported Platforms

The qwiic Python package current supports the following platforms:


This driver package depends on the qwiic I2C driver: Qwiic_I2C_Py


The SparkFun qwiic Micro OLED module documentation is hosted at ReadTheDocs


PyPi Installation

This repository is hosted on PyPi as the sparkfun-qwiic-micro-oled 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-micro-oled

For the current user:

pip install sparkfun_qwiic_micro_oled

Local Installation

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

Direct installation at the command line:

python install

To build a package for use with pip:

python 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_micro_oled-<version>.tar.gz

Example Use

See the examples directory for more detailed use examples.

import qwiic_micro_oled
import sys

def runExample():

    #  These three lines of code are all you need to initialize the
    #  OLED and print the splash screen.
    #  Before you can start using the OLED, call begin() to init
    #  all of the pins and configure the OLED.

    print("\nSparkFun Micro OLED Hello Example\n")
    myOLED = qwiic_micro_oled.QwiicMicroOled()

    if myOLED.isConnected() == False:
        print("The Qwiic Micro OLED device isn't connected to the system. Please check your connection", \

    #  clear(ALL) will clear out the OLED's graphic memory.
    #  clear(PAGE) will clear the Arduino's display buffer.
    myOLED.clear(myOLED.ALL)  #  Clear the display's memory (gets rid of artifacts)
    #  To actually draw anything on the display, you must call the
    #  display() function. 


SparkFun - Start Something

You can’t perform that action at this time.