Adafruit CircuitPython driver for SSD1306 or SSD1305 OLED displays. Note that SSD1305 displays are back compatible so they can be used in-place of SSD1306 with the same code and commands.

This driver implements the adafruit_framebuf interface. It is not the displayio driver for the SSD1306. See the Adafruit CircuitPython DisplayIO SSD1306 driver for displayio support.

This driver depends on:

• Adafruit CircuitPython
• Bus Device
• Adafruit framebuf

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-ssd1306

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-ssd1306

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 adafruit-circuitpython-ssd1306

# Basic example of clearing and drawing pixels on a SSD1306 OLED display. # This example and library is meant to work with Adafruit CircuitPython API. # Author: Tony DiCola # License: Public Domain # Import all board pins. from board import SCL, SDA import busio # Import the SSD1306 module. import adafruit_ssd1306 # Create the I2C interface. i2c = busio.I2C(SCL, SDA) # Create the SSD1306 OLED class. # The first two parameters are the pixel width and pixel height. Change these # to the right size for your display! display = adafruit_ssd1306.SSD1306_I2C(128, 32, i2c) # Alternatively you can change the I2C address of the device with an addr parameter: #display = adafruit_ssd1306.SSD1306_I2C(128, 32, i2c, addr=0x31) # Clear the display. Always call show after changing pixels to make the display # update visible! display.fill(0) display.show()

More examples and details can be found in the adafruit_framebuf docs.

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

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