DisplayIO driver for SSD1306 monochrome displays

This driver depends on:

• Adafruit CircuitPython Version 5+

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

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 .env source .env/bin/activate pip3 install adafruit-circuitpython-displayio-ssd1306

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)

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):

python3 -m venv .env source .env/bin/activate pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

cd docs sphinx-build -E -W -b html . _build/html

This will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.