B4R Library rLiquidCrystalI2CEx

rLiquidCrystalI2CEx is an open source B4R library for writing to LCD Displays connected to microcontroller, like Arduino.

The library provides extended methods based on the B4R library rLiquiCrystal_I2C.

Attached
rLiquidCrystalI2CEx.zip archive contains the library and sample project.

Install
The library files are installed in the B4R additional libraries folder.
From the zip archive, copy the content of the library folder, to the B4R additional libraries folder keeping the folder structure.

<path to b4r additional libraries folder>\rLiquidCrystalI2CEx.xml
<path to b4r additional libraries folder>\rLiquidCrystalI2CEx\rLiquidCrystalI2CEx.h, rLiquidCrystalI2CEx.cpp, LiquidCrystal_I2C.h , LiquidCrystal_I2C.cpp

Wiring

Arduino = LCD I2C
GND = GND (Black)
5v = VCC (Red)
SDA = SDA (Blue)
SCL = SCL (Green)

Tested with an Arduino UNO and Arduino MEGA.

Methods
Initialize the LCD
LCD16x2: 0x3F, 16, 2
LCD20x4: 0x27, 20, 4

Initialize (Address As Byte, Columns As Byte, Rows As Byte)

Set Cursor Position at Column, Row

SetCursor (Column As Byte, Row As Byte)

Write Text
At the position prior set via SetCursor(Col,Row).

Write (Message As Object)

Write Text Position Column, Row

WriteAt (Column As Byte, Row As Byte, Message As Object)

Clear Screen and Set Cursor Position 0,0

Clear

Clear Row and Set Cursor Position 0, Row

ClearRow (Row As Byte)

Create Special Character Location 0-7

CreateChar (Location As Byte, Charmap() As Byte)

Write Special Character Location 0-7

WriteChar (Location As Byte)

Write Special Character Location 0-7 at Position Column, Row

WriteCharAt (Column As Byte, Row As Byte, Location As Byte)

Properties
Set Cursor Blink ON (true) or OFF (false)

Blink As bool [write only]

Set Cursor State ON (true) or OFF ( false)

CursorOn As bool [write only]

Turn LCD backlight ON (true) or OFF (false)

Backlight As bool [write only]

Fields
Create lcd Object

lcd As LiquidCrystalI2CEX

Get Number of Columns

ColumnSize As Byte

Get Number of Rows

RowSize As Byte

B4R Example

Sub Process_Globals
    Public serialLine As Serial
    Private lcd As LiquidCrystalI2CEX
    ' Special characters with location index 0,1...
    Private CharArrowUp As Byte = 0
    Private CharArrowDown As Byte = 1
    Private CharBell As Byte = 2
End Sub

Private Sub AppStart
    serialLine.Initialize(115200)
       Log("AppStart")

    'Init the LCD: Address (1602 = 0x3F,2004 = 0x27), Columns, Rows
    lcd.Initialize(0x27, 20, 4)
    'lcd.Initialize(0x3F, 16, 2)

    'Turn the backlight on (default is turned off), set cursor 0,0, write some text
       lcd.Backlight = True
    lcd.SetCursor(0,0)
    lcd.Write("Hello World")
    lcd.WriteAt(0,3,"B4X is great")

    'Define Special Chars
    lcd.CreateChar(CharArrowUp, Array As Byte (0x00,0x04,0x0E,0x1F,0x04,0x04,0x04,0x00))
    lcd.CreateChar(CharArrowDown, Array As Byte (0x00,0x04,0x04,0x04,0x1F,0x0E,0x04,0x00))
    lcd.CreateChar(CharBell, Array As Byte (0x04,0x0E,0x0E,0x0E,0x1F,0x00,0x04,0x00))
    'Write Special Chars at row 1
    lcd.WriteCharAt(0,1,CharArrowUp)
    lcd.WriteCharAt(5,1,CharArrowDown)
    lcd.WriteCharAt(10,1,CharBell)
End Sub

Hints
Handy tools (written in B4J) working with LCD displays: LCD Char Maker, LCD Display Designer

Licence
GNU General Public License v3.0.

Changelog
v1.00 (20210217) - Published B4R Forum