adafruit / adafruit_circuitpython_ssd1322 Goto Github PK

View Code? Open in Web Editor NEW

7.0 17.0 5.0 113 KB

DisplayIO driver for grayscale OLEDs driven by SSD1322

License: MIT License

Python 100.00%

circuitpython displayio grayscale-display oled-display ssd1322 hacktoberfest

adafruit_circuitpython_ssd1322's Introduction

Introduction

DisplayIO driver for grayscale OLEDs driven by SSD1322

Dependencies

This driver depends on:

Adafruit CircuitPython

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

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

sudo pip3 install adafruit-circuitpython-ssd1322

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

Usage Example

import time
import board
import busio
import displayio
import adafruit_ssd1322

displayio.release_displays()

# This pinout works on a Metro and may need to be altered for other boards.
spi = busio.SPI(board.SCL, board.SDA)
tft_cs = board.D6
tft_dc = board.D9
tft_reset = board.D5

display_bus = displayio.FourWire(spi, command=tft_dc, chip_select=tft_cs,
                                 reset=tft_reset, baudrate=1000000)
time.sleep(1)
display = adafruit_ssd1322.SSD1322(display_bus, width=256, height=64, colstart=28)

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.

adafruit_circuitpython_ssd1322's People

Contributors

Stargazers

Watchers

Forkers

tannewt sommersoft jepler lesamouraipourpre foamyguy

adafruit_circuitpython_ssd1322's Issues

Library not usable

I have a single line:
import adafruit_ssd1322

On a Raspberry Pi 4 3.11.2
This already fails with:

Traceback (most recent call last):
  File "/home/pi/displaytestvenv/test.py", line 2, in <module>
    import adafruit_ssd1322
  File "/home/pi/displaytestvenv/lib/python3.11/site-packages/adafruit_ssd1322.py", line 67, in <module>
    class SSD1322(displayio.Display):
                  ^^^^^^^^^^^^^^^^^
AttributeError: module 'displayio' has no attribute 'Display'. Did you mean: 'displays'?

Missing Type Annotations

There are missing type annotations for some functions in this library.

The typing module does not exist on CircuitPython devices so the import needs to be wrapped in try/except to catch the error for missing import. There is an example of how that is done here:

try:
    from typing import List, Tuple
except ImportError:
    pass

Once imported the typing annotations for the argument type(s), and return type(s) can be added to the function signature. Here is an example of a function that has had this done already:

def wrap_text_to_pixels(
    string: str, max_width: int, font=None, indent0: str = "", indent1: str = ""
) -> List[str]:

If you are new to Git or Github we have a guide about contributing to our projects here: https://learn.adafruit.com/contribute-to-circuitpython-with-git-and-github

There is also a guide that covers our CI utilities and how to run them locally to ensure they will pass in Github Actions here: https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/check-your-code In particular the pages: Sharing docs on ReadTheDocs and Check your code with pre-commit contain the tools to install and commands to run locally to run the checks.

If you are attempting to resolve this issue and need help, you can post a comment on this issue and tag both @FoamyGuy and @kattni or reach out to us on Discord: https://adafru.it/discord in the #circuitpython-dev channel.

The following locations are reported by mypy to be missing type annotations:

adafruit_ssd1322.py:76

Is there any way to draw a pixel without a bitmap?

I have been using this driver with my SSD1322 display and have just started making animations and have discovered it in incredibly slow because I have to recreate the group, tile_grid, and bitmap in order to update the screen. How can I draw a single pixel without using a bitmap to improve the speed?

Thanks!

EDIT: To articulate more, maybe a series of displayio.send() commands that select column and row and turn on that pixel? Lot's of register stuff that I know nothing about!
Thanks again!

This happens when I run the example program. Also, the display does not display anything.
What does this mean and how can I fix it?
Thanks!