Author
|
Matrix Ltd
|
Version
|
1.8
|
Category
|
Graphical Monochrome
|
GLCD (SSD1305) component
Graphical display component based on the SSD1305 monochrome graphical controller IC.
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
|
|
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
|
|
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 background by creating a mixture of red, green and blue.
|
- 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 by creating a mixture of red, green and blue.
|
- 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
|
|
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 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.
|
- 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
|
Resets and initialises the Internet E-Block. It sets up the gateway address, subnet mask, device IP address and device MAC address as defined in the properties of the Flowcode component. This macro must be called before any other TCP_IP component macros
|
- VOID
|
Return
|
|
Initialise
|
Resets and initialises the Internet E-Block. It sets up the gateway address, subnet mask, device IP address and device MAC address as defined in the properties of the Flowcode component. This macro must be called before any other TCP_IP component macros
|
- VOID
|
Return
|
|
Initialise
|
Resets and initialises the Internet E-Block. It sets up the gateway address, subnet mask, device IP address and device MAC address as defined in the properties of the Flowcode component. This macro must be called before any other TCP_IP component macros
|
- VOID
|
Return
|
|
MODPMSHAPE
|
Sets PM waveform shape to; 0 = SINE, 1 = SQUARE, 2 = RAMPUP, 3 = RAMPDN, 4 = TRIANG, 5 = NOISE, 6 = DC, 7 = SINC, 8 = EXPRISE, 9 = LOGRISE, 10 = ARB1, 11 = ARB2, 12 = ARB3, 13= ARB4.
|
- BYTE
|
Shape
|
Sets PM waveform shape (1 = SINE, 2 = SQUARE, 3 = RAMPUP, 4 = RAMPDN, 5 = TRIANG, 6 = NOISE, 7 = DC, 8 = SINC, 9 = EXPRISE, 10 = LOGRISE, 11 = ARB1, 12 = ARB2, 13 = ARB3, 14= ARB4).
|
- VOID
|
Return
|
|
ARB4
|
Loads the binary-data to an existing arbitrary waveform memory location ARB4.
|
- BYTE
|
Waveform
|
|
- VOID
|
Return
|
|
CLKSRRet
|
Returns the clock source <INT> or <EXT>.
|
[[File:]] -
|
Return
|
|
MODPMDEV
|
Sets PM waveform deviation to <nrf> degrees. (Lower limit: -360° - Upper limit: 360°).
|
[[File:]] -
|
Degrees
|
Sets PM waveform deviation in degrees (-360 - 360).
|
- VOID
|
Return
|
|
MSTLOCK
|
Sends signal to SLAVE generator to get synchronised
|
- VOID
|
Return
|
|
HILVL
|
Sets the amplitude-high-level to <nrf> Volts. (Lower limit: -0.490 V - Upper limit: 5.000 V).
|
[[File:]] -
|
HighLevel
|
Sets the amplitude-high-level in Volts(V) (-0.490 V - 5.000 V).
|
- VOID
|
Return
|
|
ARB3
|
Loads the binary-data to an existing arbitrary waveform memory location ARB3.
|
- UINT
|
Waveform
|
|
- VOID
|
Return
|
|
WAVE
|
Sets the waveform type. 0 = SINE, 1 = SQUARE, 2 = RAMP, 3 = TRIANG, 4 = PULSE, 5 = NOISE, 6 = ARB
|
- BYTE
|
WaveType
|
0 = SINE, 1 = SQUARE, 2 = RAMP, 3 = TRIANG, 4 = PULSE, 5 = NOISE, 6 = ARB.
|
- VOID
|
Return
|
|
CALADJ
|
Adjust the selected calibration value by <nrf> (Lower limit: -100 - Upper limit: 100).
|
[[File:]] -
|
Calibrate
|
Adjust the selected calibration value (-100 - 100).
|
- VOID
|
Return
|
|
STBRet
|
Returns the value of the Status Byte Register in <nr1> numeric format.
|
- BYTE
|
Return
|
|
ARB2
|
Loads the binary-data to an existing arbitrary waveform memory location ARB2.
|
- UINT
|
Waveform
|
|
- VOID
|
Return
|
|
EERRet
|
Query and clear execution error number register.
|
- STRING
|
Return
|
|
MODFMSRC
|
Sets FM waveform source to; 0 INT, 1 = EXT.
|
[[File:]] -
|
Source
|
Sets FM waveform source (0 = INT, 1 = EXT).
|
- VOID
|
Return
|
|
MODAMFREQ
|
Sets AM waveform frequency to <nrf> Hz. (Lower limit: 1uHz - Upper limit: 20kHz).
|
[[File:]] -
|
Frequency
|
Sets AM waveform frequency in Hertz(Hz) (1uHz - 20kHz).
|
- VOID
|
Return
|
|
ESE
|
Sets the Standard Event Status Enable Register to the value of <nrf>.
|
- BYTE
|
Value
|
Value of register 0-255
|
- VOID
|
Return
|
|
ARB1
|
Loads the binary-data to an existing arbitrary waveform memory location ARB1.
|
- UINT
|
Waveform
|
16 Bit binary number for arbitrary waveform.
|
- VOID
|
Return
|
|
ARB4DEFRet
|
Returns user specified waveform name, waveform pint interpolation state and waveform length of ARB4.
|
- STRING
|
Return
|
|
CLS
|
Clears status byte register of the interface.
|
- VOID
|
Return
|
|
MSTRELOCK
|
Resynchronises the two generators in MASTER-SLAVE mode.
|
- VOID
|
Return
|
|
NOISLVL
|
Sets the output noise level to <nr1> %. (Lower limit: 0% - Upper limit: 50%)
|
- BYTE
|
Percent
|
Sets the output noise level in percent. (0 - 50)
|
- VOID
|
Return
|
|
LOCKMODE
|
Sets the synchronising mode to; 0 = MASTER, 1 = SLAVE, 2 = INDEP.
|
- BYTE
|
Mode
|
Sets the synchronising mode (0 = MASTER, 1 = SLAVE, 2 = INDEP).
|
- VOID
|
Return
|
|
ADDRESSRet
|
Returns the instruments address
|
[[File:]] -
|
Return
|
|
MODPMSRC
|
Sets PM waveform source to; 0 INT, 1 = EXT.
|
[[File:]] -
|
Source
|
Sets PM waveform source (0 = INT, 1 = EXT).
|
- VOID
|
Return
|
|
MODPWMSRC
|
Sets PWM waveform source to; 0 = INT, 1 = EXT.
|
[[File:]] -
|
Source
|
Sets PWM waveform source (0 = INT, 1 = EXT).
|
- VOID
|
Return
|
|
MOD
|
Sets modulation to; 0 = OFF, 1 = AM, 2 = FM, 3 = PM, 4 = FSK, 5 = PWM.
|
- BYTE
|
Modulation
|
Sets modulation (0 = OFF, 1 = AM, 2 = FM, 3 = PM, 4 = FSK, 5 = PWM).
|
- VOID
|
Return
|
|
ISTRet
|
Returns IST local message as defined by IEEE Std. 488.2. The syntax of the response is 0<rmt>, if the local message is false, or 1<rmt>, if the local message is true.
|
[[File:]] -
|
Return
|
|
LRNRet
|
Returns the complete setup of the instrument as a binary data block
|
[[File:]] -
|
Return
|
|
OPCRet
|
Query Operation Complete status. The response is always 1<rmt> and will be available immediately the command is executed because all commands are sequential.
|
[[File:]] -
|
Return
|
|
SWPTYPE
|
Sets the sweep type to; 0 = LINUP, 1 = LINDN, 2 = LINUPDN, 3 = LINDNUP, 4 = LOGUP, 5 = LOGDN, 6 = LOGUPDN, 7 = LOGDNUP.
|
- BYTE
|
Type
|
Set the sweep type (0 = LINUP, 1 = LINDN, 2 = LINUPDN, 3 = LINDNUP, 4 = LOGUP, 5 = LOGDN, 6 = LOGUPDN, 7 = LOGDNUP).
|
- VOID
|
Return
|
|
PULSRANGE
|
Sets PWM waveform source to <1>, <2> or <3>; 1 = 1, 2 = 2, 3 = 3.
|
- BYTE
|
Range
|
Sets the pulse rise and fall range. (1, 2 or 3)
|
- VOID
|
Return
|
|
TSTRet
|
The generator has no self test capability and the response is always 0 <rmt>.
|
[[File:]] -
|
Return
|
|
BSTTRGPOL
|
Sets the burst trigger slope to; 0 = POS, 1 = NEG.
|
[[File:]] -
|
Slope
|
Set the burst trigger slope (0 = POS, 1 = NEG).
|
- VOID
|
Return
|
|
ARB3Ret
|
Returns the binary-data from an existing abbitrary wavefrom memory location.
|
- UINT
|
Return
|
|
BSTPHASE
|
Sets the burst phase to <nrf> degrees. (Lower limit: -360 - Upper limit: 360)
|
[[File:]] -
|
Degrees
|
Sets the burst phase in degrees (-360 - 360)
|
- VOID
|
Return
|
|
IDNRet
|
Returns the instrument identification. The IDN is saved to the variable passed from the function 'ReturnIDN'. The return parameter is TRUE when the IDN is successfully returned.
|
- STRING
|
ReturnIDN
|
|
- STRING
|
Return
|
|
SWPTRGPER
|
Sets the sweep trigger period to <nrf> seconds
|
[[File:]] -
|
Seconds
|
Set the sweep trigger period in seconds.
|
- VOID
|
Return
|
|
PULSDLY
|
Sets the waveform delay to <nrf> sec
|
[[File:]] -
|
Sec
|
|
- VOID
|
Return
|
|
Initialise
|
Opens the COM port ready for communications.
|
- VOID
|
Return
|
Property reference
|
Properties
|
|
Pixel Width
|
Width of gLCD canvas measured in pixels.
|
|
Pixel Height
|
Heigt of gLCD canvas measured in pixels.
|
|
H Offset
|
Offset from the edge of the display, default 0.
|
|
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
|
|
Chip Select (CS)
|
Chip select pin connection
|
|
Read / Write (R/W)
|
|
|
Reg Select (RS)
|
|
|
Data (SD)
|
LED backlight strobe pin connection
|
|
Serial Clock (SCK)
|
Reset pin connection
|
|
Reset (RST)
|
Instruction / Command pin connection
|
|
Simulations
|