Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-displayio-sh1107/badge/?version=latest
:target: https://docs.circuitpython.org/projects/displayio-sh1107/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_SH1107/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SH1107/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 SH1107 monochrome displays. DisplayIO drivers enable terminal output.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython Version 6+ <https://github.com/adafruit/circuitpython>`_ A new quirk in 6.0 for SH1107
* An SH1107 OLED display, eg. `Adafruit FeatherWing 128 x 64 OLED <https://www.adafruit.com/product/4650>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading the
`Adafruit library and driver bundle <https://circuitpython.org/libraries>`_.
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_sh1107/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-displayio-sh1107
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-displayio-sh1107
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-sh1107
Usage Example
=============
.. code-block:: python
import board
import displayio
import terminalio
import bitmap_label as label # from adafruit_display_text
import adafruit_displayio_sh1107
displayio.release_displays()
#oled_reset = board.D9
# Use for I2C
i2c = board.I2C()
display_bus = displayio.I2CDisplay(i2c, device_address=0x3C)
# SH1107 is vertically oriented 64x128
WIDTH = 128
HEIGHT = 64
BORDER = 2
display = adafruit_displayio_sh1107.SH1107(display_bus, width=WIDTH, height=HEIGHT)
# Make the display context
splash = displayio.Group()
display.root_group = splash
color_bitmap = displayio.Bitmap(WIDTH, HEIGHT, 1)
color_palette = displayio.Palette(1)
color_palette[0] = 0xFFFFFF # White
bg_sprite = displayio.TileGrid(color_bitmap, pixel_shader=color_palette, x=0, y=0)
splash.append(bg_sprite)
# Draw a smaller inner rectangle in black
inner_bitmap = displayio.Bitmap(WIDTH - BORDER * 2, HEIGHT - BORDER * 2, 1)
inner_palette = displayio.Palette(1)
inner_palette[0] = 0x000000 # Black
inner_sprite = displayio.TileGrid(inner_bitmap, pixel_shader=inner_palette, x=BORDER, y=BORDER)
splash.append(inner_sprite)
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/displayio-sh1107/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_SH1107/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-displayio-sh1107",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, displayio_sh1107, display, oled",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/bc/05/06dd2f467498fd30080b0a009cb6d254501f21a84af61b7c4e2a8db21002/adafruit_circuitpython_displayio_sh1107-1.7.2.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-displayio-sh1107/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/displayio-sh1107/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_SH1107/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SH1107/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 SH1107 monochrome displays. DisplayIO drivers enable terminal output.\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython Version 6+ <https://github.com/adafruit/circuitpython>`_ A new quirk in 6.0 for SH1107\n* An SH1107 OLED display, eg. `Adafruit FeatherWing 128 x 64 OLED <https://www.adafruit.com/product/4650>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading the\n`Adafruit library and driver bundle <https://circuitpython.org/libraries>`_.\n\nInstalling from PyPI\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_sh1107/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-displayio-sh1107\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-sh1107\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-sh1107\n\nUsage Example\n=============\n\n.. code-block:: python\n\n import board\n import displayio\n import terminalio\n import bitmap_label as label # from adafruit_display_text\n import adafruit_displayio_sh1107\n\n displayio.release_displays()\n #oled_reset = board.D9\n\n # Use for I2C\n i2c = board.I2C()\n display_bus = displayio.I2CDisplay(i2c, device_address=0x3C)\n\n # SH1107 is vertically oriented 64x128\n WIDTH = 128\n HEIGHT = 64\n BORDER = 2\n\n display = adafruit_displayio_sh1107.SH1107(display_bus, width=WIDTH, height=HEIGHT)\n\n # Make the display context\n splash = displayio.Group()\n display.root_group = splash\n\n color_bitmap = displayio.Bitmap(WIDTH, HEIGHT, 1)\n color_palette = displayio.Palette(1)\n color_palette[0] = 0xFFFFFF # White\n\n bg_sprite = displayio.TileGrid(color_bitmap, pixel_shader=color_palette, x=0, y=0)\n splash.append(bg_sprite)\n\n # Draw a smaller inner rectangle in black\n inner_bitmap = displayio.Bitmap(WIDTH - BORDER * 2, HEIGHT - BORDER * 2, 1)\n inner_palette = displayio.Palette(1)\n inner_palette[0] = 0x000000 # Black\n inner_sprite = displayio.TileGrid(inner_bitmap, pixel_shader=inner_palette, x=BORDER, y=BORDER)\n splash.append(inner_sprite)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/displayio-sh1107/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_SH1107/blob/master/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Support for the SH1107 OLED display driver IC",
"version": "1.7.2",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SH1107"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" displayio_sh1107",
" display",
" oled"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4161f9f9bb6aa2e6cd32f25efa95860182a877f8187a9ad8753862d5ee2e3edf",
"md5": "3f844e3033ab600ab6b27ee5f2aa7114",
"sha256": "7a662d0372251c075aaffa89b764050589808025e9759d10b8edf5939f65bbac"
},
"downloads": -1,
"filename": "adafruit_circuitpython_displayio_sh1107-1.7.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3f844e3033ab600ab6b27ee5f2aa7114",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6600,
"upload_time": "2024-11-20T22:30:17",
"upload_time_iso_8601": "2024-11-20T22:30:17.566881Z",
"url": "https://files.pythonhosted.org/packages/41/61/f9f9bb6aa2e6cd32f25efa95860182a877f8187a9ad8753862d5ee2e3edf/adafruit_circuitpython_displayio_sh1107-1.7.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bc0506dd2f467498fd30080b0a009cb6d254501f21a84af61b7c4e2a8db21002",
"md5": "bf9da886caa357ead8920c1cbed5af17",
"sha256": "87068ccf4446a5da911a47e8f04ce238fb8bcec5cd8b8807611c1a92ca2f33b3"
},
"downloads": -1,
"filename": "adafruit_circuitpython_displayio_sh1107-1.7.2.tar.gz",
"has_sig": false,
"md5_digest": "bf9da886caa357ead8920c1cbed5af17",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 30401,
"upload_time": "2024-11-20T22:30:19",
"upload_time_iso_8601": "2024-11-20T22:30:19.133437Z",
"url": "https://files.pythonhosted.org/packages/bc/05/06dd2f467498fd30080b0a009cb6d254501f21a84af61b7c4e2a8db21002/adafruit_circuitpython_displayio_sh1107-1.7.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-20 22:30:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_DisplayIO_SH1107",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "Adafruit-Blinka-Displayio",
"specs": []
}
],
"lcname": "adafruit-circuitpython-displayio-sh1107"
}
JSON
