Difference between revisions of "Component: GLCD (ILI9341 SPI) (Graphical Color)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix Ltd
 
| Matrix Ltd
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 2.0 (Release)
+
| 2.0
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Graphical Color
 
| Graphical Color
 
|}
 
|}
  
  
 +
==GLCD (ILI9341 SPI) component==
 +
Graphical display component designed to work with the ILI9341 controller IC Based on the ILI9341 16-bit colour graphical controller IC. Uses the SPI CAL component to allow for faster serial display communications.
 +
 +
==Detailed description==
  
−
==[[File:Component Icon 7bd84555_ae51_40cc_8e1a_a7bcba661e52.png|Image]] GLCD (ILI9341 SPI) component==
+
''No detailed description exists yet for this component''
−
Graphical display component designed to work with the ILI9341 controller IC
 
−
Based on the ILI9341 16-bit colour graphical controller IC.
 
−
Uses the SPI CAL component to allow for faster serial display communications.
 
  
 
==Examples==
 
==Examples==
 +
 +
 
''<span style="color:red;">No additional examples</span>''
 
''<span style="color:red;">No additional examples</span>''
  
Line 26: Line 27:
 
==Downloadable macro reference==
 
==Downloadable macro reference==
  
−
===<span style="font-weight: normal;"><u><tt>BacklightOn</tt></u></span>===
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
Sets the backlight enable pin allowing the display backlight to switch on.
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadFontWidth'''
 +
|-
 +
| colspan="2" | Reads the number of pixel columns used in the selected font&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Font
 +
|-
 +
| colspan="2" | Font selection range: 0 to (NumFonts - 1)&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Character
 +
|-
 +
| colspan="2" | ASCII character to get the pixel width e.g. 'A' or 65&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
−
Switching the backlight on and off at high speed allow the light to be dimmed.
 
  
−
'''Parameters'''
+
{| 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;" | '''BacklightOn'''
 +
|-
 +
| colspan="2" | Sets the backlight enable pin allowing the display backlight to switch on. Switching the backlight on and off at high speed allow the light to be dimmed.&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 macro has no parameters''
 
  
 +
{| 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;" | '''SetFontScaler'''
 +
|-
 +
| colspan="2" | Allows the fonts to be scaled up by multiplying the number of pixels on the X and Y.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | ScaleX
 +
|-
 +
| colspan="2" | Sets the horizontal scale of the font, default 1&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | ScaleY
 +
|-
 +
| colspan="2" | Sets the vertical scale of the font, default 1&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''
+
{| 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" | This macro prints a decimal number to the Graphical LCD.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:]] -
 +
| width="90%" | Number
 +
|-
 +
| colspan="2" | Byte or Integer number to send to the display.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | X
 +
|-
 +
| colspan="2" | X pixel coordinate to set the output string position.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Y
 +
|-
 +
| colspan="2" | Y pixel coordinate to set the output string position.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Font
 +
|-
 +
| colspan="2" | Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Transparent
 +
|-
 +
| colspan="2" | Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn.&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>PrintNumber</tt></u></span>===
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
This macro prints a decimal number to the Graphical LCD.
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DrawLine'''
 +
|-
 +
| colspan="2" | Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | X1
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Y1
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | X2
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Y2
 +
|-
 +
| 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|INT]] ''Number''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
::Byte or Integer number to send to the display.
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DrawEllipse'''
 +
|-
 +
| colspan="2" | Draws an ellipse object on the display with the center of the ellipse at the location X,Y&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | X
 +
|-
 +
| colspan="2" | X Coordinate for the center of the circle&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Y
 +
|-
 +
| colspan="2" | Y coordinate for the center of the circle&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | XRadius
 +
|-
 +
| colspan="2" | Radius of the circle on the X axis specified in pixels&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | YRadius
 +
|-
 +
| colspan="2" | Radius of the circle on the Y axis specified in pixels&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Transparent
 +
|-
 +
| colspan="2" | 0=Fill inside circle using background colour / 1=Draw outer circle only&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Solid
 +
|-
 +
| colspan="2" | 0=Use Transparent Setting / 1=Fill with foreground colour&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|UINT]] ''X''
 
−
::X pixel coordinate to set the output string position.
 
  
−
:[[Variable Types|UINT]] ''Y''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
::Y pixel coordinate to set the output string position.
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Plot'''
 +
|-
 +
| colspan="2" | Sets a pixel with the current foreground colour at pixel location X, Y.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | X1
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Y1
 +
|-
 +
| 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''
 +
|}
  
−
:[[Variable Types|BYTE]] ''Font''
 
−
::Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes
 
  
−
:[[Variable Types|BYTE]] ''Transparent''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
::Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn.
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FastPlot'''
 +
|-
 +
| colspan="2" | Sets a pixel with the current foreground colour at current pixel location. Not compatible with orientations other than 0.&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'''
+
{| 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;" | '''SetDisplayOrientation'''
 +
|-
 +
| colspan="2" | Controls the way data is printed out on the display allowing multiple different viewing orientations. Default is 0.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Orientation
 +
|-
 +
| colspan="2" | 0=Default, 1=90°CW, 2=180°CW, 3=270°CW&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''
 
  
 +
{| 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;" | '''BacklightOff'''
 +
|-
 +
| colspan="2" | Clears the backlight enable pin allowing the display backlight to switch off. Switching the backlight on and off at high speed allow the light to be dimmed.&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>DrawLine</tt></u></span>===
 
−
Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2.
 
  
−
'''Parameters'''
+
{| 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;" | '''BPlot'''
 +
|-
 +
| colspan="2" | Sets a pixel with the current background colour at pixel location X, Y.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | X1
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Y1
 +
|-
 +
| 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''
 +
|}
  
−
:[[Variable Types|UINT]] ''X1''
 
  
−
:[[Variable Types|UINT]] ''Y1''
+
{| 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;" | '''Window'''
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | X1
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Y1
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | X2
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Y2
 +
|-
 +
| 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''
 +
|}
  
−
:[[Variable Types|UINT]] ''X2''
 
  
−
:[[Variable Types|UINT]] ''Y2''
+
{| 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;" | '''ReadFontStat'''
 +
|-
 +
| colspan="2" | Gets a stat from the selected embedded ASCII font data.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Font
 +
|-
 +
| colspan="2" | Font selection range: 0 to (NumFonts - 1)&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Index
 +
|-
 +
| colspan="2" | 0=SpaceWidth, 1=PixelHeight&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
'''Return value'''
+
{| 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;" | '''Print'''
 +
|-
 +
| colspan="2" | This macro prints a string of characters to the Graphical LCD.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Str
 +
|-
 +
| colspan="2" | String of characters to send to the display.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | X1
 +
|-
 +
| colspan="2" | X pixel coordinate to set the output string position.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Y1
 +
|-
 +
| colspan="2" | Y pixel coordinate to set the output string position.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Font
 +
|-
 +
| colspan="2" | Selects which Font to use Range: 0 to Font Count&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Transparent
 +
|-
 +
| colspan="2" | Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn.&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''
 
  
 +
{| 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;" | '''ClearDisplay'''
 +
|-
 +
| colspan="2" | This macro clears the display of any previous output by overwriting the entire display with the background colour.&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>Plot</tt></u></span>===
 
−
Sets a pixel with the current foreground colour at pixel location X, Y.
 
  
−
'''Parameters'''
+
{| 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;" | '''SetBackgroundColour'''
 +
|-
 +
| colspan="2" | Specifies the colour of the background by creating a mixture of red, green and blue. &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Red
 +
|-
 +
| colspan="2" | 0 - 255 where 0 = no red and 255 = maximum red&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Green
 +
|-
 +
| colspan="2" | 0 - 255 where 0 = no green and 255 = maximum green&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Blue
 +
|-
 +
| colspan="2" | 0 - 255 where 0 = no blue and 255 = maximum blue&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|UINT]] ''X1''
 
  
−
:[[Variable Types|UINT]] ''Y1''
+
{| 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;" | '''DrawCircle'''
 +
|-
 +
| colspan="2" | Draws a circle object on the display with the center of the circle at the location X,Y&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | X
 +
|-
 +
| colspan="2" | X Coordinate for the center of the circle&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Y
 +
|-
 +
| colspan="2" | Y coordinate for the center of the circle&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Radius
 +
|-
 +
| colspan="2" | Radius of the circle specified in pixels&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Transparent
 +
|-
 +
| colspan="2" | 0=Fill inside circle using background colour / 1=Draw outer circle only&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Solid
 +
|-
 +
| colspan="2" | 0=Use Transparent Setting / 1=Fill with foreground colour&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'''
+
{| 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;" | '''SetForegroundColour'''
 +
|-
 +
| colspan="2" | Specifies the colour of the foreground by creating a mixture of red, green and blue. &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Red
 +
|-
 +
| colspan="2" | 0 - 255 where 0 = no red and 255 = maximum red&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Green
 +
|-
 +
| colspan="2" | 0 - 255 where 0 = no green and 255 = maximum green&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Blue
 +
|-
 +
| colspan="2" | 0 - 255 where 0 = no blue and 255 = maximum blue&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''
 
  
 +
{| 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;" | '''DrawRectangle'''
 +
|-
 +
| colspan="2" | Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | X1
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Y1
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | X2
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Y2
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Transparent
 +
|-
 +
| colspan="2" | Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Solid
 +
|-
 +
| colspan="2" | Chooses to fill the box with colour - 0 = Box contains transparency data, 1 = Box contains foreground colour.&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>DrawEllipse</tt></u></span>===
 
−
Draws an ellipse object on the display with the center of the ellipse at the location X,Y
 
  
−
'''Parameters'''
+
{| 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;" | '''Initialise'''
 +
|-
 +
| colspan="2" | The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called.&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|UINT]] ''X''
 
−
::X Coordinate for the center of the circle
 
  
−
:[[Variable Types|UINT]] ''Y''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
::Y coordinate for the center of the circle
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 +
|-
 +
| colspan="2" | The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called.&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|UINT]] ''XRadius''
 
−
::Radius of the circle on the X axis specified in pixels
 
  
−
:[[Variable Types|UINT]] ''YRadius''
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
::Radius of the circle on the Y axis specified in pixels
+
|-
−
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
:[[Variable Types|BYTE]] ''Transparent''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
−
::0=Fill inside circle using background colour / 1=Draw outer circle only
+
|-
−
 
+
| colspan="2" | The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called.&nbsp;
−
:[[Variable Types|BYTE]] ''Solid''
+
|-
−
::0=Use Transparent Setting / 1=Fill with foreground colour
+
|-
−
 
+
| 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''
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>FastPlot</tt></u></span>===
 
−
Sets a pixel with the current foreground colour at current pixel location.
 
−
 
 
−
Not compatible with orientations other than 0.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:''This macro has no parameters''
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>SetDisplayOrientation</tt></u></span>===
 
−
Controls the way data is printed out on the display allowing multiple different viewing orientations. Default is 0.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:[[Variable Types|BYTE]] ''Orientation''
 
−
::0=Default, 1=90 Degrees CW, 2=180 Degrees CW, 3=270 Degrees CW
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>BacklightOff</tt></u></span>===
 
−
Clears the backlight enable pin allowing the display backlight to switch off.
 
−
 
 
−
Switching the backlight on and off at high speed allow the light to be dimmed.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:''This macro has no parameters''
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>BPlot</tt></u></span>===
 
−
Sets a pixel with the current background colour at pixel location X, Y.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:[[Variable Types|UINT]] ''X1''
 
−
 
 
−
:[[Variable Types|UINT]] ''Y1''
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>Window</tt></u></span>===
 
−
''<span style="color:red;">No additional information</span>''
 
−
 
 
−
 
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:[[Variable Types|UINT]] ''X1''
 
−
 
 
−
:[[Variable Types|UINT]] ''Y1''
 
−
 
 
−
:[[Variable Types|UINT]] ''X2''
 
−
 
 
−
:[[Variable Types|UINT]] ''Y2''
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>Print</tt></u></span>===
 
−
This macro prints a string of characters to the Graphical LCD.
 
−
 
 
−
'''Parameters'''
 
−
 
 
−
:[[Variable Types|<- STRING]] ''Str''
 
−
::String of characters to send to the display.
 
−
::''This parameter may be returned back to the caller''
 
−
 
 
−
:[[Variable Types|UINT]] ''X1''
 
−
::X pixel coordinate to set the output string position.
 
−
 
 
−
:[[Variable Types|UINT]] ''Y1''
 
−
::Y pixel coordinate to set the output string position.
 
−
 
 
−
:[[Variable Types|BYTE]] ''Font''
 
−
::Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes
 
−
 
 
−
:[[Variable Types|BYTE]] ''Transparent''
 
−
::Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn.
 
−
 
 
−
 
 
−
'''Return value'''
 
−
 
 
−
:''This call does not return a value''
 
−
 
 
−
 
 
−
===<span style="font-weight: normal;"><u><tt>ClearDisplay</tt></u></span>===
 
−
This macro clears the display of any previous output by overwriting the entire display with the background colour.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
−
 
−
 
−
'''Return value'''
 
−
 
−
:''This call does not return a value''
 
−
 
−
 
−
===<span style="font-weight: normal;"><u><tt>SetBackgroundColour</tt></u></span>===
 
−
Specifies the colour of the background by creating a mixture of red, green and blue.
 
−
 
−
'''Parameters'''
 
−
 
−
:[[Variable Types|BYTE]] ''Red''
 
−
::0 - 255 where 0 = no red and 255 = maximum red
 
−
 
−
:[[Variable Types|BYTE]] ''Green''
 
−
::0 - 255 where 0 = no green and 255 = maximum green
 
−
 
−
:[[Variable Types|BYTE]] ''Blue''
 
−
::0 - 255 where 0 = no blue and 255 = maximum blue
 
−
 
−
 
−
'''Return value'''
 
−
 
−
:''This call does not return a value''
 
−
 
−
 
−
===<span style="font-weight: normal;"><u><tt>DrawCircle</tt></u></span>===
 
−
Draws a circle object on the display with the center of the circle at the location X,Y
 
−
 
−
'''Parameters'''
 
−
 
−
:[[Variable Types|UINT]] ''X''
 
−
::X Coordinate for the center of the circle
 
−
 
−
:[[Variable Types|UINT]] ''Y''
 
−
::Y coordinate for the center of the circle
 
−
 
−
:[[Variable Types|UINT]] ''Radius''
 
−
::Radius of the circle specified in pixels
 
−
 
−
:[[Variable Types|BYTE]] ''Transparent''
 
−
::0=Fill inside circle using background colour / 1=Draw outer circle only
 
−
 
−
:[[Variable Types|BYTE]] ''Solid''
 
−
::0=Use Transparent Setting / 1=Fill with foreground colour
 
−
 
−
 
−
'''Return value'''
 
−
 
−
:''This call does not return a value''
 
−
 
−
 
−
===<span style="font-weight: normal;"><u><tt>SetForegroundColour</tt></u></span>===
 
−
Specifies the colour of the foreground by creating a mixture of red, green and blue.
 
−
 
−
'''Parameters'''
 
−
 
−
:[[Variable Types|BYTE]] ''Red''
 
−
::0 - 255 where 0 = no red and 255 = maximum red
 
−
 
−
:[[Variable Types|BYTE]] ''Green''
 
−
::0 - 255 where 0 = no green and 255 = maximum green
 
−
 
−
:[[Variable Types|BYTE]] ''Blue''
 
−
::0 - 255 where 0 = no blue and 255 = maximum blue
 
−
 
−
 
−
'''Return value'''
 
−
 
−
:''This call does not return a value''
 
−
 
−
 
−
===<span style="font-weight: normal;"><u><tt>DrawRectangle</tt></u></span>===
 
−
Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2
 
−
 
−
'''Parameters'''
 
−
 
−
:[[Variable Types|UINT]] ''X1''
 
−
 
−
:[[Variable Types|UINT]] ''Y1''
 
−
 
−
:[[Variable Types|UINT]] ''X2''
 
−
 
−
:[[Variable Types|UINT]] ''Y2''
 
−
 
−
:[[Variable Types|BYTE]] ''Transparent''
 
−
::Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data.
 
−
 
−
:[[Variable Types|BYTE]] ''Solid''
 
−
::Chooses to fill the box with colour - 0 = Box contains transparency data, 1 = Box contains foreground colour.
 
−
 
−
 
−
'''Return value'''
 
−
 
−
:''This call does not return a value''
 
−
 
−
 
−
===<span style="font-weight: normal;"><u><tt>Initialise</tt></u></span>===
 
−
The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called.
 
−
 
−
'''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>Pixel Height</u></span>
 
  
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''pixel_height''.
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
Heigt of gLCD canvas measured in pixels.
+
| 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>Pixel Width</u></span>
+
|-
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''pixel_width''.
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Pixel Width
−
Width of gLCD canvas measured in pixels.
+
|-
−
 
+
| colspan="2" | Width of gLCD canvas measured in pixels.&nbsp;
−
<span style="font-weight: normal;"><u>Monochrome</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
This property is of type ''True or false'' and can be referenced with the variable name ''monochrome''.
+
| width="90%" | Pixel Height
−
 
+
|-
−
Specifies if the display is capable of colour or monochrome only.
+
| colspan="2" | Heigt of gLCD canvas measured in pixels.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Foreground Color</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Flip X
−
This property is of type ''Color picker'' and can be referenced with the variable name ''foreground_colour''.
+
|-
−
 
+
| colspan="2" | Flips the horizontal display axis in hardware.&nbsp;
−
Specifies the initial foreground color.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
<span style="font-weight: normal;"><u>Background Color</u></span>
+
| width="90%" | Flip Y
−
 
+
|-
−
This property is of type ''Color picker'' and can be referenced with the variable name ''background_colour''.
+
| colspan="2" | Flips the vertical display axis in hardware.&nbsp;
−
 
+
|-
−
Specifies the initial background color.
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Monochrome
−
<span style="font-weight: normal;"><u>Colour Bit Depth</u></span>
+
|-
−
 
+
| colspan="2" | Specifies if the display is capable of colour or monochrome only.&nbsp;
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''colour_bit_depth''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
Total color bit depth for the display.
+
| width="90%" | Foreground Color
−
 
+
|-
−
<span style="font-weight: normal;"><u>Red Bit Depth</u></span>
+
| colspan="2" | Specifies the initial foreground color.&nbsp;
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''red_bit_depth''.
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
 
+
| width="90%" | Background Color
−
Specifies the red bit depth for the display.
+
|-
−
 
+
| colspan="2" | Specifies the initial background color.&nbsp;
−
<span style="font-weight: normal;"><u>Green Bit Depth</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''green_bit_depth''.
+
| width="90%" | Colour Bit Depth
−
 
+
|-
−
Specifies the green bit depth for the display.
+
| colspan="2" | Total color bit depth for the display.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Blue Bit Depth</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Red Bit Depth
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''blue_bit_depth''.
+
|-
−
 
+
| colspan="2" | Specifies the red bit depth for the display.&nbsp;
−
Specifies the blue bit depth for the display.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
<span style="font-weight: normal;"><u>Channel</u></span>
+
| width="90%" | Green Bit Depth
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_spi1::CHANNEL''.
+
| colspan="2" | Specifies the green bit depth for the display.&nbsp;
−
 
+
|-
−
SPI Channel selector
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Blue Bit Depth
−
<span style="font-weight: normal;"><u>Prescale</u></span>
+
|-
−
 
+
| colspan="2" | Specifies the blue bit depth for the display.&nbsp;
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_spi1::PR_SCALE''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
Prescale option selector
+
| width="90%" | Font Count
−
 
+
|-
−
<span style="font-weight: normal;"><u>MOSI</u></span>
+
| colspan="2" | Specifies the number of fonts available to use on the display.&nbsp;
−
 
+
|-
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi1::MOSI''.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Font
−
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.
+
|-
−
 
+
| colspan="2" | Font picker to decide which font to use on your display.&nbsp;
−
<span style="font-weight: normal;"><u>MISO</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi1::MISO''.
+
| width="90%" | Character Spacing
−
 
+
|-
−
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.
+
| colspan="2" | Sets the number of blank pixels between each character when printing text. Default 1.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>CLK</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Space Width
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi1::CLK''.
+
|-
−
 
+
| colspan="2" | Sets the number of horizontal pixels used to represent a space character.&nbsp;
−
SPI Clock Pin CLK - The Clock signal is driven by the SPI master.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
<span style="font-weight: normal;"><u>Toggle CS</u></span>
+
| width="90%" | Font
−
 
+
|-
−
This property is of type ''True or false'' and can be referenced with the variable name ''ToggleCS''.
+
| colspan="2" | Font picker to decide which font to use on your display.&nbsp;
−
 
+
|-
−
Allows the CS pin to be toggled by the component when communicating with the display.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Character Spacing
−
No - Allows for better performace, the display is always enabled
+
|-
−
 
+
| colspan="2" | Sets the number of blank pixels between each character when printing text. Default 1.&nbsp;
−
Yes - Allows for the display pins to be multiplexed with other functionality without the risk of display corruption
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
<span style="font-weight: normal;"><u>Chip Select</u></span>
+
| width="90%" | Space Width
−
 
+
|-
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''chip_sel_pin''.
+
| colspan="2" | Sets the number of horizontal pixels used to represent a space character.&nbsp;
−
 
+
|-
−
Chip select pin connection
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Font
−
<span style="font-weight: normal;"><u>D/C</u></span>
+
|-
−
 
+
| colspan="2" | Font picker to decide which font to use on your display.&nbsp;
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''dc_pin''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
Instruction / Command pin connection
+
| width="90%" | Character Spacing
−
 
+
|-
−
<span style="font-weight: normal;"><u>Reset</u></span>
+
| colspan="2" | Sets the number of blank pixels between each character when printing text. Default 1.&nbsp;
−
 
+
|-
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''reset_pin''.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Space Width
−
Reset pin connection
+
|-
−
 
+
| colspan="2" | Sets the number of horizontal pixels used to represent a space character.&nbsp;
−
<span style="font-weight: normal;"><u>LED</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''led_pin''.
+
| width="90%" | Font
−
 
+
|-
−
LED backlight strobe pin connection
+
| colspan="2" | Font picker to decide which font to use on your display.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Use Backlight Pin</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Character Spacing
−
This property is of type ''True or false'' and can be referenced with the variable name ''UseBacklight''.
+
|-
−
 
+
| colspan="2" | Sets the number of blank pixels between each character when printing text. Default 1.&nbsp;
−
''<span style="color:red;">No additional information</span>''
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Space Width
−
 
+
|-
−
<span style="font-weight: normal;"><u>Display Method</u></span>
+
| colspan="2" | Sets the number of horizontal pixels used to represent a space character.&nbsp;
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''DisplayMethod''.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Display Method
−
Chooses which method to use when drawing to the gLCD component
+
|-
−
 
+
| colspan="2" | Chooses which method to use when drawing to the gLCD component The bitmap is the more common mode but may run slowly on some machines. The point cloud should run faster but may use more memory. &nbsp;
−
The bitmap is the more common mode but may run slowly on some machines.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
The point cloud should run faster but may use more memory.
+
| width="90%" | Simulate Comms
−
 
+
|-
−
<span style="font-weight: normal;"><u>Scope Traces</u></span>
+
| colspan="2" | Allows the communications to be simulated to either see the waveforms on the data recorder or to drive an injector component.&nbsp;
−
 
+
|-
−
This property is of type ''True or false'' and can be referenced with the variable name ''cal_spi1::ScopeTraces''.
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Console Data
−
Selects if the scope traces are automatically generated or not
+
|-
−
 
+
| colspan="2" | Selects if the console data is automatically generated or not&nbsp;
−
<span style="font-weight: normal;"><u>Console Data</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
This property is of type ''True or false'' and can be referenced with the variable name ''cal_spi1::ConsoleData''.
+
| width="90%" | Scope Traces
−
 
+
|-
−
Selects if the console data is automatically generated or not
+
| colspan="2" | Selects if the scope traces are automatically generated or not&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Injector</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | API
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_spi1::Injector''.
+
|-
−
 
+
| colspan="2" | &nbsp;
−
''<span style="color:red;">No additional information</span>''
+
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''  
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | SPI Channel selector&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Prescale
 +
|-
 +
| colspan="2" | Prescale option selector&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | MOSI
 +
|-
 +
| colspan="2" | SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | MISO
 +
|-
 +
| colspan="2" | SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | CLK
 +
|-
 +
| colspan="2" | SPI Clock Pin CLK - The Clock signal is driven by the SPI master.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Toggle CS
 +
|-
 +
| colspan="2" | Allows the CS pin to be toggled by the component when communicating with the display. No - Allows for better performace, the display is always enabled Yes - Allows for the display pins to be multiplexed with other functionality without the risk of display corruption&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | Chip Select
 +
|-
 +
| colspan="2" | Chip select pin connection&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | D/C
 +
|-
 +
| colspan="2" | Instruction / Command pin connection&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | Reset
 +
|-
 +
| colspan="2" | Reset pin connection&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 +
| width="90%" | LED
 +
|-
 +
| colspan="2" | LED backlight strobe pin connection&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Use Backlight Pin
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''  
 +
|-
 +
|}

Revision as of 21:02, 16 November 2021

Author Matrix Ltd
Version 2.0
Category Graphical Color


GLCD (ILI9341 SPI) component

Graphical display component designed to work with the ILI9341 controller IC Based on the ILI9341 16-bit colour graphical controller IC. Uses the SPI CAL component to allow for faster serial display communications.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png ReadFontWidth
Reads the number of pixel columns used in the selected font 
Fc9-u8-icon.png - BYTE Font
Font selection range: 0 to (NumFonts - 1) 
Fc9-u8-icon.png - BYTE Character
ASCII character to get the pixel width e.g. 'A' or 65 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png BacklightOn
Sets the backlight enable pin allowing the display backlight to switch on. Switching the backlight on and off at high speed allow the light to be dimmed. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetFontScaler
Allows the fonts to be scaled up by multiplying the number of pixels on the X and Y. 
Fc9-u8-icon.png - BYTE ScaleX
Sets the horizontal scale of the font, default 1 
Fc9-u8-icon.png - BYTE ScaleY
Sets the vertical scale of the font, default 1 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png PrintNumber
This macro prints a decimal number to the Graphical LCD. 
[[File:]] - Number
Byte or Integer number to send to the display. 
Fc9-u16-icon.png - UINT X
X pixel coordinate to set the output string position. 
Fc9-u16-icon.png - UINT Y
Y pixel coordinate to set the output string position. 
Fc9-u8-icon.png - BYTE Font
Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes 
Fc9-u8-icon.png - BYTE Transparent
Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png DrawLine
Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2. 
Fc9-u16-icon.png - UINT X1
 
Fc9-u16-icon.png - UINT Y1
 
Fc9-u16-icon.png - UINT X2
 
Fc9-u16-icon.png - UINT Y2
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png DrawEllipse
Draws an ellipse object on the display with the center of the ellipse at the location X,Y 
Fc9-u16-icon.png - UINT X
X Coordinate for the center of the circle 
Fc9-u16-icon.png - UINT Y
Y coordinate for the center of the circle 
Fc9-u16-icon.png - UINT XRadius
Radius of the circle on the X axis specified in pixels 
Fc9-u16-icon.png - UINT YRadius
Radius of the circle on the Y axis specified in pixels 
Fc9-u8-icon.png - BYTE Transparent
0=Fill inside circle using background colour / 1=Draw outer circle only 
Fc9-u8-icon.png - BYTE Solid
0=Use Transparent Setting / 1=Fill with foreground colour 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Plot
Sets a pixel with the current foreground colour at pixel location X, Y. 
Fc9-u16-icon.png - UINT X1
 
Fc9-u16-icon.png - UINT Y1
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png FastPlot
Sets a pixel with the current foreground colour at current pixel location. Not compatible with orientations other than 0. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetDisplayOrientation
Controls the way data is printed out on the display allowing multiple different viewing orientations. Default is 0. 
Fc9-u8-icon.png - BYTE Orientation
0=Default, 1=90°CW, 2=180°CW, 3=270°CW 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png BacklightOff
Clears the backlight enable pin allowing the display backlight to switch off. Switching the backlight on and off at high speed allow the light to be dimmed. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png BPlot
Sets a pixel with the current background colour at pixel location X, Y. 
Fc9-u16-icon.png - UINT X1
 
Fc9-u16-icon.png - UINT Y1
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Window
 
Fc9-u16-icon.png - UINT X1
 
Fc9-u16-icon.png - UINT Y1
 
Fc9-u16-icon.png - UINT X2
 
Fc9-u16-icon.png - UINT Y2
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadFontStat
Gets a stat from the selected embedded ASCII font data. 
Fc9-u8-icon.png - BYTE Font
Font selection range: 0 to (NumFonts - 1) 
Fc9-u8-icon.png - BYTE Index
0=SpaceWidth, 1=PixelHeight 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png Print
This macro prints a string of characters to the Graphical LCD. 
Fc9-string-icon.png - STRING Str
String of characters to send to the display. 
Fc9-u16-icon.png - UINT X1
X pixel coordinate to set the output string position. 
Fc9-u16-icon.png - UINT Y1
Y pixel coordinate to set the output string position. 
Fc9-u8-icon.png - BYTE Font
Selects which Font to use Range: 0 to Font Count 
Fc9-u8-icon.png - BYTE Transparent
Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ClearDisplay
This macro clears the display of any previous output by overwriting the entire display with the background colour. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetBackgroundColour
Specifies the colour of the background by creating a mixture of red, green and blue.  
Fc9-u8-icon.png - BYTE Red
0 - 255 where 0 = no red and 255 = maximum red 
Fc9-u8-icon.png - BYTE Green
0 - 255 where 0 = no green and 255 = maximum green 
Fc9-u8-icon.png - BYTE Blue
0 - 255 where 0 = no blue and 255 = maximum blue 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png DrawCircle
Draws a circle object on the display with the center of the circle at the location X,Y 
Fc9-u16-icon.png - UINT X
X Coordinate for the center of the circle 
Fc9-u16-icon.png - UINT Y
Y coordinate for the center of the circle 
Fc9-u16-icon.png - UINT Radius
Radius of the circle specified in pixels 
Fc9-u8-icon.png - BYTE Transparent
0=Fill inside circle using background colour / 1=Draw outer circle only 
Fc9-u8-icon.png - BYTE Solid
0=Use Transparent Setting / 1=Fill with foreground colour 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetForegroundColour
Specifies the colour of the foreground by creating a mixture of red, green and blue.  
Fc9-u8-icon.png - BYTE Red
0 - 255 where 0 = no red and 255 = maximum red 
Fc9-u8-icon.png - BYTE Green
0 - 255 where 0 = no green and 255 = maximum green 
Fc9-u8-icon.png - BYTE Blue
0 - 255 where 0 = no blue and 255 = maximum blue 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png DrawRectangle
Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2 
Fc9-u16-icon.png - UINT X1
 
Fc9-u16-icon.png - UINT Y1
 
Fc9-u16-icon.png - UINT X2
 
Fc9-u16-icon.png - UINT Y2
 
Fc9-u8-icon.png - BYTE Transparent
Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data. 
Fc9-u8-icon.png - BYTE Solid
Chooses to fill the box with colour - 0 = Box contains transparency data, 1 = Box contains foreground colour. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Initialise
The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Initialise
The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Initialise
The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-14-icon.png Pixel Width
Width of gLCD canvas measured in pixels. 
Fc9-type-14-icon.png Pixel Height
Heigt of gLCD canvas measured in pixels. 
Fc9-type-7-icon.png Flip X
Flips the horizontal display axis in hardware. 
Fc9-type-7-icon.png Flip Y
Flips the vertical display axis in hardware. 
Fc9-type-7-icon.png Monochrome
Specifies if the display is capable of colour or monochrome only. 
Fc9-type-1-icon.png Foreground Color
Specifies the initial foreground color. 
Fc9-type-1-icon.png Background Color
Specifies the initial background color. 
Fc9-type-14-icon.png Colour Bit Depth
Total color bit depth for the display. 
Fc9-type-14-icon.png Red Bit Depth
Specifies the red bit depth for the display. 
Fc9-type-14-icon.png Green Bit Depth
Specifies the green bit depth for the display. 
Fc9-type-14-icon.png Blue Bit Depth
Specifies the blue bit depth for the display. 
Fc9-type-16-icon.png Font Count
Specifies the number of fonts available to use on the display. 
Fc9-type-16-icon.png Font
Font picker to decide which font to use on your display. 
Fc9-type-16-icon.png Character Spacing
Sets the number of blank pixels between each character when printing text. Default 1. 
Fc9-type-16-icon.png Space Width
Sets the number of horizontal pixels used to represent a space character. 
Fc9-type-16-icon.png Font
Font picker to decide which font to use on your display. 
Fc9-type-16-icon.png Character Spacing
Sets the number of blank pixels between each character when printing text. Default 1. 
Fc9-type-16-icon.png Space Width
Sets the number of horizontal pixels used to represent a space character. 
Fc9-type-16-icon.png Font
Font picker to decide which font to use on your display. 
Fc9-type-16-icon.png Character Spacing
Sets the number of blank pixels between each character when printing text. Default 1. 
Fc9-type-16-icon.png Space Width
Sets the number of horizontal pixels used to represent a space character. 
Fc9-type-16-icon.png Font
Font picker to decide which font to use on your display. 
Fc9-type-16-icon.png Character Spacing
Sets the number of blank pixels between each character when printing text. Default 1. 
Fc9-type-16-icon.png Space Width
Sets the number of horizontal pixels used to represent a space character. 
Fc9-type-16-icon.png Display Method
Chooses which method to use when drawing to the gLCD component The bitmap is the more common mode but may run slowly on some machines. The point cloud should run faster but may use more memory.  
Fc9-type-7-icon.png Simulate Comms
Allows the communications to be simulated to either see the waveforms on the data recorder or to drive an injector component. 
Fc9-type-7-icon.png Console Data
Selects if the console data is automatically generated or not 
Fc9-type-7-icon.png Scope Traces
Selects if the scope traces are automatically generated or not 
Fc9-type-16-icon.png API
 
Fc9-conn-icon.png Connections
Fc9-type-16-icon.png Channel
SPI Channel selector 
Fc9-type-16-icon.png Prescale
Prescale option selector 
Fc9-type-5-icon.png MOSI
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. 
Fc9-type-5-icon.png MISO
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. 
Fc9-type-5-icon.png CLK
SPI Clock Pin CLK - The Clock signal is driven by the SPI master. 
Fc9-type-7-icon.png Toggle CS
Allows the CS pin to be toggled by the component when communicating with the display. No - Allows for better performace, the display is always enabled Yes - Allows for the display pins to be multiplexed with other functionality without the risk of display corruption 
Fc9-type-5-icon.png Chip Select
Chip select pin connection 
Fc9-type-5-icon.png D/C
Instruction / Command pin connection 
Fc9-type-5-icon.png Reset
Reset pin connection 
Fc9-type-5-icon.png LED
LED backlight strobe pin connection 
Fc9-type-7-icon.png Use Backlight Pin
 
Fc9-conn-icon.png Simulations
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_GLCD_(ILI9341_SPI)_(Graphical_Color)&oldid=25743"