Component: LCD (Adafruit, 20x4) (Alphanumeric): Difference between revisions

Latest revision as of 14:37, 13 July 2026

Author	Matrix Ltd
Version	1.10
Category	Alphanumeric

LCD (Adafruit, 20x4) component

Adafruit OLED LCD display capable of displaying 4 lines of 20 characters.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

Clear

	Clear
Clears the entire contents of the display.
- VOID	Return

ClearLine

	ClearLine
Clears a single line on the display before moving the cursor back to the start of the line to allow new data to be displayed.
- 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
Send a defined command to the LCD Screen. See datasheet for supported commands.
- 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
Holds an ascii value.
- 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
Based on v5 macro, will allow you to print a number. This is limited to a signed-INT, -32768 to 32767
- INT	Number

- VOID	Return

PrintString

	PrintString
Breaks down a string of text and sends it to the LCD via the private RawSend(byte, mask) macro
- 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
Values 0 to 7
- BYTE	d0

- BYTE	d1

- BYTE	d2

- BYTE	d3

- BYTE	d4

- BYTE	d5

- BYTE	d6

- BYTE	d7

- VOID	Return

RemapCharacter

	RemapCharacter
Assigns a remap character allowing the PrintString function to automatically swap between pre-defined characters. The characters can be custom (in the range 0-9) or can point to an existing character in the LCD character map.
- BYTE	RemapIdx
Remap Index, Range: 0 to (Remap Characters - 1)
- BYTE	SearchCharacter
Character to look for a replace
- BYTE	ReplacementCharacter
New character value to use in place of the search character.
- VOID	Return

ScrollDisplay

	ScrollDisplay
Scrolls the display left or right by a number of given positions.
- BYTE	Position
Holds the number of positions to shift the display
- BYTE	direction
0 = left, 1 = right
- VOID	Return

Start

	Start
Startup routine required by the hardware device. Automatically clears the display when complete.
- VOID	Return

Property reference

	Properties
	Connections
	Data 0 (11)
Data pin 0 connects to data pin 4 on the hardware
	Data 1 (12)
Data pin 1 connects to data pin 5 on the hardware
	Data 2 (13)
Data pin 2 connects to data pin 6 on the hardware
	Data 3 (14)
Data pin 3 connects to data pin 7 on the hardware
	Register Select (4)
Register select pin, determines if the incoming value is a command or a data byte
	Read / Write (5)
Read / Write pin determines the data direction
	Enable (6)
Enable pin, used to clock data in and out of the device.
	Remap Characters

	Display Settings
	Rows
Number of vertical characters that can be shown on the display
	Columns
Number of horizontal characters that can be shown on the display
	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
Colour surrounding the font characters drawn on the display
	Display Background
Colour of the background of the display

@@ Line 65: / Line 65: @@
 |-
 | 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" | Clears the entire contents of the display.&nbsp;
@@ Line 79: / Line 79: @@
 |-
 | 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" | Clears a single line on the display before moving the cursor back to the start of the line to allow new data to be displayed.&nbsp;
@@ Line 98: / Line 98: @@
 |-
 | 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 117: / Line 117: @@
 |-
 | 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 141: / Line 141: @@
 |-
 | 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 160: / Line 160: @@
 |-
 | 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 184: / Line 184: @@
 |-
 | 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 208: / Line 208: @@
 |-
 | 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" | Based on v5 macro, will allow you to print a number. This is limited to a signed-INT, -32768 to 32767&nbsp;
@@ Line 227: / Line 227: @@
 |-
 | 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" | Breaks down a string of text and sends it to the LCD via the private RawSend(byte, mask) macro&nbsp;
@@ Line 246: / Line 246: @@
 |-
 | 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 305: / Line 305: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RemapCharacter'''
+| width="90%" class="mtx-class-macrohead" | '''RemapCharacter'''
 |-
 | colspan="2" | Assigns a remap character allowing the PrintString function to automatically swap between pre-defined characters.  The characters can be custom (in the range 0-9) or can point to an existing character in the LCD character map.&nbsp;
@@ Line 334: / Line 334: @@
 |-
 | 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 358: / Line 358: @@
 |-
 | 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. Automatically clears the display when complete.&nbsp;
@@ Line 373: / Line 373: @@
 |-
 | 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;" | Connections
+| width="90%" class="mtx-class-propfolder" | Connections
 |-
 |-
@@ Line 420: / Line 420: @@
 | 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;" | Display Settings
+| width="90%" class="mtx-class-propfolder" | Display Settings
 |-
 |-
@@ Line 434: / Line 434: @@
 | colspan="2" | Number of horizontal characters that can be shown on the display&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)