{"id":13594457,"url":"https://github.com/adafruit/Adafruit_CircuitPython_SSD1306","last_synced_at":"2025-04-09T07:32:22.140Z","repository":{"id":44411429,"uuid":"78462222","full_name":"adafruit/Adafruit_CircuitPython_SSD1306","owner":"adafruit","description":"Adafruit CircuitPython framebuf driver for SSD1306 or SSD1305 OLED displays. Not for use with displayio. See README.","archived":false,"fork":false,"pushed_at":"2024-10-07T22:20:31.000Z","size":180,"stargazers_count":296,"open_issues_count":2,"forks_count":72,"subscribers_count":27,"default_branch":"main","last_synced_at":"2024-10-29T16:58:20.335Z","etag":null,"topics":["circuitpython","hacktoberfest","monochrome-oled-displays","oled-display","oled-display-ssd1306","ssd1306"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adafruit.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-01-09T19:40:39.000Z","updated_at":"2024-10-26T18:51:21.000Z","dependencies_parsed_at":"2024-06-18T16:49:40.475Z","dependency_job_id":"0b0a4e79-82dd-4b5a-9f28-83300a5c6650","html_url":"https://github.com/adafruit/Adafruit_CircuitPython_SSD1306","commit_stats":{"total_commits":160,"total_committers":35,"mean_commits":4.571428571428571,"dds":0.85625,"last_synced_commit":"a990c874389b6fd27636b21f9b831fc91781e925"},"previous_names":[],"tags_count":54,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adafruit%2FAdafruit_CircuitPython_SSD1306","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adafruit%2FAdafruit_CircuitPython_SSD1306/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adafruit%2FAdafruit_CircuitPython_SSD1306/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adafruit%2FAdafruit_CircuitPython_SSD1306/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adafruit","download_url":"https://codeload.github.com/adafruit/Adafruit_CircuitPython_SSD1306/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223090236,"owners_count":17085827,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["circuitpython","hacktoberfest","monochrome-oled-displays","oled-display","oled-display-ssd1306","ssd1306"],"created_at":"2024-08-01T16:01:33.745Z","updated_at":"2024-11-06T16:31:23.683Z","avatar_url":"https://github.com/adafruit.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"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 \u003chttps://docs.circuitpython.org/projects/framebuf/en/latest/\u003e`__. It is **not** the `displayio` driver for the SSD1306. See the `Adafruit CircuitPython DisplayIO SSD1306 \u003chttps://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SSD1306/\u003e`_ driver for `displayio` support.\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython \u003chttps://github.com/adafruit/circuitpython\u003e`_\n* `Bus Device \u003chttps://github.com/adafruit/Adafruit_CircuitPython_BusDevice\u003e`_\n* `Adafruit framebuf \u003chttps://github.com/adafruit/Adafruit_CircuitPython_framebuf\u003e`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle \u003chttps://github.com/adafruit/Adafruit_CircuitPython_Bundle\u003e`_.\n\nInstalling from PyPI\n====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI \u003chttps://pypi.org/project/adafruit-circuitpython-ssd1306/\u003e`_. 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 \u0026\u0026 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 \u003chttps://docs.circuitpython.org/projects/framebuf/en/latest\u003e`__.\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs \u003chttps://docs.circuitpython.org/projects/ssd1306/en/latest/\u003e`_.\n\nFor information on building library documentation, please check out `this guide \u003chttps://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1\u003e`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n\u003chttps://github.com/adafruit/adafruit_CircuitPython_SSD1306/blob/main/CODE_OF_CONDUCT.md\u003e`_\nbefore contributing to help this project stay welcoming.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadafruit%2FAdafruit_CircuitPython_SSD1306","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadafruit%2FAdafruit_CircuitPython_SSD1306","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadafruit%2FAdafruit_CircuitPython_SSD1306/lists"}