Difference between revisions of "Component: LCD (Adafruit, 16x2) (Alphanumeric)"

From Flowcode Help
Jump to navigationJump to search
 
(5 intermediate revisions by the same user not shown)
Line 22: Line 22:
  
 
==Detailed description==
 
==Detailed description==
 +
 +
  
  
Line 38: Line 40:
  
 
==Examples==
 
==Examples==
 +
 +
  
  
Line 67: Line 71:
 
{{Fcfile|Adafruit LCD Example.fcfx|Adafruit LCD Example}}
 
{{Fcfile|Adafruit LCD Example.fcfx|Adafruit LCD Example}}
  
−
==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 the entire contents of 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;" | '''PrintString'''
 
−
|-
 
−
| colspan="2" | Breaks down a string of text and sends it to the LCD via the private RawSend(byte, mask) macro 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 
−
| width="90%" | Text
 
−
|-
 
−
| 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;" | '''PrintAscii'''
 
−
|-
 
−
| colspan="2" | Takes the ascii value for a character and prints the character 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | character
 
−
|-
 
−
| colspan="2" | Holds an ascii 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''
 
−
|}
 
  
  
−
{| 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 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
 
−
| width="90%" | Number
 
−
|-
 
−
| 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''
 
−
|}
 
  
  
 +
 +
 +
 +
==Macro reference==
 +
 +
===Clear===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RAMWrite'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Clear'''
 
|-
 
|-
−
| 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 
+
| colspan="2" | Clears the entire contents of the display. 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Index
 
−
|-
 
−
| colspan="2" | Values 0 to 7 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | d0
 
 
|-
 
|-
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | d1
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | d2
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | d3
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | d4
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | d5
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | d6
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | d7
 
−
|-
 
−
| colspan="2" |  
 
 
|-
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 194: Line 99:
  
  
 +
===ClearLine===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 212: Line 118:
  
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+
===Command===
−
|-
 
−
| 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 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | x
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | y
 
−
|-
 
−
| 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;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 253: Line 137:
  
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+
===Cursor===
−
|-
 
−
| 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 
 
−
|-
 
−
|-
 
−
| 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 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 
−
| width="90%" | Format
 
−
|-
 
−
| colspan="2" | 0=Signed, 1=Unsigned 
 
−
|-
 
−
| 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;" | '''ScrollDisplay'''
 
−
|-
 
−
| colspan="2" | Scrolls the display left or right by a number of given positions. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Position
 
−
|-
 
−
| colspan="2" | Holds the number of positions to shift the display 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | direction
 
−
|-
 
−
| colspan="2" | 0 = left, 1 = right 
 
−
|-
 
−
| 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;" | '''PrintFloat'''
 
−
|-
 
−
| colspan="2" | Print a Float number rounded up to a specified amount of decimal places. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 
−
| width="90%" | Number
 
−
|-
 
−
| colspan="2" | Enter the number or variable to print to the LCD 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | DecimalPlaces
 
−
|-
 
−
| colspan="2" | Enter how many decimal places to round up to (1 - 6) 
 
−
|-
 
−
| 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;" | '''Start'''
 
−
|-
 
−
| colspan="2" | Startup routine required by the hardware device. Automatically clears the display when complete. 
 
−
|-
 
−
|-
 
−
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
−
| width="90%" | Data 0 (11)
 
−
|-
 
−
| colspan="2" | Data pin 0 connects to data pin 4 on the hardware 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
−
| width="90%" | Data 1 (12)
 
−
|-
 
−
| colspan="2" | Data pin 1 connects to data pin 5 on the hardware 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
−
| width="90%" | Data 2 (13)
 
−
|-
 
−
| colspan="2" | Data pin 2 connects to data pin 6 on the hardware 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
−
| width="90%" | Data 3 (14)
 
−
|-
 
−
| colspan="2" | Data pin 3 connects to data pin 7 on the hardware 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
−
| width="90%" | Register Select (4)
 
−
|-
 
−
| colspan="2" | Register select pin, determines if the incoming value is a command or a data byte 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
−
| width="90%" | Read / Write (5)
 
−
|-
 
−
| colspan="2" | Read / Write pin determines the data direction 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
−
| width="90%" | Enable (6)
 
−
|-
 
−
| colspan="2" | Enable pin, used to clock data in and out of the device. 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Display Settings
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | Rows
 
−
|-
 
−
| colspan="2" | Number of lines of characters the LCD can display. 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | Columns
 
−
|-
 
−
| colspan="2" | Number of characters the LCD can display on a single line. 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
 
−
|-
 
−
|-
 
−
| 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;"
 
−
|-
 
−
| 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. 
 
−
|-
 
−
|-
 
−
| 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;" | '''PrintString'''
 
−
|-
 
−
| colspan="2" | Breaks down a string of text and sends it to the LCD via the private RawSend(byte, mask) macro 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 
−
| width="90%" | Text
 
−
|-
 
−
| 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;" | '''PrintAscii'''
 
−
|-
 
−
| colspan="2" | Takes the ascii value for a character and prints the character 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | character
 
−
|-
 
−
| colspan="2" | Holds an ascii 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''
 
−
|}
 
−
 
 
−
 
 
−
{| 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 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
 
−
| width="90%" | Number
 
−
|-
 
−
| 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;" | '''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 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Index
 
−
|-
 
−
| colspan="2" | Values 0 to 7 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | d0
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | d1
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | d2
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | d3
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | d4
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | d5
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | d6
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | d7
 
−
|-
 
−
| 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;" | '''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. 
 
−
|-
 
−
|-
 
−
| 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;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 594: Line 161:
  
  
 +
===PrintAscii===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Command'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PrintAscii'''
 
|-
 
|-
−
| 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. 
+
| colspan="2" | Takes the ascii value for a character and prints the character 
 
|-
 
|-
 
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
−
| width="90%" | instruction
+
| width="90%" | character
 
|-
 
|-
−
| colspan="2" | Send a defined command to the LCD Screen. See datasheet for supported commands. 
+
| colspan="2" | Holds an ascii 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''
 
−
|}
 
−
 
 
−
 
 
−
{| 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 
 
−
|-
 
−
|-
 
−
| 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 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 
−
| width="90%" | Format
 
−
|-
 
−
| colspan="2" | 0=Signed, 1=Unsigned 
 
−
|-
 
−
| 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;" | '''ScrollDisplay'''
 
−
|-
 
−
| colspan="2" | Scrolls the display left or right by a number of given positions. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Position
 
−
|-
 
−
| colspan="2" | Holds the number of positions to shift the display 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | direction
 
−
|-
 
−
| colspan="2" | 0 = left, 1 = right 
 
 
|-
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 658: Line 180:
  
  
 +
===PrintFloat===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 681: Line 204:
  
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+
===PrintFormattedNumber===
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Start'''
 
−
|-
 
−
| colspan="2" | Startup routine required by the hardware device. Automatically clears the display when complete. 
 
−
|-
 
−
|-
 
−
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
−
| width="90%" | Data 0 (11)
 
−
|-
 
−
| colspan="2" | Data pin 0 connects to data pin 4 on the hardware 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
−
| width="90%" | Data 1 (12)
 
−
|-
 
−
| colspan="2" | Data pin 1 connects to data pin 5 on the hardware 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
−
| width="90%" | Data 2 (13)
 
−
|-
 
−
| colspan="2" | Data pin 2 connects to data pin 6 on the hardware 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
−
| width="90%" | Data 3 (14)
 
−
|-
 
−
| colspan="2" | Data pin 3 connects to data pin 7 on the hardware 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
−
| width="90%" | Register Select (4)
 
−
|-
 
−
| colspan="2" | Register select pin, determines if the incoming value is a command or a data byte 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
−
| width="90%" | Read / Write (5)
 
−
|-
 
−
| colspan="2" | Read / Write pin determines the data direction 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
−
| width="90%" | Enable (6)
 
−
|-
 
−
| colspan="2" | Enable pin, used to clock data in and out of the device. 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Display Settings
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | Rows
 
−
|-
 
−
| colspan="2" | Number of lines of characters the LCD can display. 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | Columns
 
−
|-
 
−
| colspan="2" | Number of characters the LCD can display on a single line. 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
 
−
|-
 
−
|-
 
−
| 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;"
 
−
|-
 
−
| 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. 
 
−
|-
 
−
|-
 
−
| 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;" | '''PrintString'''
 
−
|-
 
−
| colspan="2" | Breaks down a string of text and sends it to the LCD via the private RawSend(byte, mask) macro 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 
−
| width="90%" | Text
 
−
|-
 
−
| 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;" | '''PrintAscii'''
 
−
|-
 
−
| colspan="2" | Takes the ascii value for a character and prints the character 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | character
 
−
|-
 
−
| colspan="2" | Holds an ascii 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''
 
−
|}
 
−
 
 
−
 
 
−
{| 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 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
 
−
| width="90%" | Number
 
−
|-
 
−
| 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;" | '''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 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | Index
 
−
|-
 
−
| colspan="2" | Values 0 to 7 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | d0
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | d1
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | d2
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | d3
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | d4
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | d5
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | d6
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | d7
 
−
|-
 
−
| 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;" | '''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. 
 
−
|-
 
−
|-
 
−
| 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;" | '''Cursor'''
 
−
|-
 
−
| colspan="2" | Moves the cursor on the LCD Display 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | x
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | y
 
−
|-
 
−
| 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;" | '''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. 
 
−
|-
 
−
|-
 
−
| 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. 
 
−
|-
 
−
| 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;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 994: Line 228:
  
  
 +
===PrintNumber===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ScrollDisplay'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PrintNumber'''
 
|-
 
|-
−
| colspan="2" | Scrolls the display left or right by a number of given positions. 
+
| colspan="2" | Based on v5 macro, will allow you to print a number. This is limited to a signed-INT, -32768 to 32767 
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
−
| width="90%" | Position
 
−
|-
 
−
| colspan="2" | Holds the number of positions to shift the display 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | direction
 
−
|-
 
−
| colspan="2" | 0 = left, 1 = right 
 
−
|-
 
−
| 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;" | '''PrintFloat'''
 
−
|-
 
−
| colspan="2" | Print a Float number rounded up to a specified amount of decimal places. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 
 
| width="90%" | Number
 
| width="90%" | Number
−
|-
 
−
| colspan="2" | Enter the number or variable to print to the LCD 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | DecimalPlaces
 
−
|-
 
−
| colspan="2" | Enter how many decimal places to round up to (1 - 6) 
 
−
|-
 
−
| 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;" | '''Start'''
 
−
|-
 
−
| colspan="2" | Startup routine required by the hardware device. Automatically clears the display when complete. 
 
−
|-
 
−
|-
 
−
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
−
| width="90%" | Data 0 (11)
 
−
|-
 
−
| colspan="2" | Data pin 0 connects to data pin 4 on the hardware 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
−
| width="90%" | Data 1 (12)
 
−
|-
 
−
| colspan="2" | Data pin 1 connects to data pin 5 on the hardware 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
−
| width="90%" | Data 2 (13)
 
−
|-
 
−
| colspan="2" | Data pin 2 connects to data pin 6 on the hardware 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
−
| width="90%" | Data 3 (14)
 
−
|-
 
−
| colspan="2" | Data pin 3 connects to data pin 7 on the hardware 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
−
| width="90%" | Register Select (4)
 
−
|-
 
−
| colspan="2" | Register select pin, determines if the incoming value is a command or a data byte 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
−
| width="90%" | Read / Write (5)
 
−
|-
 
−
| colspan="2" | Read / Write pin determines the data direction 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
−
| width="90%" | Enable (6)
 
−
|-
 
−
| colspan="2" | Enable pin, used to clock data in and out of the device. 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Display Settings
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | Rows
 
−
|-
 
−
| colspan="2" | Number of lines of characters the LCD can display. 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | Columns
 
−
|-
 
−
| colspan="2" | Number of characters the LCD can display on a single line. 
 
−
|-
 
−
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
−
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
−
| width="90%" | Component Label
 
 
|-
 
|-
 
| colspan="2" |  
 
| 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;"
 
−
|-
 
−
| 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. 
 
−
|-
 
 
|-
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 1,159: Line 247:
  
  
 +
===PrintString===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 1,177: Line 266:
  
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+
===RAMWrite===
−
|-
 
−
| 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 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | character
 
−
|-
 
−
| colspan="2" | Holds an ascii 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''
 
−
|}
 
−
 
 
−
 
 
−
{| 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 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
 
−
| width="90%" | Number
 
−
|-
 
−
| 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;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 1,271: Line 325:
  
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+
===ScrollDisplay===
−
|-
 
−
| 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 before moving the cursor back to the start of the line to allow new data to be displayed. 
 
−
|-
 
−
|-
 
−
| 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;" | '''Cursor'''
 
−
|-
 
−
| colspan="2" | Moves the cursor on the LCD Display 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | x
 
−
|-
 
−
| colspan="2" |  
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | y
 
−
|-
 
−
| 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;" | '''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. 
 
−
|-
 
−
|-
 
−
| 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. 
 
−
|-
 
−
| 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;" | '''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 
 
−
|-
 
−
|-
 
−
| 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 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
 
−
| width="90%" | Format
 
−
|-
 
−
| colspan="2" | 0=Signed, 1=Unsigned 
 
−
|-
 
−
| 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;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 1,376: Line 349:
  
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+
===Start===
−
|-
 
−
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PrintFloat'''
 
−
|-
 
−
| colspan="2" | Print a Float number rounded up to a specified amount of decimal places. 
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 
−
| width="90%" | Number
 
−
|-
 
−
| colspan="2" | Enter the number or variable to print to the LCD 
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 
−
| width="90%" | DecimalPlaces
 
−
|-
 
−
| colspan="2" | Enter how many decimal places to round up to (1 - 6) 
 
−
|-
 
−
| 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;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 1,410: Line 361:
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
−
 
−
 
  
  

Latest revision as of 10:26, 20 October 2023

Author Matrix Ltd
Version 1.8
Category Alphanumeric


LCD (Adafruit, 16x2) component

Adafruit OLED LCD display capable of displaying 2 lines of 16 characters.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

Connections

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 Adafruit 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 before moving the cursor back to the start of the line to allow new data to be displayed. 
Fc9-u8-icon.png - BYTE Line
 
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
 
Fc9-u8-icon.png - BYTE y
 
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


PrintFloat

Fc9-comp-macro.png PrintFloat
Print a Float number rounded up to a specified amount of decimal places. 
Fc9-f32-icon.png - FLOAT Number
Enter the number or variable to print to the LCD 
Fc9-u8-icon.png - BYTE DecimalPlaces
Enter how many decimal places to round up to (1 - 6) 
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
 
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
 
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


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 when complete. 
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)
Data pin 0 connects to data pin 4 on the hardware 
Fc9-type-5-icon.png Data 1 (12)
Data pin 1 connects to data pin 5 on the hardware 
Fc9-type-5-icon.png Data 2 (13)
Data pin 2 connects to data pin 6 on the hardware 
Fc9-type-5-icon.png Data 3 (14)
Data pin 3 connects to data pin 7 on the hardware 
Fc9-type-5-icon.png Register Select (4)
Register select pin, determines if the incoming value is a command or a data byte 
Fc9-type-5-icon.png Read / Write (5)
Read / Write pin determines the data direction 
Fc9-type-5-icon.png Enable (6)
Enable pin, used to clock data in and out of the device. 
Fc9-conn-icon.png Display Settings
Fc9-type-16-icon.png Rows
Number of lines of characters the LCD can display. 
Fc9-type-16-icon.png Columns
Number of characters the LCD can display on a single line. 
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_(Adafruit,_16x2)_(Alphanumeric)&oldid=39616"