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

File metadata

File hashes

Hashes for adafruit_circuitpython_displayio_ssd1306-2.1.1.tar.gz
Algorithm Hash digest
SHA256 82242d2a1b553228eac4d968780a932c5512c41ccfb3692e7553b5b04b3028e0
MD5 01916c003292d8cb982f5db4672fc4fa
BLAKE2b-256 85a2c706609be5ad2f2e859c3f3a7fd7af0b6d38d49d3320c3952fcbc9c9e890

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_displayio_ssd1306-2.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 661642fa16f5ae16d4a982dce1ad9ca328c06b07afeb705e8c67b99edf2257f0
MD5 2ed0db5632666d5026414dd6b41dfeaa
BLAKE2b-256 eaffe4fb6debf7a0792dba53d8ff2dc6d1a65f06594f3351e355d95db39b6614

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