{"id":16603272,"url":"https://github.com/dbrgn/rplcd","last_synced_at":"2025-05-15T07:03:22.863Z","repository":{"id":8339848,"uuid":"9896961","full_name":"dbrgn/RPLCD","owner":"dbrgn","description":"A Raspberry Pi LCD library for the widely used Hitachi HD44780 controller, written in Python. GPIO (parallel) and I²C modes supported.","archived":false,"fork":false,"pushed_at":"2025-03-29T22:45:31.000Z","size":955,"stargazers_count":272,"open_issues_count":12,"forks_count":72,"subscribers_count":16,"default_branch":"master","last_synced_at":"2025-05-15T07:01:49.541Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://rplcd.readthedocs.io/en/latest/","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/dbrgn.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"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,"zenodo":null}},"created_at":"2013-05-06T21:09:10.000Z","updated_at":"2025-04-30T22:00:09.000Z","dependencies_parsed_at":"2024-10-30T16:04:36.464Z","dependency_job_id":"e1ace106-d704-4773-8326-0b75efe9d8f7","html_url":"https://github.com/dbrgn/RPLCD","commit_stats":{"total_commits":228,"total_committers":17,"mean_commits":"13.411764705882353","dds":0.4473684210526315,"last_synced_commit":"486533e25c423a884c8d73486d2b8e53bbaabb97"},"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbrgn%2FRPLCD","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbrgn%2FRPLCD/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbrgn%2FRPLCD/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dbrgn%2FRPLCD/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dbrgn","download_url":"https://codeload.github.com/dbrgn/RPLCD/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254291961,"owners_count":22046424,"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":[],"created_at":"2024-10-12T00:48:51.856Z","updated_at":"2025-05-15T07:03:22.807Z","avatar_url":"https://github.com/dbrgn.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"RPLCD\n#####\n\n.. image:: https://img.shields.io/github/actions/workflow/status/dbrgn/RPLCD/ci.yml?branch=master\n    :target: https://github.com/dbrgn/RPLCD/actions/workflows/ci.yml\n    :alt: Build Status\n.. image:: https://img.shields.io/pypi/v/RPLCD.svg\n    :target: https://pypi.python.org/pypi/RPLCD/\n    :alt: PyPI Version\n.. image:: https://img.shields.io/pypi/wheel/RPLCD.svg\n    :target: https://pypi.python.org/pypi/RPLCD/\n    :alt: PyPI Wheel\n.. image:: https://img.shields.io/pypi/pyversions/RPLCD.svg\n    :target: https://pypi.python.org/pypi/RPLCD/\n    :alt: PyPI Python Versions\n.. image:: https://img.shields.io/badge/dependencies-0-blue.svg\n    :target: https://pypi.python.org/pypi/RPLCD/\n    :alt: Dependencies\n.. image:: https://img.shields.io/pypi/l/RPLCD.svg\n    :target: https://pypi.python.org/pypi/RPLCD/\n    :alt: License\n\nA Python 3 Raspberry PI Character LCD library for the Hitachi HD44780\ncontroller. It supports both GPIO (parallel) mode as well as boards with an I²C\nport expander (e.g. the PCF8574 or the MCP23008).\n\nThis library is inspired by Adafruit Industries' CharLCD_ library as well as by\nArduino's LiquidCrystal_ library.\n\nFor GPIO mode, no external dependencies (except the ``RPi.GPIO`` library, which\ncomes preinstalled on Raspbian) are needed to use this library. If you want to\ncontrol LCDs via I²C, then you also need the ``python-smbus`` or ``smbus2`` library. If you\nwant to control the LCD with ``pigpio``, you have to install the pigpio_ library.\n\nIf you're trying to get started with RPLCD, you should probably `read the docs\n\u003c#documentation\u003e`__ :)\n\n.. image:: https://raw.github.com/dbrgn/RPLCD/master/photo-i2c.jpg\n    :alt: Photo of 20x4 LCD in action\n\n\nSetup\n=====\n\nYou can install RPLCD directly from `PyPI\n\u003chttps://pypi.python.org/pypi/RPLCD/\u003e`_ using pip::\n\n    $ sudo pip install RPLCD\n\nIf you want to use I²C, you also need either the smbus or `smbus2 \u003chttps://pypi.org/project/smbus2/\u003e`_ library::\n\n    $ sudo apt install python-smbus\n    or\n    $ sudo pip install smbus2\n\nRPLCD will first try to use smbus if available and if not, fall back to smbus2.\n\nYou can also install the library manually without pip. Either just copy the\nscripts to your working directory and import them, or download the repository\nand run ``python setup.py install`` to install it into your Python package\ndirectory.\n\n\nFeatures\n========\n\nImplemented\n-----------\n\n- Simple to use API\n- Support for both 4 bit and 8 bit modes\n- Support for both parallel (GPIO) and I²C connection\n- Support for custom characters\n- Support for backlight control circuits\n- Built-in support for `A00`, `A02` (standard HD44780)\n  or `ST0B` (see ST7066_, page 11) character tables\n- Caching: Only write characters if they changed\n- No external dependencies (except `RPi.GPIO`, and `python-smbus` or `smbus2` if you need\n  I²C support)\n\nWishlist\n--------\n\nThese things may get implemented in the future, depending on my free time and\nmotivation:\n\n- MicroPython port\n\nSupported I²C Port Expanders\n----------------------------\n\n- PCF8574 (used by a lot of I²C LCD adapters on Ali Express)\n- MCP23008 (used in Adafruit I²C LCD backpack)\n- MCP23017\n\n\nDocumentation\n=============\n\n- Stable (released on PyPI): http://rplcd.readthedocs.io/en/stable/\n- Latest (current master): http://rplcd.readthedocs.io/en/latest/\n\nTesting\n=======\n\nInteractive Test Script\n-----------------------\n\nTo test your LCD, please run the ``rplcd-tests`` script with the ``testsuite``\ntarget.\n\nUnit Tests\n----------\n\nThere are also unit tests. First, install dependencies:\n\n    pip install -U -r requirements-dev.txt\n\nThen run the tests:\n\n    py.test -v\n\n\nCoding Guidelines\n=================\n\nPlease reformat your code using `ruff format \u003chttps://docs.astral.sh/ruff/formatter/\u003e`_::\n\n    ruff format\n\n\nAbout HD44780\n=============\n\nThe HD44780 LCD controller is a controller chip for driving alphanumeric LCD displays. Though it's\nnot manufactured anymore there are a lot of compatible chips / clones of it e.g. the ST7066 or the\nKS0066. Displays sold with 'HD44780' in its name today typically are built with one of those \nclones, though they all look the same from the outside most of the time (like in the image at the \nstart of this README). \n\n\nResources\n=========\n\n- TC2004A-01 Data Sheet: http://www.adafruit.com/datasheets/TC2004A-01.pdf\n- HD44780U Data Sheet: http://www.adafruit.com/datasheets/HD44780.pdf\n- ST7066 Data Sheet: https://www.sparkfun.com/datasheets/LCD/st7066.pdf\n\n\nLicense\n=======\n\nThis code is licensed under the MIT license, see the `LICENSE file\n\u003chttps://github.com/dbrgn/RPLCD/blob/master/LICENSE\u003e`_ or `tldrlegal\n\u003chttp://www.tldrlegal.com/license/mit-license\u003e`_ for more information. \n\n\n.. _charlcd: https://github.com/adafruit/Adafruit-Raspberry-Pi-Python-Code/tree/master/Adafruit_CharLCD\n.. _liquidcrystal: http://arduino.cc/en/Reference/LiquidCrystal\n.. _pigpio: http://abyz.me.uk/rpi/pigpio/\n.. _st7066: https://www.sparkfun.com/datasheets/LCD/st7066.pdf\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdbrgn%2Frplcd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdbrgn%2Frplcd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdbrgn%2Frplcd/lists"}