Metadata-Version: 2.1
Name: adafruit-circuitpython-ssd1306
Version: 2.6.5
Summary: CircuitPython library for SSD1306 OLED displays.
Home-page: https://github.com/adafruit/Adafruit_CircuitPython_SSD1306
Author: Adafruit Industries
Author-email: circuitpython@adafruit.com
License: MIT
Description: Introduction
        ============
        
        .. image:: https://readthedocs.org/projects/adafruit-circuitpython-ssd1306/badge/?version=latest
            :target: https://circuitpython.readthedocs.io/projects/ssd1306/en/latest/
            :alt: Documentation Status
        
        .. image:: https://img.shields.io/discord/327254708534116352.svg
            :target: https://discord.gg/nBQh6qu
            :alt: Discord
        
        .. image:: https://travis-ci.com/adafruit/Adafruit_CircuitPython_SSD1306.svg?branch=master
            :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_SSD1306
            :alt: Build Status
        
        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 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>`_.
        
        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()
        
        
        Contributing
        ============
        
        Contributions are welcome! Please read our `Code of Conduct
        <https://github.com/adafruit/adafruit_CircuitPython_SSD1306/blob/master/CODE_OF_CONDUCT.md>`_
        before contributing to help this project stay welcoming.
        
        Building locally
        ================
        
        Zip release files
        -----------------
        
        To build this library locally you'll need to install the
        `circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
        
        .. code-block:: shell
        
            python3 -m venv .env
            source .env/bin/activate
            pip install circuitpython-build-tools
        
        Once installed, make sure you are in the virtual environment:
        
        .. code-block:: shell
        
            source .env/bin/activate
        
        Then run the build:
        
        .. code-block:: shell
        
            circuitpython-build-bundles --filename_prefix adafruit-circuitpython-ssd1306 --library_location .
        
        Sphinx documentation
        -----------------------
        
        Sphinx is used to build the documentation based on rST files and comments in the code. First,
        install dependencies (feel free to reuse the virtual environment from above):
        
        .. code-block:: shell
        
            python3 -m venv .env
            source .env/bin/activate
            pip install Sphinx sphinx-rtd-theme
        
        Now, once you have the virtual environment activated:
        
        .. code-block:: shell
        
            cd docs
            sphinx-build -E -W -b html . _build/html
        
        This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
        view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
        locally verify it will pass.
        
Keywords: adafruit ssd1306 oled displays hardware micropython circuitpython
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: System :: Hardware
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Description-Content-Type: text/x-rst
