adafruit-circuitpython-ssd1306


Nameadafruit-circuitpython-ssd1306 JSON
Version 2.12.16 PyPI version JSON
download
home_page
SummaryCircuitPython library for SSD1306 OLED displays.
upload_time2023-12-09 17:34:42
maintainer
docs_urlNone
author
requires_python
licenseMIT
keywords adafruit ssd1306 oled displays hardware micropython circuitpython
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ssd1306/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/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_SSD1306/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_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

Adafruit CircuitPython driver for SSD1306 or SSD1305 OLED displays. Note that SSD1305 displays are back compatible so they can be used in-place of SSD1306 with the same code and commands.

This driver implements the `adafruit_framebuf interface <https://docs.circuitpython.org/projects/framebuf/en/latest/>`__. It is **not** the `displayio` driver for the SSD1306. See the `Adafruit CircuitPython DisplayIO SSD1306 <https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SSD1306/>`_ driver for `displayio` support.


Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `Adafruit framebuf <https://github.com/adafruit/Adafruit_CircuitPython_framebuf>`_

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-ssd1306/>`_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-ssd1306

To install system-wide (this may be required in some cases):

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-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-ssd1306

Usage Example
=============

.. code-block:: python3

  # Basic example of clearing and drawing pixels on a SSD1306 OLED display.
  # This example and library is meant to work with Adafruit CircuitPython API.
  # Author: Tony DiCola
  # License: Public Domain

  # Import all board pins.
  from board import SCL, SDA
  import busio

  # Import the SSD1306 module.
  import adafruit_ssd1306


  # Create the I2C interface.
  i2c = busio.I2C(SCL, SDA)

  # Create the SSD1306 OLED class.
  # The first two parameters are the pixel width and pixel height.  Change these
  # to the right size for your display!
  display = adafruit_ssd1306.SSD1306_I2C(128, 32, i2c)
  # Alternatively you can change the I2C address of the device with an addr parameter:
  #display = adafruit_ssd1306.SSD1306_I2C(128, 32, i2c, addr=0x31)

  # Clear the display.  Always call show after changing pixels to make the display
  # update visible!
  display.fill(0)

  display.show()

  # Set a pixel in the origin 0,0 position.
  display.pixel(0, 0, 1)
  # Set a pixel in the middle 64, 16 position.
  display.pixel(64, 16, 1)
  # Set a pixel in the opposite 127, 31 position.
  display.pixel(127, 31, 1)
  display.show()

More examples and details can be found in the `adafruit_framebuf docs <https://docs.circuitpython.org/projects/framebuf/en/latest>`__.


Documentation
=============

API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/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_SSD1306/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "adafruit-circuitpython-ssd1306",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "adafruit,ssd1306,oled,displays,hardware,micropython,circuitpython",
    "author": "",
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/ce/cf/bdb41fd674c3f019316fecb59d06764041636ba415059faef5d59a7db714/adafruit-circuitpython-ssd1306-2.12.16.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ssd1306/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/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_SSD1306/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_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\nAdafruit CircuitPython driver for SSD1306 or SSD1305 OLED displays. Note that SSD1305 displays are back compatible so they can be used in-place of SSD1306 with the same code and commands.\n\nThis driver implements the `adafruit_framebuf interface <https://docs.circuitpython.org/projects/framebuf/en/latest/>`__. It is **not** the `displayio` driver for the SSD1306. See the `Adafruit CircuitPython DisplayIO SSD1306 <https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SSD1306/>`_ driver for `displayio` support.\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n* `Adafruit framebuf <https://github.com/adafruit/Adafruit_CircuitPython_framebuf>`_\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-ssd1306/>`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-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-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-ssd1306\n\nUsage Example\n=============\n\n.. code-block:: python3\n\n  # Basic example of clearing and drawing pixels on a SSD1306 OLED display.\n  # This example and library is meant to work with Adafruit CircuitPython API.\n  # Author: Tony DiCola\n  # License: Public Domain\n\n  # Import all board pins.\n  from board import SCL, SDA\n  import busio\n\n  # Import the SSD1306 module.\n  import adafruit_ssd1306\n\n\n  # Create the I2C interface.\n  i2c = busio.I2C(SCL, SDA)\n\n  # Create the SSD1306 OLED class.\n  # The first two parameters are the pixel width and pixel height.  Change these\n  # to the right size for your display!\n  display = adafruit_ssd1306.SSD1306_I2C(128, 32, i2c)\n  # Alternatively you can change the I2C address of the device with an addr parameter:\n  #display = adafruit_ssd1306.SSD1306_I2C(128, 32, i2c, addr=0x31)\n\n  # Clear the display.  Always call show after changing pixels to make the display\n  # update visible!\n  display.fill(0)\n\n  display.show()\n\n  # Set a pixel in the origin 0,0 position.\n  display.pixel(0, 0, 1)\n  # Set a pixel in the middle 64, 16 position.\n  display.pixel(64, 16, 1)\n  # Set a pixel in the opposite 127, 31 position.\n  display.pixel(127, 31, 1)\n  display.show()\n\nMore examples and details can be found in the `adafruit_framebuf docs <https://docs.circuitpython.org/projects/framebuf/en/latest>`__.\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/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_SSD1306/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "CircuitPython library for SSD1306 OLED displays.",
    "version": "2.12.16",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_SSD1306"
    },
    "split_keywords": [
        "adafruit",
        "ssd1306",
        "oled",
        "displays",
        "hardware",
        "micropython",
        "circuitpython"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "daac07656ba0572f774de197c5c2543ca5de20dfdb3633cabaaeecd8b1f34c8c",
                "md5": "a35325ca739967c89ede5b83190fde7a",
                "sha256": "43ceb12b7f6cbc3b4335d525b34fe3b7d45c18ceaba4e417b03df8f43c930ece"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_ssd1306-2.12.16-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a35325ca739967c89ede5b83190fde7a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 7614,
            "upload_time": "2023-12-09T17:34:38",
            "upload_time_iso_8601": "2023-12-09T17:34:38.333421Z",
            "url": "https://files.pythonhosted.org/packages/da/ac/07656ba0572f774de197c5c2543ca5de20dfdb3633cabaaeecd8b1f34c8c/adafruit_circuitpython_ssd1306-2.12.16-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "cecfbdb41fd674c3f019316fecb59d06764041636ba415059faef5d59a7db714",
                "md5": "c36ec43c6b9ca019b8ce7511f6d8e0c2",
                "sha256": "2587f9b8e82cd544ebce838a256b6ba302183670922c1eeb97010e7ad3dbc6ef"
            },
            "downloads": -1,
            "filename": "adafruit-circuitpython-ssd1306-2.12.16.tar.gz",
            "has_sig": false,
            "md5_digest": "c36ec43c6b9ca019b8ce7511f6d8e0c2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 40949,
            "upload_time": "2023-12-09T17:34:42",
            "upload_time_iso_8601": "2023-12-09T17:34:42.310859Z",
            "url": "https://files.pythonhosted.org/packages/ce/cf/bdb41fd674c3f019316fecb59d06764041636ba415059faef5d59a7db714/adafruit-circuitpython-ssd1306-2.12.16.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-12-09 17:34:42",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_SSD1306",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "adafruit-circuitpython-ssd1306"
}
        
Elapsed time: 0.26066s