Difference between revisions of "Component: Console Writer (Indicators)"

Latest revision as of 13:01, 2 July 2024

Author	Matrix TSL
Version	2.0
Category	Indicators

Console Writer component

A simple component to aid in creating and wiriting data to a console tab. Allows text to be coloured and automatically appended with a timestamp.

Version information

Library Version, Component Version, Date, Author, Info
4, 2.0, 02-07-24, BR, Added a load more functionality to the component related to cursor control

Detailed description

No detailed description exists yet for this component

Examples

A basic example using two circular knobs to simulate data e.g., temperature. Both xy chart and Console, log the data.

Logging Example

Macro reference

AddString

	AddString
Adds text string to the end of the console window.
- STRING	Data

- VOID	Return

AddStringAtCursor

	AddStringAtCursor
Adds text string to the current cursor position.
- STRING	Data

- VOID	Return

Clear

	Clear
Clears the contents of the console tab.
- VOID	Return

ClearFromCursorToLineEnd

	ClearFromCursorToLineEnd
Clears the contents of the current selected line from the cursor position to the end of the line.
- VOID	Return

ClearFromLineStartToCursor

	ClearFromLineStartToCursor
Clears the contents of the current selected line from the start of the line to the cursor position. Sets the Column position to 0.
- VOID	Return

ClearLine

	ClearLine
Clears all data from a specific line. Automatically sets the cursor to the start of the line.
- LONG	Line
Line number, -1 for the last line.
- VOID	Return

ClearXCharsFromCursorPosition

	ClearXCharsFromCursorPosition
Clears the specified number of characters starting from the cursor position.
- UINT	CharacterCount
Number of characters to remove
- VOID	Return

CountLines

	CountLines
Counts the number of lines in the console.
- ULONG	Return

GetTextLine

	GetTextLine
Gets the string data from a specific line in the console.
- LONG	Line
Line number, -1 for the last line.
- STRING	Return

SetColour

	SetColour
Allows for full RGB colour selection
- BYTE	R
Colour channel, Range: 0-255
- BYTE	G
Colour channel, Range: 0-255
- BYTE	B
Colour channel, Range: 0-255
- VOID	Return

SetColourIdx

	SetColourIdx
Sets the text colour from the properties selection of colours.
- BYTE	Index
Range: 0-3
- VOID	Return

SetCursorPosition

	SetCursorPosition
Sets the position of the cursor
- LONG	Column
Character position along the line, starting from 0
- LONG	Line
Line number, -1 for the last line.
- VOID	Return

SetTextLine

	SetTextLine
Sets the string data from a specific line in the console.
- LONG	Line
Line number, -1 for the last line.
- STRING	Data

- VOID	Return

ShowConsole

	ShowConsole
Pops up the console window and shows the correct tab.
- VOID	Return

Property reference

	Properties
	Console Name
Textual name of the console shown as the tab name at the top of the console window.
	Colour 0
Used to define a colour channel referenced by the SetColourIdx component macro call.
	Colour 1
Used to define a colour channel referenced by the SetColourIdx component macro call.
	Colour 2
Used to define a colour channel referenced by the SetColourIdx component macro call.
	Colour 3
Used to define a colour channel referenced by the SetColourIdx component macro call.
	New Line After Data
Automatically append a newline character after any data has been written to the console using the AddString component macro.
	Clear On Sim Start
Automatically clear the console tab when the simulation is started.
	Add Timestamp
Automatically adds a timestamp to the console after a newline character has been received.
	Timestamp
	Date Format
Specifies the format of the date string. No - "DD/MM/YY" Yes - "MM/DD/YY"
	Time Separator
Characters that are used in between the time digits
	Date Separator
Characters that are used in between the date digits
	TimeStamp Separator
Characters that are used between the time and date strings when returning a full time stamp.
	Override Colour
Overrides the current selected colour when writing the timestamp.
	Timestamp Colour
Defines the colour of the time stamp text

Component Source Code

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

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

@@ Line 5: / Line 5: @@
 |-
 | width="20%" style="color:gray;" | Version
-| 1.0
+| 2.0
 |-
 | width="20%" style="color:gray;" | Category
@@ Line 15: / Line 15: @@
 A simple component to aid in creating and wiriting data to a console tab. Allows text to be coloured and automatically appended with a timestamp.
-==Component Source Code==
+==Version information==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_ConsoleWriter.fcfx FC_Comp_Source_ConsoleWriter.fcfx]
-Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_ConsoleWriter.fcfx FC_Comp_Source_ConsoleWriter.fcfx]
+ Library Version, Component Version, Date, Author, Info
+, 2.0, 02-07-24, BR, Added a load more functionality to the component related to cursor control
 ==Detailed description==
@@ Line 93: / Line 92: @@
 | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AddString'''
 |-
-| colspan="2" | Adds text string to the console window.&nbsp;
+| colspan="2" | Adds text string to the end of the console window.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+| width="90%" | Data
+|-
+| 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''
+|}
+===AddStringAtCursor===
+{| 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;" | '''AddStringAtCursor'''
+|-
+| colspan="2" | Adds text string to the current cursor position.&nbsp;
 |-
 |-
@@ Line 114: / Line 132: @@
 | colspan="2" | Clears the contents of the console tab.&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''
+|}
+===ClearFromCursorToLineEnd===
+{| 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;" | '''ClearFromCursorToLineEnd'''
+|-
+| colspan="2" | Clears the contents of the current selected line from the cursor position to the end of the line.&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''
+|}
+===ClearFromLineStartToCursor===
+{| 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;" | '''ClearFromLineStartToCursor'''
+|-
+| colspan="2" | Clears the contents of the current selected line from the start of the line to the cursor position. Sets the Column position to 0.&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''
+|}
+===ClearLine===
+{| 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;" | '''ClearLine'''
+|-
+| colspan="2" | Clears all data from a specific line. Automatically sets the cursor to the start of the line.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
+| width="90%" | Line
+|-
+| colspan="2" | Line number, -1 for the last line.&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''
+|}
+===ClearXCharsFromCursorPosition===
+{| 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;" | '''ClearXCharsFromCursorPosition'''
+|-
+| colspan="2" | Clears the specified number of characters starting from the cursor position.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | CharacterCount
+|-
+| colspan="2" | Number of characters to remove&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 195: / Line 279: @@
 |-
 | colspan="2" | Range: 0-3&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''
+|}
+===SetCursorPosition===
+{| 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;" | '''SetCursorPosition'''
+|-
+| colspan="2" | Sets the position of the cursor&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
+| width="90%" | Column
+|-
+| colspan="2" | Character position along the line, starting from 0&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
+| width="90%" | Line
+|-
+| colspan="2" | Line number, -1 for the last line.&nbsp;
 |-
 | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
@@ Line 321: / Line 429: @@
 | colspan="2" | Defines the colour of the time stamp text&nbsp;
 |}
+==Component Source Code==
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_ConsoleWriter.fcfx FC_Comp_Source_ConsoleWriter.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_ConsoleWriter.fcfx FC_Comp_Source_ConsoleWriter.fcfx]