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

File metadata

File hashes

Hashes for adafruit-circuitpython-displayio-ssd1306-1.5.9.tar.gz
Algorithm Hash digest
SHA256 991a0ffcb21cf3348fa3fb07472b0f17e4cf05837ba529c5e497bce9d6a74e5c
MD5 def9c660e890fb4a70a7df21d0deec6f
BLAKE2b-256 e59c4793a1d7382b92f4e3cfd392b733a8293dbd81e18cbda2ddab5399bbdacb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_displayio_ssd1306-1.5.9-py3-none-any.whl
Algorithm Hash digest
SHA256 ca0021af0e3c8f7714289628573db68e56a0c540d46f7129a94071cdf435bce8
MD5 d71f3fb41ea9b2028ba8d60c26bdcd53
BLAKE2b-256 47cc7fd35d4eae7f3acc09f60c9d5696d96021618f4cd76a076099331dd46644

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