Difference between revisions of "Component: GLCD (EBM001) (EBM Modules)"

From Flowcode Help
Jump to navigationJump to search
(XML import - Pre 8.0 release)
 
(18 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
+
{| style="width:50%"
 
 
{| width="50%"
 
 
|-
 
|-
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix Ltd
 
| Matrix Ltd
 
|-
 
|-
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
| 1.6 (Release)
+
| 1.6
 
|-
 
|-
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| EBM Modules
 
| EBM Modules
 
|}
 
|}
  
  
 +
==GLCD (EBM001) component==
 +
Graphical display component designed to work with the EBM001 modules and EB084 E-blocks. Based on the ILI9163C 16-bit colour graphical controller IC.
  
==[[File:Component Icon 5a6d2f2e_da92_49b4_ad5c_71f51e8fe24b.png|Image]] GLCD (EBM001) component==
+
==Version information==
Graphical display component designed to work with the EBM001 modules and EB084 E-blocks.
 
Based on the ILI9163C 16-bit colour graphical controller IC.
 
  
==Examples==
+
Library Version, Component Version, Date, Author, Info
===EBM001 Basic Example===
+
11, 1.0, 22-07-24, BR, Added DrawArc and DrawRoundedRectangle functions
  
EBM001 gLCD Example File
+
==Detailed description==
{{Fcfile|EBM001_Test.fcfx|EBM001 Example}}
 
Example should show the following on the display on the panel and on the hardware.
 
  
[[File:EBM001.jpg]]
 
  
  
===EBM001 Maze Builder===
 
{{Fcfile|Maze_Builder_gLCD.fcfx|Maze Builder gLCD}}
 
Example to draw a randomly generated 2D maze on an EBM001 graphical display.
 
  
[[File:MazeBuildGLCD.jpg]]
 
  
  
  
===EBM001 Drawing 3D Objects With Perspective===
 
{{Fcfile|3D_Manipulations.fcfx|3D Manipulations}}
 
Example should show the following on the display on the panel and on the hardware. The two switches allow you to move closer to or away from the object. The perspective provides more and more distortion to the object the closer you get.
 
  
[[File:3DClose.jpg]]
 
  
[[File:3DFar.jpg]]
 
  
==Downloadable macro reference==
 
  
===<span style="font-weight: normal;"><u><tt>BacklightOn</tt></u></span>===
 
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.
 
  
'''Parameters'''
 
  
:''This macro has no parameters''
 
  
  
'''Return value'''
 
  
:''This call does not return a value''
 
  
  
===<span style="font-weight: normal;"><u><tt>PrintNumber</tt></u></span>===
 
This macro prints a decimal number to the Graphical LCD.
 
  
'''Parameters'''
 
  
:[[Variable Types|INT]] ''Number''
 
::Byte or Integer number to send to the display.
 
  
:[[Variable Types|UINT]] ''X''
 
::X pixel coordinate to set the output string position.
 
  
:[[Variable Types|UINT]] ''Y''
+
''No detailed description exists yet for this component''
::Y pixel coordinate to set the output string position.
 
  
:[[Variable Types|BYTE]] ''Font''
+
==Examples==
::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>DrawLine</tt></u></span>===
 
Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2.
 
  
'''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>Plot</tt></u></span>===
 
Sets a pixel with the current foreground 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>DrawEllipse</tt></u></span>===
+
===EBM001 Basic Example===
Draws an ellipse object on the display with the center of the ellipse at the location X,Y
 
  
'''Parameters'''
+
EBM001 gLCD Example File
 +
{{Fcfile|EBM001_Test.fcfx|EBM001 Example}}
 +
Example should show the following on the display on the panel and on the hardware.
  
:[[Variable Types|UINT]] ''X''
+
[[File:EBM001.jpg]]
::X Coordinate for the center of the circle
 
  
:[[Variable Types|UINT]] ''Y''
 
::Y coordinate for the center of the circle
 
  
:[[Variable Types|UINT]] ''XRadius''
+
===EBM001 Maze Builder===
::Radius of the circle on the X axis specified in pixels
+
{{Fcfile|Maze_Builder_gLCD.fcfx|Maze Builder gLCD}}
 +
Example to draw a randomly generated 2D maze on an EBM001 graphical display.
  
:[[Variable Types|UINT]] ''YRadius''
+
[[File:MazeBuildGLCD.jpg]]
::Radius of the circle on the Y axis 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
 
  
 +
===EBM001 Drawing 3D Objects With Perspective===
 +
{{Fcfile|3D_Manipulations.fcfx|3D Manipulations}}
 +
Example should show the following on the display on the panel and on the hardware. The two switches allow you to move closer to or away from the object. The perspective provides more and more distortion to the object the closer you get.
  
'''Return value'''
+
[[File:3DClose.jpg]]
  
:''This call does not return a value''
+
[[File:3DFar.jpg]]
  
  
===<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°CW, 2=180°CW, 3=270°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''
+
==Macro reference==
  
 +
===BPlot===
 +
{| 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''
 +
|}
  
===<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'''
+
===BacklightOff===
 +
{| 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''
 +
|}
  
:[[Variable Types|UINT]] ''X1''
 
  
:[[Variable Types|UINT]] ''Y1''
+
===BacklightOn===
 +
{| 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''
 +
|}
  
  
'''Return value'''
+
===ClearDisplay===
 +
{| 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''
 +
|}
  
:''This call does not return a value''
 
  
 +
===DrawArc===
 +
{| 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;" | '''DrawArc'''
 +
|-
 +
| colspan="2" | Draws an arc either as an outline or as a filled object.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | X
 +
|-
 +
| colspan="2" | Center X coordinate&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Y
 +
|-
 +
| colspan="2" | Center Y coordinate&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Radius
 +
|-
 +
| colspan="2" | Radius, distance of edge from the centre coordinates&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | StartAngle
 +
|-
 +
| colspan="2" | Angle to start drawing, in degrees&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
 +
| width="90%" | EndAngle
 +
|-
 +
| colspan="2" | Angle to end drawing, in degrees&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | Resolution
 +
|-
 +
| colspan="2" | Number of lines to draw from the center to the outer edge, 0=Fill&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Transparent
 +
|-
 +
| colspan="2" | Chooses the transparency - 0 = Arc contains background colour, 1 = Arc contains previous pixel data.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Solid
 +
|-
 +
| colspan="2" | Chooses to fill with colour - 0 = Arc transparency data, 1 = Arc 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>Print</tt></u></span>===
 
This macro prints a string of characters to the Graphical LCD.
 
  
'''Parameters'''
+
===DrawCircle===
 +
{| 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''
 +
|}
  
:[[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''
+
===DrawEllipse===
::X pixel coordinate to set the output string position.
+
{| 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;" | '''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]] ''Y1''
 
::Y pixel coordinate to set the output string position.
 
  
:[[Variable Types|BYTE]] ''Font''
+
===DrawLine===
::Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes
+
{| 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;" | '''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''
 +
|}
  
:[[Variable Types|BYTE]] ''Transparent''
 
::Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn.
 
  
 +
===DrawRectangle===
 +
{| 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''
 +
|}
  
'''Return value'''
 
  
:''This call does not return a value''
+
===DrawRoundedRectangle===
 +
{| 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;" | '''DrawRoundedRectangle'''
 +
|-
 +
| colspan="2" | Draws a rectangle with rounded corners&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-u16-icon.png]] - UINT
 +
| width="90%" | Radius
 +
|-
 +
| 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>ClearDisplay</tt></u></span>===
+
===FastPlot===
This macro clears the display of any previous output by overwriting the entire display with the background colour.
+
{| 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;" | '''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''
 +
|}
  
'''Parameters'''
 
  
:''This macro has no parameters''
+
===Initialise===
 +
{| 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''
 +
|}
  
  
'''Return value'''
+
===Plot===
 +
{| 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;" | '''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''
 +
|}
  
:''This call does not return a value''
 
  
 +
===Print===
 +
{| 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''
 +
|}
  
===<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'''
+
===PrintNumber===
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PrintNumber'''
 +
|-
 +
| colspan="2" | This macro prints a decimal number to the Graphical LCD.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
 +
| 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''
 +
|}
  
:[[Variable Types|BYTE]] ''Red''
 
::0 - 255 where 0 = no red and 255 = maximum red
 
  
:[[Variable Types|BYTE]] ''Green''
+
===ReadFontStat===
::0 - 255 where 0 = no green and 255 = maximum green
+
{| 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''
 +
|}
  
:[[Variable Types|BYTE]] ''Blue''
 
::0 - 255 where 0 = no blue and 255 = maximum blue
 
  
 +
===ReadFontWidth===
 +
{| 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;" | '''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''
 +
|}
  
'''Return value'''
 
  
:''This call does not return a value''
+
===SetBackgroundColour===
 +
{| 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''
 +
|}
  
  
===<span style="font-weight: normal;"><u><tt>DrawCircle</tt></u></span>===
+
===SetDisplayOrientation===
Draws a circle object on the display with the center of the circle at the location X,Y
+
{| 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''
 +
|}
  
'''Parameters'''
 
  
:[[Variable Types|UINT]] ''X''
+
===SetFontScaler===
::X Coordinate for the center of the circle
+
{| 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''
 +
|}
  
:[[Variable Types|UINT]] ''Y''
 
::Y coordinate for the center of the circle
 
  
:[[Variable Types|UINT]] ''Radius''
+
===SetForegroundColour===
::Radius of the circle specified in pixels
+
{| 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''
 +
|}
  
:[[Variable Types|BYTE]] ''Transparent''
 
::0=Fill inside circle using background colour / 1=Draw outer circle only
 
  
:[[Variable Types|BYTE]] ''Solid''
+
===Window===
::0=Use Transparent Setting / 1=Fill with foreground colour
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
+
|-
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
'''Return value'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Window'''
 
+
|-
:''This call does not return a value''
+
| colspan="2" | Specifies a full screen or sub window of pixels to draw. Useful when used with the FastPlot function to draw bitmaps at high speed.&nbsp;
 
+
|-
 
+
|-
===<span style="font-weight: normal;"><u><tt>SetForegroundColour</tt></u></span>===
+
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
Specifies the colour of the foreground by creating a mixture of red, green and blue.
+
| width="90%" | X1
 
+
|-
'''Parameters'''
+
| colspan="2" | &nbsp;
 
+
|-
:[[Variable Types|BYTE]] ''Red''
+
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
::0 - 255 where 0 = no red and 255 = maximum red
+
| width="90%" | Y1
 
+
|-
:[[Variable Types|BYTE]] ''Green''
+
| colspan="2" | &nbsp;
::0 - 255 where 0 = no green and 255 = maximum green
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
:[[Variable Types|BYTE]] ''Blue''
+
| width="90%" | X2
::0 - 255 where 0 = no blue and 255 = maximum blue
+
|-
 
+
| colspan="2" | &nbsp;
 
+
|-
'''Return value'''
+
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 
+
| width="90%" | Y2
:''This call does not return a value''
+
|-
 
+
| colspan="2" | &nbsp;
 
+
|-
===<span style="font-weight: normal;"><u><tt>DrawRectangle</tt></u></span>===
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2
+
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
+
|}
'''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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Dimensions
Width of gLCD canvas measured in pixels.
+
|-
 
+
|-
<span style="font-weight: normal;"><u>Monochrome</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 
+
| width="90%" | Pixel Width
This property is of type ''True or false'' and can be referenced with the variable name ''monochrome''.
+
|-
 
+
| colspan="2" | Width of gLCD canvas measured in pixels.&nbsp;
Specifies if the display is capable of colour or monochrome only.
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
<span style="font-weight: normal;"><u>Foreground Color</u></span>
+
| width="90%" | Pixel Height
 
+
|-
This property is of type ''Color picker'' and can be referenced with the variable name ''foreground_colour''.
+
| colspan="2" | Heigt of gLCD canvas measured in pixels.&nbsp;
 
+
|-
Specifies the initial foreground color.
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Colour
<span style="font-weight: normal;"><u>Background Color</u></span>
+
|-
 
+
|-
This property is of type ''Color picker'' and can be referenced with the variable name ''background_colour''.
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 
+
| width="90%" | Monochrome
Specifies the initial background color.
+
|-
 
+
| colspan="2" | Specifies if the display is capable of colour or monochrome only.&nbsp;
<span style="font-weight: normal;"><u>Colour Bit Depth</u></span>
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
This property is of type ''Signed integer'' and can be referenced with the variable name ''colour_bit_depth''.
+
| width="90%" | Foreground Color
 
+
|-
Total color bit depth for the display.
+
| colspan="2" | Specifies the initial foreground color.&nbsp;
 
+
|-
<span style="font-weight: normal;"><u>Red Bit Depth</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 
+
| width="90%" | Background Color
This property is of type ''Signed integer'' and can be referenced with the variable name ''red_bit_depth''.
+
|-
 
+
| colspan="2" | Specifies the initial background color.&nbsp;
Specifies the red bit depth for the display.
+
|-
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
<span style="font-weight: normal;"><u>Green Bit Depth</u></span>
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Bit Depth
 
+
|-
This property is of type ''Signed integer'' and can be referenced with the variable name ''green_bit_depth''.
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
Specifies the green bit depth for the display.
+
| width="90%" | Colour Bit Depth
 
+
|-
<span style="font-weight: normal;"><u>Blue Bit Depth</u></span>
+
| colspan="2" | Total color bit depth for the display.&nbsp;
 
+
|-
This property is of type ''Signed integer'' and can be referenced with the variable name ''blue_bit_depth''.
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 
+
| width="90%" | Red Bit Depth
Specifies the blue bit depth for the display.
+
|-
 
+
| colspan="2" | Specifies the red bit depth for the display.&nbsp;
<span style="font-weight: normal;"><u>Data</u></span>
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
This property is of type ''Single digital pin'' and can be referenced with the variable name ''data_pin''.
+
| width="90%" | Green Bit Depth
 
+
|-
Data pin connection
+
| colspan="2" | Specifies the green bit depth for the display.&nbsp;
 
+
|-
<span style="font-weight: normal;"><u>Clock</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 
+
| width="90%" | Blue Bit Depth
This property is of type ''Single digital pin'' and can be referenced with the variable name ''clock_pin''.
+
|-
 
+
| colspan="2" | Specifies the blue bit depth for the display.&nbsp;
Clock pin connection
+
|-
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
<span style="font-weight: normal;"><u>Chip Select</u></span>
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
 
+
|-
This property is of type ''Single digital pin'' and can be referenced with the variable name ''chip_sel_pin''.
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
Chip select pin connection
+
| width="90%" | Data
 
+
|-
<span style="font-weight: normal;"><u>A0</u></span>
+
| colspan="2" | Data pin connection&nbsp;
 
+
|-
This property is of type ''Single digital pin'' and can be referenced with the variable name ''a0_pin''.
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
+
| width="90%" | Clock
Instruction / Command pin connection
+
|-
 
+
| colspan="2" | Clock pin connection&nbsp;
<span style="font-weight: normal;"><u>Reset</u></span>
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
This property is of type ''Single digital pin'' and can be referenced with the variable name ''reset_pin''.
+
| width="90%" | Chip Select
 
+
|-
Reset pin connection
+
| colspan="2" | Chip select pin connection&nbsp;
 
+
|-
<span style="font-weight: normal;"><u>LED</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
+
| width="90%" | A0
This property is of type ''Single digital pin'' and can be referenced with the variable name ''led_pin''.
+
|-
 
+
| colspan="2" | Instruction / Command pin connection&nbsp;
LED backlight strobe pin connection
+
|-
 
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
<span style="font-weight: normal;"><u>Display Method</u></span>
+
| width="90%" | Reset
 
+
|-
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''DisplayMethod''.
+
| 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" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Fonts
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Font Count
 +
|-
 +
| colspan="2" | Specifies the number of fonts available to use on the display.&nbsp;
 +
|-
 +
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 +
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Font 0
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Font
 +
|-
 +
| colspan="2" | Font picker to decide which font to use on your display.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Character Spacing
 +
|-
 +
| colspan="2" | Sets the number of blank pixels between each character when printing text. Default 1.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Space Width
 +
|-
 +
| colspan="2" | Sets the number of horizontal pixels used to represent a space character.&nbsp;
 +
|-
 +
| 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" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Component Label Scale
 +
|-
 +
| colspan="2" | The label scale can be change if the amout of text is too wide for the display &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Physical Orientation
 +
|-
 +
| colspan="2" | Rotates the simulated canvas to match the orientation of real world hardware.&nbsp;
 +
|}
  
Chooses which method to use when drawing to the gLCD component
+
==Component Source Code==
  
The bitmap is the more common mode but may run slowly on some machines.
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_GLCD_EBM001.fcfx FC_Comp_Source_GLCD_EBM001.fcfx]
  
The point cloud should run faster but may use more memory.
+
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_GLCD_EBM001.fcfx FC_Comp_Source_GLCD_EBM001.fcfx]

Latest revision as of 09:49, 23 July 2024

Author Matrix Ltd
Version 1.6
Category EBM Modules


GLCD (EBM001) component

Graphical display component designed to work with the EBM001 modules and EB084 E-blocks. Based on the ILI9163C 16-bit colour graphical controller IC.

Version information

Library Version, Component Version, Date, Author, Info
11, 1.0, 22-07-24, BR, Added DrawArc and DrawRoundedRectangle functions

Detailed description

No detailed description exists yet for this component

Examples

EBM001 Basic Example

EBM001 gLCD Example File FC6 Icon.png EBM001 Example Example should show the following on the display on the panel and on the hardware.

EBM001.jpg


EBM001 Maze Builder

FC6 Icon.png Maze Builder gLCD Example to draw a randomly generated 2D maze on an EBM001 graphical display.

MazeBuildGLCD.jpg


EBM001 Drawing 3D Objects With Perspective

FC6 Icon.png 3D Manipulations Example should show the following on the display on the panel and on the hardware. The two switches allow you to move closer to or away from the object. The perspective provides more and more distortion to the object the closer you get.

3DClose.jpg

3DFar.jpg








Macro reference

BPlot

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


BacklightOff

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


BacklightOn

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


ClearDisplay

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


DrawArc

Fc9-comp-macro.png DrawArc
Draws an arc either as an outline or as a filled object. 
Fc9-u16-icon.png - UINT X
Center X coordinate 
Fc9-u16-icon.png - UINT Y
Center Y coordinate 
Fc9-u16-icon.png - UINT Radius
Radius, distance of edge from the centre coordinates 
Fc9-f32-icon.png - FLOAT StartAngle
Angle to start drawing, in degrees 
Fc9-f32-icon.png - FLOAT EndAngle
Angle to end drawing, in degrees 
Fc9-u16-icon.png - UINT Resolution
Number of lines to draw from the center to the outer edge, 0=Fill 
Fc9-u8-icon.png - BYTE Transparent
Chooses the transparency - 0 = Arc contains background colour, 1 = Arc contains previous pixel data. 
Fc9-u8-icon.png - BYTE Solid
Chooses to fill with colour - 0 = Arc transparency data, 1 = Arc contains foreground colour. 
Fc9-void-icon.png - VOID Return


DrawCircle

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


DrawEllipse

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


DrawLine

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


DrawRectangle

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


DrawRoundedRectangle

Fc9-comp-macro.png DrawRoundedRectangle
Draws a rectangle with rounded corners 
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-u16-icon.png - UINT Radius
 
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


FastPlot

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


Initialise

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


Plot

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


Print

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


PrintNumber

Fc9-comp-macro.png PrintNumber
This macro prints a decimal number to the Graphical LCD. 
Fc9-s16-icon.png - INT 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


ReadFontStat

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


ReadFontWidth

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


SetBackgroundColour

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


SetDisplayOrientation

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


SetFontScaler

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


SetForegroundColour

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


Window

Fc9-comp-macro.png Window
Specifies a full screen or sub window of pixels to draw. Useful when used with the FastPlot function to draw bitmaps at high speed. 
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


Property reference

Fc9-prop-icon.png Properties
Fc9-conn-icon.png Dimensions
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-conn-icon.png Colour
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-conn-icon.png Bit Depth
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-conn-icon.png Connections
Fc9-type-5-icon.png Data
Data pin connection 
Fc9-type-5-icon.png Clock
Clock pin connection 
Fc9-type-5-icon.png Chip Select
Chip select pin connection 
Fc9-type-5-icon.png A0
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-conn-icon.png Fonts
Fc9-type-16-icon.png Font Count
Specifies the number of fonts available to use on the display. 
Fc9-conn-icon.png Font 0
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-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-16-icon.png Physical Orientation
Rotates the simulated canvas to match the orientation of real world hardware. 

Component Source Code

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

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