Skip to main content

Introduction

Documentation Status Discord Build Status Code Style: Ruff

DisplayIO driver for SSD1306 monochrome displays. DisplayIO drivers enable terminal output

For the framebuf based driver see Adafruit CircuitPython SSD1306.

Dependencies

This driver depends on:

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

Installing from PyPI

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-displayio-ssd1306

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

sudo pip3 install adafruit-circuitpython-displayio-ssd1306

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-displayio-ssd1306

Usage Example

import board
import displayio
import fourwire
import adafruit_displayio_ssd1306
import busio

displayio.release_displays()

# This pinout works on a Metro and may need to be altered for other boards.
spi = busio.SPI(board.SCL, board.SDA)
tft_cs = board.D9
tft_dc = board.D8
tft_reset = board.D7

display_bus = fourwire.FourWire(spi, command=tft_dc, chip_select=tft_cs, reset=tft_reset, baudrate=1000000)
display = adafruit_displayio_ssd1306.SSD1306(display_bus, width=128, height=64)

Documentation

API documentation for this library can be found on Read the Docs.

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

Contributing

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

Metadata

Release files for adafruit-circuitpython-displayio-ssd1306 3.0.6

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for adafruit-circuitpython-displayio-ssd1306 3.0.6
File Size Uploaded
adafruit_circuitpython_displayio_ssd1306-3.0.6.tar.gz 25.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for adafruit-circuitpython-displayio-ssd1306 3.0.6
File Interpreter ABI Platform
adafruit_circuitpython_displayio_ssd1306-3.0.6-py3-none-any.whl Python 3 none any Details

Total release size: 31.7 kB

Release files / adafruit_circuitpython_displayio_ssd1306-3.0.6.tar.gz

Download URL adafruit_circuitpython_displayio_ssd1306-3.0.6.tar.gz
Size 25.7 kB
Tags Source
SHA-256 checksum
How to use checksums
944a79ddbceba7be8a6e88241380153795431ea0d1ec6daeaf3031e46e968df1
BLAKE2b-256 checksum
How to use checksums
b349aa490d858fb0bff95b0451f48ad026b17d058132ec7f814fe49139840c89
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Release files / adafruit_circuitpython_displayio_ssd1306-3.0.6-py3-none-any.whl

Download URL adafruit_circuitpython_displayio_ssd1306-3.0.6-py3-none-any.whl
Size 6.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
72effdf82a9acd3f50313bf8cd3b6cf1e871c89e7aae0bb99a3916c835b3f6dd
BLAKE2b-256 checksum
How to use checksums
a98473072a2e6cc871849ef5bbf928f38ee44c610d4b1d0c8e580d939ddc95d9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Release history Release notifications | RSS feed

This release

3.0.6 This release

2 release files

3.0.5

2 release files

3.0.4

2 release files

3.0.3

2 release files

3.0.2

2 release files

3.0.1

2 release files

3.0.0

2 release files

2.1.2

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.3

2 release files

2.0.2

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.8.0

2 release files

1.7.1

2 release files

1.7.0

2 release files

1.6.3

2 release files

1.6.2

2 release files

1.6.1

2 release files

1.6.0

2 release files

1.5.11

2 release files

1.5.9

2 release files

1.5.8

2 release files

1.5.7

2 release files

1.5.6

2 release files

1.5.5

1 release file

1.5.4

1 release file

1.5.3

1 release file

1.5.2

1 release file

1.5.1

1 release file

1.5.0

1 release file

1.4.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page