Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-displayio_sh1106/badge/?version=latest
:target: https://docs.circuitpython.org/projects/displayio_sh1106/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_SH1106/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SH1106/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 compatible library for SH1106 OLED displays
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://circuitpython.org/libraries>`_
or individual libraries can be installed using
`circup <https://github.com/adafruit/circup>`_.
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_sh1106/>`_.
To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-displayio-sh1106
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-displayio-sh1106
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-sh1106
Usage Example
=============
.. code-block:: python3
import busio
import displayio
import terminalio
import fourwire
from adafruit_display_text import label
import adafruit_displayio_sh1106
displayio.release_displays()
spi = busio.SPI(board.SCK, board.MOSI)
display_bus = fourwire.FourWire(
spi,
command=board.OLED_DC,
chip_select=board.OLED_CS,
reset=board.OLED_RESET,
baudrate=1000000,
)
WIDTH = 128
HEIGHT = 64
BORDER = 5
display = adafruit_displayio_sh1106.SH1106(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
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)
# Draw a label
text = "Hello World!"
text_area = label.Label(
terminalio.FONT, text=text, color=0xFFFFFF, x=28, y=HEIGHT // 2 - 1
)
splash.append(text_area)
while True:
pass
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/displayio_sh1106/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_SH1106/blob/HEAD/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-displayio-sh1106",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,displayio_sh1106,displayio,oled,sh1106,display",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/8d/c0/bf55eb9e14a7d594e1e4d64af40c6a14b3faf73b415715f7f36d06980613/adafruit-circuitpython-displayio-sh1106-1.3.0.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-displayio_sh1106/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/displayio_sh1106/en/latest/\n :alt: Documentation Status\n\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\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SH1106/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SH1106/actions\n :alt: Build Status\n\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 compatible library for SH1106 OLED displays\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://circuitpython.org/libraries>`_\nor individual libraries can be installed using\n`circup <https://github.com/adafruit/circup>`_.\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_sh1106/>`_.\nTo install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-displayio-sh1106\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-sh1106\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-sh1106\n\n\n\nUsage Example\n=============\n\n.. code-block:: python3\n\n import busio\n import displayio\n import terminalio\n import fourwire\n from adafruit_display_text import label\n import adafruit_displayio_sh1106\n\n displayio.release_displays()\n\n spi = busio.SPI(board.SCK, board.MOSI)\n display_bus = fourwire.FourWire(\n spi,\n command=board.OLED_DC,\n chip_select=board.OLED_CS,\n reset=board.OLED_RESET,\n baudrate=1000000,\n )\n\n WIDTH = 128\n HEIGHT = 64\n BORDER = 5\n display = adafruit_displayio_sh1106.SH1106(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\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(\n inner_bitmap, pixel_shader=inner_palette, x=BORDER, y=BORDER\n )\n splash.append(inner_sprite)\n\n # Draw a label\n text = \"Hello World!\"\n text_area = label.Label(\n terminalio.FONT, text=text, color=0xFFFFFF, x=28, y=HEIGHT // 2 - 1\n )\n splash.append(text_area)\n\n while True:\n pass\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/displayio_sh1106/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_SH1106/blob/HEAD/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "DisplayIO compatible library for SH1106 OLED displays",
"version": "1.3.0",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SH1106.git"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"displayio_sh1106",
"displayio",
"oled",
"sh1106",
"display"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4861acaaa6df7423fef3a17894a4345f5df2c4c1c424df4bd944523c9b508676",
"md5": "028af6affac834153c2bf9c56b00c693",
"sha256": "42726d5c3484330f9f162f990bb4c20537809d72a9f128b77512e0f20d43f9ae"
},
"downloads": -1,
"filename": "adafruit_circuitpython_displayio_sh1106-1.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "028af6affac834153c2bf9c56b00c693",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5699,
"upload_time": "2023-11-03T13:27:17",
"upload_time_iso_8601": "2023-11-03T13:27:17.420217Z",
"url": "https://files.pythonhosted.org/packages/48/61/acaaa6df7423fef3a17894a4345f5df2c4c1c424df4bd944523c9b508676/adafruit_circuitpython_displayio_sh1106-1.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8dc0bf55eb9e14a7d594e1e4d64af40c6a14b3faf73b415715f7f36d06980613",
"md5": "16573f8c03fd7259948e9bdcce0a2070",
"sha256": "622744c25c6d27c9dcbb9691b2b4b79fec7c72f467a548856d869c8c1209969d"
},
"downloads": -1,
"filename": "adafruit-circuitpython-displayio-sh1106-1.3.0.tar.gz",
"has_sig": false,
"md5_digest": "16573f8c03fd7259948e9bdcce0a2070",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 26956,
"upload_time": "2023-11-03T13:27:19",
"upload_time_iso_8601": "2023-11-03T13:27:19.479464Z",
"url": "https://files.pythonhosted.org/packages/8d/c0/bf55eb9e14a7d594e1e4d64af40c6a14b3faf73b415715f7f36d06980613/adafruit-circuitpython-displayio-sh1106-1.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-03 13:27:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_DisplayIO_SH1106",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-displayio-sh1106"
}
JSON
