Component: GLCD (SSD1306) SPI (SSD1306) (Graphical Monochrome): Difference between revisions

Latest revision as of 14:23, 13 July 2026

Author	Matrix TSL
Version	0.1
Category	Graphical Monochrome

GLCD (SSD1306) SPI component

Graphical display component based on the SPI version of the SSD1306 monochrome graphical controller IC. Functions without the use of a read pin forcing the data to be written a byte at a time.

Component Pack

FREE

Detailed description

No detailed description exists yet for this component

Examples

The following files provide examples of how to use this component:

Digilent - Basic IO Shield

This template allows users to quickly and simply get up and running with their hardware.

The default microcontroller for this template board is the 32bit PIC32MX320F128H found

on the Uno32 hardware.

It features;

4x push-switch, 4x slide switch

8x LEDS, 1x Potentiometer

1x OLED Screen

Downloadable macro reference

	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

	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

	SendCommand

- BYTE	Command

- VOID	Return

	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

	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

	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

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

- UINT	Y1

- VOID	Return

	ControlDisplay
Allows the display to be switched on and off
- BYTE	Control
0=Off, 1=On
- VOID	Return

	SendData

- BYTE	Byte

- VOID	Return

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

- UINT	Y1

- VOID	Return

	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

	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

	ControlContrast
Sets the display contrast from 0 to 255.
- BYTE	Contrast
Range 0 - 255, Default 207
- VOID	Return

	Uninitialise

- VOID	Return

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

	SetBackgroundColour
Specifies the colour of the foreground
- BYTE	PixelColour
0=White, 1=Black
- VOID	Return

	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

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

	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

	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

Property reference

	Properties
	Pixel Width
Width of gLCD canvas measured in pixels.
	Pixel Height
Heigt of gLCD canvas measured in pixels.
	Interlaced
Determines if the display is interlaced in the Y axis or not
	Monochrome
Specifies if the display is capable of colour or monochrome only.
	Foreground Color
Specifies the initial foreground color.
	Background Color
Specifies the initial background color.
	Colour 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.
	Font Count
Specifies the number of fonts available to use on the display.
	Font
Font picker to decide which font to use on your display.
	Character Spacing
Sets the number of blank pixels between each character when printing text. Default 1.
	Space Width
Sets the number of horizontal pixels used to represent a space character.
	Font
Font picker to decide which font to use on your display.
	Character Spacing
Sets the number of blank pixels between each character when printing text. Default 1.
	Space Width
Sets the number of horizontal pixels used to represent a space character.
	Font
Font picker to decide which font to use on your display.
	Character Spacing
Sets the number of blank pixels between each character when printing text. Default 1.
	Space Width
Sets the number of horizontal pixels used to represent a space character.
	Font
Font picker to decide which font to use on your display.
	Character Spacing
Sets the number of blank pixels between each character when printing text. Default 1.
	Space Width
Sets the number of horizontal pixels used to represent a space character.
	Display Method
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.
	Connections
	Data (SDA)
LED backlight strobe pin connection
	Serial Clock (SCL)
Reset pin connection
	DataCommand Pin (DC)
Data / Command select pin
	VBAT Enable

	VDD Enable
VDD Enable Pin
	Reset
The LCD Reset pin
	Simulations

@@ Line 77: / Line 77: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadFontWidth'''
+| width="90%" class="mtx-class-macrohead" | '''ReadFontWidth'''
 |-
 | colspan="2" | Reads the number of pixel columns used in the selected font&nbsp;
@@ Line 100: / Line 100: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetFontScaler'''
+| width="90%" class="mtx-class-macrohead" | '''SetFontScaler'''
 |-
 | colspan="2" | Allows the fonts to be scaled up by multiplying the number of pixels on the X and Y.&nbsp;
@@ Line 123: / Line 123: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SendCommand'''
+| width="90%" class="mtx-class-macrohead" | '''SendCommand'''
 |-
 | colspan="2" | &nbsp;
@@ Line 141: / Line 141: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''PrintNumber'''
+| width="90%" class="mtx-class-macrohead" | '''PrintNumber'''
 |-
 | colspan="2" | This macro prints a decimal number to the Graphical LCD.&nbsp;
@@ Line 179: / Line 179: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DrawLine'''
+| width="90%" class="mtx-class-macrohead" | '''DrawLine'''
 |-
 | colspan="2" | Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2.&nbsp;
@@ Line 212: / Line 212: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DrawEllipse'''
+| width="90%" class="mtx-class-macrohead" | '''DrawEllipse'''
 |-
 | colspan="2" | Draws an ellipse object on the display with the center of the ellipse at the location X,Y&nbsp;
@@ Line 255: / Line 255: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Plot'''
+| width="90%" class="mtx-class-macrohead" | '''Plot'''
 |-
 | colspan="2" | Sets a pixel with the current foreground colour at pixel location X, Y.&nbsp;
@@ Line 278: / Line 278: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ControlDisplay'''
+| width="90%" class="mtx-class-macrohead" | '''ControlDisplay'''
 |-
 | colspan="2" | Allows the display to be switched on and off&nbsp;
@@ Line 296: / Line 296: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SendData'''
+| width="90%" class="mtx-class-macrohead" | '''SendData'''
 |-
 | colspan="2" | &nbsp;
@@ Line 314: / Line 314: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''BPlot'''
+| width="90%" class="mtx-class-macrohead" | '''BPlot'''
 |-
 | colspan="2" | Sets a pixel with the current background colour at pixel location X, Y.&nbsp;
@@ Line 337: / Line 337: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadFontStat'''
+| width="90%" class="mtx-class-macrohead" | '''ReadFontStat'''
 |-
 | colspan="2" | Gets a stat from the selected embedded ASCII font data.&nbsp;
@@ Line 360: / Line 360: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Print'''
+| width="90%" class="mtx-class-macrohead" | '''Print'''
 |-
 | colspan="2" | This macro prints a string of characters to the Graphical LCD.&nbsp;
@@ Line 398: / Line 398: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ControlContrast'''
+| width="90%" class="mtx-class-macrohead" | '''ControlContrast'''
 |-
 | colspan="2" | Sets the display contrast from 0 to 255.&nbsp;
@@ Line 416: / Line 416: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Uninitialise'''
+| width="90%" class="mtx-class-macrohead" | '''Uninitialise'''
 |-
 | colspan="2" | &nbsp;
@@ Line 429: / Line 429: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ClearDisplay'''
+| width="90%" class="mtx-class-macrohead" | '''ClearDisplay'''
 |-
 | colspan="2" | This macro clears the display of any previous output by overwriting the entire display with the background colour.&nbsp;
@@ Line 442: / Line 442: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetBackgroundColour'''
+| width="90%" class="mtx-class-macrohead" | '''SetBackgroundColour'''
 |-
 | colspan="2" | Specifies the colour of the foreground&nbsp;
@@ Line 460: / Line 460: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DrawCircle'''
+| width="90%" class="mtx-class-macrohead" | '''DrawCircle'''
 |-
 | colspan="2" | Draws a circle object on the display with the center of the circle at the location X,Y&nbsp;
@@ Line 498: / Line 498: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetForegroundColour'''
+| width="90%" class="mtx-class-macrohead" | '''SetForegroundColour'''
 |-
 | colspan="2" | Specifies the colour of the foreground. &nbsp;
@@ Line 516: / Line 516: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''DrawRectangle'''
+| width="90%" class="mtx-class-macrohead" | '''DrawRectangle'''
 |-
 | colspan="2" | Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2&nbsp;
@@ Line 559: / Line 559: @@
 |-
 | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
+| width="90%" class="mtx-class-macrohead" | '''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;
@@ Line 575: / Line 575: @@
 {| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
 |-
@@ Line 699: / Line 699: @@
 | colspan="2" | 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. &nbsp;
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''
+| width="90%" class="mtx-class-macrohead" | '''Connections'''
 |-
 |-
@@ Line 733: / Line 733: @@
 | colspan="2" | The LCD Reset pin&nbsp;
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''
+| width="90%" class="mtx-class-macrohead" | '''Simulations'''
 |-
 |}

SteveT (talk | contribs)