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

From Flowcode Help
Jump to navigationJump to search
 
(11 intermediate revisions by one other user not shown)
Line 5: Line 5:
 
|-
 
|-
 
| width="20%" style="color:gray;" | Version
 
| width="20%" style="color:gray;" | Version
−
| 1.0
+
| 2.0
 
|-
 
|-
 
| width="20%" style="color:gray;" | Category
 
| 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.
 
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 for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_ConsoleWriter.fcfx FC_Comp_Source_ConsoleWriter.fcfx]
+
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==
 
==Detailed description==
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
  
Line 38: Line 51:
  
 
==Examples==
 
==Examples==
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
  
Line 49: Line 74:
 
{{Fcfile|Logging_Example.fcsx|Logging Example}}
 
{{Fcfile|Logging_Example.fcsx|Logging Example}}
  
−
==Downloadable macro reference==
 
  
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
==Macro reference==
 +
 +
===AddString===
 +
{| 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;" | '''AddString'''
 +
|-
 +
| colspan="2" | Adds text string to the end of the console window. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
===Clear===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 64: Line 138:
  
  
 +
===ClearFromCursorToLineEnd===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CountLines'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ClearFromCursorToLineEnd'''
 
|-
 
|-
−
| colspan="2" | Counts the number of lines in the console. 
+
| colspan="2" | Clears the contents of the current selected line from the cursor position to the end of the line. 
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
+
| 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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
 +
===ClearFromLineStartToCursor===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AddString'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ClearFromLineStartToCursor'''
 
|-
 
|-
−
| colspan="2" | Adds text string to the console window. 
+
| 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. 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 
−
| width="90%" | Data
 
 
|-
 
|-
−
| colspan="2" |  
 
 
|-
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 95: Line 166:
  
  
 +
===ClearLine===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetTextLine'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ClearLine'''
 
|-
 
|-
−
| colspan="2" | Sets the string data from a specific line in the console. 
+
| colspan="2" | Clears all data from a specific line. Automatically sets the cursor to the start of the line. 
 
|-
 
|-
 
|-
 
|-
Line 108: Line 180:
 
| colspan="2" | Line number, -1 for the last line. 
 
| colspan="2" | Line number, -1 for the last line. 
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
+
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
−
| width="90%" | Data
+
| 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. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
 +
| width="90%" | CharacterCount
 
|-
 
|-
−
| colspan="2" |  
+
| colspan="2" | Number of characters to remove 
 
|-
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 118: Line 204:
  
  
 +
===CountLines===
 +
{| 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;" | '''CountLines'''
 +
|-
 +
| colspan="2" | Counts the number of lines in the console. 
 +
|-
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 +
 +
===GetTextLine===
 +
{| 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;" | '''GetTextLine'''
 +
|-
 +
| colspan="2" | Gets the string data from a specific line in the console. 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
 +
| width="90%" | Line
 +
|-
 +
| colspan="2" | Line number, -1 for the last line. 
 +
|-
 +
| 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''
 +
|}
 +
 +
 +
===SetColour===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 146: Line 266:
  
  
 +
===SetColourIdx===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 164: Line 285:
  
  
 +
===SetCursorPosition===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ShowConsole'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetCursorPosition'''
 +
|-
 +
| colspan="2" | Sets the position of the cursor 
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
 +
| width="90%" | Column
 +
|-
 +
| colspan="2" | Character position along the line, starting from 0 
 
|-
 
|-
−
| colspan="2" | Pops up the console window and shows the correct tab. 
+
| width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG
 +
| width="90%" | Line
 
|-
 
|-
 +
| colspan="2" | Line number, -1 for the last line. 
 
|-
 
|-
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
Line 177: Line 309:
  
  
 +
===SetTextLine===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
−
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetTextLine'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetTextLine'''
 
|-
 
|-
−
| colspan="2" | Gets the string data from a specific line in the console. 
+
| colspan="2" | Sets the string data from a specific line in the console. 
 
|-
 
|-
 
|-
 
|-
Line 190: Line 323:
 
| colspan="2" | Line number, -1 for the last line. 
 
| colspan="2" | Line number, -1 for the last line. 
 
|-
 
|-
−
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
+
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Data
 +
|-
 +
| colspan="2" |  
 +
|-
 +
| 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''
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
|}
 
|}
  
  
 +
===ShowConsole===
 +
{| 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;" | '''ShowConsole'''
 +
|-
 +
| colspan="2" | Pops up the console window and shows the correct tab. 
 +
|-
 +
|-
 +
| 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 279: Line 429:
 
| colspan="2" | Defines the colour of the time stamp text 
 
| colspan="2" | Defines the colour of the time stamp text 
 
|}
 
|}
 +
 +
==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]

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.

FC6 Icon.png Logging Example






Macro reference

AddString

Fc9-comp-macro.png AddString
Adds text string to the end of the console window. 
Fc9-string-icon.png - STRING Data
 
Fc9-void-icon.png - VOID Return


AddStringAtCursor

Fc9-comp-macro.png AddStringAtCursor
Adds text string to the current cursor position. 
Fc9-string-icon.png - STRING Data
 
Fc9-void-icon.png - VOID Return


Clear

Fc9-comp-macro.png Clear
Clears the contents of the console tab. 
Fc9-void-icon.png - VOID Return


ClearFromCursorToLineEnd

Fc9-comp-macro.png ClearFromCursorToLineEnd
Clears the contents of the current selected line from the cursor position to the end of the line. 
Fc9-void-icon.png - VOID Return


ClearFromLineStartToCursor

Fc9-comp-macro.png 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. 
Fc9-void-icon.png - VOID Return


ClearLine

Fc9-comp-macro.png ClearLine
Clears all data from a specific line. Automatically sets the cursor to the start of the line. 
Fc9-s32-icon.png - LONG Line
Line number, -1 for the last line. 
Fc9-void-icon.png - VOID Return


ClearXCharsFromCursorPosition

Fc9-comp-macro.png ClearXCharsFromCursorPosition
Clears the specified number of characters starting from the cursor position. 
Fc9-u16-icon.png - UINT CharacterCount
Number of characters to remove 
Fc9-void-icon.png - VOID Return


CountLines

Fc9-comp-macro.png CountLines
Counts the number of lines in the console. 
Fc9-u32-icon.png - ULONG Return


GetTextLine

Fc9-comp-macro.png GetTextLine
Gets the string data from a specific line in the console. 
Fc9-s32-icon.png - LONG Line
Line number, -1 for the last line. 
Fc9-string-icon.png - STRING Return


SetColour

Fc9-comp-macro.png SetColour
Allows for full RGB colour selection 
Fc9-u8-icon.png - BYTE R
Colour channel, Range: 0-255 
Fc9-u8-icon.png - BYTE G
Colour channel, Range: 0-255 
Fc9-u8-icon.png - BYTE B
Colour channel, Range: 0-255 
Fc9-void-icon.png - VOID Return


SetColourIdx

Fc9-comp-macro.png SetColourIdx
Sets the text colour from the properties selection of colours. 
Fc9-u8-icon.png - BYTE Index
Range: 0-3 
Fc9-void-icon.png - VOID Return


SetCursorPosition

Fc9-comp-macro.png SetCursorPosition
Sets the position of the cursor 
Fc9-s32-icon.png - LONG Column
Character position along the line, starting from 0 
Fc9-s32-icon.png - LONG Line
Line number, -1 for the last line. 
Fc9-void-icon.png - VOID Return


SetTextLine

Fc9-comp-macro.png SetTextLine
Sets the string data from a specific line in the console. 
Fc9-s32-icon.png - LONG Line
Line number, -1 for the last line. 
Fc9-string-icon.png - STRING Data
 
Fc9-void-icon.png - VOID Return


ShowConsole

Fc9-comp-macro.png ShowConsole
Pops up the console window and shows the correct tab. 
Fc9-void-icon.png - VOID Return


Property reference

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

Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Console_Writer_(Indicators)&oldid=40901"