Component: LCD (Adafruit, 20x4) (Alphanumeric)
From Flowcode Help
Jump to navigationJump to search| Author | Matrix Ltd |
| Version | 1.10 |
| Category | Alphanumeric |
Contents
LCD (Adafruit, 20x4) component
Adafruit OLED LCD display capable of displaying 4 lines of 20 characters.
Component Source Code
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 |
| Clears the entire contents of the display. | |
 - VOID
|
Return |
|
|
PrintString |
| Breaks down a string of text and sends it to the LCD via the private RawSend(byte, mask) macro | |
 - STRING
|
Text |
| - VOID
|
Return |
|
|
PrintAscii |
| Takes the ascii value for a character and prints the character | |
 - BYTE
|
character |
| Holds an ascii value. | |
| - VOID
|
Return |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
Cursor |
| Moves the cursor on the LCD Display | |
| - BYTE
|
x |
| - BYTE
|
y |
| - VOID
|
Return |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 | |
==Macro reference==
|
|
Clear |
| Clears the entire contents of the display. | |
| - VOID
|
Return |
|
|
PrintString |
| Breaks down a string of text and sends it to the LCD via the private RawSend(byte, mask) macro | |
| - STRING
|
Text |
| - VOID
|
Return |
|
|
PrintAscii |
| Takes the ascii value for a character and prints the character | |
| - BYTE
|
character |
| Holds an ascii value. | |
| - VOID
|
Return |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
Cursor |
| Moves the cursor on the LCD Display | |
| - BYTE
|
x |
| - BYTE
|
y |
| - VOID
|
Return |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 |
|
|
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 | |
