Skip to main content

DisplayIO driver for SSD1306 monochrome displays

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

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 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 = displayio.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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

File details

Details for the file adafruit-circuitpython-displayio-ssd1306-2.0.0.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-displayio-ssd1306-2.0.0.tar.gz
Algorithm Hash digest
SHA256 12fce9461df161bfda9fca27231e59bc2cd733c024a6cfd9f3f89f380a48a56c
MD5 2fe453e000dee284b701fa1ba40aba0f
BLAKE2b-256 2e247c5a521d9efc6b43de508ba79b0fd277653da0f2d9ebed688b6702740052

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_displayio_ssd1306-2.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_displayio_ssd1306-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a862ad9d94b1e0a69232d37c3a996acaeae44d6253c74b81f505b0dc4b88ad3a
MD5 b262cfa2057fe954b4efbc06ce96bd10
BLAKE2b-256 a54820d6af3e5b2b611108cde55e40e8d96e46fd6bf3a9ed28f389d0c34f2ee9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page