Difference between revisions of "Component: LCD (EB005) (E-blocks 1)"

From Flowcode Help
Jump to navigationJump to search
 
(10 intermediate revisions by one other user not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix TSL
 
| Matrix TSL
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.1 (Release)
+
| 1.1
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| E-blocks 1
 
| E-blocks 1
 
|}
 
|}
  
  
−
 
+
==LCD component==
−
==[[File:Component Icon d29dda88_17de_4008_991a_c881890d4c57.png|Image]] LCD (EB005) component==
 
 
LCD based on the unit used in the Matrix EB005 E-block
 
LCD based on the unit used in the Matrix EB005 E-block
  
−
==Examples==
+
==Component Source Code==
  
−
===Connections===
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_LCD_EB005.fcfx FC_Comp_Source_LCD_EB005.fcfx]
  
−
Example of a typical LCD pinout.
+
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_LCD_EB005.fcfx FC_Comp_Source_LCD_EB005.fcfx]
  
−
[[File:Typical LCD pinout.png]]
+
==Detailed description==
  
  
  
  
−
For the LCDs to work with the Flowcode LCD component they need to be connected up in 4-bit data mode.
 
  
−
The 4 data signals actually go to the upper data nibble on the LCD as shown below.
 
  
  
−
[[File:LCDConns.jpg]]
 
  
  
  
−
A simple example that shows how to use some common functions.
 
  
−
{{Fcfile|LCD Example.fcfx|LCD Example}}
+
''No detailed description exists yet for this component''
  
−
==Downloadable macro reference==
+
==Examples==
  
−
===<span style="font-weight: normal;"><u><tt>Clear</tt></u></span>===
 
−
Clears the entire contents of the display.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>PrintString</tt></u></span>===
 
−
Breaks down a string of text and sends it to the LCD via the private RawSend(byte, mask) macro
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|<- STRING]] ''Text''
 
−
::Enter the text or variable to print to the LCD
 
−
::''This parameter may be returned back to the caller''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
+
===Connections===
  
 +
Example of a typical LCD pinout.
  
−
===<span style="font-weight: normal;"><u><tt>PrintAscii</tt></u></span>===
+
[[File:Typical LCD pinout.png]]
−
Takes the ascii value for a character and prints the character
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''character''
 
−
::Holds an ascii value.
 
  
  
−
'''Return value'''
+
For the LCDs to work with the Flowcode LCD component they need to be connected up in 4-bit data mode.
  
−
:''This call does not return a value''
+
The 4 data signals actually go to the upper data nibble on the LCD as shown below.
  
  
−
===<span style="font-weight: normal;"><u><tt>PrintNumber</tt></u></span>===
+
[[File:LCDConns.jpg]]
−
Based on v5 macro, will allow you to print a number. This is limited to a signed-INT, -32768 to 32767
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|INT]] ''Number''
 
−
::Enter the number or variable to print to the LCD
 
  
 +
A simple example that shows how to use some common functions.
  
−
'''Return value'''
+
{{Fcfile|LCD_Example.fcfx|LCD Example}}
  
−
:''This call does not return a value''
+
==Macro reference==
  
 +
===Clear===
 +
{| 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 the entire contents of the display.&nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
−
===<span style="font-weight: normal;"><u><tt>RAMWrite</tt></u></span>===
 
−
Modifies the internal memory of the LCD to allow for up to 8 customised characters to be created and stored in the device memory
 
  
−
'''Parameters'''
+
===ClearLine===
 +
{| 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 a single line on the display and then moves the cursor to the start of the line to allow you to start populating the line with data.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Line
 +
|-
 +
| colspan="2" | The line to clear, zero being the first (top) line of the display&nbsp;
 +
|-
 +
| 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''
 +
|}
  
−
:[[Variable Types|BYTE]] ''Index''
 
−
::Values 0 to 7
 
  
−
:[[Variable Types|BYTE]] ''d0''
+
===Command===
 +
{| 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;" | '''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;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | instruction
 +
|-
 +
| colspan="2" | Send a defined command to the LCD Screen. See datasheet for supported commands.&nbsp;
 +
|-
 +
| 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''
 +
|}
  
−
:[[Variable Types|BYTE]] ''d1''
 
  
−
:[[Variable Types|BYTE]] ''d2''
+
===Cursor===
 +
{| 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;" | '''Cursor'''
 +
|-
 +
| colspan="2" | Moves the cursor on the LCD Display&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | x
 +
|-
 +
| colspan="2" | Set the cursor position in the X plane, 0 is the left most cell&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | y
 +
|-
 +
| colspan="2" | Set the cursor position in the Y plane, 0 is the top most cell&nbsp;
 +
|-
 +
| 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''
 +
|}
  
−
:[[Variable Types|BYTE]] ''d3''
 
  
−
:[[Variable Types|BYTE]] ''d4''
+
===PrintAscii===
 +
{| 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;" | '''PrintAscii'''
 +
|-
 +
| colspan="2" | Takes the ascii value for a character and prints the character&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | character
 +
|-
 +
| colspan="2" | Holds an ascii value.&nbsp;
 +
|-
 +
| 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''
 +
|}
  
−
:[[Variable Types|BYTE]] ''d5''
 
  
−
:[[Variable Types|BYTE]] ''d6''
+
===PrintFormattedNumber===
 +
{| 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;" | '''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;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Number
 +
|-
 +
| colspan="2" | Enter the number or variable to print to the LCD&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | Format
 +
|-
 +
| colspan="2" | 0=Signed, 1=Unsigned&nbsp;
 +
|-
 +
| 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''
 +
|}
  
−
:[[Variable Types|BYTE]] ''d7''
 
  
 +
===PrintNumber===
 +
{| 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;" | '''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;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
 +
| width="90%" | Number
 +
|-
 +
| colspan="2" | Enter the number or variable to print to the LCD&nbsp;
 +
|-
 +
| 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''
 +
|}
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
+
===PrintString===
 +
{| 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;" | '''PrintString'''
 +
|-
 +
| colspan="2" | Breaks down a string of text and sends it to the LCD via the private RawSend(byte, mask) macro&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Text
 +
|-
 +
| colspan="2" | Enter the text or variable to print to the LCD&nbsp;
 +
|-
 +
| 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''
 +
|}
  
  
−
===<span style="font-weight: normal;"><u><tt>ClearLine</tt></u></span>===
+
===RAMWrite===
−
Clears a single line on the display and then moves the cursor to the start of the line to allow you to start populating the line with data.
+
{| 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;" | '''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;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" | Values 0 to 7&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | d0
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | d1
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | d2
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | d3
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | d4
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | d5
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | d6
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | d7
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| 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''
 +
|}
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''Line''
+
===RawSend===
−
::The line to clear, zero being the first (top) line of the display
+
{| 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;" | '''RawSend'''
 +
|-
 +
| colspan="2" | Sends data to the LCD display&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | data
 +
|-
 +
| colspan="2" | The data byte to send to the LCD&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" | type
 +
|-
 +
| colspan="2" | A boolean to indicate command type: true to write data, false to write a command&nbsp;
 +
|-
 +
| 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''
 +
|}
  
  
−
'''Return value'''
+
===RemapCharacter===
 +
{| 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;" | '''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;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | RemapIdx
 +
|-
 +
| colspan="2" | Remap Index, Range: 0 to (Remap Characters - 1)&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | SearchCharacter
 +
|-
 +
| colspan="2" | Character to look for a replace&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | ReplacementCharacter
 +
|-
 +
| colspan="2" | New character value to use in place of the search character.&nbsp;
 +
|-
 +
| 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''
 +
|}
  
−
:''This call does not return a value''
 
  
 +
===ScrollDisplay===
 +
{| 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;" | '''ScrollDisplay'''
 +
|-
 +
| colspan="2" | Scrolls the display left or right by a number of given positions.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Position
 +
|-
 +
| colspan="2" | Holds the number of positions to shift the display&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Direction
 +
|-
 +
| colspan="2" | 0 = left, 1 = right&nbsp;
 +
|-
 +
| 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''
 +
|}
  
−
===<span style="font-weight: normal;"><u><tt>Cursor</tt></u></span>===
 
−
Moves the cursor on the LCD Display
 
  
−
'''Parameters'''
+
===Start===
−
 
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
:[[Variable Types|BYTE]] ''x''
+
|-
−
::Set the cursor position in the X plane, 0 is the left most cell
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Start'''
−
:[[Variable Types|BYTE]] ''y''
+
|-
−
::Set the cursor position in the Y plane, 0 is the top most cell
+
| colspan="2" | Startup routine required by the hardware device. Automatically clears the display after initialising.&nbsp;
−
 
+
|-
−
 
+
|-
−
'''Return value'''
+
| 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''
−
:''This call does not return a value''
+
|}
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>Command</tt></u></span>===
 
−
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.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:[[Variable Types|BYTE]] ''instruction''
 
−
::Send a defined command to the LCD Screen. See datasheet for supported commands.
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>PrintFormattedNumber</tt></u></span>===
 
−
Will allow you to print a number up to 32-bits with signed or unsigned formatting.
 
−
 
 
−
Signed = -2147483648 to 2147483647
 
−
 
 
−
Unsigned = 0 to 4294967295
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:[[Variable Types|ULONG]] ''Number''
 
−
::Enter the number or variable to print to the LCD
 
−
 
 
−
:[[Variable Types|BOOL]] ''Format''
 
−
::0=Signed, 1=Unsigned
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>ScrollDisplay</tt></u></span>===
 
−
Scrolls the display left or right by a number of given positions.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:[[Variable Types|BYTE]] ''Position''
 
−
::Holds the number of positions to shift the display
 
−
 
 
−
:[[Variable Types|BYTE]] ''Direction''
 
−
::0 = left, 1 = right
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>RawSend</tt></u></span>===
 
−
Sends data to the LCD display
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:[[Variable Types|BYTE]] ''data''
 
−
::The data byte to send to the LCD
 
−
 
 
−
:[[Variable Types|BOOL]] ''type''
 
−
::A boolean to indicate command type: true to write data, false to write a command
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>RemapCharacter</tt></u></span>===
 
−
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.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:[[Variable Types|BYTE]] ''RemapIdx''
 
−
::Remap Index, Range: 0 to (Remap Characters - 1)
 
−
 
 
−
:[[Variable Types|BYTE]] ''SearchCharacter''
 
−
::Character to look for a replace
 
−
 
 
−
:[[Variable Types|BYTE]] ''ReplacementCharacter''
 
−
::New character value to use in place of the search character.
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>Start</tt></u></span>===
 
−
Startup routine required by the hardware device.
 
−
 
 
−
Automatically clears the display after initialising.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:''This macro has no parameters''
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
 
 
−
==Simulation macro reference==
 
−
 
 
−
''This component does not contain any simulation macros''
 
  
  
 
==Property reference==
 
==Property reference==
−
<span style="font-weight: normal;"><u>Data 0 (11)</u></span>
 
  
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''Pin_Data_0''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
 
+
|-
−
 
+
|-
−
<span style="font-weight: normal;"><u>Data 1 (12)</u></span>
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''Pin_Data_1''.
+
|-
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
 
+
| width="90%" | Data 0 (11)
−
 
+
|-
−
 
+
| colspan="2" | &nbsp;
−
<span style="font-weight: normal;"><u>Data 2 (13)</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''Pin_Data_2''.
+
| width="90%" | Data 1 (12)
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
| colspan="2" | &nbsp;
−
 
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
 
+
| width="90%" | Data 2 (13)
−
<span style="font-weight: normal;"><u>Data 3 (14)</u></span>
+
|-
−
 
+
| colspan="2" | &nbsp;
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''Pin_Data_3''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
''<span style="color:red;">No additional information</span>''
+
| width="90%" | Data 3 (14)
−
 
+
|-
−
 
+
| colspan="2" | &nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Register Select (4)</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
 
+
| width="90%" | Register Select (4)
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''Pin_RS''.
+
|-
−
 
+
| colspan="2" | &nbsp;
−
''<span style="color:red;">No additional information</span>''
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
 
+
| width="90%" | Enable (6)
−
 
+
|-
−
<span style="font-weight: normal;"><u>Enable (6)</u></span>
+
| colspan="2" | &nbsp;
−
 
+
|-
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''Pin_E''.
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
−
''<span style="color:red;">No additional information</span>''
+
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Component Label
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| 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 &nbsp;
 +
|-
 +
| 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&nbsp;
 +
|-
 +
| 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&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Display Background
 +
|-
 +
| colspan="2" | Colour of the background of the display&nbsp;
 +
|}

Latest revision as of 09:43, 20 April 2023

Author Matrix TSL
Version 1.1
Category E-blocks 1


LCD component

LCD based on the unit used in the Matrix EB005 E-block

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

Connections

Example of a typical LCD pinout.

Typical LCD pinout.png



For the LCDs to work with the Flowcode LCD component they need to be connected up in 4-bit data mode.

The 4 data signals actually go to the upper data nibble on the LCD as shown below.


LCDConns.jpg


A simple example that shows how to use some common functions.

FC6 Icon.png LCD Example

Macro reference

Clear

Fc9-comp-macro.png Clear
Clears the entire contents of the display. 
Fc9-void-icon.png - VOID Return


ClearLine

Fc9-comp-macro.png ClearLine
Clears a single line on the display and then moves the cursor to the start of the line to allow you to start populating the line with data. 
Fc9-u8-icon.png - BYTE Line
The line to clear, zero being the first (top) line of the display 
Fc9-void-icon.png - VOID Return


Command

Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE instruction
Send a defined command to the LCD Screen. See datasheet for supported commands. 
Fc9-void-icon.png - VOID Return


Cursor

Fc9-comp-macro.png Cursor
Moves the cursor on the LCD Display 
Fc9-u8-icon.png - BYTE x
Set the cursor position in the X plane, 0 is the left most cell 
Fc9-u8-icon.png - BYTE y
Set the cursor position in the Y plane, 0 is the top most cell 
Fc9-void-icon.png - VOID Return


PrintAscii

Fc9-comp-macro.png PrintAscii
Takes the ascii value for a character and prints the character 
Fc9-u8-icon.png - BYTE character
Holds an ascii value. 
Fc9-void-icon.png - VOID Return


PrintFormattedNumber

Fc9-comp-macro.png 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 
Fc9-u32-icon.png - ULONG Number
Enter the number or variable to print to the LCD 
Fc9-bool-icon.png - BOOL Format
0=Signed, 1=Unsigned 
Fc9-void-icon.png - VOID Return


PrintNumber

Fc9-comp-macro.png PrintNumber
Based on v5 macro, will allow you to print a number. This is limited to a signed-INT, -32768 to 32767 
Fc9-s16-icon.png - INT Number
Enter the number or variable to print to the LCD 
Fc9-void-icon.png - VOID Return


PrintString

Fc9-comp-macro.png PrintString
Breaks down a string of text and sends it to the LCD via the private RawSend(byte, mask) macro 
Fc9-string-icon.png - STRING Text
Enter the text or variable to print to the LCD 
Fc9-void-icon.png - VOID Return


RAMWrite

Fc9-comp-macro.png 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 
Fc9-u8-icon.png - BYTE Index
Values 0 to 7 
Fc9-u8-icon.png - BYTE d0
 
Fc9-u8-icon.png - BYTE d1
 
Fc9-u8-icon.png - BYTE d2
 
Fc9-u8-icon.png - BYTE d3
 
Fc9-u8-icon.png - BYTE d4
 
Fc9-u8-icon.png - BYTE d5
 
Fc9-u8-icon.png - BYTE d6
 
Fc9-u8-icon.png - BYTE d7
 
Fc9-void-icon.png - VOID Return


RawSend

Fc9-comp-macro.png RawSend
Sends data to the LCD display 
Fc9-u8-icon.png - BYTE data
The data byte to send to the LCD 
Fc9-bool-icon.png - BOOL type
A boolean to indicate command type: true to write data, false to write a command 
Fc9-void-icon.png - VOID Return


RemapCharacter

Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - BYTE RemapIdx
Remap Index, Range: 0 to (Remap Characters - 1) 
Fc9-u8-icon.png - BYTE SearchCharacter
Character to look for a replace 
Fc9-u8-icon.png - BYTE ReplacementCharacter
New character value to use in place of the search character. 
Fc9-void-icon.png - VOID Return


ScrollDisplay

Fc9-comp-macro.png ScrollDisplay
Scrolls the display left or right by a number of given positions. 
Fc9-u8-icon.png - BYTE Position
Holds the number of positions to shift the display 
Fc9-u8-icon.png - BYTE Direction
0 = left, 1 = right 
Fc9-void-icon.png - VOID Return


Start

Fc9-comp-macro.png Start
Startup routine required by the hardware device. Automatically clears the display after initialising. 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Connections
Fc9-type-5-icon.png Data 0 (11)
 
Fc9-type-5-icon.png Data 1 (12)
 
Fc9-type-5-icon.png Data 2 (13)
 
Fc9-type-5-icon.png Data 3 (14)
 
Fc9-type-5-icon.png Register Select (4)
 
Fc9-type-5-icon.png Enable (6)
 
Fc9-conn-icon.png Simulation
Fc9-type-16-icon.png Component Label
 
Fc9-type-15-icon.png Component Label Scale
The label scale can be change if the amout of text is too wide for the display  
Fc9-type-1-icon.png Text Colour
Colour of the font characters drawn on the display 
Fc9-type-1-icon.png Text Background
Colour surrounding the font characters drawn on the display 
Fc9-type-1-icon.png Display Background
Colour of the background of the display 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_LCD_(EB005)_(E-blocks_1)&oldid=38927"