Skip to main content

CircuitPython library for standard character LCDs.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

This library is compatible with standard Character LCDs such as:

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

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

sudo pip3 install adafruit-circuitpython-charlcd

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

Dependencies

This driver depends on:

I2C & SPI displays also depend on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Usage Example

The Character_LCD class interfaces a predefined Character LCD display with CircuitPython.

import board
import digitalio
import adafruit_character_lcd.character_lcd as character_lcd

You must define the data pins (RS, EN, D4, D5, D6, D7) in your code before using the Character_LCD class. If you want to have on/off backlight functionality, you can also define your backlight as lcd_backlight. Otherwise, the backlight will always remain on. The following is an example setup.

lcd_rs = digitalio.DigitalInOut(board.D7)
lcd_en = digitalio.DigitalInOut(board.D8)
lcd_d7 = digitalio.DigitalInOut(board.D12)
lcd_d6 = digitalio.DigitalInOut(board.D11)
lcd_d5 = digitalio.DigitalInOut(board.D10)
lcd_d4 = digitalio.DigitalInOut(board.D9)
lcd_backlight = digitalio.DigitalInOut(board.D13)

You must also define the size of the CharLCD by specifying its lcd_columns and lcd_rows:

lcd_columns = 16
lcd_rows = 2

After you have set up your LCD, we can make the device by calling it

lcd = character_lcd.Character_LCD_Mono(lcd_rs, lcd_en, lcd_d4, lcd_d5, lcd_d6, lcd_d7, lcd_columns, lcd_rows, lcd_backlight)

To verify that your pins are correct, print a hello message to the CharLCD:

lcd.message = "Hello\nCircuitPython"

Custom character example with create_char() is provided within /examples/

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit_circuitpython_charlcd-3.5.3.tar.gz (34.0 kB view details)

Uploaded Source

Built Distribution

adafruit_circuitpython_charlcd-3.5.3-py3-none-any.whl (14.6 kB view details)

Uploaded Python 3

File details

Details for the file adafruit_circuitpython_charlcd-3.5.3.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_charlcd-3.5.3.tar.gz
Algorithm Hash digest
SHA256 cdab9dfeb1a490623c3d05745b97d418be1ee6e16a41ebbdd01b597d2ebb3ce6
MD5 a3114bce96fc96d8ff6ae151f8d52f25
BLAKE2b-256 8c5f969c60606c7fe9326b58b5a37bafc26ef73af23484981c2e1ebf41d8ae36

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_charlcd-3.5.3-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_charlcd-3.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c0fcf70e92148dc012b81d289edefcda0fd80295b7399902e9d486db5500d5a4
MD5 1490f86ac3a50c8b4e34058ecc0e5ced
BLAKE2b-256 587f554ae905d884074f86396d5c9b760e0ee84372f8befc4044352c1e3f58b0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page