Difference between revisions of "Component: GLCD (4D Picaso v1) (EB076) (Graphical Color)"
(Created page with " {| width="50%" |- | width="20%" style="color: gray;" | Author | Matrix Ltd |- | width="20%" style="color: gray;" | Version | 1.6 (Release) |- | width="20%" style="color: gra...") |
|||
| Line 23: | Line 23: | ||
==Examples== | ==Examples== | ||
| + | |||
EB076 gLCD Example File with touch draw support. | EB076 gLCD Example File with touch draw support. | ||
| + | |||
{{Fcfile|EB076_Test.fcfx|EB076 Example}} | {{Fcfile|EB076_Test.fcfx|EB076 Example}} | ||
| + | |||
| + | |||
Example should show the following on the display on the panel and on the hardware. Note that the "TOUCH" was draw by hand by clicking and dragging the mouse around over the LCD while simulation is running. | Example should show the following on the display on the panel and on the hardware. Note that the "TOUCH" was draw by hand by clicking and dragging the mouse around over the LCD while simulation is running. | ||
Latest revision as of 10:03, 18 September 2019
| Author | Matrix Ltd |
| Version | 1.6 (Release) |
| Category | Displays: Graphical |
| This inherits from GLCD Base | |
Contents
- 1 GLCD (EB076, 4D_Picaso) component
- 2 Examples
- 3 Downloadable macro reference
- 3.1 ReadASCIILUT
- 3.2 G4D_ReadTouchCoordinatesPicaso
- 3.3 G4D_InitialiseCard
- 3.4 G4D_DumpScreenToFilePicaso
- 3.5 G4D_GetTouchCoordinatesPicaso
- 3.6 PrintNumber
- 3.7 DrawLine
- 3.8 G4D_DisplayImageFromFilePicaso
- 3.9 G4D_DisableTouchscreenPicaso
- 3.10 Plot
- 3.11 DrawEllipse
- 3.12 DisplayControl
- 3.13 G4D_EnableTouchscreenPicaso
- 3.14 G4D_SetVolumePicaso
- 3.15 G4D_DisplayVideoFromCard
- 3.16 SetDisplayOrientation
- 3.17 BPlot
- 3.18 Print
- 3.19 G4D_SetVGADisplaySizePicaso
- 3.20 G4D_DumpScreenToCard
- 3.21 ClearDisplay
- 3.22 SetBackgroundColour
- 3.23 DrawCircle
- 3.24 G4D_DisplayImageFromCard
- 3.25 SetForegroundColour
- 3.26 G4D_SetTouchRegionPicaso
- 3.27 G4D_PlayAudioFromFilePicaso
- 3.28 DrawRectangle
- 3.29 Initialise
- 4 Simulation macro reference
- 5 Property reference
GLCD (EB076, 4D_Picaso) component
Graphical display component designed to work with the Picaso range of displays from 4D Systems. Also available in the form of the EB076 GLCD Touchscreen E-block. Component based around the uLCD-32PT display.
Examples
EB076 gLCD Example File with touch draw support.
Example should show the following on the display on the panel and on the hardware. Note that the "TOUCH" was draw by hand by clicking and dragging the mouse around over the LCD while simulation is running.
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
G4D_ReadTouchCoordinatesPicaso
Returns the coordinates of the last touch event.
Axis = 0 or 'x' or 'X' - Returns the X coordinate.
Axis = 1 or 'y' or 'Y' - Returns the Y coordinate.
Parameters
- BYTE Axis
Return value
G4D_InitialiseCard
Initialises the micro SD card inserted into the module is available.
Returns 0 for succesful initialisation or 255 for a detected failure.
Parameters
- This macro has no parameters
Return value
G4D_DumpScreenToFilePicaso
Copies a section of the display to the micro SD card starting from X, Y and ranging to Width, Height.
Parameters
- UINT X
- UINT Y
- UINT Width
- UINT Height
- <- STRING Filename
- Assigns the name of the file on the card to store the data.
- This parameter may be returned back to the caller
Return value
G4D_GetTouchCoordinatesPicaso
Reads the value of the last touchscreen input from the display.
Returns a 0 if no new touch is detected.
Returns a 1 if a press is detected.
Returns a 2 if a release is detected.
Returns a 3 if a moving drag is detected.
Parameters
- This macro has no parameters
Return value
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
- Size of the font - 0 = Normal, 1 = Double Width, 2 = Double Width and Height, 3 = Double Height
- 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
G4D_DisplayImageFromFilePicaso
Attempts to print an image from the micro SD card using the specified filename on the card.
The image is printed at location starting from X, Y.
PosH and PosL specify the sector address of the previously stored image icon.
Parameters
- UINT X
- UINT Y
- STRING Filename
- UINT PosH
- UINT PosL
Return value
G4D_DisableTouchscreenPicaso
Disables the touchscreen interface if available.
Parameters
- This macro has no parameters
Return 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
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
DisplayControl
Controls the operation, contrast and backlight on the display
Parameters
- BYTE Backlight
- 0=Backlight Off, 1=Backlight On (default)
- BYTE Display
- 0=Display off, 1=Display on (default)
- BYTE Contrast
- Contrast Range 0 - 15
Return value
- This call does not return a value
G4D_EnableTouchscreenPicaso
Enables the touchscreen interface if available.
Parameters
- This macro has no parameters
Return value
G4D_SetVolumePicaso
Sets the playback volume.
Parameters
- BYTE Volume
- Volume = 0 - Mute Enabled / 1 - Volume Down 8 / 3 - Volume Down 1 / 253 - Volume Up 1 / 254 - Volume Up 8 / 255 - Mute Disabled / 8 - Minimum Volume Level / 127 - Maximum Volume Level
Return value
G4D_DisplayVideoFromCard
Attempts to display a sequence of images from the micro SD card at the specified address location on the card.
The images are printed at location starting from X, Y and ranging to Width, Height.
Parameters
- UINT X
- UINT Y
- UINT Width
- UINT Height
- BYTE ColourMode
- Specifes the colour depth setting - 0 = 8-bit colour, 1 = 16-bit colour.
- BYTE Delay
- Specifies the number of milliseconds to wait in between displaying each image.
- UINT Frames
- Specifies the number of frames to display.
- BYTE AddH
- BYTE AddM
- BYTE AddL
Return 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
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
- Size of the font - 0 = Normal, 1 = Double Width, 2 = Double Width and Height, 3 = Double Height
- 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
G4D_SetVGADisplaySizePicaso
Specifies the VGA display size in pixels.
Size = 0 - 320 x 240 Resolution.
Size = 1 - 640 x 480 Resolution.
Size = 2 - 800 x 480 Resolution.
Size = 3 - Custom Resolution
Parameters
- BYTE Size
Return value
G4D_DumpScreenToCard
Copies a section of the display to the micro SD card starting from X, Y and ranging to Width, Height.
The address parameters assign where on the card to store the data.
Parameters
- UINT X
- UINT Y
- UINT Width
- UINT Height
- BYTE AddH
- BYTE AddM
- BYTE AddL
Return 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 background by creating a mixture of red, green and blue.
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
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
G4D_DisplayImageFromCard
Attempts to print an image from the micro SD card at the specified address location on the card.
The image is printed at location starting from X, Y and ranging to Width, Height.
Parameters
- UINT X
- UINT Y
- UINT Width
- UINT Height
- BYTE ColourMode
- Specifies the colour depth setting - 0 = 8-bit colour, 1 = 16-bit colour.
- BYTE AddH
- BYTE AddM
- BYTE AddL
Return value
SetForegroundColour
Specifies the colour of the foreground by creating a mixture of red, green and blue.
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
G4D_SetTouchRegionPicaso
Specifies the area of the screen which will respond to touchscreen inputs.
Parameters
- UINT X1
- UINT Y1
- UINT X2
- UINT Y2
Return value
G4D_PlayAudioFromFilePicaso
Attempts to stream an audio wav file from the micro SD card using the specified filename.
Parameters
- BYTE Play_Option
- Play_Option = 0 - Return when playing complete / 1 - Return immediatley / 2 - Stop Playback / 3 - Pause Playback / 4 - Resume Playback / 5 - Loop Playing until stopped
- STRING Filename
Return 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
- Size of the font - 0 = Normal, 1 = Double Width, 2 = Double Width and Height, 3 = Double Height
- 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
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
- Size of the font - 0 = Normal, 1 = Double Width, 2 = Double Width and Height, 3 = Double Height
- 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 Colour
This property is of type Color picker and can be referenced with the variable name background_colour.
Specifies the initial background color.
Colour Bit Depth
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.
Red Bit Depth
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.
Green Bit Depth
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.
Blue Bit Depth
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.
UART Channel
This property is of type Fixed list of ints and can be referenced with the variable name channel.
UART Peripheral to use for communications with the display.
Reset Pin
This property is of type Single digital pin and can be referenced with the variable name reset_pin.
I/O pin connected to the reset signal on the gLCD
TX Pin
This property is of type Single digital pin and can be referenced with the variable name tx_pin.
UART transmit pin - connected to the RX pin on the 4D display
RX Pin
This property is of type Single digital pin and can be referenced with the variable name rx_pin.
UART transmit pin - connected to the RX pin on the 4D display
High Speed
This property is of type True or false and can be referenced with the variable name HighSpeed.
Determines if the baud rate is automaticaly switched from 9600 baud on initialise to 57600 baud.
Only available in hardware mode.
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.
