Skip to main content

Framebuf (non-displayio) driver for SSD1305 displays

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

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.3.14.tar.gz (31.3 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit-circuitpython-ssd1305-1.3.14.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-ssd1305-1.3.14.tar.gz
Algorithm Hash digest
SHA256 20dfb2d1e515bec6bc11509caa5c258d9fe5e27f6b4d04b22a143e15426f8698
MD5 98fe0349351eceffa93af2cf001f372a
BLAKE2b-256 2578ba22aac55b04575aa8048014d2cf3236fdd7fea5ce899471bff313ca4156

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for adafruit_circuitpython_ssd1305-1.3.14-py3-none-any.whl
Algorithm Hash digest
SHA256 92b9b0c45394813ed31e859686c988e8520c1f89d7831badc2e6ab8d8bdf2e55
MD5 ba93b57204dfff8dfc3a6a473ccd3e5f
BLAKE2b-256 c12592bf57581d7bd4d921bf63f992f52bb8e2f8d978f77861d2f130fa13288f

See more details on using hashes here.

Supported by

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