Difference between revisions of "Component: LCD control (Alphanumeric)"
From Flowcode Help
Jump to navigationJump to search| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
| − | Please click here to download the component source project: [https://www.flowcode.co.uk/ | + | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_LCD_Alphanumeric_Sim.fcfx FC_Comp_Source_LCD_Alphanumeric_Sim.fcfx] |
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_LCD_Alphanumeric_Sim.fcfx FC_Comp_Source_LCD_Alphanumeric_Sim.fcfx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_LCD_Alphanumeric_Sim.fcfx FC_Comp_Source_LCD_Alphanumeric_Sim.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 36: | Line 38: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 52: | Line 56: | ||
==Macro reference== | ==Macro reference== | ||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Clear''' | ||
| + | |- | ||
| + | | colspan="2" | Clears all text from the display | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AddChar''' | ||
| + | |- | ||
| + | | colspan="2" | Prints a single ASCII character to the display | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT | ||
| + | | width="90%" | X | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT | ||
| + | | width="90%" | Y | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Char | ||
| + | |- | ||
| + | | colspan="2" | Holds an ASCII value e.g. 'A' | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetScrollX''' | ||
| + | |- | ||
| + | | colspan="2" | Gets the scroll position in X set by SetScrollX() | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ClearLine''' | ||
| + | |- | ||
| + | | colspan="2" | Clears one row of text from the display | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Line | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetScrollX''' | ||
| + | |- | ||
| + | | colspan="2" | Sets the scroll offset in X of the LCD | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| + | | width="90%" | Pos | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AddText''' | ||
| + | |- | ||
| + | | colspan="2" | Prints a string of ASCII characters to the display | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT | ||
| + | | width="90%" | X | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT | ||
| + | | width="90%" | Y | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
| + | | width="90%" | Text | ||
| + | |- | ||
| + | | colspan="2" | Enter the text or variable to print to the display | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
| + | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
| + | |} | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | ==Property reference== | ||
| + | |||
| + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
| + | |- | ||
| + | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | ||
| + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Columns | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Rows | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | ||
| + | | width="90%" | Horizontal buffer | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
| + | | width="90%" | Show Background Elements | ||
| + | |- | ||
| + | | colspan="2" | Show or hide features like the title and background. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| + | | width="90%" | Component Label | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-15-icon.png]] | ||
| + | | width="90%" | Component Label Scale | ||
| + | |- | ||
| + | | colspan="2" | The label scale can be change if the amout of text is too wide for the display | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | ||
| + | | width="90%" | Text Colour | ||
| + | |- | ||
| + | | colspan="2" | Colour of the font characters drawn on the display | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | ||
| + | | width="90%" | Text Background | ||
| + | |- | ||
| + | | colspan="2" | Colour surrounding the font characters drawn on the display | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-1-icon.png]] | ||
| + | | width="90%" | Display Background | ||
| + | |- | ||
| + | | colspan="2" | Colour of the background of the display | ||
| + | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 09:57, 27 January 2023
| Author | Matrix Ltd |
| Version | 1.0 |
| Category | Alphanumeric |
Contents
LCD control component
An LCD control pane supporting up to 40 x 4 units Suitable for simulation only
Component Source Code
Please click here to download the component source project: FC_Comp_Source_LCD_Alphanumeric_Sim.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_LCD_Alphanumeric_Sim.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
|
Clear |
| Clears all text from the display | |
 - VOID
|
Return |
|
|
AddChar |
| Prints a single ASCII character to the display | |
 - INT
|
X |
| - INT
|
Y |
 - BYTE
|
Char |
| Holds an ASCII value e.g. 'A' | |
| - VOID
|
Return |
|
|
GetScrollX |
| Gets the scroll position in X set by SetScrollX() | |
 - UINT
|
Return |
|
|
ClearLine |
| Clears one row of text from the display | |
| - BYTE
|
Line |
| - VOID
|
Return |
|
|
SetScrollX |
| Sets the scroll offset in X of the LCD | |
| - BYTE
|
Pos |
| - VOID
|
Return |
|
|
AddText |
| Prints a string of ASCII characters to the display | |
| - INT
|
X |
| - INT
|
Y |
 - STRING
|
Text |
| Enter the text or variable to print to the display | |
| - VOID
|
Return |
Property reference
|
Properties |
|
Columns |
|
|
Rows |
|
Horizontal buffer |
|
Show Background Elements |
| Show or hide features like the title and background. | |
|
|
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 all text from the display | |
| - VOID
|
Return |
|
|
AddChar |
| Prints a single ASCII character to the display | |
| - INT
|
X |
| - INT
|
Y |
| - BYTE
|
Char |
| Holds an ASCII value e.g. 'A' | |
| - VOID
|
Return |
|
|
GetScrollX |
| Gets the scroll position in X set by SetScrollX() | |
| - UINT
|
Return |
|
|
ClearLine |
| Clears one row of text from the display | |
| - BYTE
|
Line |
| - VOID
|
Return |
|
|
SetScrollX |
| Sets the scroll offset in X of the LCD | |
| - BYTE
|
Pos |
| - VOID
|
Return |
|
|
AddText |
| Prints a string of ASCII characters to the display | |
| - INT
|
X |
| - INT
|
Y |
| - STRING
|
Text |
| Enter the text or variable to print to the display | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Columns |
|
|
Rows |
|
|
Horizontal buffer |
|
|
Show Background Elements |
| Show or hide features like the title and background. | |
|
|
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 all text from the display | |
| - VOID
|
Return |
|
|
AddChar |
| Prints a single ASCII character to the display | |
| - INT
|
X |
| - INT
|
Y |
| - BYTE
|
Char |
| Holds an ASCII value e.g. 'A' | |
| - VOID
|
Return |
|
|
GetScrollX |
| Gets the scroll position in X set by SetScrollX() | |
| - UINT
|
Return |
|
|
ClearLine |
| Clears one row of text from the display | |
| - BYTE
|
Line |
| - VOID
|
Return |
|
|
SetScrollX |
| Sets the scroll offset in X of the LCD | |
| - BYTE
|
Pos |
| - VOID
|
Return |
|
|
AddText |
| Prints a string of ASCII characters to the display | |
| - INT
|
X |
| - INT
|
Y |
| - STRING
|
Text |
| Enter the text or variable to print to the display | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Columns |
|
|
Rows |
|
|
Horizontal buffer |
|
|
Show Background Elements |
| Show or hide features like the title and background. | |
|
|
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 all text from the display | |
| - VOID
|
Return |
|
|
AddChar |
| Prints a single ASCII character to the display | |
| - INT
|
X |
| - INT
|
Y |
| - BYTE
|
Char |
| Holds an ASCII value e.g. 'A' | |
| - VOID
|
Return |
|
|
GetScrollX |
| Gets the scroll position in X set by SetScrollX() | |
| - UINT
|
Return |
|
|
ClearLine |
| Clears one row of text from the display | |
| - BYTE
|
Line |
| - VOID
|
Return |
|
|
SetScrollX |
| Sets the scroll offset in X of the LCD | |
| - BYTE
|
Pos |
| - VOID
|
Return |
|
|
AddText |
| Prints a string of ASCII characters to the display | |
| - INT
|
X |
| - INT
|
Y |
| - STRING
|
Text |
| Enter the text or variable to print to the display | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Columns |
|
|
Rows |
|
|
Horizontal buffer |
|
|
Show Background Elements |
| Show or hide features like the title and background. | |
|
|
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 | |
