Component: GLCD (SSD1306) I2C (SSD1306) (Graphical Monochrome)
From Flowcode Help
Jump to navigationJump to search| Author | Matrix Ltd |
| Version | 1.9 |
| Category | Graphical Monochrome |
Contents
- 1 GLCD (SSD1306) I2C component
- 2 Component Source Code
- 3 Detailed description
- 4 Examples
- 5 Macro reference
- 5.1 BPlot
- 5.2 ClearDisplay
- 5.3 ControlContrast
- 5.4 ControlDisplay
- 5.5 DrawCircle
- 5.6 DrawEllipse
- 5.7 DrawLine
- 5.8 DrawRectangle
- 5.9 Initialise
- 5.10 InvertDisplay
- 5.11 Plot
- 5.12 Print
- 5.13 PrintNumber
- 5.14 ReadFontStat
- 5.15 ReadFontWidth
- 5.16 SendCommand
- 5.17 SetBackgroundColour
- 5.18 SetDisplayOrientation
- 5.19 SetFontScaler
- 5.20 SetForegroundColour
- 6 Property reference
GLCD (SSD1306) I2C component
Graphical display component based on the I2C version of the SSD1306 monochrome graphical controller IC. Functions without the use of a read pin by hosting the 1K of graphical memory using the microcontroller's RAM memory.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_GLCD_SSD1306_I2C.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_GLCD_SSD1306_I2C.fcfx
Detailed description
No detailed description exists yet for this component
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 |
ControlContrast
|
|
ControlContrast |
| Sets the display contrast from 0 to 255. | |
 - BYTE
|
Contrast |
| Range 0 - 255, Default 207 | |
| - VOID
|
Return |
ControlDisplay
|
|
ControlDisplay |
| Allows the display to be switched on and off | |
| - BYTE
|
Control |
| 0=Off, 1=On | |
| - 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 |
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 |
InvertDisplay
|
|
InvertDisplay |
| - VOID
|
Return |
Plot
|
|
Plot |
| Sets a pixel with the current foreground colour at pixel location X, Y. | |
| - UINT
|
X1 |
| - UINT
|
Y1 |
| - VOID
|
Return |
|
|
|
| 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 |
SendCommand
|
|
SendCommand |
| - BYTE
|
Command |
| - VOID
|
Return |
SetBackgroundColour
|
|
SetBackgroundColour |
| Specifies the colour of the background by creating a mixture of red, green and blue. | |
| - BYTE
|
PixelColour |
| 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 by creating a mixture of red, green and blue. | |
| - BYTE
|
PixelColour |
| 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. | |
|
Interlaced |
| Determines if the display is interlaced in the Y axis or not | |
|
Offset X |
|
|
Offset Y |
|
|
Colour |
|
|
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. | |
|
|
Bit Depth |
|
|
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. | |
|
|
Connections |
|
I2C Address |
|
|
Channel |
| Channel selection | |
|
|
Baud Select |
| Baud rate option selector | |
|
|
Baud Rate |
| Baud rate to be used | |
|
|
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. | |
|
SDA |
| Pin used for SDA (data signal) | |
|
|
SCL |
| Pin used for SCL (clock signal) | |
|
|
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. | |
|
|
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. | |
|
|
Simulation Mode |
|
|
Physical Orientation |
| Rotates the simulated canvas to match the orientation of real world hardware. | |
|
|
Simulate Comms |
| Allows the communications to be simulated to either see the waveforms on the data recorder or to drive an injector component. | |
