Component: LCD (Grove - UART) (Alphanumeric)
From Flowcode Help
Jump to navigationJump to search| Author | Matrix Ltd |
| Version | 2.0 |
| Category | Alphanumeric |
Contents
LCD (Grove - UART) component
Standard alphanumeric LCD based on the Grove display module.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_LCD_Grove_Uart.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_LCD_Grove_Uart.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
|
ClearSim |
 - VOID
|
Return |
|
|
Clear |
| - VOID
|
Return |
|
|
PrintString |
 - STRING
|
Text |
| - VOID
|
Return |
|
|
PrintAscii |
| Takes the ascii value for a character and prints the character | |
 - BYTE
|
character |
| - VOID
|
Return |
|
|
PrintNumber |
| Allows you to print a number. This is limited to a signed-INT, -32768 to 32767 | |
 - INT
|
Number |
| - VOID
|
Return |
|
|
BacklightControl |
| - BYTE
|
State |
| 0=Backlight Off, 1=Backlight On | |
| - VOID
|
Return |
|
|
ClearLine |
| - BYTE
|
Line |
| - VOID
|
Return |
|
|
Cursor |
| Moves the cursor on the LCD Display | |
| - BYTE
|
x |
| - BYTE
|
y |
| - 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 |
| Number of positions to scroll the display | |
| - BYTE
|
direction |
| Direction to scroll the display: 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 |
|
|
Start |
| Startup routine required by the hardware device. | |
| - VOID
|
Return |
Property reference
|
Properties |
|
LCD Configuration |
|
Rows |
|
|
Columns |
|
|
Connections |
|
|
Channel |
| UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller. | |
|
TX |
| Pin to be used for Transmit data | |
|
Use RX |
| Selects if the Receive pin is used by the component. Yes: The RX pin is active and used to receive data for the UART. No: The RX pin is disabled and free to be used as general I/O. | |
|
|
Baud Options |
| Baud rate option selector | |
|
Baud Rate |
|
|
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 |
|
|
Scope Traces |
| Selects if the scope traces are automatically added to the data recorder window or not. Simulation - draws an approximation of the UART data onto the scope trace. ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD. | |
|
|
Console Data |
| Selects if the console data is automatically generated or not | |
|
Console Columns |
| Number of characters that can be displayed on a single line of the console. | |
|
|
Data Source |
| Simulation data source used to allow the component to connect to various remote devices Nothing - Simulation data is ignored COM port - Routes the communication data to and from a physical or virtual COM port Injector - Routes the communication data via a data injector component on the Panel. | |
==Macro reference==
|
|
ClearSim |
| - VOID
|
Return |
|
|
Clear |
| - VOID
|
Return |
|
|
PrintString |
| - STRING
|
Text |
| - VOID
|
Return |
|
|
PrintAscii |
| Takes the ascii value for a character and prints the character | |
| - BYTE
|
character |
| - VOID
|
Return |
|
|
PrintNumber |
| Allows you to print a number. This is limited to a signed-INT, -32768 to 32767 | |
| - INT
|
Number |
| - VOID
|
Return |
|
|
BacklightControl |
| - BYTE
|
State |
| 0=Backlight Off, 1=Backlight On | |
| - VOID
|
Return |
|
|
ClearLine |
| - BYTE
|
Line |
| - VOID
|
Return |
|
|
Cursor |
| Moves the cursor on the LCD Display | |
| - BYTE
|
x |
| - BYTE
|
y |
| - 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 |
| Number of positions to scroll the display | |
| - BYTE
|
direction |
| Direction to scroll the display: 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 |
|
|
Start |
| Startup routine required by the hardware device. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
LCD Configuration |
|
|
Rows |
|
|
Columns |
|
|
Connections |
|
|
Channel |
| UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller. | |
|
|
TX |
| Pin to be used for Transmit data | |
|
|
Use RX |
| Selects if the Receive pin is used by the component. Yes: The RX pin is active and used to receive data for the UART. No: The RX pin is disabled and free to be used as general I/O. | |
|
|
Baud Options |
| Baud rate option selector | |
|
|
Baud Rate |
|
|
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 |
|
|
Scope Traces |
| Selects if the scope traces are automatically added to the data recorder window or not. Simulation - draws an approximation of the UART data onto the scope trace. ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD. | |
|
|
Console Data |
| Selects if the console data is automatically generated or not | |
|
|
Console Columns |
| Number of characters that can be displayed on a single line of the console. | |
|
|
Data Source |
| Simulation data source used to allow the component to connect to various remote devices Nothing - Simulation data is ignored COM port - Routes the communication data to and from a physical or virtual COM port Injector - Routes the communication data via a data injector component on the Panel. | |
==Macro reference==
|
|
ClearSim |
| - VOID
|
Return |
|
|
Clear |
| - VOID
|
Return |
|
|
PrintString |
| - STRING
|
Text |
| - VOID
|
Return |
|
|
PrintAscii |
| Takes the ascii value for a character and prints the character | |
| - BYTE
|
character |
| - VOID
|
Return |
|
|
PrintNumber |
| Allows you to print a number. This is limited to a signed-INT, -32768 to 32767 | |
| - INT
|
Number |
| - VOID
|
Return |
|
|
BacklightControl |
| - BYTE
|
State |
| 0=Backlight Off, 1=Backlight On | |
| - VOID
|
Return |
|
|
ClearLine |
| - BYTE
|
Line |
| - VOID
|
Return |
|
|
Cursor |
| Moves the cursor on the LCD Display | |
| - BYTE
|
x |
| - BYTE
|
y |
| - 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 |
| Number of positions to scroll the display | |
| - BYTE
|
direction |
| Direction to scroll the display: 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 |
|
|
Start |
| Startup routine required by the hardware device. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
LCD Configuration |
|
|
Rows |
|
|
Columns |
|
|
Connections |
|
|
Channel |
| UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller. | |
|
|
TX |
| Pin to be used for Transmit data | |
|
|
Use RX |
| Selects if the Receive pin is used by the component. Yes: The RX pin is active and used to receive data for the UART. No: The RX pin is disabled and free to be used as general I/O. | |
|
|
Baud Options |
| Baud rate option selector | |
|
|
Baud Rate |
|
|
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 |
|
|
Scope Traces |
| Selects if the scope traces are automatically added to the data recorder window or not. Simulation - draws an approximation of the UART data onto the scope trace. ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD. | |
|
|
Console Data |
| Selects if the console data is automatically generated or not | |
|
|
Console Columns |
| Number of characters that can be displayed on a single line of the console. | |
|
|
Data Source |
| Simulation data source used to allow the component to connect to various remote devices Nothing - Simulation data is ignored COM port - Routes the communication data to and from a physical or virtual COM port Injector - Routes the communication data via a data injector component on the Panel. | |
==Macro reference==
|
|
ClearSim |
| - VOID
|
Return |
|
|
Clear |
| - VOID
|
Return |
|
|
PrintString |
| - STRING
|
Text |
| - VOID
|
Return |
|
|
PrintAscii |
| Takes the ascii value for a character and prints the character | |
| - BYTE
|
character |
| - VOID
|
Return |
|
|
PrintNumber |
| Allows you to print a number. This is limited to a signed-INT, -32768 to 32767 | |
| - INT
|
Number |
| - VOID
|
Return |
|
|
BacklightControl |
| - BYTE
|
State |
| 0=Backlight Off, 1=Backlight On | |
| - VOID
|
Return |
|
|
ClearLine |
| - BYTE
|
Line |
| - VOID
|
Return |
|
|
Cursor |
| Moves the cursor on the LCD Display | |
| - BYTE
|
x |
| - BYTE
|
y |
| - 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 |
| Number of positions to scroll the display | |
| - BYTE
|
direction |
| Direction to scroll the display: 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 |
|
|
Start |
| Startup routine required by the hardware device. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
LCD Configuration |
|
|
Rows |
|
|
Columns |
|
|
Connections |
|
|
Channel |
| UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller. | |
|
|
TX |
| Pin to be used for Transmit data | |
|
|
Use RX |
| Selects if the Receive pin is used by the component. Yes: The RX pin is active and used to receive data for the UART. No: The RX pin is disabled and free to be used as general I/O. | |
|
|
Baud Options |
| Baud rate option selector | |
|
|
Baud Rate |
|
|
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 |
|
|
Scope Traces |
| Selects if the scope traces are automatically added to the data recorder window or not. Simulation - draws an approximation of the UART data onto the scope trace. ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD. | |
|
|
Console Data |
| Selects if the console data is automatically generated or not | |
|
|
Console Columns |
| Number of characters that can be displayed on a single line of the console. | |
|
|
Data Source |
| Simulation data source used to allow the component to connect to various remote devices Nothing - Simulation data is ignored COM port - Routes the communication data to and from a physical or virtual COM port Injector - Routes the communication data via a data injector component on the Panel. | |
