Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ssd1327/badge/?version=latest
:target: https://docs.circuitpython.org/projects/ssd1327/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_SSD1327/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_SSD1327/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 drivers for grayscale OLEDs driven by SSD1327
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-ssd1327/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-ssd1327
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-ssd1327
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-ssd1327
Usage Example
=============
.. code-block:: python
import board
import displayio
import adafruit_ssd1327
import busio
import time
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.D6
tft_dc = board.D9
tft_reset = board.D5
display_bus = displayio.FourWire(spi, command=tft_dc, chip_select=tft_cs, reset=tft_reset, baudrate=1000000)
time.sleep(1)
display = adafruit_ssd1327.SSD1327(display_bus, width=128, height=128)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ssd1327/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_SSD1327/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-ssd1327",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,ssd1327,oled,grayscale,displayio",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/60/d4/9b3d19100e1d5789cdf1a054ca0ef10d4354ad656047a6af54686c189979/adafruit-circuitpython-ssd1327-1.4.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ssd1327/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/ssd1327/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_SSD1327/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_SSD1327/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 drivers for grayscale OLEDs driven by SSD1327\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-ssd1327/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-ssd1327\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-ssd1327\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-ssd1327\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import board\n import displayio\n import adafruit_ssd1327\n import busio\n import time\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.D6\n tft_dc = board.D9\n tft_reset = board.D5\n\n display_bus = displayio.FourWire(spi, command=tft_dc, chip_select=tft_cs, reset=tft_reset, baudrate=1000000)\n time.sleep(1)\n display = adafruit_ssd1327.SSD1327(display_bus, width=128, height=128)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ssd1327/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_SSD1327/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "DisplayIO driver for grayscale OLEDs drive by SSD1327",
"version": "1.4.1",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_SSD1327"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"ssd1327",
"oled",
"grayscale",
"displayio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4f4b3805b8929607acc0c8b829f4b8c7d145a417c4bd561a81baa9a6ad712539",
"md5": "44e7c6a33ef62c24f66f39e1c63d3db1",
"sha256": "76f6a344131195bb4113e9c851848b8d5f5deda2c7d24311b72c0fc5a283c5c8"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ssd1327-1.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "44e7c6a33ef62c24f66f39e1c63d3db1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4820,
"upload_time": "2023-12-09T17:34:38",
"upload_time_iso_8601": "2023-12-09T17:34:38.047250Z",
"url": "https://files.pythonhosted.org/packages/4f/4b/3805b8929607acc0c8b829f4b8c7d145a417c4bd561a81baa9a6ad712539/adafruit_circuitpython_ssd1327-1.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "60d49b3d19100e1d5789cdf1a054ca0ef10d4354ad656047a6af54686c189979",
"md5": "ae2a2e0127b485c07d739ca526147d22",
"sha256": "dc8af1c83e4acf6e8e13ce31bdb77e8c75d1186b6d5ed51505d53674a8099a53"
},
"downloads": -1,
"filename": "adafruit-circuitpython-ssd1327-1.4.1.tar.gz",
"has_sig": false,
"md5_digest": "ae2a2e0127b485c07d739ca526147d22",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26543,
"upload_time": "2023-12-09T17:34:39",
"upload_time_iso_8601": "2023-12-09T17:34:39.296180Z",
"url": "https://files.pythonhosted.org/packages/60/d4/9b3d19100e1d5789cdf1a054ca0ef10d4354ad656047a6af54686c189979/adafruit-circuitpython-ssd1327-1.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 17:34:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_SSD1327",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-ssd1327"
}
JSON
