https://github.com/mateusznowakdev/circuitpython_displayio_st7565

CircuitPython displayio library for ST7565 and ST7567 controllers
https://github.com/mateusznowakdev/circuitpython_displayio_st7565

circuitpython st7565 st7567

Last synced: 4 days ago
JSON representation

CircuitPython displayio library for ST7565 and ST7567 controllers

• Host: GitHub
• URL: https://github.com/mateusznowakdev/circuitpython_displayio_st7565
• Owner: mateusznowakdev
• License: mit
• Created: 2024-05-28T21:34:22.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-05-28T23:40:49.000Z (7 months ago)
• Last Synced: 2024-12-20T01:44:19.902Z (4 days ago)
• Topics: circuitpython, st7565, st7567
• Language: Python
• Homepage:
• Size: 35.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Introduction

============

.. image:: https://github.com/mateusznowakdev/CircuitPython_DisplayIO_ST7565/workflows/Build%20CI/badge.svg

    :target: https://github.com/mateusznowakdev/CircuitPython_DisplayIO_ST7565/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

CircuitPython displayio library for ST7565 and ST7567 controllers, based on the original framebuf implementation.

As a community effort, this library was tested with only one ST7567 display and may be not fully compatible with other hardware.

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 `_

or individual libraries can be installed using

`circup `_.

Installing from PyPI

=====================

.. note:: This library is not available on PyPI yet. Install documentation is included

   as a standard element. Stay tuned for PyPI availability!

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from

PyPI `_.

To install for current user:

.. code-block:: shell

    pip3 install circuitpython-displayio-st7565

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

.. code-block:: shell

    sudo pip3 install circuitpython-displayio-st7565

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name

    python3 -m venv .venv

    source .env/bin/activate

    pip3 install circuitpython-displayio-st7565

Installing to a Connected CircuitPython Device with Circup

==========================================================

Make sure that you have ``circup`` installed in your Python environment.

Install it with the following command if necessary:

.. code-block:: shell

    pip3 install circup

With ``circup`` installed and your CircuitPython device connected use the

following command to install:

.. code-block:: shell

    circup install displayio_st7565

Or the following command to update an existing version:

.. code-block:: shell

    circup update

Usage Example

=============

.. code-block:: python

    import board

    import busio

    import displayio

    import terminalio

    from adafruit_display_text import label

    import displayio_st7565

    # Compatibility with both CircuitPython 8.x.x and 9.x.x.

    # Remove after 8.x.x is no longer a supported release.

    try:

        from fourwire import FourWire

    except ImportError:

        from displayio import FourWire

    displayio.release_displays()

    spi = busio.SPI(board.GP18, board.GP19)

    display_bus = FourWire(

        spi, command=board.GP20, chip_select=board.GP17, reset=board.GP21, baudrate=1000000

    )

    display = displayio_st7565.ST7565(display_bus, width=128, height=64)

    splash = displayio.Group()

    display.root_group = splash

    text = "Hello World!"

    text_area = label.Label(terminalio.FONT, text=text, color=0xFFFFFF, x=0, y=8)

    splash.append(text_area)

    while True:

        pass

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.