Component: Panel Console Viewer (Runtime Tools)
| Author | Matrix Ltd |
| Version | 1.1 |
| Category | Runtime Tools |
Panel Console Viewer component
An easy way to display the data from up to four console windows on the panel.
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Downloadable macro reference
|
SetText |
| Allows the selected text to be specified. | |
 - BYTE
|
Item |
| 0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4 | |
 - STRING
|
Text |
 - VOID
|
Return |
|
|
GetText |
| Allows the selected text to be read back. | |
| - BYTE
|
Item |
| 0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4 | |
| - STRING
|
Return |
|
|
AssignConsoleHandle |
| Assigns a specific console handle to one of the text fields. | |
| - BYTE
|
Item |
| 1=Col1, 2=Col2, 3=Col3, 4=Col4 | |
| [[File:]] - | ConsoleHandle |
| - VOID
|
Return |
|
|
SetColor |
| Sets the selected item's color. | |
| - BYTE
|
Item |
| 0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4, 5=Border | |
 - ULONG
|
Color |
| - VOID
|
Return |
|
|
AppendText |
| Allows the text to be appended to without overwriting any existing text. | |
| - BYTE
|
Item |
| 0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4 | |
| - STRING
|
Text |
| - BYTE
|
AppendType |
| 0=Start of Text, 1=End of Text | |
| - VOID
|
Return |
|
|
CheckBuffer |
| Returns the number of values in the transmit or receive buffer | |
| [[File:]] - | Buffer |
| 0=Transmit / 1=Receive | |
 - UINT
|
Return |
|
|
ReceiveString |
| Gets a string from the receive buffer | |
| - UINT
|
MaxChars |
| - UINT
|
Timeout |
| Time in milliseconds to wait for data | |
| - STRING
|
Return |
|
|
Initialise |
| Initialises the UART component pins ready to send and receive data | |
| - VOID
|
Return |
|
|
ReceiveByteArray |
| Receives an array of bytes and returns the number of bytes received. | |
| - BYTE
|
Data |
| A byte array variable to hold the received data | |
| - UINT
|
NumBytes |
| Maximum number of bytes to try and receive | |
| - UINT
|
Timeout |
| Max amount of time in ms to wait between bytes | |
| - UINT
|
Return |
|
|
ReceiveString |
| Receives a string of bytes and returns the number of bytes received. | |
| - STRING
|
StringData |
| - UINT
|
NumBytes |
| Maximum number of bytes to try and receive | |
| - UINT
|
Timeout |
| Max amount of time in ms to wait between bytes | |
| - BYTE
|
Return |
|
|
Uninit |
| Un-initialize the UART and release the resources | |
| - VOID
|
Return |
|
|
GetList |
| Gets Named property List | |
| - STRING
|
Name |
| - STRING
|
Return |
|
|
Delay |
| Software UART Bit Delay | |
| - VOID
|
Return |
|
|
SetValue |
| set Value of Named property | |
| - STRING
|
Name |
| - STRING
|
Value |
| - VOID
|
Return |
|
|
Uninit |
| Un-initialize the UART and release the resources | |
| - VOID
|
Return |
|
|
GetList |
| Gets Named property List | |
| - STRING
|
Name |
| - STRING
|
Return |
|
|
ReceiveByteArray |
| Receives an array of bytes and returns the number of bytes received. | |
| - BYTE
|
Data |
| - BYTE
|
NumBytes |
| Maximum number of bytes to try and receive | |
| - BYTE
|
Timeout |
| Max amount of time in ms to wait between bytes | |
| - BYTE
|
Return |
|
|
ReceiveString |
| Receives a string of bytes and returns the number of bytes received. | |
| - STRING
|
StringData |
| - BYTE
|
NumBytes |
| Maximum number of bytes to try and receive | |
| - BYTE
|
Timeout |
| Max amount of time in ms to wait between bytes | |
| - BYTE
|
Return |
|
|
GetList |
| returns Named property list | |
| - STRING
|
Name |
| - STRING
|
Return |
Property reference
|
Properties |
|
Width |
| Width of the console ripper component. | |
|
|
Height |
| Heigth of the console ripper component. | |
|
|
Title Size |
| Size applied to the title text font. | |
|
|
Text Size |
| Size applied to the data text font. | |
|
Number Columns |
| Sets the maximum number of consoles that can be displayed by the component. | |
|
Title Color |
| Sets the colour of the title text. | |
|
|
Text1 Color |
| Sets the colour of the data text 1. | |
|
|
Text2 Color |
| Sets the colour of the data text 2. | |
|
|
Border Color |
| Sets the colour of the border. | |
|
Show Title |
| Decides if the title text is displayed. | |
|
|
Clear Old Data |
| Removes old data from the console viewer when starting simulation if active. | |
|
Connections |
|
|
Simulations |