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 <https://github.com/adafruit/Adafruit_CircuitPython_SSD1306/>`_.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-displayio-ssd1306/>`_. 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 <https://docs.circuitpython.org/projects/displayio_ssd1306/en/latest/>`_.
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SSD1306/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-displayio-ssd1306",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, displayio_ssd1306, displayio, ssd1306, oled",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/95/ec/5d0ac7c15138342994b8bf122e61b04b7bd8e4baa4c11e4578915e26da1f/adafruit_circuitpython_displayio_ssd1306-2.1.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-displayio-ssd1306/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/displayio_ssd1306/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SSD1306/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SSD1306/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nDisplayIO driver for SSD1306 monochrome displays. DisplayIO drivers enable terminal output\n\nFor the framebuf based driver see\n`Adafruit CircuitPython SSD1306 <https://github.com/adafruit/Adafruit_CircuitPython_SSD1306/>`_.\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-displayio-ssd1306/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-displayio-ssd1306\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-displayio-ssd1306\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-displayio-ssd1306\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import board\n import displayio\n import adafruit_displayio_ssd1306\n import busio\n\n displayio.release_displays()\n\n # This pinout works on a Metro and may need to be altered for other boards.\n spi = busio.SPI(board.SCL, board.SDA)\n tft_cs = board.D9\n tft_dc = board.D8\n tft_reset = board.D7\n\n display_bus = displayio.FourWire(spi, command=tft_dc, chip_select=tft_cs, reset=tft_reset, baudrate=1000000)\n display = adafruit_displayio_ssd1306.SSD1306(display_bus, width=128, height=64)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/displayio_ssd1306/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SSD1306/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "DisplayIO driver for SSD1306 monochrome displays",
"version": "2.1.0",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SSD1306"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" displayio_ssd1306",
" displayio",
" ssd1306",
" oled"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ec313ac94654425712582056c1cc5e9a7216612fc2740e07c95813da51bcd044",
"md5": "1c519f24c428c865697d005c081386d8",
"sha256": "68800a01fe3dbea7975d5706d90a5d134f1c6fca286de73ef350a4c5ee0b909f"
},
"downloads": -1,
"filename": "adafruit_circuitpython_displayio_ssd1306-2.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1c519f24c428c865697d005c081386d8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6002,
"upload_time": "2024-10-07T13:53:56",
"upload_time_iso_8601": "2024-10-07T13:53:56.518247Z",
"url": "https://files.pythonhosted.org/packages/ec/31/3ac94654425712582056c1cc5e9a7216612fc2740e07c95813da51bcd044/adafruit_circuitpython_displayio_ssd1306-2.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "95ec5d0ac7c15138342994b8bf122e61b04b7bd8e4baa4c11e4578915e26da1f",
"md5": "e93370cdffb2eea7878fa75724fcbb3a",
"sha256": "2403ddbfc60fad8ad4c5eb847a15667b096e453058e3447d41386db71a49df69"
},
"downloads": -1,
"filename": "adafruit_circuitpython_displayio_ssd1306-2.1.0.tar.gz",
"has_sig": false,
"md5_digest": "e93370cdffb2eea7878fa75724fcbb3a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 29162,
"upload_time": "2024-10-07T13:53:57",
"upload_time_iso_8601": "2024-10-07T13:53:57.457319Z",
"url": "https://files.pythonhosted.org/packages/95/ec/5d0ac7c15138342994b8bf122e61b04b7bd8e4baa4c11e4578915e26da1f/adafruit_circuitpython_displayio_ssd1306-2.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-07 13:53:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_DisplayIO_SSD1306",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-displayio-ssd1306"
}
JSON
