Component: GLCD (SSD1305) (SSD1305) (Graphical Monochrome)

From Flowcode Help
Revision as of 10:42, 17 November 2021 by Wiki bot (talk | contribs)
Jump to navigationJump to search
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

Fc9-comp-macro.png ReadFontWidth
Reads the number of pixel columns used in the selected font 
Fc9-u8-icon.png - BYTE Font
Font selection range: 0 to (NumFonts - 1) 
Fc9-u8-icon.png - BYTE Character
ASCII character to get the pixel width e.g. 'A' or 65 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png SetFontScaler
Allows the fonts to be scaled up by multiplying the number of pixels on the X and Y. 
Fc9-u8-icon.png - BYTE ScaleX
Sets the horizontal scale of the font, default 1 
Fc9-u8-icon.png - BYTE ScaleY
Sets the vertical scale of the font, default 1 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png PrintNumber
This macro prints a decimal number to the Graphical LCD. 
[[File:]] - Number
Byte or Integer number to send to the display. 
Fc9-u16-icon.png - UINT X
X pixel coordinate to set the output string position. 
Fc9-u16-icon.png - UINT Y
Y pixel coordinate to set the output string position. 
Fc9-u8-icon.png - BYTE Font
Range: 0 to 31 - 0=5x8, 1=10x8, 2=10x16, 3=5x16, 4-31=Extended Sizes 
Fc9-u8-icon.png - BYTE Transparent
Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png DrawLine
Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2. 
Fc9-u16-icon.png - UINT X1
 
Fc9-u16-icon.png - UINT Y1
 
Fc9-u16-icon.png - UINT X2
 
Fc9-u16-icon.png - UINT Y2
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png DrawEllipse
Draws an ellipse object on the display with the center of the ellipse at the location X,Y 
Fc9-u16-icon.png - UINT X
X Coordinate for the center of the circle 
Fc9-u16-icon.png - UINT Y
Y coordinate for the center of the circle 
Fc9-u16-icon.png - UINT XRadius
Radius of the circle on the X axis specified in pixels 
Fc9-u16-icon.png - UINT YRadius
Radius of the circle on the Y axis specified in pixels 
Fc9-u8-icon.png - BYTE Transparent
0=Fill inside circle using background colour / 1=Draw outer circle only 
Fc9-u8-icon.png - BYTE Solid
0=Use Transparent Setting / 1=Fill with foreground colour 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Plot
Sets a pixel with the current foreground colour at pixel location X, Y. 
Fc9-u16-icon.png - UINT X1
 
Fc9-u16-icon.png - UINT Y1
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetDisplayOrientation
Controls the way data is printed out on the display allowing multiple different viewing orientations. Default is 0. 
Fc9-u8-icon.png - BYTE Orientation
0=Default, 1=90°CW, 2=180°CW, 3=270°CW 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png BPlot
Sets a pixel with the current background colour at pixel location X, Y. 
Fc9-u16-icon.png - UINT X1
 
Fc9-u16-icon.png - UINT Y1
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ReadFontStat
Gets a stat from the selected embedded ASCII font data. 
Fc9-u8-icon.png - BYTE Font
Font selection range: 0 to (NumFonts - 1) 
Fc9-u8-icon.png - BYTE Index
0=SpaceWidth, 1=PixelHeight 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png Print
This macro prints a string of characters to the Graphical LCD. 
Fc9-string-icon.png - STRING Str
String of characters to send to the display. 
Fc9-u16-icon.png - UINT X1
X pixel coordinate to set the output string position. 
Fc9-u16-icon.png - UINT Y1
Y pixel coordinate to set the output string position. 
Fc9-u8-icon.png - BYTE Font
Selects which Font to use Range: 0 to Font Count 
Fc9-u8-icon.png - BYTE Transparent
Specifies if the background of the text is drawn - 0 = Background colour is drawn, 1 = Background colour not drawn. 
Fc9-void-icon.png - VOID Return


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


Fc9-comp-macro.png SetBackgroundColour
Specifies the colour of the background by creating a mixture of red, green and blue.  
Fc9-u8-icon.png - BYTE PixelColour
0=White, 1=Black 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png DrawCircle
Draws a circle object on the display with the center of the circle at the location X,Y 
Fc9-u16-icon.png - UINT X
X Coordinate for the center of the circle 
Fc9-u16-icon.png - UINT Y
Y coordinate for the center of the circle 
Fc9-u16-icon.png - UINT Radius
Radius of the circle specified in pixels 
Fc9-u8-icon.png - BYTE Transparent
0=Fill inside circle using background colour / 1=Draw outer circle only 
Fc9-u8-icon.png - BYTE Solid
0=Use Transparent Setting / 1=Fill with foreground colour 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetForegroundColour
Specifies the colour of the foreground by creating a mixture of red, green and blue.  
Fc9-u8-icon.png - BYTE PixelColour
0=White, 1=Black 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png DrawRectangle
Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2 
Fc9-u16-icon.png - UINT X1
 
Fc9-u16-icon.png - UINT Y1
 
Fc9-u16-icon.png - UINT X2
 
Fc9-u16-icon.png - UINT Y2
 
Fc9-u8-icon.png - BYTE Transparent
Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data. 
Fc9-u8-icon.png - BYTE Solid
Chooses to fill the box with colour - 0 = Box contains transparency data, 1 = Box contains foreground colour. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Initialise
The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png DrawCircle
Draws a circle object on the display with the center of the circle at the location X,Y 
Fc9-u16-icon.png - UINT X
X Coordinate for the center of the circle 
Fc9-u16-icon.png - UINT Y
Y coordinate for the center of the circle 
Fc9-u16-icon.png - UINT Radius
Radius of the circle specified in pixels 
Fc9-u8-icon.png - BYTE Transparent
0=Fill inside circle using background colour / 1=Draw outer circle only 
Fc9-u8-icon.png - BYTE Solid
0=Use Transparent Setting / 1=Fill with foreground colour 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png SetForegroundColour
Specifies the colour of the foreground by creating a mixture of red, green and blue.  
Fc9-u8-icon.png - BYTE Red
0 - 255 where 0 = no red and 255 = maximum red 
Fc9-u8-icon.png - BYTE Green
0 - 255 where 0 = no green and 255 = maximum green 
Fc9-u8-icon.png - BYTE Blue
0 - 255 where 0 = no blue and 255 = maximum blue 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png DrawRectangle
Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2 
Fc9-u16-icon.png - UINT X1
 
Fc9-u16-icon.png - UINT Y1
 
Fc9-u16-icon.png - UINT X2
 
Fc9-u16-icon.png - UINT Y2
 
Fc9-u8-icon.png - BYTE Transparent
Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data. 
Fc9-u8-icon.png - BYTE Solid
Chooses to fill the box with colour - 0 = Box contains transparency data, 1 = Box contains foreground colour. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Initialise
The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Initialise
The Init macro must be called once to initialise the Graphical LCD display before any other Graphical LCD component macros are called. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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  
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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  
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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  
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-u8-icon.png - 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). 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ARB4
Loads the binary-data to an existing arbitrary waveform memory location ARB4. 
Fc9-u8-icon.png - BYTE Waveform
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png CLKSRRet
Returns the clock source <INT> or <EXT>. 
[[File:]] - Return


Fc9-comp-macro.png MODPMDEV
Sets PM waveform deviation to <nrf> degrees. (Lower limit: -360° - Upper limit: 360°). 
[[File:]] - Degrees
Sets PM waveform deviation in degrees (-360 - 360). 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png MSTLOCK
Sends signal to SLAVE generator to get synchronised 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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). 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ARB3
Loads the binary-data to an existing arbitrary waveform memory location ARB3. 
Fc9-u16-icon.png - UINT Waveform
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png WAVE
Sets the waveform type. 0 = SINE, 1 = SQUARE, 2 = RAMP, 3 = TRIANG, 4 = PULSE, 5 = NOISE, 6 = ARB 
Fc9-u8-icon.png - BYTE WaveType
0 = SINE, 1 = SQUARE, 2 = RAMP, 3 = TRIANG, 4 = PULSE, 5 = NOISE, 6 = ARB. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png CALADJ
Adjust the selected calibration value by <nrf> (Lower limit: -100 - Upper limit: 100). 
[[File:]] - Calibrate
Adjust the selected calibration value (-100 - 100). 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png STBRet
Returns the value of the Status Byte Register in <nr1> numeric format. 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png ARB2
Loads the binary-data to an existing arbitrary waveform memory location ARB2. 
Fc9-u16-icon.png - UINT Waveform
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png EERRet
Query and clear execution error number register. 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png MODFMSRC
Sets FM waveform source to; 0 INT, 1 = EXT. 
[[File:]] - Source
Sets FM waveform source (0 = INT, 1 = EXT). 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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). 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ESE
Sets the Standard Event Status Enable Register to the value of <nrf>. 
Fc9-u8-icon.png - BYTE Value
Value of register 0-255 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ARB1
Loads the binary-data to an existing arbitrary waveform memory location ARB1. 
Fc9-u16-icon.png - UINT Waveform
16 Bit binary number for arbitrary waveform. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ARB4DEFRet
Returns user specified waveform name, waveform pint interpolation state and waveform length of ARB4. 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png CLS
Clears status byte register of the interface. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png MSTRELOCK
Resynchronises the two generators in MASTER-SLAVE mode. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png NOISLVL
Sets the output noise level to <nr1> %. (Lower limit: 0% - Upper limit: 50%) 
Fc9-u8-icon.png - BYTE Percent
Sets the output noise level in percent. (0 - 50) 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png LOCKMODE
Sets the synchronising mode to; 0 = MASTER, 1 = SLAVE, 2 = INDEP. 
Fc9-u8-icon.png - BYTE Mode
Sets the synchronising mode (0 = MASTER, 1 = SLAVE, 2 = INDEP). 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ADDRESSRet
Returns the instruments address 
[[File:]] - Return


Fc9-comp-macro.png MODPMSRC
Sets PM waveform source to; 0 INT, 1 = EXT. 
[[File:]] - Source
Sets PM waveform source (0 = INT, 1 = EXT). 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png MODPWMSRC
Sets PWM waveform source to; 0 = INT, 1 = EXT. 
[[File:]] - Source
Sets PWM waveform source (0 = INT, 1 = EXT). 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png MOD
Sets modulation to; 0 = OFF, 1 = AM, 2 = FM, 3 = PM, 4 = FSK, 5 = PWM. 
Fc9-u8-icon.png - BYTE Modulation
Sets modulation (0 = OFF, 1 = AM, 2 = FM, 3 = PM, 4 = FSK, 5 = PWM). 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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


Fc9-comp-macro.png LRNRet
Returns the complete setup of the instrument as a binary data block 
[[File:]] - Return


Fc9-comp-macro.png 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


Fc9-comp-macro.png SWPTYPE
Sets the sweep type to; 0 = LINUP, 1 = LINDN, 2 = LINUPDN, 3 = LINDNUP, 4 = LOGUP, 5 = LOGDN, 6 = LOGUPDN, 7 = LOGDNUP. 
Fc9-u8-icon.png - BYTE Type
Set the sweep type (0 = LINUP, 1 = LINDN, 2 = LINUPDN, 3 = LINDNUP, 4 = LOGUP, 5 = LOGDN, 6 = LOGUPDN, 7 = LOGDNUP). 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png PULSRANGE
Sets PWM waveform source to <1>, <2> or <3>; 1 = 1, 2 = 2, 3 = 3. 
Fc9-u8-icon.png - BYTE Range
Sets the pulse rise and fall range. (1, 2 or 3) 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png TSTRet
The generator has no self test capability and the response is always 0 <rmt>. 
[[File:]] - Return


Fc9-comp-macro.png BSTTRGPOL
Sets the burst trigger slope to; 0 = POS, 1 = NEG. 
[[File:]] - Slope
Set the burst trigger slope (0 = POS, 1 = NEG). 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png ARB3Ret
Returns the binary-data from an existing abbitrary wavefrom memory location. 
Fc9-u16-icon.png - UINT Return


Fc9-comp-macro.png BSTPHASE
Sets the burst phase to <nrf> degrees. (Lower limit: -360 - Upper limit: 360) 
[[File:]] - Degrees
Sets the burst phase in degrees (-360 - 360) 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png 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. 
Fc9-string-icon.png - STRING ReturnIDN
 
Fc9-string-icon.png - STRING Return


Fc9-comp-macro.png SWPTRGPER
Sets the sweep trigger period to <nrf> seconds 
[[File:]] - Seconds
Set the sweep trigger period in seconds. 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png PULSDLY
Sets the waveform delay to <nrf> sec 
[[File:]] - Sec
 
Fc9-void-icon.png - VOID Return


Fc9-comp-macro.png Initialise
Opens the COM port ready for communications. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-14-icon.png Pixel Width
Width of gLCD canvas measured in pixels. 
Fc9-type-14-icon.png Pixel Height
Heigt of gLCD canvas measured in pixels. 
Fc9-type-21-icon.png H Offset
Offset from the edge of the display, default 0. 
Fc9-type-7-icon.png Monochrome
Specifies if the display is capable of colour or monochrome only. 
Fc9-type-1-icon.png Foreground Color
Specifies the initial foreground color. 
Fc9-type-1-icon.png Background Color
Specifies the initial background color. 
Fc9-type-14-icon.png Colour Bit Depth
Total color bit depth for the display. 
Fc9-type-14-icon.png Red Bit Depth
Specifies the red bit depth for the display. 
Fc9-type-14-icon.png Green Bit Depth
Specifies the green bit depth for the display. 
Fc9-type-14-icon.png Blue Bit Depth
Specifies the blue bit depth for the display. 
Fc9-type-16-icon.png Font Count
Specifies the number of fonts available to use on the display. 
Fc9-type-16-icon.png Font
Font picker to decide which font to use on your display. 
Fc9-type-16-icon.png Character Spacing
Sets the number of blank pixels between each character when printing text. Default 1. 
Fc9-type-16-icon.png Space Width
Sets the number of horizontal pixels used to represent a space character. 
Fc9-type-16-icon.png Font
Font picker to decide which font to use on your display. 
Fc9-type-16-icon.png Character Spacing
Sets the number of blank pixels between each character when printing text. Default 1. 
Fc9-type-16-icon.png Space Width
Sets the number of horizontal pixels used to represent a space character. 
Fc9-type-16-icon.png Font
Font picker to decide which font to use on your display. 
Fc9-type-16-icon.png Character Spacing
Sets the number of blank pixels between each character when printing text. Default 1. 
Fc9-type-16-icon.png Space Width
Sets the number of horizontal pixels used to represent a space character. 
Fc9-type-16-icon.png Font
Font picker to decide which font to use on your display. 
Fc9-type-16-icon.png Character Spacing
Sets the number of blank pixels between each character when printing text. Default 1. 
Fc9-type-16-icon.png Space Width
Sets the number of horizontal pixels used to represent a space character. 
Fc9-type-16-icon.png 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.  
Fc9-conn-icon.png Connections
Fc9-type-5-icon.png Chip Select (CS)
Chip select pin connection 
Fc9-type-5-icon.png Read / Write (R/W)
 
Fc9-type-5-icon.png Reg Select (RS)
 
Fc9-type-5-icon.png Data (SD)
LED backlight strobe pin connection 
Fc9-type-5-icon.png Serial Clock (SCK)
Reset pin connection 
Fc9-type-5-icon.png Reset (RST)
Instruction / Command pin connection 
Fc9-conn-icon.png Simulations