Difference between revisions of "Component: Panel Console Viewer (Runtime Tools)"

Latest revision as of 13:09, 7 February 2023

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.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

AppendText

	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

AssignConsoleHandle

	AssignConsoleHandle
Assigns a specific console handle to one of the text fields.
- BYTE	Item
1=Col1, 2=Col2, 3=Col3, 4=Col4
- HANDLE	ConsoleHandle

- VOID	Return

GetText

	GetText
Allows the selected text to be read back.
- BYTE	Item
0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4
- STRING	Return

SetColor

	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

SetText

	SetText
Allows the selected text to be specified.
- BYTE	Item
0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4
- STRING	Text

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

Difference between revisions of "Component: Panel Console Viewer (Runtime Tools)"

Latest revision as of 13:09, 7 February 2023

Contents

Panel Console Viewer component

Component Source Code

Detailed description

Examples

Macro reference

AppendText

AssignConsoleHandle

GetText

SetColor

SetText

Property reference

Navigation menu

Page actions

Page actions

Personal tools

Navigation

Search

Tools

@@ Line 14: / Line 14: @@
 ==Panel Console Viewer component==
 An easy way to display the data from up to four console windows on the panel.
+==Component Source Code==
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_DynamicTextField.fcfx FC_Comp_Source_DynamicTextField.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_DynamicTextField.fcfx FC_Comp_Source_DynamicTextField.fcfx]
 ==Detailed description==
@@ Line 24: / Line 74: @@
 ==Examples==
@@ Line 33: / Line 127: @@
-==Downloadable macro reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetText'''
-|-
-| colspan="2" | Allows the selected text to be specified.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Item
-|-
-| colspan="2" | 0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
-| width="90%" | Text
-|-
-| colspan="2" | &nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetText'''
-|-
-| colspan="2" | Allows the selected text to be read back.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Item
-|-
-| colspan="2" | 0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AssignConsoleHandle'''
-|-
-| colspan="2" | Assigns a specific console handle to one of the text fields.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Item
-|-
-| colspan="2" | 1=Col1, 2=Col2, 3=Col3, 4=Col4&nbsp;
-|-
-| width="10%" align="center" | [[File:]] -
-| width="90%" | ConsoleHandle
-|-
-| colspan="2" | &nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetColor'''
-|-
-| colspan="2" | Sets the selected item's color.&nbsp;
-|-
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Item
-|-
-| colspan="2" | 0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4, 5=Border&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" | Color
-|-
-| colspan="2" | &nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
+==Macro reference==
+===AppendText===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 150: / Line 178: @@
+===AssignConsoleHandle===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetOffset'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AssignConsoleHandle'''
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | Assigns a specific console handle to one of the text fields.&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
+| width="90%" | Item
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| colspan="2" | 1=Col1, 2=Col2, 3=Col3, 4=Col4&nbsp;
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveString'''
 |-
-| colspan="2" | Gets a string from the receive buffer&nbsp;
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
-|-
+| width="90%" | ConsoleHandle
-|-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | MaxChars
 |-
 | colspan="2" | &nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | Timeout
-|-
-| colspan="2" | Time in milliseconds to wait for data&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
-|-
-| colspan="2" | Initialises the UART component pins ready to send and receive data&nbsp;
-|-
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 199: / Line 202: @@
+===GetText===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReceiveString'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetText'''
 |-
-| colspan="2" | Receives a string of bytes and returns the number of bytes received.&nbsp;
+| colspan="2" | Allows the selected text to be read back.&nbsp;
 |-
 |-
-| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | StringData
+| width="90%" | Item
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | 0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
-| width="90%" | NumBytes
-|-
-| colspan="2" | Maximum number of bytes to try and receive&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
-| width="90%" | Timeout
-|-
-| colspan="2" | Max amount of time in ms to wait between bytes&nbsp;
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
+===SetColor===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Start'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetColor'''
 |-
-| colspan="2" | Startup routine required by the hardware device. Automatically clears the display after initialising.&nbsp;
+| colspan="2" | Sets the selected item's color.&nbsp;
-|-
-|-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLEDState'''
-|-
-| colspan="2" | Sets the state of a single LED&nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Port
+| width="90%" | Item
 |-
-| colspan="2" | 0 = PortA, 1 = PortB&nbsp;
+| colspan="2" | 0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4, 5=Border&nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-| width="90%" | LED
+| width="90%" | Color
-|-
-| colspan="2" | 0 = LED0, 7 = LED7&nbsp;
-|-
-| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | State
 |-
 | colspan="2" | &nbsp;
@@ Line 268: / Line 245: @@
+===SetText===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
 | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetRxIdent'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetText'''
 |-
-| colspan="2" | Gets the Rx ID as a Integer Standard and Extended IDs.&nbsp;
+| colspan="2" | Allows the selected text to be specified.&nbsp;
 |-
 |-
 | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-| width="90%" | Buffer
+| width="90%" | Item
 |-
-| colspan="2" | &nbsp;
+| colspan="2" | 0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4&nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
-| width="90%" style="border-top: 2px solid #000;" | ''Return''
+| width="90%" | Text
-|}
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
-|-
-| colspan="2" | Must be called before any other CAN component macros to enable and initialise the CAN peripheral. &nbsp;
 |-
+| colspan="2" | &nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 | width="90%" style="border-top: 2px solid #000;" | ''Return''
 |}
@@ Line 363: / Line 331: @@
 |-
 | colspan="2" | Removes old data from the console viewer when starting simulation if active.&nbsp;
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''
-|-
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''
-|-
 |}