Skip to main content

Framebuf (non-displayio) driver for SSD1305 displays

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

Framebuf (non-displayio) driver for SSD1305 displays

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-ssd1305

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

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

Usage Example

# Basic example of clearing and drawing pixels on a SSD1305 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 SSD1305 module.
import adafruit_ssd1305


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

# Create the SSD1305 OLED class.
# The first two parameters are the pixel width and pixel height.  Change these
# to the right size for your display!
display = adafruit_ssd1305.SSD1305_I2C(128, 32, i2c)
# Alternatively you can change the I2C address of the device with an addr parameter:
#display = adafruit_ssd1305.SSD1305_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()

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit_circuitpython_ssd1305-1.4.2.tar.gz (26.4 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_ssd1305-1.4.2.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_ssd1305-1.4.2.tar.gz
Algorithm Hash digest
SHA256 d954adaa08af195e3f98977b5c87c0db1cfd18e9dd15368c3e4f70d8c2504563
MD5 e47fcff58105251ae18e13c532ef134d
BLAKE2b-256 09d4401295592a4f5999904be7969dc547dbfc50c1bf13a4d3d603b2735c72ee

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_ssd1305-1.4.2-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_ssd1305-1.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 65806524dc4bd55011c3f55de3f485b0da305815c96fe0aafd220d76ba90aa9a
MD5 ef1a114ed19e8829a26a4cb6fb9c6615
BLAKE2b-256 cf38e9b0edbaa3d3b25cd1ff1638336ca520ddcd706c749dd84b21768fbaf235

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page