Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ssd1322/badge/?version=latest
:target: https://docs.circuitpython.org/projects/ssd1322/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_SSD1322/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_SSD1322/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 grayscale OLEDs driven by SSD1322
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-ssd1322/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-ssd1322
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-ssd1322
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-ssd1322
Usage Example
=============
.. code-block:: python
import time
import board
import busio
import displayio
import adafruit_ssd1322
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_ssd1322.SSD1322(display_bus, width=256, height=64, colstart=28)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ssd1322/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_SSD1322/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-ssd1322",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,ssd1322,oled,grayscale,displayio",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/71/f7/a5089f633a75be92527142ec958c88a96c414fac4cd3b1230a9bdb9d7d85/adafruit-circuitpython-ssd1322-1.4.1.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ssd1322/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/ssd1322/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_SSD1322/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_SSD1322/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 grayscale OLEDs driven by SSD1322\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-ssd1322/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-ssd1322\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-ssd1322\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-ssd1322\n\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import time\n import board\n import busio\n import displayio\n import adafruit_ssd1322\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,\n reset=tft_reset, baudrate=1000000)\n time.sleep(1)\n display = adafruit_ssd1322.SSD1322(display_bus, width=256, height=64, colstart=28)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ssd1322/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_SSD1322/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 SSD1322",
"version": "1.4.1",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_SSD1322"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"ssd1322",
"oled",
"grayscale",
"displayio"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e69b067839c6eec659906169e69f54d498f5b7c0cd4a76f99539fb21fd426302",
"md5": "70d5d8f707a46c1fe35327f65468c7a8",
"sha256": "215726de2ed26d0479195f01e68b2de4c007e4b3f2e165bad940688cf5922b43"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ssd1322-1.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "70d5d8f707a46c1fe35327f65468c7a8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5695,
"upload_time": "2023-12-09T17:34:32",
"upload_time_iso_8601": "2023-12-09T17:34:32.823225Z",
"url": "https://files.pythonhosted.org/packages/e6/9b/067839c6eec659906169e69f54d498f5b7c0cd4a76f99539fb21fd426302/adafruit_circuitpython_ssd1322-1.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "71f7a5089f633a75be92527142ec958c88a96c414fac4cd3b1230a9bdb9d7d85",
"md5": "60d8c5a5bd142669c0e184ffc875e0ab",
"sha256": "ea844a6cefa57f45275d448fccc04d285bd2b23bf7a4e41094dfd630ae37dc2a"
},
"downloads": -1,
"filename": "adafruit-circuitpython-ssd1322-1.4.1.tar.gz",
"has_sig": false,
"md5_digest": "60d8c5a5bd142669c0e184ffc875e0ab",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27021,
"upload_time": "2023-12-09T17:34:33",
"upload_time_iso_8601": "2023-12-09T17:34:33.959348Z",
"url": "https://files.pythonhosted.org/packages/71/f7/a5089f633a75be92527142ec958c88a96c414fac4cd3b1230a9bdb9d7d85/adafruit-circuitpython-ssd1322-1.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 17:34:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_SSD1322",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-ssd1322"
}
JSON
