Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ssd1305/badge/?version=latest
:target: https://docs.circuitpython.org/projects/ssd1305/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_SSD1305/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_SSD1305/actions/
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
Framebuf (non-displayio) driver for SSD1305 displays
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-ssd1305/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-ssd1305
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-ssd1305
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-ssd1305
Usage Example
=============
.. code-block:: python
# 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 <https://docs.circuitpython.org/projects/ssd1305/en/latest/>`_.
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_SSD1305/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-ssd1305",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,ssd1305,framebuf,rpi",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/de/3b/602537f5abea5f37e8e3267e3add142196bf47a453562e944df6d9694a64/adafruit-circuitpython-ssd1305-1.3.19.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-ssd1305/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/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_SSD1305/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_SSD1305/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nFramebuf (non-displayio) driver for SSD1305 displays\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-ssd1305/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-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-ssd1305\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-ssd1305\n\nUsage Example\n=============\n\n.. code-block:: python\n\n # Basic example of clearing and drawing pixels on a SSD1305 OLED display.\n # This example and library is meant to work with Adafruit CircuitPython API.\n # Author: Tony DiCola\n # License: Public Domain\n\n # Import all board pins.\n from board import SCL, SDA\n import busio\n\n # Import the SSD1305 module.\n import adafruit_ssd1305\n\n\n # Create the I2C interface.\n i2c = busio.I2C(SCL, SDA)\n\n # Create the SSD1305 OLED class.\n # The first two parameters are the pixel width and pixel height. Change these\n # to the right size for your display!\n display = adafruit_ssd1305.SSD1305_I2C(128, 32, i2c)\n # Alternatively you can change the I2C address of the device with an addr parameter:\n #display = adafruit_ssd1305.SSD1305_I2C(128, 32, i2c, addr=0x31)\n\n # Clear the display. Always call show after changing pixels to make the display\n # update visible!\n display.fill(0)\n\n display.show()\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/ssd1305/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_SSD1305/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Framebuf (non-displayio) driver for SSD1305 displays",
"version": "1.3.19",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_SSD1305"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"ssd1305",
"framebuf",
"rpi"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "01496f151dbf4d86c5db29100b6febebc6bfead010b7ba54f5102a74d8a25cd4",
"md5": "aa9105f19ade8465527557b433f78329",
"sha256": "321fbe9aa4ade1d13c499fe319fce4cd011f786bd6227ff1cbfc629f68512736"
},
"downloads": -1,
"filename": "adafruit_circuitpython_ssd1305-1.3.19-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aa9105f19ade8465527557b433f78329",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6907,
"upload_time": "2023-12-09T17:34:26",
"upload_time_iso_8601": "2023-12-09T17:34:26.083772Z",
"url": "https://files.pythonhosted.org/packages/01/49/6f151dbf4d86c5db29100b6febebc6bfead010b7ba54f5102a74d8a25cd4/adafruit_circuitpython_ssd1305-1.3.19-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "de3b602537f5abea5f37e8e3267e3add142196bf47a453562e944df6d9694a64",
"md5": "f6ee06323adfc78ca48e568fcdd8a0f6",
"sha256": "936cfe945c00339e63b4c41f9ae5ea904f6331a54971c22c47579e26b539538f"
},
"downloads": -1,
"filename": "adafruit-circuitpython-ssd1305-1.3.19.tar.gz",
"has_sig": false,
"md5_digest": "f6ee06323adfc78ca48e568fcdd8a0f6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 29748,
"upload_time": "2023-12-09T17:34:29",
"upload_time_iso_8601": "2023-12-09T17:34:29.867501Z",
"url": "https://files.pythonhosted.org/packages/de/3b/602537f5abea5f37e8e3267e3add142196bf47a453562e944df6d9694a64/adafruit-circuitpython-ssd1305-1.3.19.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-09 17:34:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_SSD1305",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-ssd1305"
}
JSON
