View source for Component: GLCD (ILI9341) (Outputs: General)

From Flowcode Help

← Component: GLCD (ILI9341) (Outputs: General)

You do not have permission to edit this page, for the following reason:

---

You can view and copy the source of this page.

{| width="50%" |- | width="20%" style="color: gray;" | Author | Matrix Ltd |- | width="20%" style="color: gray;" | Version | 1.8 (Release) |- | width="20%" style="color: gray;" | Category | Outputs: General |- | colspan="2" | This inherits from [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD base]] |} ==[[File:Component Icon bc0a0612_ef85_48fb_8960_5e78f4083df1.png|Image]] GLCD (ILI9341) component== Graphical display component designed to work with the ILI9341 controller IC Based on the ILI9341 16-bit colour graphical controller IC. ==Examples== ''<span style="color:red;">No additional examples</span>'' ==Downloadable macro reference== ''This component inherits downloadable macros from ''[[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD base]] ===<span style="font-weight: normal;"><u><tt>ReadASCIILUT</tt></u></span>=== Gets a byte of the embedded ASCII font data. ''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD base]]'' '''Parameters''' :[[Variable Types|BYTE]] ''pos_str'' ::ASCII position -32 so A = 'A' - 32 = 33 :[[Variable Types|BYTE]] ''count'' ::Font column Ranging 0-4 '''Return value''' :[[Variable Types|BYTE]] ===<span style="font-weight: normal;"><u><tt>BacklightOn</tt></u></span>=== Sets the backlight enable pin allowing the display backlight to switch on. Switching the backlight on and off at high speed allow the light to be dimmed. '''Parameters''' :''This macro has no parameters'' '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>PrintNumber</tt></u></span>=== This macro prints a decimal number to the Graphical LCD. '''Parameters''' :[[Variable Types|INT]] ''Number'' ::Byte or Integer number to send to the display. :[[Variable Types|UINT]] ''X'' ::X pixel coordinate to set the output string position. :[[Variable Types|UINT]] ''Y'' ::Y pixel coordinate to set the output string position. :[[Variable Types|BYTE]] ''Font'' ::Size of the font - 0 = Normal, 1 = Double Width, 2 = Double Width and Height, 3 = Double Height :[[Variable Types|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'' ===<span style="font-weight: normal;"><u><tt>DrawLine</tt></u></span>=== Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2. '''Parameters''' :[[Variable Types|UINT]] ''X1'' :[[Variable Types|UINT]] ''Y1'' :[[Variable Types|UINT]] ''X2'' :[[Variable Types|UINT]] ''Y2'' '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>Plot</tt></u></span>=== Sets a pixel with the current foreground colour at pixel location X, Y. '''Parameters''' :[[Variable Types|UINT]] ''X1'' :[[Variable Types|UINT]] ''Y1'' '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>SetDisplayOrientation</tt></u></span>=== Controls the way data is printed out on the display allowing multiple different viewing orientations. Default is 0. '''Parameters''' :[[Variable Types|BYTE]] ''Orientation'' ::0=Default, 1=90°CW, 2=180°CW, 3=270°CW '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>BacklightOff</tt></u></span>=== Clears the backlight enable pin allowing the display backlight to switch off. Switching the backlight on and off at high speed allow the light to be dimmed. '''Parameters''' :''This macro has no parameters'' '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>BPlot</tt></u></span>=== Sets a pixel with the current background colour at pixel location X, Y. '''Parameters''' :[[Variable Types|UINT]] ''X1'' :[[Variable Types|UINT]] ''Y1'' '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>Print</tt></u></span>=== This macro prints a string of characters to the Graphical LCD. '''Parameters''' :[[Variable Types|<- STRING]] ''Str'' ::String of characters to send to the display. ::''This parameter may be returned back to the caller'' :[[Variable Types|UINT]] ''X1'' ::X pixel coordinate to set the output string position. :[[Variable Types|UINT]] ''Y1'' ::Y pixel coordinate to set the output string position. :[[Variable Types|BYTE]] ''Font'' ::Size of the font - 0 = Normal, 1 = Double Width, 2 = Double Width and Height, 3 = Double Height :[[Variable Types|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'' ===<span style="font-weight: normal;"><u><tt>ClearDisplay</tt></u></span>=== 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'' ===<span style="font-weight: normal;"><u><tt>SetBackgroundColour</tt></u></span>=== Specifies the colour of the background by creating a mixture of red, green and blue. '''Parameters''' :[[Variable Types|BYTE]] ''Red'' ::0 - 255 where 0 = no red and 255 = maximum red :[[Variable Types|BYTE]] ''Green'' ::0 - 255 where 0 = no green and 255 = maximum green :[[Variable Types|BYTE]] ''Blue'' ::0 - 255 where 0 = no blue and 255 = maximum blue '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>SetForegroundColour</tt></u></span>=== Specifies the colour of the foreground by creating a mixture of red, green and blue. '''Parameters''' :[[Variable Types|BYTE]] ''Red'' ::0 - 255 where 0 = no red and 255 = maximum red :[[Variable Types|BYTE]] ''Green'' ::0 - 255 where 0 = no green and 255 = maximum green :[[Variable Types|BYTE]] ''Blue'' ::0 - 255 where 0 = no blue and 255 = maximum blue '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>DrawRectangle</tt></u></span>=== Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2 '''Parameters''' :[[Variable Types|UINT]] ''X1'' :[[Variable Types|UINT]] ''Y1'' :[[Variable Types|UINT]] ''X2'' :[[Variable Types|UINT]] ''Y2'' :[[Variable Types|BYTE]] ''Transparent'' ::Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data. :[[Variable Types|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'' ===<span style="font-weight: normal;"><u><tt>Initialise</tt></u></span>=== 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 ''[[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD base]] ===<span style="font-weight: normal;"><u><tt>PrintNumber</tt></u></span>=== This macro prints a decimal number to the Graphical LCD. ''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD base]]'' '''Parameters''' :[[Variable Types|INT]] ''Number'' ::Byte or Integer number to send to the display. :[[Variable Types|UINT]] ''X'' ::X pixel coordinate to set the output string position. :[[Variable Types|UINT]] ''Y'' ::Y pixel coordinate to set the output string position. :[[Variable Types|BYTE]] ''Font'' ::Size of the font - 0 = Normal, 1 = Double Width, 2 = Double Width and Height, 3 = Double Height :[[Variable Types|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'' ===<span style="font-weight: normal;"><u><tt>DrawLine</tt></u></span>=== Draws a line with the current foreground colour from pixel location X1, Y1 to pixel location X2, Y2. ''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD base]]'' '''Parameters''' :[[Variable Types|UINT]] ''X1'' :[[Variable Types|UINT]] ''Y1'' :[[Variable Types|UINT]] ''X2'' :[[Variable Types|UINT]] ''Y2'' '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>Plot</tt></u></span>=== Sets a pixel with the current foreground colour at pixel location X, Y. ''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD base]]'' '''Parameters''' :[[Variable Types|UINT]] ''X1'' :[[Variable Types|UINT]] ''Y1'' '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>SetDisplayOrientation</tt></u></span>=== Controls the way data is printed out on the display allowing multiple different viewing orientations. Default is 0. ''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD base]]'' '''Parameters''' :[[Variable Types|BYTE]] ''Orientation'' ::0=Default, 1=90°CW, 2=180°CW, 3=270°CW '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>BPlot</tt></u></span>=== Sets a pixel with the current background colour at pixel location X, Y. ''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD base]]'' '''Parameters''' :[[Variable Types|UINT]] ''X1'' :[[Variable Types|UINT]] ''Y1'' '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>Print</tt></u></span>=== This macro prints a string of characters to the Graphical LCD. ''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD base]]'' '''Parameters''' :[[Variable Types|<- STRING]] ''Str'' ::String of characters to send to the display. ::''This parameter may be returned back to the caller'' :[[Variable Types|UINT]] ''X1'' ::X pixel coordinate to set the output string position. :[[Variable Types|UINT]] ''Y1'' ::Y pixel coordinate to set the output string position. :[[Variable Types|BYTE]] ''Font'' ::Size of the font - 0 = Normal, 1 = Double Width, 2 = Double Width and Height, 3 = Double Height :[[Variable Types|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'' ===<span style="font-weight: normal;"><u><tt>ClearDisplay</tt></u></span>=== This macro clears the display of any previous output by overwriting the entire display with the background colour. ''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD base]]'' '''Parameters''' :''This macro has no parameters'' '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>SetBackgroundColour</tt></u></span>=== Specifies the colour of the background by creating a mixture of red, green and blue. ''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD base]]'' '''Parameters''' :[[Variable Types|BYTE]] ''Red'' ::0 - 255 where 0 = no red and 255 = maximum red :[[Variable Types|BYTE]] ''Green'' ::0 - 255 where 0 = no green and 255 = maximum green :[[Variable Types|BYTE]] ''Blue'' ::0 - 255 where 0 = no blue and 255 = maximum blue '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>SetForegroundColour</tt></u></span>=== Specifies the colour of the foreground by creating a mixture of red, green and blue. ''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD base]]'' '''Parameters''' :[[Variable Types|BYTE]] ''Red'' ::0 - 255 where 0 = no red and 255 = maximum red :[[Variable Types|BYTE]] ''Green'' ::0 - 255 where 0 = no green and 255 = maximum green :[[Variable Types|BYTE]] ''Blue'' ::0 - 255 where 0 = no blue and 255 = maximum blue '''Return value''' :''This call does not return a value'' ===<span style="font-weight: normal;"><u><tt>DrawRectangle</tt></u></span>=== Draws a rectangle with the current foreground colour from pixel loaction X1, Y1 to pixel location X2, Y2. ''This call is provided by [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD base]]'' '''Parameters''' :[[Variable Types|UINT]] ''X1'' :[[Variable Types|UINT]] ''Y1'' :[[Variable Types|UINT]] ''X2'' :[[Variable Types|UINT]] ''Y2'' :[[Variable Types|BYTE]] ''Transparent'' ::Chooses the transparency of the box - 0 = Box contains background colour, 1 = Box contains previous pixel data. :[[Variable Types|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'' ===<span style="font-weight: normal;"><u><tt>Initialise</tt></u></span>=== 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 [[Component: ID 4384cba9_0bea_4359_8c5b_dcd046aa7778|GLCD base]]'' '''Parameters''' :''This macro has no parameters'' '''Return value''' :''This call does not return a value'' ==Property reference== <span style="font-weight: normal;"><u>Pixel Height</u></span> This property is of type ''Signed integer'' and can be referenced with the variable name ''pixel_height''. Heigt of gLCD canvas measured in pixels. <span style="font-weight: normal;"><u>Pixel Width</u></span> This property is of type ''Signed integer'' and can be referenced with the variable name ''pixel_width''. Width of gLCD canvas measured in pixels. <span style="font-weight: normal;"><u>Monochrome</u></span> 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. <span style="font-weight: normal;"><u>Foreground Color</u></span> This property is of type ''Color picker'' and can be referenced with the variable name ''foreground_colour''. Specifies the initial foreground color. <span style="font-weight: normal;"><u>Background Color</u></span> This property is of type ''Color picker'' and can be referenced with the variable name ''background_colour''. Specifies the initial background color. <span style="font-weight: normal;"><u>Colour Bit Depth</u></span> This property is of type ''Signed integer'' and can be referenced with the variable name ''colour_bit_depth''. Total color bit depth for the display. <span style="font-weight: normal;"><u>Red Bit Depth</u></span> This property is of type ''Signed integer'' and can be referenced with the variable name ''red_bit_depth''. Specifies the red bit depth for the display. <span style="font-weight: normal;"><u>Green Bit Depth</u></span> This property is of type ''Signed integer'' and can be referenced with the variable name ''green_bit_depth''. Specifies the green bit depth for the display. <span style="font-weight: normal;"><u>Blue Bit Depth</u></span> This property is of type ''Signed integer'' and can be referenced with the variable name ''blue_bit_depth''. Specifies the blue bit depth for the display. <span style="font-weight: normal;"><u>Data Out (MOSI)</u></span> This property is of type ''Single digital pin'' and can be referenced with the variable name ''dataout_pin''. Data pin connection <span style="font-weight: normal;"><u>Clock</u></span> This property is of type ''Single digital pin'' and can be referenced with the variable name ''clock_pin''. Clock pin connection <span style="font-weight: normal;"><u>Chip Select</u></span> This property is of type ''Single digital pin'' and can be referenced with the variable name ''chip_sel_pin''. Chip select pin connection <span style="font-weight: normal;"><u>D/C</u></span> This property is of type ''Single digital pin'' and can be referenced with the variable name ''dc_pin''. Instruction / Command pin connection <span style="font-weight: normal;"><u>Reset</u></span> This property is of type ''Single digital pin'' and can be referenced with the variable name ''reset_pin''. Reset pin connection <span style="font-weight: normal;"><u>LED</u></span> This property is of type ''Single digital pin'' and can be referenced with the variable name ''led_pin''. LED backlight strobe pin connection <span style="font-weight: normal;"><u>Display Method</u></span> 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.

Return to Component: GLCD (ILI9341) (Outputs: General).