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/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
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": "",
"name": "adafruit-circuitpython-charlcd",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,character,lcd,rgb,16x2,20x4,hardware,micropython,circuitpython",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/30/f6/659418778a216a15c2f0422cbb865e0612db8f71d404cc93baa325af5177/adafruit-circuitpython-charlcd-3.4.9.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/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\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.4.9",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_CharLCD"
},
"split_keywords": [
"adafruit",
"character",
"lcd",
"rgb",
"16x2",
"20x4",
"hardware",
"micropython",
"circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f37ff00d69f41cc5f5c4549aa89a0e2ea13b69dbe1a7c12147372c8d9cc9d3ba",
"md5": "516325a89ce49dd65ce6729710068af5",
"sha256": "0f298f808fb15ea17d31cfb49cac182c429b8e523a1c7307238f4ed76a2cb53c"
},
"downloads": -1,
"filename": "adafruit_circuitpython_charlcd-3.4.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "516325a89ce49dd65ce6729710068af5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 14412,
"upload_time": "2023-09-25T15:38:07",
"upload_time_iso_8601": "2023-09-25T15:38:07.647323Z",
"url": "https://files.pythonhosted.org/packages/f3/7f/f00d69f41cc5f5c4549aa89a0e2ea13b69dbe1a7c12147372c8d9cc9d3ba/adafruit_circuitpython_charlcd-3.4.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "30f6659418778a216a15c2f0422cbb865e0612db8f71d404cc93baa325af5177",
"md5": "714fff35e50893907759c65c991def26",
"sha256": "c2dfccdb2e8c39ebf07d332e2fce20ccf32fdbab194c52ad5a149e6dc040d382"
},
"downloads": -1,
"filename": "adafruit-circuitpython-charlcd-3.4.9.tar.gz",
"has_sig": false,
"md5_digest": "714fff35e50893907759c65c991def26",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 37177,
"upload_time": "2023-09-25T15:38:08",
"upload_time_iso_8601": "2023-09-25T15:38:08.743874Z",
"url": "https://files.pythonhosted.org/packages/30/f6/659418778a216a15c2f0422cbb865e0612db8f71d404cc93baa325af5177/adafruit-circuitpython-charlcd-3.4.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-25 15:38:08",
"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": [],
"lcname": "adafruit-circuitpython-charlcd"
}
JSON
