Framebuf (non-displayio) driver for SSD1305 displays
Project description
Introduction
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-ssd1305To install system-wide (this may be required in some cases):
sudo pip3 install adafruit-circuitpython-ssd1305To install in a virtual environment in your current project:
mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install adafruit-circuitpython-ssd1305Usage 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()Contributing
Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.
Sphinx documentation
Sphinx is used to build the documentation based on rST files and comments in the code. First, install dependencies (feel free to reuse the virtual environment from above):
python3 -m venv .env
source .env/bin/activate
pip install Sphinx sphinx-rtd-themeNow, once you have the virtual environment activated:
cd docs
sphinx-build -E -W -b html . _build/htmlThis will output the documentation to docs/_build/html. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to locally verify it will pass.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file adafruit-circuitpython-ssd1305-1.0.1.tar.gz.
File metadata
- Download URL: adafruit-circuitpython-ssd1305-1.0.1.tar.gz
- Upload date:
- Size: 21.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.14.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.6.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 00c73429abd76fe89cb4cf053ad62f35efb369a9dbe609e65e4aa533be3e3af2 |
|
| MD5 | 6bac8ecdf424fbd8314001df713cc18f |
|
| BLAKE2b-256 | a3d7b2642f1a3a660d3cfd8a8dc366a87cdeb67113c0f01f55852b853c2cf9bd |
