Component: GLCD (KS0108) (Graphical Monochrome)

Author	Matrix Ltd
Version	1.4
Category	Graphical Monochrome

GLCD (KS0108) component

Graphical display component designed to work with the KS0108 type monochrome displays. Also compatible with the newer S6A0107 controller IC displays.

Version information

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

Detailed description

Click here for an in depth guide to graphical LCDs using Flowcode.

Information on the Fonts available for this component are available here. GLCD Font Subcomponent

Examples

No additional examples

Macro reference

BPlot

	BPlot
Sets a pixel with the current background colour at pixel location X, Y.
- UINT	X1
- UINT	Y1
- VOID	Return

ClearDisplay

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

DrawArc

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

DrawCircle

	DrawCircle
Draws a circle object on the display with the center of the circle at the location X,Y
- 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
- VOID	Return

DrawEllipse

	DrawEllipse
Draws an ellipse object on the display with the center of the ellipse at the location X,Y
- 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
- VOID	Return

DrawLine

	DrawLine
Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2.
- UINT	X1
- UINT	Y1
- UINT	X2
- UINT	Y2
- VOID	Return

DrawRectangle

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

DrawRoundedRectangle

	DrawRoundedRectangle
Draws a rectangle with rounded corners
- UINT	X1
- UINT	Y1
- UINT	X2
- UINT	Y2
- UINT	Radius
- BYTE	Transparent
Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data.
- BYTE	Solid
Chooses to fill the box with colour - 0 = Box contains transparency data, 1 = Box contains foreground colour.
- VOID	Return

Initialise

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

Plot

	Plot
Sets a pixel with the current foreground colour at pixel location X, Y.
- UINT	X1
- UINT	Y1
- VOID	Return

Print

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

PrintNumber

	PrintNumber
This macro prints a decimal number to the Graphical LCD.
- 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.
- VOID	Return

ReadFontStat

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

ReadFontWidth

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

SetBackgroundColour

	SetBackgroundColour
Specifies the colour of the background.
- BYTE	Pixel_Colour
0=White, 1=Black
- VOID	Return

SetDisplayOrientation

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

SetFontScaler

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

SetForegroundColour

	SetForegroundColour
Specifies the colour of the foreground.
- BYTE	Pixel_Colour
0=White, 1=Black
- VOID	Return

Property reference

	Properties
	Dimensions
	Pixel Width
Width of gLCD canvas measured in pixels.
	Pixel Height
Heigt of gLCD canvas measured in pixels.
	Controller Count
Speicifies the number of controller IC's built into the display and therefore the number of available chip select pins
	Colour
	Monochrome
Specifies if the display is capable of colour or monochrome only.
	Foreground Color
Specifies the initial foreground color.
	Background Colour
Specifies the initial background color.
	Bit Depth
	Color Bit Depth
Total color bit depth for the display.
	Red Bit Depth
Specifies the red bit depth for the display.
	Green Bit Depth
Specifies the green bit depth for the display.
	Blue Bit Depth
Specifies the blue bit depth for the display.
	Connections
	CS1
Chip select to address the first controller IC
	CS2
Chip select to address the second controller IC
	RS
Data / Instruction register select pin.
	RW
Read / write select pin
	Enable
Data enable to clock a command or data in or out of the device
	Data0
Data Pin 0
	Data1
Data Pin 1
	Data2
Data Pin 2
	Data3
Data Pin 3
	Data4
Data Pin 4
	Data5
Data Pin 5
	Data6
Data Pin 6
	Data7
Data Pin 7
	Reset
Display reset pin
	Fonts
	Font Count
Specifies the number of fonts available to use on the display.
	Font 0
	Font
Font picker to decide which font to use on your display.
	Bytes Required
Number of bytes required in program memory to store the selected font.
	Character Spacing
Sets the number of blank pixels between each character when printing text.
	Space Width
Sets the number of horizontal pixels used to represent a space character.
	Simulation
	Component Label
	Component Label Scale
The label scale can be change if the amout of text is too wide for the display
	Physical Orientation
Rotates the simulated canvas to match the orientation of real world hardware.
	Display Delay
	Enable Delay
Time in micro seconds to wait before and after toggling the enable pin.

Component Source Code

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

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