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

File metadata

File hashes

Hashes for adafruit_circuitpython_displayio_ssd1306-2.0.2.tar.gz
Algorithm Hash digest
SHA256 4e8af13f52fee09c0c288829b5db8692aa8ac085e06e3d46ab55f41aca474035
MD5 d82920490daffb52f5aa59e690cec5a9
BLAKE2b-256 cd492bd2b4697ac5cf9e0c087f1fb38cf4a1181d26835f78790d10ed652c6f78

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_displayio_ssd1306-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d3f4f105385b80467b32f3d9081676b179b1152bac48b3364a410974c7525829
MD5 0fb9e30bd841c376934aaae0e5761e98
BLAKE2b-256 5a8337184bc61d17d36274f7745beb8da179db2dcde450ca2869a34569a3f692

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