Component: LCD (Generic, Configurable) ()

Author	Matrix Ltd
Version	1.1
Category

LCD (Generic, Configurable) component

LCD based on the standard hitachi alphanumeric display unit.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Downloadable macro reference

	PrintAscii
Takes the ascii value for a character and prints the character
- BYTE	character
Holds an ascii value.
- VOID	Return

	PrintNumber
Based on v5 macro, will allow you to print a number. This is limited to a signed-INT, -32768 to 32767
[[File:]] -	Number
Enter the number or variable to print to the LCD
- VOID	Return

	RAMWrite
Modifies the internal memory of the LCD to allow for up to 8 customised characters to be created and stored in the device memory
- BYTE	Index
Values 0 to 7
- BYTE	d0
- BYTE	d1
- BYTE	d2
- BYTE	d3
- BYTE	d4
- BYTE	d5
- BYTE	d6
- BYTE	d7
- VOID	Return

	ClearLine
Clears a single line on the display and then moves the cursor to the start of the line to allow you to start populating the line with data.
- BYTE	Line
The line to clear, zero being the first (top) line of the display
- VOID	Return

	Cursor
Moves the cursor on the LCD Display
- BYTE	x
Set the cursor position in the X plane, 0 is the left most cell
- BYTE	y
Set the cursor position in the Y plane, 0 is the top most cell
- VOID	Return

	Command
Use this method/macro to send a specific command to the LCD. Refer to the Matrix Multimedia EB006 datasheet for a list of supported instructions. For Non-Matrix LCD's refer to the manufacturers datasheet.
- BYTE	instruction
Send a defined command to the LCD Screen. See datasheet for supported commands.
- VOID	Return

	PrintFormattedNumber
Will allow you to print a number up to 32-bits with signed or unsigned formatting. Signed = -2147483648 to 2147483647 Unsigned = 0 to 4294967295
- ULONG	Number
Enter the number or variable to print to the LCD
[[File:]] -	Format
0=Signed, 1=Unsigned
- VOID	Return

	ScrollDisplay
Scrolls the display left or right by a number of given positions.
- BYTE	Position
Holds the number of positions to shift the display
- BYTE	Direction
0 = left, 1 = right
- VOID	Return

	RawSend
Sends data to the LCD display
- BYTE	data
The data byte to send to the LCD
[[File:]] -	type
A boolean to indicate command type: true to write data, false to write a command
- VOID	Return

	RemapCharacter
Assigns a remap character allowing the PrintString function to automatically swap between pre-defined characters. The characters can be custom (in the range 0-9) or can point to an existing character in the LCD character map.
- BYTE	RemapIdx
Remap Index, Range: 0 to (Remap Characters - 1)
- BYTE	SearchCharacter
Character to look for a replace
- BYTE	ReplacementCharacter
New character value to use in place of the search character.
- VOID	Return

	Start
Startup routine required by the hardware device. Automatically clears the display after initialising.
- 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

	InvertDisplay
- 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
	Rows
Number of lines of characters the LCD can display.
	Columns
Number of characters the LCD can display on a single line.
	Remap Characters
Used to allow characters to be replaced with alternate characters. Custom characters or characters from the LCD memory map can be used as replacements. Each replacement consumes two bytes of RAM memory and is applied automatically when printing strings.
	Delay Timings
Delay in microseconds used in the display send function. Most displays will work with the default value of 100us. Some displays may need a slightly longer delay, 166us is known to work well.
	Background Color
Simulation only background colour, the actual hardware will have a fixed colour
	Line Color
Simulation only line colour, the actual hardware will have a fixed colour
	Text Color
Simulation only text colour, the actual hardware will have a fixed colour
	Font
Font to use for simulation, the actual hardware will have a inbuilt fixed font.
	Connections
	Interface mode
Choose between 4-bit mode, 8-bit mode and 8-bit mode using a port instead of individual pins to improve code efficiency.
	Data 0 (11 / 7)
Data pin 0 - Connects to Data 4 on the hardware in 4-bit mode or Data 0 in 8-bit mode
	Data 1 (12 / 8)
Data pin 1 - Connects to Data 5 on the hardware in 4-bit mode or Data 1 in 8-bit mode
	Data 2 (13 / 9)
Data pin 2 - Connects to Data 6 on the hardware in 4-bit mode or Data 2 in 8-bit mode
	Data 3 (14 / 10)
Data pin 3 - Connects to Data 7 on the hardware in 4-bit mode or Data 3 in 8-bit mode
	Register Select (4)
Register Select Pin - Informs the display if a command or data is about to be sent.
	Enable (6)
Enable pin - Used to synchronise data writes to the display
	Use Read/Write Pin
Set to "true" if the displays R/W pin is not hard wired. Set to "false" if the R/W pin is wired to ground.
	Simulations