Component: GLCD (SH1106) SPI (Graphical Monochrome)
| Author | Matrix Ltd |
| Version | 2.0 |
| Category | Graphical Monochrome |
GLCD (SH1106) SPI component
Graphical display component designed to work with the SH1106 type monochrome displays. Transfers data using a 4-wire SPI interface.
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
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 |
|
|
PrintNumber |
| This macro prints a decimal number to the Graphical LCD. | |
| [[File:]] - | 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 |
|
|
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 |
|
|
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 |
|
|
|
| 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 |
|
|
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 |
|
|
Write_Command |
| - BYTE
|
Command |
| - 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 |
|
|
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 |
|
|
SetForegroundColour |
| Specifies the colour of the foreground by creating a mixture of red, green and blue. | |
| - BYTE
|
Red |
| 0 - 255 where 0 = no red and 255 = maximum red | |
| - BYTE
|
Green |
| 0 - 255 where 0 = no green and 255 = maximum green | |
| - BYTE
|
Blue |
| 0 - 255 where 0 = no blue and 255 = maximum blue | |
| - 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. | |
| - BYTE
|
Return |
Property reference
|
Properties |
|
Pixel Width |
| Width of gLCD canvas measured in pixels. | |
|
|
Pixel Height |
| Heigt of gLCD canvas measured in pixels. | |
|
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. | |
|
|
Color Bit Depth |
| Number of bits of colour depth available on the display | |
|
|
Red Bit Depth |
| Number of bits of Red colour depth on the display | |
|
|
Green Bit Depth |
| Number of bits of Green colour depth on the display | |
|
|
Blue Bit Depth |
| Number of bits of Blue colour depth on 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. | |
|
|
Simulate Comms |
| Allows the communications to be simulated to either see the waveforms on the data recorder or to drive an injector component. | |
|
|
Console Data |
| Selects if the console data is automatically generated or not | |
|
|
Scope Traces |
| Selects if the scope traces are automatically generated or not | |
|
|
API |
|
Connections |
|
|
Channel |
| SPI Channel selector | |
|
|
Prescale |
| Prescale option selector | |
|
MOSI |
| SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode. | |
|
|
MISO |
| SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode. | |
|
|
CLK |
| SPI Clock Pin CLK - The Clock signal is driven by the SPI master. | |
|
|
CS / SS |
| Chip Select / Slave Select Pin Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device. | |
|
|
DC |
| Address pin to tell the display if we are sending commands or data | |
|
|
Reset |
| Reset pin on the display, used during initialise to force a clean startup of the display | |
|
|
Simulations |