Component: GLCD (SH1106) SPI (Displays: Graphical)

From Flowcode Help
Jump to navigationJump to search


Author Matrix Ltd
Version 2.0 (Release)
Category Displays: Graphical
This inherits from GLCD Base


Image GLCD (SH1106) SPI component

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


Examples

No additional examples


Downloadable macro reference

This component inherits downloadable macros from GLCD Base

ReadASCIILUT

Gets a byte of the embedded ASCII font data.

This call is provided by GLCD Base

Parameters

BYTE pos_str
ASCII position -32 so A = 'A' - 32 = 33
BYTE count
Font column Ranging 0-4


Return value

BYTE


PrintNumber

This macro prints a decimal number to the Graphical LCD.

Parameters

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.


Return value

This call does not return a value


DrawLine

Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2.

Parameters

UINT X1
UINT Y1
UINT X2
UINT Y2


Return value

This call does not return a value


DrawEllipse

Draws an ellipse object on the display with the center of the ellipse at the location X,Y

Parameters

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


Return value

This call does not return a value


Plot

Sets a pixel with the current foreground colour at pixel location X, Y.

Parameters

UINT X1
UINT Y1


Return value

This call does not return a value


SetDisplayOrientation

Controls the way data is printed out on the display allowing multiple different viewing orientations. Default is 0.

Parameters

BYTE Orientation
0=Default, 1=90°CW, 2=180°CW, 3=270°CW


Return value

This call does not return a value


BPlot

Sets a pixel with the current background colour at pixel location X, Y.

Parameters

UINT X1
UINT Y1


Return value

This call does not return a value


Print

This macro prints a string of characters to the Graphical LCD.

Parameters

<- STRING Str
String of characters to send to the display.
This parameter may be returned back to the caller
UINT X1
X pixel coordinate to set the output string position.
UINT Y1
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.


Return value

This call does not return a value


ClearDisplay

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

Parameters

This macro has no parameters


Return value

This call does not return a value


SetBackgroundColour

Specifies the colour of the foreground

Parameters

BYTE PixelColour
0=White, 1=Black


Return value

This call does not return a value


Write_Command

No additional information


Parameters

BYTE Command


Return value

This call does not return a value


DrawCircle

Draws a circle object on the display with the center of the circle at the location X,Y

Parameters

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


Return value

This call does not return a value


SetForegroundColour

Specifies the colour of the foreground.

Parameters

BYTE PixelColour
0=White, 1=Black


Return value

This call does not return a value


DrawRectangle

Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2

Parameters

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.


Return value

This call does not return a value


Initialise

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

Parameters

This macro has no parameters


Return value

This call does not return a value


Simulation macro reference

This component inherits simulation macros from GLCD Base

PrintNumber

This macro prints a decimal number to the Graphical LCD.

This call is provided by GLCD Base

Parameters

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.


Return value

This call does not return a value


DrawLine

Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2.

This call is provided by GLCD Base

Parameters

UINT X1
UINT Y1
UINT X2
UINT Y2


Return value

This call does not return a value


Plot

Sets a pixel with the current foreground colour at pixel location X, Y.

This call is provided by GLCD Base

Parameters

UINT X1
UINT Y1


Return value

This call does not return a value


DrawEllipse

Draws an ellipse object on the display with the center of the ellipse at the location X,Y

This call is provided by GLCD Base

Parameters

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


Return value

This call does not return a value


SetDisplayOrientation

Controls the way data is printed out on the display allowing multiple different viewing orientations. Default is 0.

This call is provided by GLCD Base

Parameters

BYTE Orientation
0=Default, 1=90°CW, 2=180°CW, 3=270°CW


Return value

This call does not return a value


BPlot

Sets a pixel with the current background colour at pixel location X, Y.

This call is provided by GLCD Base

Parameters

UINT X1
UINT Y1


Return value

This call does not return a value


Print

This macro prints a string of characters to the Graphical LCD.

This call is provided by GLCD Base

Parameters

<- STRING Str
String of characters to send to the display.
This parameter may be returned back to the caller
UINT X1
X pixel coordinate to set the output string position.
UINT Y1
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.


Return value

This call does not return a value


ClearDisplay

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

This call is provided by GLCD Base

Parameters

This macro has no parameters


Return value

This call does not return a value


SetBackgroundColour

Specifies the colour of the background by creating a mixture of red, green and blue.

This call is provided by GLCD Base

Parameters

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


Return value

This call does not return a value


DrawCircle

Draws a circle object on the display with the center of the circle at the location X,Y

This call is provided by GLCD Base

Parameters

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


Return value

This call does not return a value


SetForegroundColour

Specifies the colour of the foreground by creating a mixture of red, green and blue.

This call is provided by GLCD Base

Parameters

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


Return value

This call does not return a value


DrawRectangle

Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2.

This call is provided by GLCD Base

Parameters

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.


Return value

This call does not return a value


Initialise

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

This call is provided by GLCD Base

Parameters

This macro has no parameters


Return value

This call does not return a value



Property reference

Pixel Height

This property is of type Signed integer and can be referenced with the variable name pixel_height.

Heigt of gLCD canvas measured in pixels.

Pixel Width

This property is of type Signed integer and can be referenced with the variable name pixel_width.

Width of gLCD canvas measured in pixels.

Monochrome

This property is of type True or false and can be referenced with the variable name monochrome.

Specifies if the display is capable of colour or monochrome only.

Foreground Color

This property is of type Color picker and can be referenced with the variable name foreground_colour.

Specifies the initial foreground color.

Background Color

This property is of type Color picker and can be referenced with the variable name background_colour.

Specifies the initial background color.

Color Bit Depth

This property is of type Signed integer and can be referenced with the variable name colour_bit_depth.

Number of bits of colour depth available on the display

Red Bit Depth

This property is of type Signed integer and can be referenced with the variable name red_bit_depth.

Number of bits of Red colour depth on the display

Green Bit Depth

This property is of type Signed integer and can be referenced with the variable name green_bit_depth.

Number of bits of Green colour depth on the display

Blue Bit Depth

This property is of type Signed integer and can be referenced with the variable name blue_bit_depth.

Number of bits of Blue colour depth on the display

Channel

This property is of type Fixed list of ints and can be referenced with the variable name cal_spi::CHANNEL.

SPI Channel selector

Prescale

This property is of type Fixed list of ints and can be referenced with the variable name cal_spi::PR_SCALE.

Prescale option selector

MOSI

This property is of type Single digital pin and can be referenced with the variable name cal_spi::MOSI.

SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.

MISO

This property is of type Single digital pin and can be referenced with the variable name cal_spi::MISO.

SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.

CLK

This property is of type Single digital pin and can be referenced with the variable name cal_spi::CLK.

SPI Clock Pin CLK - The Clock signal is driven by the SPI master.

CS / SS

This property is of type Single digital pin and can be referenced with the variable name cal_spi::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

This property is of type Single digital pin and can be referenced with the variable name dc_pin.

Address pin to tell the display if we are sending commands or data

Reset

This property is of type Single digital pin and can be referenced with the variable name Reset.

Reset pin on the display, used during initialise to force a clean startup of the display

Display Method

This property is of type Fixed list of ints and can be referenced with the variable name DisplayMethod.

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.

Scope Traces

This property is of type True or false and can be referenced with the variable name cal_spi::ScopeTraces.

Selects if the scope traces are automatically generated or not

Console Data

This property is of type True or false and can be referenced with the variable name cal_spi::ConsoleData.

Selects if the console data is automatically generated or not

Injector

This property is of type Fixed list of ints and can be referenced with the variable name cal_spi::Injector.

No additional information

Retrieved from "https://www.matrixtsl.com/wiki/index.php?title=Component:_GLCD_(SH1106)_SPI_(Displays:_Graphical)&oldid=21341"