Skip to content

adafruit/Adafruit_CircuitPython_DisplayIO_SSD1305

Repository files navigation

Introduction

Documentation Status Discord Build Status Code Style: Ruff

DisplayIO driver for SSD1305 monochrome displays

For the framebuf based driver see Adafruit CircuitPython SSD1305.

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-displayio-ssd1305

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

sudo pip3 install adafruit-circuitpython-displayio-ssd1305

To install in a virtual environment in your current project:

mkdir project-name && cd project-name python3 -m venv .venv source .venv/bin/activate pip3 install adafruit-circuitpython-displayio-ssd1305

Usage Example

import board import displayio # Starting in CircuitPython 9.x fourwire will be a seperate internal library # rather than a component of the displayio library try: from fourwire import FourWire # Use for I2C # from i2cdisplaybus import I2CDisplayBus except ImportError: from displayio import FourWire # from displayio import I2CDisplay as I2CDisplayBus import terminalio from adafruit_display_text import label import adafruit_displayio_ssd1305 displayio.release_displays() # Use for SPI spi = board.SPI() oled_cs = board.D5 oled_dc = board.D6 display_bus = FourWire( spi, command=oled_dc, chip_select=oled_cs, baudrate=1000000, reset=board.D9 ) # Use for I2C # i2c = board.I2C() # # display_bus = I2CDisplayBus(i1c, device_address=0x3c) WIDTH = 128 HEIGHT = 64 # Change to 32 if needed BORDER = 8 FONTSCALE = 1 display = adafruit_displayio_ssd1305.SSD1305(display_bus, width=WIDTH, height=HEIGHT) # Make the display context splash = displayio.Group() display.root_group = splash color_bitmap = displayio.Bitmap(display.width, display.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(display.width - BORDER * 2, display.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) text_width = text_area.bounding_box[2] * FONTSCALE text_group = displayio.Group(scale=FONTSCALE, x=display.width // 2 - text_width // 2, y=display.height // 2) text_group.append(text_area) # Subgroup for text scaling splash.append(text_group) while True: pass

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.