Component: LCD (Grove - I2C) (Alphanumeric): Difference between revisions

Latest revision as of 14:37, 13 July 2026

Author	Matrix Ltd
Version	12.0
Category	Alphanumeric

LCD (Grove - I2C) component

Standard alphanumeric LCD based on the Grove I2C LCD module with RGB backlight.

Version information

Library Version, Component Version, Date, Author, Info
12, 12.0, 22-08-24, MW, Fixed bug within SetReg that causes compile to fail with ESP32

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

BacklightControl

	BacklightControl

- BYTE	Red

- BYTE	Green

- BYTE	Blue

- VOID	Return

Clear

	Clear

- VOID	Return

ClearLine

	ClearLine

- BYTE	Line

- VOID	Return

Command

	Command
Use this method/macro to send a specific command to the LCD. Refer to the Matrix Multimedia EB006 datasheet for a list of supported instructions. For Non-Matrix LCD's refer to the manufacturers datasheet.
- BYTE	instruction

- VOID	Return

Cursor

	Cursor
Moves the cursor on the LCD Display
- BYTE	x

- BYTE	y

- VOID	Return

PrintAscii

	PrintAscii
Takes the ascii value for a character and prints the character
- BYTE	character

- VOID	Return

PrintFloat

	PrintFloat
Print a Float number rounded up to a specified amount of decimal places.
- FLOAT	Number
Enter the number or variable to print to the LCD
- BYTE	DecimalPlaces
Enter how many decimal places to round up to (1 - 6)
- VOID	Return

PrintFormattedNumber

	PrintFormattedNumber
Will allow you to print a number up to 32-bits with signed or unsigned formatting. Signed = -2147483648 to 2147483647 Unsigned = 0 to 4294967295
- ULONG	Number
Enter the number or variable to print to the LCD
- BOOL	Format
0=Signed, 1=Unsigned
- VOID	Return

PrintNumber

	PrintNumber
Allows you to print a number. This is limited to a signed-INT, -32768 to 32767
- INT	Number

- VOID	Return

PrintString

	PrintString

- STRING	Text

- VOID	Return

RAMWrite

	RAMWrite
Modifies the internal memory of the LCD to allow for up to 8 customised characters to be created and stored in the device memory
- BYTE	Index

- BYTE	d0

- BYTE	d1

- BYTE	d2

- BYTE	d3

- BYTE	d4

- BYTE	d5

- BYTE	d6

- BYTE	d7

- VOID	Return

ScrollDisplay

	ScrollDisplay
Scrolls the display left or right by a number of given positions.
- BYTE	position

- BYTE	direction

- VOID	Return

SetI2CAddress

	SetI2CAddress
Allows the I2C device address to be dynamically changed in software without having to re-compile. Can be called before the first Start macro or at any point after.
- BYTE	Address
New I2C Device Address excluding R/W bit - Range 0 - 127
- VOID	Return

Start

	Start
Startup routine required by the hardware device.
- VOID	Return

Property reference

	Properties
	I2C Config
	LCD Address

	RGB Address

	Alt RGB Address

	Channel
Channel selection
	Baud Select
Baud rate option selector
	Baud Rate
Baud rate to be used
	Stop Delay
On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not a 10ms delay between an I2C stop event and the next I2C start event. Most modern microcontrollers will not have a problem so this property can be disabled to speed up the I2C communications.
	Connections
	SDA
Pin used for SDA (data signal)
	SCL
Pin used for SCL (clock signal)
	LCD Configuration
	LCD Backlight Type

	Rows

	Columns

	Simulation
	Component Label

	Component Label Scale
The label scale can be change if the amout of text is too wide for the display
	Text Colour
Colour of the font characters drawn on the display
	Text Background

	Display Background

	Simulate Comms
Used to drive the comms durig simulation which can be used to: Data Recorder waveform generation Console Logging Data Injector to redirect the data e.g. to a SCADA slave connected to the physical hardware
	Scope Traces
Selects if the component pin connections are automatically generated on the data recorder window or not. Yes: Automatically add the component pins to a group on the data recorder which will reflect the sim data during simultion. No: Do not show the pin signals on the data recorder window.
	Console Data
Selects if the console data is automatically generated or not
	API
Specifies the injector component on the panel to interact with to provide comms simulation.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_LCD_Grove_I2C.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_LCD_Grove_I2C.fcfx

@@ Line 78: / Line 78: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''BacklightControl'''
+| width="90%" class="mtx-class-macrohead" | '''BacklightControl'''
 |-
 | colspan="2" | &nbsp;
@@ Line 107: / Line 107: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Clear'''
+| width="90%" class="mtx-class-macrohead" | '''Clear'''
 |-
 | colspan="2" | &nbsp;
@@ Line 121: / Line 121: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ClearLine'''
+| width="90%" class="mtx-class-macrohead" | '''ClearLine'''
 |-
 | colspan="2" | &nbsp;
@@ Line 140: / Line 140: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Command'''
+| width="90%" class="mtx-class-macrohead" | '''Command'''
 |-
 | colspan="2" | Use this method/macro to send a specific command to the LCD. Refer to the Matrix Multimedia EB006 datasheet for a list of supported instructions. For Non-Matrix LCD's refer to the manufacturers datasheet.&nbsp;
@@ Line 159: / Line 159: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Cursor'''
+| width="90%" class="mtx-class-macrohead" | '''Cursor'''
 |-
 | colspan="2" | Moves the cursor on the LCD Display&nbsp;
@@ Line 183: / Line 183: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PrintAscii'''
+| width="90%" class="mtx-class-macrohead" | '''PrintAscii'''
 |-
 | colspan="2" | Takes the ascii value for a character and prints the character&nbsp;
@@ Line 202: / Line 202: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PrintFloat'''
+| width="90%" class="mtx-class-macrohead" | '''PrintFloat'''
 |-
 | colspan="2" | Print a Float number rounded up to a specified amount of decimal places.&nbsp;
@@ Line 226: / Line 226: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PrintFormattedNumber'''
+| width="90%" class="mtx-class-macrohead" | '''PrintFormattedNumber'''
 |-
 | colspan="2" | Will allow you to print a number up to 32-bits with signed or unsigned formatting. Signed = -2147483648 to 2147483647 Unsigned = 0 to 4294967295&nbsp;
@@ Line 250: / Line 250: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PrintNumber'''
+| width="90%" class="mtx-class-macrohead" | '''PrintNumber'''
 |-
 | colspan="2" | Allows you to print a number. This is limited to a signed-INT, -32768 to 32767&nbsp;
@@ Line 269: / Line 269: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PrintString'''
+| width="90%" class="mtx-class-macrohead" | '''PrintString'''
 |-
 | colspan="2" | &nbsp;
@@ Line 288: / Line 288: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RAMWrite'''
+| width="90%" class="mtx-class-macrohead" | '''RAMWrite'''
 |-
 | colspan="2" | Modifies the internal memory of the LCD to allow for up to 8 customised characters to be created and stored in the device memory&nbsp;
@@ Line 347: / Line 347: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ScrollDisplay'''
+| width="90%" class="mtx-class-macrohead" | '''ScrollDisplay'''
 |-
 | colspan="2" | Scrolls the display left or right by a number of given positions.&nbsp;
@@ Line 371: / Line 371: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetI2CAddress'''
+| width="90%" class="mtx-class-macrohead" | '''SetI2CAddress'''
 |-
 | colspan="2" | Allows the I2C device address to be dynamically changed in software without having to re-compile. Can be called before the first Start macro or at any point  after.&nbsp;
@@ Line 390: / Line 390: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Start'''
+| width="90%" class="mtx-class-macrohead" | '''Start'''
 |-
 | colspan="2" | Startup routine required by the hardware device.&nbsp;
@@ Line 405: / Line 405: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | I2C Config
+| width="90%" class="mtx-class-propfolder" | I2C Config
 |-
 |-
@@ Line 447: / Line 447: @@
 | colspan="2" | On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not  a 10ms delay between an I2C stop event and the next I2C start event.  Most modern microcontrollers will not have a problem so this property can be disabled to speed up the  I2C communications. &nbsp;
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
+| width="90%" class="mtx-class-propfolder" | Connections
 |-
 |-
@@ Line 461: / Line 461: @@
 | colspan="2" | Pin used for SCL (clock signal)&nbsp;
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | LCD Configuration
+| width="90%" class="mtx-class-propfolder" | LCD Configuration
 |-
 |-
@@ Line 480: / Line 480: @@
 | colspan="2" | &nbsp;
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
+| width="90%" class="mtx-class-propfolder" | Simulation
 |-
 |-

SteveT (talk | contribs)