{"id":15023444,"url":"https://github.com/adafruit/adafruit_circuitpython_displayio_ssd1305","last_synced_at":"2025-10-19T17:31:58.815Z","repository":{"id":47542217,"uuid":"220047064","full_name":"adafruit/Adafruit_CircuitPython_DisplayIO_SSD1305","owner":"adafruit","description":"DisplayIO driver for SSD1305 monochrome OLED displays","archived":false,"fork":false,"pushed_at":"2025-01-16T18:49:37.000Z","size":84,"stargazers_count":3,"open_issues_count":0,"forks_count":4,"subscribers_count":20,"default_branch":"main","last_synced_at":"2025-01-28T22:37:31.784Z","etag":null,"topics":["circuitpython","displayio","hacktoberfest","monochrome-displays","monochrome-oled-displays","oled","oled-display","ssd1305"],"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":"2019-11-06T16:56:57.000Z","updated_at":"2025-01-16T15:11:08.000Z","dependencies_parsed_at":"2023-01-23T18:45:17.128Z","dependency_job_id":"c55052a3-abde-4141-a583-3092a71f71ac","html_url":"https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SSD1305","commit_stats":{"total_commits":72,"total_committers":13,"mean_commits":5.538461538461538,"dds":0.7222222222222222,"last_synced_commit":"63e6aa551f268a86857292c3046561e3d0b357b8"},"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adafruit%2FAdafruit_CircuitPython_DisplayIO_SSD1305","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adafruit%2FAdafruit_CircuitPython_DisplayIO_SSD1305/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adafruit%2FAdafruit_CircuitPython_DisplayIO_SSD1305/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adafruit%2FAdafruit_CircuitPython_DisplayIO_SSD1305/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adafruit","download_url":"https://codeload.github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SSD1305/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237181567,"owners_count":19268057,"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","displayio","hacktoberfest","monochrome-displays","monochrome-oled-displays","oled","oled-display","ssd1305"],"created_at":"2024-09-24T19:59:04.433Z","updated_at":"2025-10-19T17:31:58.810Z","avatar_url":"https://github.com/adafruit.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-displayio_ssd1305/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/displayio_ssd1305/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_SSD1305/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SSD1305/actions\n    :alt: Build Status\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n    :target: https://github.com/astral-sh/ruff\n    :alt: Code Style: Ruff\n\nDisplayIO driver for SSD1305 monochrome displays\n\nFor the framebuf based driver see `Adafruit CircuitPython SSD1305 \u003chttps://github.com/adafruit/Adafruit_CircuitPython_SSD1305/\u003e`_.\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython Version 5+ \u003chttps://github.com/adafruit/circuitpython\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://circuitpython.org/libraries\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-displayio_ssd1305/\u003e`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-displayio-ssd1305\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-ssd1305\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-displayio-ssd1305\n\nUsage Example\n=============\n\n.. code-block:: python\n\n    import board\n    import displayio\n    # Starting in CircuitPython 9.x fourwire will be a seperate internal library\n    # rather than a component of the displayio library\n    try:\n        from fourwire import FourWire\n    # Use for I2C\n    #    from i2cdisplaybus import I2CDisplayBus\n    except ImportError:\n        from displayio import FourWire\n        # from displayio import I2CDisplay as I2CDisplayBus\n    import terminalio\n    from adafruit_display_text import label\n    import adafruit_displayio_ssd1305\n\n    displayio.release_displays()\n\n    # Use for SPI\n    spi = board.SPI()\n    oled_cs = board.D5\n    oled_dc = board.D6\n    display_bus = FourWire(\n        spi, command=oled_dc, chip_select=oled_cs, baudrate=1000000, reset=board.D9\n    )\n\n    # Use for I2C\n    # i2c = board.I2C()\n    #\n    # display_bus = I2CDisplayBus(i1c, device_address=0x3c)\n\n    WIDTH = 128\n    HEIGHT = 64     # Change to 32 if needed\n    BORDER = 8\n    FONTSCALE = 1\n\n    display = adafruit_displayio_ssd1305.SSD1305(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(display.width, display.height, 1)\n    color_palette = displayio.Palette(1)\n    color_palette[0] = 0xFFFFFF # White\n\n    bg_sprite = displayio.TileGrid(color_bitmap,\n                                   pixel_shader=color_palette,\n                                   x=0, y=0)\n    splash.append(bg_sprite)\n\n    # Draw a smaller inner rectangle\n    inner_bitmap = displayio.Bitmap(display.width - BORDER * 2, display.height - BORDER * 2, 1)\n    inner_palette = displayio.Palette(1)\n    inner_palette[0] = 0x000000 # Black\n    inner_sprite = displayio.TileGrid(inner_bitmap,\n                                      pixel_shader=inner_palette,\n                                      x=BORDER, y=BORDER)\n    splash.append(inner_sprite)\n\n    # Draw a label\n    text = \"Hello World!\"\n    text_area = label.Label(terminalio.FONT, text=text, color=0xFFFFFF)\n    text_width = text_area.bounding_box[2] * FONTSCALE\n    text_group = displayio.Group(scale=FONTSCALE, x=display.width // 2 - text_width // 2,\n                                 y=display.height // 2)\n    text_group.append(text_area) # Subgroup for text scaling\n    splash.append(text_group)\n\n    while True:\n        pass\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs \u003chttps://docs.circuitpython.org/projects/displayio_ssd1305/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_DisplayIO_SSD1305/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_displayio_ssd1305","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadafruit%2Fadafruit_circuitpython_displayio_ssd1305","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadafruit%2Fadafruit_circuitpython_displayio_ssd1305/lists"}