The Python package for the Qwiic OLED Display 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.
The qwiic Python package current supports the following platforms:
This driver package depends on the qwiic I2C driver: Qwiic_I2C_Py
This package depends on the OLED display driver base package: Qwiic_OLED_Base_Py
The SparkFun Qwiic OLED Display module documentation is hosted at ReadTheDocs
This repository is hosted on PyPi as the sparkfun-qwiic-oled-display 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-oled-display
For the current user:
pip install sparkfun_qwiic_oled_display
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.
pip install sparkfun_oled_display-<version>.tar.gz
# These lines of code are all you need to initialize the OLED display and print text on the screen.
print("\nSparkFun Qwiic OLED Display - Hello Example\n")
myOLED = qwiic_oled_display.QwiicOledDisplay()
if myOLED.is_connected() == False:
print("The Qwiic OLED Display isn't connected to the system. Please check your connection", \
# Before you can start using the OLED, call begin() to init all of the pins and configure the OLED.
myOLED.clear(myOLED.PAGE) # Clear the display's buffer
myOLED.print("Hello World") # Add "Hello World" to buffer
# To actually draw anything on the display, you must call the display() function.