gavinlyonsrepo / HD44780_LCD_RPI

Library to support the HD44780 LCD , (I2C PCF8574 "backpack" interface) for the Raspberry PI.

Home Page:https://gavinlyonsrepo.github.io/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Website Rss Donate

 lcd

HD44780_LCD_RPI

Table of contents

Overview

  • Name : HD44780_LCD_RPI
  • Description :
  1. Library to support the HD44780 LCD , (I2C PCF8574 "backpack" interface) for the Raspberry PI.
  2. Dynamic install-able system level Raspberry Pi C++ library.
  3. Backlight, scroll, cursor and entrymode control.
  4. Custom character support + print class for numerical data.
  5. Hardware I2C using bcm2835 library
  6. Dependency: bcm2835 Library
  7. Tested on size 16x02 and 20x04 (but may work on other sizes eg 16x04 , untested)
  • Author: Gavin Lyons
  • Development Tool chain.
    1. Raspberry PI 3 model b
    2. C++, g++ (Debian 12.2.0)
    3. Raspbian , Debian 12 bookworm OS, , 64 bit.
    4. kernel : aarch64 Linux 6.1.0-rpi7-rpi-v8
    5. bcm2835 Library 1.74 dependency. Provides low level I2C bus, delays and GPIO control.

Installation

  1. Install the dependency bcm2835 Library if not installed.

  2. Download the HD44780_LCD_RPI library

    • Open a Terminal in a folder where you want to download,build & test library
    • Run following command to download from github.
curl -sL https://github.com/gavinlyonsrepo/HD44780_LCD_RPI/archive/1.3.3.tar.gz | tar xz
  1. Run "make" to run the makefile in repo base folder to install library, it will be installed to usr/lib and usr/include
cd HD44780_LCD_RPI-1.3.3
make
sudo make install

Test

  1. Next step is to test LCD and installed library with the example test file. Wire up your LCD. Next enter the examples folder and run the makefile in THAT folder, This 2nd makefile builds the example file using the just installed library. and creates a test exe file in "bin".
cd examples/
make
make run
  1. There are 5 examples files. To decide which one the makefile builds simply edit "SRC" variable at top of the makefile in examples folder. in the "User SRC directory Option Section". Pick an example "SRC" directory path and ONE ONLY. Comment out the rest and repeat: make & make run.
Filepath File Function Screen Size
src/HELLO_16x02 Hello world basic use case 16x02
src/TEST_16x02 Carries out test sequence testing features 16x02
src/TEST_20x04 Carries out test sequence testing features 20x04
src/CLOCK_16x02 A basic clock Demo 16x02
src/TEST_I2C_16x02 Check I2C connection 16x02

Hardware

Connections

  1. LCD SCLK = SCLK1 I2C pins P1-05 GPIO3
  2. LCD SDA = SDA1 I2C pins P1-03 GPIO2

Software

I2C

Hardware I2C.

  1. I2C Address is set by default to 0x27(your module could be different, user can change argument passed into LCD class constructor).

  2. I2C Clock rate can be a passed into in the LCD class constructor method as a argument, User can pass 1 of 4 BCM2835_I2C_CLOCK_DIVIDER values 2500, 626 150 or 148. See image below.

  3. In the event of an error writing a byte, debug info with error code will be written to console. This error code is the bcm2835I2CReasonCodes enum. Debug flag must be set to true to see this output. See image below for bcm2835I2CReasonCodes. User can set error timeout between retry attempts and number of retry attempts and can monitor the Error flag to see current bcm2835I2CReasonCodes.

  4. If you have multiple devices on I2C bus at different clock speeds. The I2C clock speed function may have to called before each tranche of LCD commands. and not just at start.

 bcm

For more info on bcm2835I2CClockDivider & bcm2835I2CReasonCodes see bcm2835 doc's for details

Debug

User can turn on debug messages with LCDDebugSet method see example file.

API

The API (application programming interface) html documentation is at link. Hosted on github pages and generated by Doxygen software. Here the user will find lots of information on files, functions & data types. NOTE :: This API is for the Arduino source port. It is very similar expect constructor, I2C method's will be different.

Software API Url Link

Output

Output of custom character test in test file.

 pic

20x04 display.

 pic2

Notes and issues

  1. For detailed graphical description of entry modes , cursor types, custom characters and more see here link

  2. 16X04 board not tested but should work

See Also

Combined Display library 'Display_Lib_RPI'

About

Library to support the HD44780 LCD , (I2C PCF8574 "backpack" interface) for the Raspberry PI.

https://gavinlyonsrepo.github.io/

License:GNU General Public License v3.0


Languages

Language:C++ 92.0%Language:Makefile 8.0%