Component: LCD (Grove UART) (Misc)
| Author | Matrix Ltd |
| Version | 2.0 (Release) |
| Category | Misc |
| This inherits from LCD control | |
Contents
LCD (Grove _ UART) component
Standard alphanumeric LCD based on the Grove display module.
Examples
No additional examples
Downloadable macro reference
Clear
No additional information
Parameters
- This macro has no parameters
Return value
- This call does not return a value
PrintString
No additional information
Parameters
- <- STRING Text
- This parameter may be returned back to the caller
Return value
- This call does not return a value
PrintAscii
Takes the ascii value for a character and prints the character
Parameters
- BYTE character
Return value
- This call does not return a value
PrintNumber
Allows you to print a number. This is limited to a signed-INT, -32768 to 32767
Parameters
- INT Number
Return value
- This call does not return a value
BacklightControl
No additional information
Parameters
- BYTE State
- 0=Backlight Off, 1=Backlight On
Return value
- This call does not return a value
ClearLine
No additional information
Parameters
- BYTE Line
Return value
- This call does not return a value
Cursor
Moves the cursor on the LCD Display
Parameters
- BYTE x
- BYTE y
Return value
- This call does not return a value
ScrollDisplay
Scrolls the display left or right by a number of given positions.
Parameters
- BYTE position
- Number of positions to scroll the display
- BYTE direction
- Direction to scroll the display: 0=Left, 1=Right
Return value
- This call does not return a value
Start
Startup routine required by the hardware device.
Parameters
- This macro has no parameters
Return value
- This call does not return a value
Simulation macro reference
This component inherits simulation macros from LCD control
Clear
No additional information
This call is provided by LCD control
Parameters
- This macro has no parameters
Return value
- This call does not return a value
AddChar
Adds a text character to the LCD at a given position
This call is provided by LCD control
Parameters
- INT X
- X location of the text to add
- INT Y
- Y location of the text to add
- BYTE Text
- The text character to add
Return value
- This call does not return a value
GetScrollX
Gets the scroll position in X set by SetScrollX()
This call is provided by LCD control
Parameters
- This macro has no parameters
Return value
SetScrollX
Sets the scroll offset in X of the LCD
This call is provided by LCD control
Parameters
- UINT Pos
Return value
- This call does not return a value
AddText
Adds a text string to the LCD at a given position
This call is provided by LCD control
Parameters
- INT X
- X location of the text to add
- INT Y
- Y location of the text to add
- STRING Text
- The text to add
Return value
- This call does not return a value
SetSize
Sets the size of the LCD grid
This call is provided by LCD control
Parameters
- BYTE X
- The number of X cells
- BYTE Y
- The number of Y cells
Return value
- This call does not return a value
Property reference
Rows
This property is of type Fixed list of ints and can be referenced with the variable name Rows.
No additional information
Columns
This property is of type Fixed list of ints and can be referenced with the variable name Columns.
No additional information
Channel
This property is of type Fixed list of ints and can be referenced with the variable name cal_uart::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
This property is of type Single digital pin and can be referenced with the variable name cal_uart::TX.
Pin to be used for Transmit data
Use RX
This property is of type True or false and can be referenced with the variable name cal_uart::UseRX.
Selects if the Receive pin is used by the component.
Yes: The RX pin is active and used to receive data for the UART.
No: The RX pin is disabled and free to be used as general I/O.
Baud Options
This property is of type Fixed list of ints and can be referenced with the variable name cal_uart::BAUD_LIST.
Baud rate option selector
Baud Rate
This property is of type Signed integer and can be referenced with the variable name cal_uart::BAUD.
No additional information
Scope Traces
This property is of type True or false and can be referenced with the variable name cal_uart::ScopeTraces.
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
This property is of type True or false and can be referenced with the variable name cal_uart::ConsoleData.
Selects if the console data is automatically generated or not
Console Columns
This property is of type Unsigned integer and can be referenced with the variable name cal_uart::ConsoleColumns.
Number of characters that can be displayed on a single line of the console.
Data Source
This property is of type Fixed list of ints and can be referenced with the variable name cal_uart::DataSource.
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.
