Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-charlcd/badge/?version=latest
:target: https://docs.circuitpython.org/projects/charlcd/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_CharLCD/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_CharLCD/actions/
:alt: Build Status
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
:target: https://github.com/astral-sh/ruff
:alt: Code Style: Ruff
This library is compatible with standard Character LCDs such as:
* `Adafruit Standard LCD 16x2 <https://www.adafruit.com/product/181>`_
* `Adafruit RGB backlight negative LCD 16x2 <https://www.adafruit.com/product/399>`_
* `Adafruit RGB backlight negative LCD 20x4 <https://www.adafruit.com/product/498>`_
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-charlcd/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-charlcd
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-charlcd
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-charlcd
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Adafruit CircuitPython BusDevice <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
* `Adafruit CircuitPython MCP230xx <https://github.com/adafruit/Adafruit_CircuitPython_MCP230xx>`_
* `Adafruit CircuitPython 74HC595 <https://github.com/adafruit/Adafruit_CircuitPython_74HC595>`_
I2C & SPI displays also depend on:
* `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>`_.
Usage Example
=============
The ``Character_LCD`` class interfaces a predefined Character LCD display with CircuitPython.
.. code-block:: python
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.
.. code-block:: python
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``:
.. code-block:: python
lcd_columns = 16
lcd_rows = 2
After you have set up your LCD, we can make the device by calling it
.. code-block:: python
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:
.. code-block:: python
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 <https://docs.circuitpython.org/projects/charlcd/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_CharLCD/blob/main/CODE_OF_CONDUCT.md>`_ before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-charlcd",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, character, lcd, rgb, 16x2, 20x4, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/7e/41/4e8b6778058668260ef1a47207b44152a86baa866d10e6148d9f606d102e/adafruit_circuitpython_charlcd-3.5.5.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-charlcd/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/charlcd/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_CharLCD/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_CharLCD/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json\n :target: https://github.com/astral-sh/ruff\n :alt: Code Style: Ruff\n\nThis library is compatible with standard Character LCDs such as:\n\n* `Adafruit Standard LCD 16x2 <https://www.adafruit.com/product/181>`_\n* `Adafruit RGB backlight negative LCD 16x2 <https://www.adafruit.com/product/399>`_\n* `Adafruit RGB backlight negative LCD 20x4 <https://www.adafruit.com/product/498>`_\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-charlcd/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-charlcd\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-charlcd\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-charlcd\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Adafruit CircuitPython BusDevice <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n* `Adafruit CircuitPython MCP230xx <https://github.com/adafruit/Adafruit_CircuitPython_MCP230xx>`_\n* `Adafruit CircuitPython 74HC595 <https://github.com/adafruit/Adafruit_CircuitPython_74HC595>`_\n\nI2C & SPI displays also depend on:\n\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 the\n`Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nUsage Example\n=============\n\nThe ``Character_LCD`` class interfaces a predefined Character LCD display with CircuitPython.\n\n.. code-block:: python\n\n import board\n import digitalio\n import adafruit_character_lcd.character_lcd as character_lcd\n\nYou must define the data pins (``RS``, ``EN``, ``D4``, ``D5``, ``D6``, ``D7``) in your code before using the ``Character_LCD`` class.\nIf you want to have on/off ``backlight`` functionality, you can also define your backlight as ``lcd_backlight``. Otherwise, the backlight\nwill always remain on. The following is an example setup.\n\n.. code-block:: python\n\n lcd_rs = digitalio.DigitalInOut(board.D7)\n lcd_en = digitalio.DigitalInOut(board.D8)\n lcd_d7 = digitalio.DigitalInOut(board.D12)\n lcd_d6 = digitalio.DigitalInOut(board.D11)\n lcd_d5 = digitalio.DigitalInOut(board.D10)\n lcd_d4 = digitalio.DigitalInOut(board.D9)\n lcd_backlight = digitalio.DigitalInOut(board.D13)\n\nYou must also define the size of the CharLCD by specifying its ``lcd_columns`` and ``lcd_rows``:\n\n.. code-block:: python\n\n lcd_columns = 16\n lcd_rows = 2\n\nAfter you have set up your LCD, we can make the device by calling it\n\n.. code-block:: python\n\n lcd = character_lcd.Character_LCD_Mono(lcd_rs, lcd_en, lcd_d4, lcd_d5, lcd_d6, lcd_d7, lcd_columns, lcd_rows, lcd_backlight)\n\n\nTo verify that your pins are correct, print a hello message to the CharLCD:\n\n.. code-block:: python\n\n lcd.message = \"Hello\\nCircuitPython\"\n\n\nCustom character example with ``create_char()`` is provided within /examples/\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/charlcd/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_CharLCD/blob/main/CODE_OF_CONDUCT.md>`_ before contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for standard character LCDs.",
"version": "3.5.5",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_CharLCD"
},
"split_keywords": [
"adafruit",
" character",
" lcd",
" rgb",
" 16x2",
" 20x4",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "05235149aed7754a310537a7283a4da1657c7912732b48375294cc2ac419844e",
"md5": "ff3cedfae0f7081880f72f6b7cee3f8b",
"sha256": "c98ec54c72e0f167700573b74f3ce867503501cc539593ae14b011e607bf26f2"
},
"downloads": -1,
"filename": "adafruit_circuitpython_charlcd-3.5.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ff3cedfae0f7081880f72f6b7cee3f8b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 14626,
"upload_time": "2025-10-20T16:39:05",
"upload_time_iso_8601": "2025-10-20T16:39:05.679396Z",
"url": "https://files.pythonhosted.org/packages/05/23/5149aed7754a310537a7283a4da1657c7912732b48375294cc2ac419844e/adafruit_circuitpython_charlcd-3.5.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "7e414e8b6778058668260ef1a47207b44152a86baa866d10e6148d9f606d102e",
"md5": "c86b4ed3575f6a06314ce93b059d2a41",
"sha256": "7df596378d6af50a967dd95c55cb1e07b6cb8a29ee57d73ea050eff92c978671"
},
"downloads": -1,
"filename": "adafruit_circuitpython_charlcd-3.5.5.tar.gz",
"has_sig": false,
"md5_digest": "c86b4ed3575f6a06314ce93b059d2a41",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 34291,
"upload_time": "2025-10-20T16:39:06",
"upload_time_iso_8601": "2025-10-20T16:39:06.558250Z",
"url": "https://files.pythonhosted.org/packages/7e/41/4e8b6778058668260ef1a47207b44152a86baa866d10e6148d9f606d102e/adafruit_circuitpython_charlcd-3.5.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-20 16:39:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_CharLCD",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-circuitpython-mcp230xx",
"specs": []
},
{
"name": "adafruit-circuitpython-busdevice",
"specs": []
},
{
"name": "adafruit-circuitpython-74hc595",
"specs": []
},
{
"name": "adafruit-circuitpython-typing",
"specs": [
[
"~=",
"1.5"
]
]
}
],
"lcname": "adafruit-circuitpython-charlcd"
}
JSON
