Component: GLCD (4D Picaso v2) (EB076) (Graphical Color)

Author	Matrix Ltd
Version	2.0
Category	Graphical Color

GLCD (4D Picaso v2) component

Graphical display component designed to work with the Picaso range of displays from 4D Systems. Component based around the uLCD-32PTU display.

Detailed description

No detailed description exists yet for this component

Examples

EB076 gLCD Example File with touch draw support.

EB076v2 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.

Macro reference

BPlot

	BPlot
Sets a pixel with the current background colour at pixel location X, Y.
- UINT	X1
- UINT	Y1
- VOID	Return

ClearDisplay

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

DisplayControl

	DisplayControl
Controls the operation, contrast and backlight on the display
- BYTE	Backlight
0=Backlight Off, 1=Backlight On (default)
- BYTE	Display
0=Display off, 1=Display on (default)
- BYTE	Contrast
Contrast Range 1 - 15
- VOID	Return

DrawCircle

	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

DrawEllipse

	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

DrawLine

	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

DrawRectangle

	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

FastPlot

	FastPlot
Sets a pixel with the current foreground colour at current pixel location. Not compatible with orientations other than 0.
- VOID	Return

G4D_DisableTouchscreenPicaso

	G4D_DisableTouchscreenPicaso
Disables the touchscreen interface if available.
- BYTE	Return

G4D_DisplayImageFromCard

	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.
- UINT	X
- UINT	Y
- UINT	Handle
- BYTE	Return

G4D_DisplayImageFromFilePicaso

	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.
- UINT	X
- UINT	Y
- STRING	Filename
- UINT	OffsetHi
Upper 16-bit image offset within the 4D systems resource file, default = 0
- UINT	OffsetLo
Lower 16-bit Image offset within the 4D systems resource file, default = 0
- BYTE	Return

G4D_DisplayVideoFromCard

	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.
- 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
- BYTE	Return

G4D_DumpScreenToCard

	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.
- UINT	X
- UINT	Y
- UINT	Width
- UINT	Height
- BYTE	AddH
- BYTE	AddM
- BYTE	AddL
- BYTE	Return

G4D_DumpScreenToFilePicaso

	G4D_DumpScreenToFilePicaso
Copies a section of the display to the micro SD card starting from X, Y and ranging to Width, Height.
- UINT	X
- UINT	Y
- UINT	Width
- UINT	Height
- STRING	Filename
Assigns the name of the file on the card to store the data.
- BYTE	Return

G4D_EnableTouchscreenPicaso

	G4D_EnableTouchscreenPicaso
Enables the touchscreen interface if available.
- BYTE	Return

G4D_GetTouchCoordinatesPicaso

	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.
- BYTE	Return

G4D_InitialiseCard

	G4D_InitialiseCard
Checks to see if an SD card is inserted into the module. If the SD card is available then the card is initialised ready for use. Returns 0 for succesful initialisation or 255 for a detected failure.
- BYTE	Return

G4D_IsAudioPlayingPicaso

	G4D_IsAudioPlayingPicaso
Checks to see if an audio file is currently playing. Returns 0 is no audio is currently playing. Returns 1 if there is audio playing.
- BYTE	Return

G4D_PlayAudioFromFilePicaso

	G4D_PlayAudioFromFilePicaso
Attempts to stream an audio wav file from the micro SD card using the specified filename.
- BYTE	Play_Option
Play_Option = 0 - Return when playing complete / 1 - Return immediatley / 2 - Stop Playback / 3 - Pause Playback / 4 - Resume Playback
- STRING	Filename
- BYTE	Return

G4D_ReadTouchCoordinatesPicaso

	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.
- BYTE	Axis
- UINT	Return

G4D_SetTouchRegionPicaso

	G4D_SetTouchRegionPicaso
Specifies the area of the screen which will respond to touchscreen inputs.
- UINT	X1
- UINT	Y1
- UINT	X2
- UINT	Y2
- BYTE	Return

G4D_SetVGADisplaySizePicaso

	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
- BYTE	Size
- BYTE	Return

G4D_SetVolumePicaso

	G4D_SetVolumePicaso
Sets the playback volume.
- BYTE	Volume
Range 8-127, 8 = Minimum Volume Level / 127 = Maximum Volume Level
- BYTE	Return

Initialise

	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

Plot

	Plot
Sets a pixel with the current foreground colour at pixel location X, Y.
- UINT	X1
- UINT	Y1
- VOID	Return

Print

	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
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.
- VOID	Return

PrintNumber

	PrintNumber
This macro prints a decimal number to the Graphical LCD.
- 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.
- VOID	Return

SetBackgroundColour

	SetBackgroundColour
Specifies the colour of the background 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

SetDisplayOrientation

	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

SetForegroundColour

	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

Window

	Window
- UINT	X1
- UINT	Y1
- UINT	X2
- UINT	Y2
- VOID	Return

Property reference

	Properties
	Dimensions
	Pixel Height
Heigt of gLCD canvas measured in pixels.
	Pixel Width
Width of gLCD canvas measured in pixels.
	Colour
	Monochrome
Specifies if the display is capable of colour or monochrome only.
	Foreground Color
Specifies the initial foreground color.
	Background Colour
Specifies the initial background color.
	Bit Depth
	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.
	Connections
	Channel
UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller.
	TX
Pin to be used for Transmit data
	RX
Pin to be used for Receive data
	Reset Pin
I/O pin connected to the reset signal on the gLCD
	High Speed
Determines if the baud rate is automaticaly switched from 9600 baud on initialise to 57600 baud. Only available in hardware mode.
	Baud Options
Baud rate option selector
	Baud Rate
	Simulation
	Component Label
	Component Label Scale
The label scale can be change if the amout of text is too wide for the display
	Physical Orientation
Rotates the simulated canvas to match the orientation of real world hardware.
	Simulation Mode
	Scope Traces
Selects if the scope traces are automatically added to the data recorder window or not. Simulation - draws an approximation of the UART data onto the scope trace. ICT - sets up the scope trace for incoming data and adds UART packet decoding at the correct BAUD.
	Console Data
Selects if the console data is automatically generated or not
	Console Columns
Number of characters that can be displayed on a single line of the console.
	Data Source
Simulation data source used to allow the component to connect to various remote devices Nothing - Simulation data is ignored COM port - Routes the communication data to and from a physical or virtual COM port Injector - Routes the communication data via a data injector component on the Panel.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_API_Display_4D_Picaso2.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_API_Display_4D_Picaso2.fcfx