RPLCD 0.1.1

Prerequisites

As prerequisite to build the RPIO dependency, you need the python-dev package. And to install the package itself, you’ll want to use pip. Both should already be installed on a regular Raspbian image. Otherwise, install them:

$ sudo apt-get install python-dev python-pip

Virtualenv Installation

I would recommend you to always use virtualenv and virtualenvwrapper when developing Python applications. This way, you have an isolated environment for each project, which prevents package version conflicts.

To install virtualenv and virtualenvwrapper:

$ sudo apt-get install virtualenvwrapper

Log out and back in to activate the virtualenvwrapper scripts. Then create a new virtualenv:

$ mkvirtualenv myproject

To enable the virtualenv, use workon myproject and to disable it use deactivate.

Then install the RPLCD library with its dependencies:

$ pip install RPLCD

Systemwide Installation

If you want you can also skip the virtualenv part and install the library system-wide. In that case just run pip as root:

$ sudo pip install RPLCD

Manual Installation

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.

Init, Setup, Teardown

import RPIO
from RPLCD import CharLCD

# Initialize display. All values have default values and are therefore
# optional.
lcd = CharLCD(pin_rs=15, pin_e=16, pins_data=[21, 22, 23, 24],
              numbering_mode=RPIO.BOARD,
              cols=20, rows=4, dotsize=8)

...

# If desired, reset the GPIO configuration and optionally clear the screen.
# Note that this can lead to undesired effects on the LCD, because the GPIO
# pins are not configured as input or output anymore.
lcd.close(clear=True)

Properties

• display_enabled -> True / False

• cursor_pos -> (row, col)

• text_align_mode -> Alignment.left / Alignment.right

• write_shift_mode -> ShiftMode.cursor / ShiftMode.display

• cursor_mode -> CursorMode.hide / CursorMode.line / CursorMode.blink

High Level Functions

• write_string(value): Write the specified string to the display. You can use newline (\n) and carriage return (\n) characters.

• clear(): Overwrite display with blank characters and reset cursor position.

• home(): Set cursor to initial position and reset any shifting.

• shift_display(amount): Shift the display. Use negative amounts to shift left and positive amounts to shift right.

Mid Level Functions

• write(value): Send a raw command to the LCD.

• command(value): Write a raw byte to the LCD.