{"id":15018609,"url":"https://github.com/adafruit/adafruit_circuitpython_charlcd","last_synced_at":"2025-05-16T13:07:55.529Z","repository":{"id":45855058,"uuid":"93903760","full_name":"adafruit/Adafruit_CircuitPython_CharLCD","owner":"adafruit","description":"Library code for character LCD interfacing","archived":false,"fork":false,"pushed_at":"2025-05-13T21:33:10.000Z","size":494,"stargazers_count":73,"open_issues_count":3,"forks_count":50,"subscribers_count":24,"default_branch":"main","last_synced_at":"2025-05-15T20:56:13.602Z","etag":null,"topics":["character","circuitpython","hacktoberfest","lcd","rgb-led"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/adafruit.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-06-09T23:23:10.000Z","updated_at":"2025-05-13T21:30:45.000Z","dependencies_parsed_at":"2023-02-11T23:45:19.169Z","dependency_job_id":"c8c19f0c-5300-45b8-973e-afd176e44cd2","html_url":"https://github.com/adafruit/Adafruit_CircuitPython_CharLCD","commit_stats":{"total_commits":247,"total_committers":34,"mean_commits":7.264705882352941,"dds":0.7530364372469636,"last_synced_commit":"e7a18854183adb9116d7f71d2a405bf4a7106d47"},"previous_names":[],"tags_count":51,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adafruit%2FAdafruit_CircuitPython_CharLCD","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adafruit%2FAdafruit_CircuitPython_CharLCD/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adafruit%2FAdafruit_CircuitPython_CharLCD/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adafruit%2FAdafruit_CircuitPython_CharLCD/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adafruit","download_url":"https://codeload.github.com/adafruit/Adafruit_CircuitPython_CharLCD/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254535829,"owners_count":22087399,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["character","circuitpython","hacktoberfest","lcd","rgb-led"],"created_at":"2024-09-24T19:52:10.914Z","updated_at":"2025-05-16T13:07:55.522Z","avatar_url":"https://github.com/adafruit.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"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 \u003chttps://www.adafruit.com/product/181\u003e`_\n* `Adafruit RGB backlight negative LCD 16x2 \u003chttps://www.adafruit.com/product/399\u003e`_\n* `Adafruit RGB backlight negative LCD 20x4 \u003chttps://www.adafruit.com/product/498\u003e`_\n\nInstalling from PyPI\n--------------------\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI \u003chttps://pypi.org/project/adafruit-circuitpython-charlcd/\u003e`_. 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 \u0026\u0026 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 \u003chttps://github.com/adafruit/circuitpython\u003e`_\n* `Adafruit CircuitPython BusDevice \u003chttps://github.com/adafruit/Adafruit_CircuitPython_BusDevice\u003e`_\n* `Adafruit CircuitPython MCP230xx \u003chttps://github.com/adafruit/Adafruit_CircuitPython_MCP230xx\u003e`_\n* `Adafruit CircuitPython 74HC595 \u003chttps://github.com/adafruit/Adafruit_CircuitPython_74HC595\u003e`_\n\nI2C \u0026 SPI displays also depend on:\n\n* `Bus Device \u003chttps://github.com/adafruit/Adafruit_CircuitPython_BusDevice\u003e`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading the\n`Adafruit library and driver bundle \u003chttps://github.com/adafruit/Adafruit_CircuitPython_Bundle\u003e`_.\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 \u003chttps://docs.circuitpython.org/projects/charlcd/en/latest/\u003e`_.\n\nFor information on building library documentation, please check out `this guide \u003chttps://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1\u003e`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n\u003chttps://github.com/adafruit/Adafruit_CircuitPython_CharLCD/blob/main/CODE_OF_CONDUCT.md\u003e`_ before contributing to help this project stay welcoming.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadafruit%2Fadafruit_circuitpython_charlcd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadafruit%2Fadafruit_circuitpython_charlcd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadafruit%2Fadafruit_circuitpython_charlcd/lists"}