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-1.6.3.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-displayio-ssd1306-1.6.3.tar.gz
Algorithm Hash digest
SHA256 fbd935dc2498f8a0ef50242062e1f673dacdadc14128ead362f9c4d688076be9
MD5 64d31e91a135ed9b2e0762dca8cbe917
BLAKE2b-256 760b4bf1e63553453b5ef0b8cfa59e7cef5641f78c53ca2e8a3341a2670d2379

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_displayio_ssd1306-1.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 690bc720c35c1d878259baa9b96e5f784d27d2e88945ceec1b1a7d824e5208a0
MD5 653f2399d383dff951e2f17767bacc4e
BLAKE2b-256 51ce22c7ef59003e23ca594b976e5c90e0ec77032ec39f6d8843274e7a2c5a16

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