Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/neradoc/circuitpython_waveshare_lcd1602

Port of the micropython driver for Waveshare's LCD1602
https://github.com/neradoc/circuitpython_waveshare_lcd1602

Last synced: about 1 month ago
JSON representation

Port of the micropython driver for Waveshare's LCD1602

Awesome Lists containing this project

README 

        
Introduction

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



.. image:: https://readthedocs.org/projects/waveshare-lcd1602-circuitpython-driver/badge/?version=latest

    :target: https://waveshare-lcd1602-circuitpython-driver.readthedocs.io/

    :alt: Documentation Status



.. image:: https://img.shields.io/discord/327254708534116352.svg

    :target: https://adafru.it/discord

    :alt: Discord



.. image:: https://github.com/Neradoc/CircuitPython_Waveshare_LCD1602/workflows/Build%20CI/badge.svg

    :target: https://github.com/Neradoc/CircuitPython_Waveshare_LCD1602/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



Driver for Waveshare's I2C character display LCD1602



Dependencies

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

This driver depends on:



* `Adafruit CircuitPython `_

* `Bus Device `_



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

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



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-waveshare-lcd1602



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



.. code-block:: shell



    sudo pip3 install circuitpython-waveshare-lcd1602



To install in a virtual environment in your current project:



.. code-block:: shell



    mkdir project-name && cd project-name

    python3 -m venv .env

    source .env/bin/activate

    pip3 install circuitpython-waveshare-lcd1602



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 waveshare_lcd1602



Or the following command to update an existing version:



.. code-block:: shell



    circup update



Usage Example

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



.. python:

    import waveshare_lcd1602

    import time

    import math

    import board

    import busio



    from rainbowio import colorwheel



    """Default I2C ports on boards that have one"""

    i2c = board.I2C()

    # i2c = board.STEMMA_I2C()

    """Default pins used by the original code for pico"""

    # i2c = busio.I2C(board.GP5, board.GP4)



    lcd = waveshare_lcd1602.LCD1602(i2c, 16, 2)

    lcd.setRGB(255, 255, 0)

    lcd.setCursor(0, 0)

    lcd.printout("Waveshare")

    lcd.setCursor(0, 1)

    lcd.printout(f"Hellow World !")



    while True:

        color = colorwheel(time.monotonic()*16)

        lcd.setRGB(color >> 16, (color >> 8) % 0x100, color % 0x100)

        time.sleep(1)



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.