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

File metadata

File hashes

Hashes for adafruit_circuitpython_displayio_ssd1306-2.0.3.tar.gz
Algorithm Hash digest
SHA256 f01736e4a07773c37479e6ca57e43cea9765109b83c5b78e935f83437e2c8393
MD5 af3c847155c0137db9c5a0f9cbb2f035
BLAKE2b-256 78630ec7d221e67ffc577c6c74f0c4dab6ab4be52265efb139b5d69a4914ce68

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_displayio_ssd1306-2.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 13fdd763f88aea6d2f76a2ff15847f39a3a89b74136f71520751e51ea655f209
MD5 73018fc582c1a79b69a99d96b7f5de0c
BLAKE2b-256 c4a16a4749e9bc3b5b67c836071fc026fbf2babe79b026c1ff8d0ae6d4aedbb5

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