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

Author	Matrix TSL
Version	1.0 (Release)
Category	E-blocks 2

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.

On the mono GLCD you can se the foreground and background colours as either black or white, using the component macros corresponding to the setting of foreground or background. There are also macros which you can put into the program to print a string or a number on the GLCDs screen. You can also draw various shapes on the mono GLCD, such as a circle, an ellipse, a line or a rectangle using component macros.

Make sure the connections in flowcode are all in the correct port and pins, the port letter should be the same as the one which your mono GLCD is connected to on your E-blocks 2 upstream board.

Examples

No additional examples

Downloadable macro reference

PrintNumber

This macro prints a decimal number to the Graphical LCD.

Parameters

INT Number

Byte or Integer number to send to the display.

UINT X

X pixel coordinate to set the output string position.

UINT Y

Y pixel coordinate to set the output string position.

BYTE Font

Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes

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

DrawLine

Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2.

Parameters

BYTE X1

BYTE Y1

BYTE X2

BYTE Y2

Return value

This call does not return a value

Write_Data

No additional information

Parameters

BYTE data

Return value

This call does not return a value

Goto_XY

No additional information

Parameters

BYTE X

BYTE Y

Return value

This call does not return a value

Plot

Sets a pixel with the current foreground colour at pixel location X, Y.

Parameters

BYTE X1

BYTE Y1

Return value

This call does not return a value

DrawEllipse

Draws an ellipse object on the display with the center of the ellipse at the location X,Y

Parameters

UINT X

X Coordinate for the center of the circle

UINT Y

Y coordinate for the center of the circle

UINT XRadius

Radius of the circle on the X axis specified in pixels

UINT YRadius

Radius of the circle on the Y axis specified in pixels

BYTE Transparent

0=Fill inside circle using background colour / 1=Draw outer circle only

BYTE Solid

0=Use Transparent Setting / 1=Fill with foreground colour

Return value

This call does not return a value

SetDisplayOrientation

Controls the way data is printed out on the display allowing multiple different viewing orientations. Default is 0.

Parameters

BYTE Orientation

0=Default, 1=90°CW, 2=180°CW, 3=270°CW

Return value

This call does not return a value

BPlot

Sets a pixel with the current background colour at pixel location X, Y.

Parameters

BYTE X1

BYTE Y1

Return value

This call does not return a value

Print

This macro prints a string of characters to the Graphical LCD.

Parameters

<- STRING Str

String of characters to send to the display.

This parameter may be returned back to the caller

UINT X1

X pixel coordinate to set the output string position.

UINT Y1

Y coordinate 0-31

BYTE Font

Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes

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

ClearDisplay

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

SetBackgroundColour

Specifies the colour of the foreground

Parameters

BYTE PixelColour

0=White, 1=Black

Return value

This call does not return a value

Write_Command

No additional information

Parameters

BYTE Command

Return value

This call does not return a value

DrawCircle

Draws a circle object on the display with the center of the circle at the location X,Y

Parameters

UINT X

X Coordinate for the center of the circle

UINT Y

Y coordinate for the center of the circle

UINT Radius

Radius of the circle specified in pixels

BYTE Transparent

0=Fill inside circle using background colour / 1=Draw outer circle only

BYTE Solid

0=Use Transparent Setting / 1=Fill with foreground colour

Return value

This call does not return a value

SetForegroundColour

Specifies the colour of the foreground.

Parameters

BYTE PixelColour

0=White, 1=Black

Return value

This call does not return a value

DrawRectangle

Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2

Parameters

BYTE X1

BYTE Y1

BYTE X2

BYTE Y2

BYTE Transparent

BYTE Solid

Return value

This call does not return a value

Initialise

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