Metadata-Version: 1.1
Name: RPLCD
Version: 0.9.0
Summary: A Raspberry Pi LCD library for the widely used Hitachi HD44780 controller.
Home-page: https://github.com/dbrgn/RPLCD
Author: Danilo Bargen
Author-email: mail@dbrgn.ch
License: MIT
Description: RPLCD
        #####
        
        .. image:: https://img.shields.io/travis/dbrgn/RPLCD/master.svg
            :target: https://travis-ci.org/dbrgn/RPLCD
            :alt: Build Status
        .. image:: https://img.shields.io/pypi/v/RPLCD.svg
            :target: https://pypi.python.org/pypi/RPLCD/
            :alt: PyPI Version
        .. image:: https://img.shields.io/pypi/dm/RPLCD.svg
            :target: https://pypi.python.org/pypi/RPLCD/
            :alt: PyPI Downloads
        .. image:: https://img.shields.io/pypi/wheel/RPLCD.svg
            :target: https://pypi.python.org/pypi/RPLCD/
            :alt: PyPI Wheel
        .. image:: https://img.shields.io/pypi/pyversions/RPLCD.svg
            :target: https://pypi.python.org/pypi/RPLCD/
            :alt: PyPI Python Versions
        .. image:: https://img.shields.io/badge/dependencies-0-blue.svg
            :target: https://pypi.python.org/pypi/RPLCD/
            :alt: Dependencies
        .. image:: https://img.shields.io/pypi/l/RPLCD.svg
            :target: https://pypi.python.org/pypi/RPLCD/
            :alt: License
        
        A Python 3/2 Raspberry PI Character LCD library for the Hitachi HD44780
        controller. It supports both GPIO (parallel) mode as well as boards with an I2C
        port expander (e.g. the PCF8574).
        
        This library is inspired by Adafruit Industries' CharLCD_ library as well as by
        Arduino's LiquidCrystal_ library.
        
        No external dependencies (except the ``RPi.GPIO`` library, which comes
        preinstalled on Raspbian) are needed to use this library.
        
        .. image:: https://raw.github.com/dbrgn/RPLCD/master/photo-i2c.jpg
            :alt: Photo of 20x4 LCD in action
        
        
        Setup
        =====
        
        You can install RPLCD directly from `PyPI
        <https://pypi.python.org/pypi/RPLCD/>`_ using pip::
        
            $ sudo pip install RPLCD
        
        If you want to use I2C, you also need smbus::
        
            $ sudo apt install python-smbus
        
        You can also install the library manually without pip. Either just copy the
        scripts to your working directory and import them, or download the repository
        and run ``python setup.py install`` to install it into your Python package
        directory.
        
        
        Features
        ========
        
        Implemented
        -----------
        
        - Simple to use API
        - Support for both 4 bit and 8 bit modes
        - Support for both parallel and I²C connection
        - Support for custom characters
        - Support for backlight control circuits
        - Built-in support for `A00` and `A02` character tables
        - Python 2/3 compatible
        - Caching: Only write characters if they changed
        - No external dependencies (except `RPi.GPIO`, and `python-smbus` if you need
          I²C support)
        
        Wishlist
        --------
        
        These things may get implemented in the future, depending on my free time and
        motivation:
        
        - MicroPython port
        
        
        Documentation
        =============
        
        You can find the documentation here: https://readthedocs.org/projects/rplcd/
        
        
        Testing
        =======
        
        Test Scripts
        ------------
        
        To test your 20x4 display, please run the ``test_20x4.py`` script and
        confirm/verify each step with the enter key. If you don't use the standard
        wiring, make sure to add your pin numbers to the ``CharLCD`` constructor in
        ``test_20x4.py``.
        
        To test a 16x2 display, proceed as explained above, but use the ``test_16x2.py``
        script instead.
        
        Unit Tests
        ----------
        
        There are also unit tests. First, install dependencies:
        
            pip install -U -r requirements-dev.txt
        
        Then run the tests:
        
            py.test -v
        
        
        Coding Guidelines
        =================
        
        `PEP8 <http://www.python.org/dev/peps/pep-0008/>`__ via `flake8
        <https://pypi.python.org/pypi/flake8>`_ with ``max-line-width`` set to 99 and
        ``E126-E128,C901`` ignored::
        
            flake8 --max-line-length=99 --ignore=E126,E127,E128,C901 RPLCD/lcd.py
        
        
        Resources
        =========
        
        - TC2004A-01 Data Sheet: http://www.adafruit.com/datasheets/TC2004A-01.pdf
        - HD44780U Data Sheet: http://www.adafruit.com/datasheets/HD44780.pdf
        
        
        License
        =======
        
        This code is licensed under the MIT license, see the `LICENSE file
        <https://github.com/dbrgn/RPLCD/blob/master/LICENSE>`_ or `tldrlegal
        <http://www.tldrlegal.com/license/mit-license>`_ for more information. 
        
        The module ``RPLCD/enum.py`` is (c) 2004-2013 by Barry Warsaw. It was
        distributed as part of the ``flufl.enum`` package under the LGPL License version
        3 or later.
        
        
        .. _charlcd: https://github.com/adafruit/Adafruit-Raspberry-Pi-Python-Code/tree/master/Adafruit_CharLCD
        .. _liquidcrystal: http://arduino.cc/en/Reference/LiquidCrystal
        
Keywords: raspberry,raspberry pi,lcd,liquid crystal,hitachi,hd44780
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Other Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: System :: Hardware :: Hardware Drivers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
