SamT: /* Image GLCD (BL0139) component */

2018-09-07T14:39:05Z

Image GLCD (BL0139) component

BenR: XML import - Pre 8.0 release

2018-05-22T14:50:53Z

XML import - Pre 8.0 release

New page

{| width="50%"
|-
| width="20%" style="color: gray;" | Author
| Matrix TSL
|-
| width="20%" style="color: gray;" | Version
| 1.0 (Release)
|-
| width="20%" style="color: gray;" | Category
| E-blocks 2
|}

==[[File:Component Icon 4d50e925_93e7_43ff_9c9f_8e958b9d714c.png|Image]] GLCD (BL0139) component==
Graphical display component designed to work with the ST7567 type monochrome displays.
Transfers data using a 4-wire SPI interface, cannot read back so pixel based routines won't work
Compatible with the EB2 BL0139 Downstream E-block.

==Examples==
''No additional examples''

==Downloadable macro reference==

===<tt>PrintNumber</tt>===
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''
::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''

===<tt>DrawLine</tt>===
Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2.

'''Parameters'''

:[[Variable Types|BYTE]] ''X1''

:[[Variable Types|BYTE]] ''Y1''

:[[Variable Types|BYTE]] ''X2''

:[[Variable Types|BYTE]] ''Y2''

'''Return value'''

:''This call does not return a value''

===<tt>Write_Data</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|BYTE]] ''data''

'''Return value'''

:''This call does not return a value''

===<tt>Goto_XY</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|BYTE]] ''X''

:[[Variable Types|BYTE]] ''Y''

'''Return value'''

:''This call does not return a value''

===<tt>Plot</tt>===
Sets a pixel with the current foreground colour at pixel location X, Y.

'''Parameters'''

:[[Variable Types|BYTE]] ''X1''

:[[Variable Types|BYTE]] ''Y1''

'''Return value'''

:''This call does not return a value''

===<tt>DrawEllipse</tt>===
Draws an ellipse object on the display with the center of the ellipse 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]] ''XRadius''
::Radius of the circle on the X axis specified in pixels

:[[Variable Types|UINT]] ''YRadius''
::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

'''Return value'''

:''This call does not return a value''

===<tt>SetDisplayOrientation</tt>===
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''

===<tt>BPlot</tt>===
Sets a pixel with the current background colour at pixel location X, Y.

'''Parameters'''

:[[Variable Types|BYTE]] ''X1''

:[[Variable Types|BYTE]] ''Y1''

'''Return value'''

:''This call does not return a value''

===<tt>Print</tt>===
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 coordinate 0-31

:[[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''

===<tt>ClearDisplay</tt>===
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''

===<tt>SetBackgroundColour</tt>===
Specifies the colour of the foreground

'''Parameters'''

:[[Variable Types|BYTE]] ''PixelColour''
::0=White, 1=Black

'''Return value'''

:''This call does not return a value''

===<tt>Write_Command</tt>===
''No additional information''

'''Parameters'''

:[[Variable Types|BYTE]] ''Command''

'''Return value'''

:''This call does not return a value''

===<tt>DrawCircle</tt>===
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''

===<tt>SetForegroundColour</tt>===
Specifies the colour of the foreground.

'''Parameters'''

:[[Variable Types|BYTE]] ''PixelColour''
::0=White, 1=Black

'''Return value'''

:''This call does not return a value''

===<tt>DrawRectangle</tt>===
Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2

'''Parameters'''

:[[Variable Types|BYTE]] ''X1''

:[[Variable Types|BYTE]] ''Y1''

:[[Variable Types|BYTE]] ''X2''

:[[Variable Types|BYTE]] ''Y2''

:[[Variable Types|BYTE]] ''Transparent''

:[[Variable Types|BYTE]] ''Solid''

'''Return value'''

:''This call does not return a value''

===<tt>Initialise</tt>===
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==
Pixel Height

This property is of type ''Signed integer'' and can be referenced with the variable name ''pixel_height''.

Heigt of gLCD canvas measured in pixels.

Pixel Width

This property is of type ''Signed integer'' and can be referenced with the variable name ''pixel_width''.

Width of gLCD canvas measured in pixels.

Monochrome

This property is of type ''True or false'' and can be referenced with the variable name ''monochrome''.

Specifies if the display is capable of colour or monochrome only.

Foreground Color

This property is of type ''Color picker'' and can be referenced with the variable name ''foreground_colour''.

Specifies the initial foreground color.

Background Color

This property is of type ''Color picker'' and can be referenced with the variable name ''background_colour''.

Specifies the initial background color.

Color Bit Depth

This property is of type ''Signed integer'' and can be referenced with the variable name ''colour_bit_depth''.

Number of bits of colour depth available on the display

Red Bit Depth

This property is of type ''Signed integer'' and can be referenced with the variable name ''red_bit_depth''.

Number of bits of Red colour depth on the display

Green Bit Depth

This property is of type ''Signed integer'' and can be referenced with the variable name ''green_bit_depth''.

Number of bits of Green colour depth on the display

Blue Bit Depth

This property is of type ''Signed integer'' and can be referenced with the variable name ''blue_bit_depth''.

Number of bits of Blue colour depth on the display

Data Pin

This property is of type ''Single digital pin'' and can be referenced with the variable name ''data_pin''.

''No additional information''

Clock Pin

This property is of type ''Single digital pin'' and can be referenced with the variable name ''clock_pin''.

''No additional information''

A0

This property is of type ''Single digital pin'' and can be referenced with the variable name ''a0_pin''.

Address pin to tell the display if we are sending commands or data

CS

This property is of type ''Single digital pin'' and can be referenced with the variable name ''chip_sel_pin''.

Chip select pin

Reset

This property is of type ''Single digital pin'' and can be referenced with the variable name ''reset_pin''.

''No additional information''

Display Method

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''DisplayMethod''.

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.

LCDVersion

This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''LCDVersion''.

''No additional information''

@@ Line 19: / Line 19: @@
 Transfers data using a 4-wire SPI interface, cannot read back so pixel based routines won't work
 Compatible with the EB2 BL0139 Downstream E-block.
 ==Examples==

Component: GLCD (BL0139) (E-blocks 2) - Revision history

SamT: /* Image GLCD (BL0139) component */

BenR: XML import - Pre 8.0 release