https://github.com/adafruit/adafruit_circuitpython_displayio_ssd1306

DisplayIO driver for SSD1306 monochrome OLED displays
https://github.com/adafruit/adafruit_circuitpython_displayio_ssd1306

circuitpython displayio hacktoberfest monochrome-displays monochrome-oled-displays oled oled-display ssd1306

Last synced: 4 days ago
JSON representation

DisplayIO driver for SSD1306 monochrome OLED displays

• Host: GitHub
• URL: https://github.com/adafruit/adafruit_circuitpython_displayio_ssd1306
• Owner: adafruit
• License: mit
• Created: 2019-07-23T21:49:11.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-10-07T21:45:06.000Z (3 months ago)
• Last Synced: 2024-12-16T17:51:12.111Z (6 days ago)
• Topics: circuitpython, displayio, hacktoberfest, monochrome-displays, monochrome-oled-displays, oled, oled-display, ssd1306
• Language: Python
• Size: 142 KB
• Stars: 63
• Watchers: 22
• Forks: 24
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Introduction

============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-displayio-ssd1306/badge/?version=latest

    :target: https://docs.circuitpython.org/projects/displayio_ssd1306/en/latest/

    :alt: Documentation Status

.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg

    :target: https://adafru.it/discord

    :alt: Discord

.. image:: https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SSD1306/workflows/Build%20CI/badge.svg

    :target: https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SSD1306/actions/

    :alt: Build Status

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

    :target: https://github.com/psf/black

    :alt: 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:

* `Adafruit CircuitPython `_

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:

.. code-block:: shell

    pip3 install adafruit-circuitpython-displayio-ssd1306

To install system-wide (this may be required in some cases):

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-displayio-ssd1306

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name

    python3 -m venv .venv

    source .venv/bin/activate

    pip3 install adafruit-circuitpython-displayio-ssd1306

Usage Example

=============

.. code-block:: python

    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.