Component: GLCD (SH1106) I2C (Graphical Monochrome)

Author	Matrix Ltd
Version	1.4
Category	Graphical Monochrome

GLCD (SH1106) I2C component

Graphical display component designed to work with the SH1106 type monochrome displays. Transfers data using a 2-wire I2C interface.

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

Error creating thumbnail: Unable to save thumbnail to destination	BPlot
Sets a pixel with the current background colour at pixel location X, Y.
Error creating thumbnail: Unable to save thumbnail to destination - UINT	X1
Error creating thumbnail: Unable to save thumbnail to destination - UINT	Y1
Error creating thumbnail: Unable to save thumbnail to destination - VOID	Return

ClearDisplay

Error creating thumbnail: Unable to save thumbnail to destination	ClearDisplay
This macro clears the display of any previous output by overwriting the entire display with the background colour.
Error creating thumbnail: Unable to save thumbnail to destination - VOID	Return

DrawCircle

Error creating thumbnail: Unable to save thumbnail to destination	DrawCircle
Draws a circle object on the display with the center of the circle at the location X,Y
Error creating thumbnail: Unable to save thumbnail to destination - UINT	X
X Coordinate for the center of the circle
Error creating thumbnail: Unable to save thumbnail to destination - UINT	Y
Y coordinate for the center of the circle
Error creating thumbnail: Unable to save thumbnail to destination - UINT	Radius
Radius of the circle specified in pixels
Error creating thumbnail: Unable to save thumbnail to destination - BYTE	Transparent
0=Fill inside circle using background colour / 1=Draw outer circle only
Error creating thumbnail: Unable to save thumbnail to destination - BYTE	Solid
0=Use Transparent Setting / 1=Fill with foreground colour
Error creating thumbnail: Unable to save thumbnail to destination - VOID	Return

DrawEllipse

Error creating thumbnail: Unable to save thumbnail to destination	DrawEllipse
Draws an ellipse object on the display with the center of the ellipse at the location X,Y
Error creating thumbnail: Unable to save thumbnail to destination - UINT	X
X Coordinate for the center of the circle
Error creating thumbnail: Unable to save thumbnail to destination - UINT	Y
Y coordinate for the center of the circle
Error creating thumbnail: Unable to save thumbnail to destination - UINT	XRadius
Radius of the circle on the X axis specified in pixels
Error creating thumbnail: Unable to save thumbnail to destination - UINT	YRadius
Radius of the circle on the Y axis specified in pixels
Error creating thumbnail: Unable to save thumbnail to destination - BYTE	Transparent
0=Fill inside circle using background colour / 1=Draw outer circle only
Error creating thumbnail: Unable to save thumbnail to destination - BYTE	Solid
0=Use Transparent Setting / 1=Fill with foreground colour
Error creating thumbnail: Unable to save thumbnail to destination - VOID	Return

DrawLine

Error creating thumbnail: Unable to save thumbnail to destination	DrawLine
Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2.
Error creating thumbnail: Unable to save thumbnail to destination - UINT	X1
Error creating thumbnail: Unable to save thumbnail to destination - UINT	Y1
Error creating thumbnail: Unable to save thumbnail to destination - UINT	X2
Error creating thumbnail: Unable to save thumbnail to destination - UINT	Y2
Error creating thumbnail: Unable to save thumbnail to destination - VOID	Return

DrawRectangle

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

Initialise

Error creating thumbnail: Unable to save thumbnail to destination	Initialise
The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called.
Error creating thumbnail: Unable to save thumbnail to destination - VOID	Return

Print

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

PrintNumber

Error creating thumbnail: Unable to save thumbnail to destination	PrintNumber
This macro prints a decimal number to the Graphical LCD.
Error creating thumbnail: Unable to save thumbnail to destination - INT	Number
Byte or Integer number to send to the display.
Error creating thumbnail: Unable to save thumbnail to destination - UINT	X
X pixel coordinate to set the output string position.
Error creating thumbnail: Unable to save thumbnail to destination - UINT	Y
Y pixel coordinate to set the output string position.
Error creating thumbnail: Unable to save thumbnail to destination - BYTE	Font
Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes
Error creating thumbnail: Unable to save thumbnail to destination - BYTE	Transparent
Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn.
Error creating thumbnail: Unable to save thumbnail to destination - VOID	Return

ReadFontStat

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

ReadFontWidth

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

SetBackgroundColour

Error creating thumbnail: Unable to save thumbnail to destination	SetBackgroundColour
Specifies the colour of the foreground
Error creating thumbnail: Unable to save thumbnail to destination - BYTE	PixelColour
0=White, 1=Black
Error creating thumbnail: Unable to save thumbnail to destination - VOID	Return

SetDisplayOrientation

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

SetFontScaler

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

SetForegroundColour

Error creating thumbnail: Unable to save thumbnail to destination	SetForegroundColour
Specifies the colour of the foreground.
Error creating thumbnail: Unable to save thumbnail to destination - BYTE	PixelColour
0=White, 1=Black
Error creating thumbnail: Unable to save thumbnail to destination - VOID	Return

Write_Command

Error creating thumbnail: Unable to save thumbnail to destination	Write_Command
Error creating thumbnail: Unable to save thumbnail to destination - BYTE	Command
Error creating thumbnail: Unable to save thumbnail to destination - VOID	Return

Property reference

Error creating thumbnail: Unable to save thumbnail to destination	Properties
Error creating thumbnail: Unable to save thumbnail to destination	Dimensions
Error creating thumbnail: Unable to save thumbnail to destination	Pixel Width
Width of gLCD canvas measured in pixels.
Error creating thumbnail: Unable to save thumbnail to destination	Pixel Height
Heigt of gLCD canvas measured in pixels.
Error creating thumbnail: Unable to save thumbnail to destination	Colour
Error creating thumbnail: Unable to save thumbnail to destination	Monochrome
Specifies if the display is capable of colour or monochrome only.
Error creating thumbnail: Unable to save thumbnail to destination	Foreground Color
Specifies the initial foreground color.
Error creating thumbnail: Unable to save thumbnail to destination	Background Color
Specifies the initial background color.
Error creating thumbnail: Unable to save thumbnail to destination	Bit Depth
Error creating thumbnail: Unable to save thumbnail to destination	Color Bit Depth
Number of bits of colour depth available on the display
Error creating thumbnail: Unable to save thumbnail to destination	Red Bit Depth
Number of bits of Red colour depth on the display
Error creating thumbnail: Unable to save thumbnail to destination	Green Bit Depth
Number of bits of Green colour depth on the display
Error creating thumbnail: Unable to save thumbnail to destination	Blue Bit Depth
Number of bits of Blue colour depth on the display
Error creating thumbnail: Unable to save thumbnail to destination	Connections
Error creating thumbnail: Unable to save thumbnail to destination	I2C Address Bit
I2C Address Bit - Bit 0 of the address and adjustable by the user.
Error creating thumbnail: Unable to save thumbnail to destination	Channel
Channel selection
Error creating thumbnail: Unable to save thumbnail to destination	Baud Select
Baud rate option selector
Error creating thumbnail: Unable to save thumbnail to destination	Baud Rate
Baud rate to be used
Error creating thumbnail: Unable to save thumbnail to destination	Stop Delay
On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not a 10ms delay between an I2C stop event and the next I2C start event. Most modern microcontrollers will not have a problem so this property can be disabled to speed up the I2C communications.
Error creating thumbnail: Unable to save thumbnail to destination	SDA
Pin used for SDA (data signal)
Error creating thumbnail: Unable to save thumbnail to destination	SCL
Pin used for SCL (clock signal)
Error creating thumbnail: Unable to save thumbnail to destination	Reset
Display reset pin
Error creating thumbnail: Unable to save thumbnail to destination	Fonts
Error creating thumbnail: Unable to save thumbnail to destination	Font Count
Specifies the number of fonts available to use on the display.
Error creating thumbnail: Unable to save thumbnail to destination	Font 0
Error creating thumbnail: Unable to save thumbnail to destination	Font
Font picker to decide which font to use on your display.
Error creating thumbnail: Unable to save thumbnail to destination	Character Spacing
Sets the number of blank pixels between each character when printing text. Default 1.
Error creating thumbnail: Unable to save thumbnail to destination	Space Width
Sets the number of horizontal pixels used to represent a space character.
Error creating thumbnail: Unable to save thumbnail to destination	Simulation
Error creating thumbnail: Unable to save thumbnail to destination	Component Label
Error creating thumbnail: Unable to save thumbnail to destination	Component Label Scale
The label scale can be change if the amout of text is too wide for the display
Error creating thumbnail: Unable to save thumbnail to destination	Physical Orientation
Rotates the simulated canvas to match the orientation of real world hardware.
Error creating thumbnail: Unable to save thumbnail to destination	Simulate Comms
Allows the communications to be simulated to either see the waveforms on the data recorder or to drive an injector component.

Component Source Code

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

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