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

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(19 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix TSL
 
| Matrix TSL
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.0 (Release)
+
| 1.0
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Indicators
 
| 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.
  
−
==[[File:Component Icon 940e39a6_d035_4e43_8dbb_455ee4679066.png|Image]] Console Writer component==
+
==Component Source Code==
−
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.
 
  
−
==Examples==
+
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]
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
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]
  
−
==Downloadable macro reference==
+
==Detailed description==
  
−
''This component does not contain any downloadable macros''
 
  
−
==Simulation macro reference==
 
  
−
===<span style="font-weight: normal;"><u><tt>Clear</tt></u></span>===
 
−
Clears the contents of the console tab.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>CountLines</tt></u></span>===
 
−
Counts the number of lines in the console.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|ULONG]]
 
  
  
−
===<span style="font-weight: normal;"><u><tt>AddString</tt></u></span>===
 
−
Adds text string to the console window.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|<- STRING]] ''Data''
 
−
::''This parameter may be returned back to the caller''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>SetTextLine</tt></u></span>===
 
−
Sets the string data from a specific line in the console.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|LONG]] ''Line''
 
−
::Line number, -1 for the last line.
 
  
−
:[[Variable Types|<- STRING]] ''Data''
+
''No detailed description exists yet for this component''
−
::''This parameter may be returned back to the caller''
 
  
 +
==Examples==
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>SetColour</tt></u></span>===
 
−
Allows for full RGB colour selection
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''R''
 
−
::Colour channel, Range: 0-255
 
  
−
:[[Variable Types|BYTE]] ''G''
 
−
::Colour channel, Range: 0-255
 
  
−
:[[Variable Types|BYTE]] ''B''
 
−
::Colour channel, Range: 0-255
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>SetColourIdx</tt></u></span>===
 
−
Sets the text colour from the properties selection of colours.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''Index''
 
−
::Range: 0-3
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
+
A basic example using two circular knobs to simulate data e.g., temperature.
 +
Both xy chart and Console, log the data.
  
 +
{{Fcfile|Logging_Example.fcsx|Logging Example}}
  
−
===<span style="font-weight: normal;"><u><tt>GetTextLine</tt></u></span>===
 
−
Gets the string data from a specific line in the console.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|LONG]] ''Line''
 
−
::Line number, -1 for the last line.
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|STRING]]
 
  
  
  
  
−
==Property reference==
 
−
<span style="font-weight: normal;"><u>Console Name</u></span>
 
  
−
This property is of type ''Line of text'' and can be referenced with the variable name ''ConsoleName''.
+
==Macro reference==
  
−
''<span style="color:red;">No additional information</span>''
+
===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 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''
 +
|}
  
  
 +
===Clear===
 +
{| 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;" | '''Clear'''
 +
|-
 +
| 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''
 +
|}
  
−
<span style="font-weight: normal;"><u>Colour 0</u></span>
 
  
−
This property is of type ''Color picker'' and can be referenced with the variable name ''Colour0''.
+
===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.&nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
−
''<span style="color:red;">No additional information</span>''
 
  
 +
===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.&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-string-icon.png]] - STRING
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
−
<span style="font-weight: normal;"><u>Colour 1</u></span>
+
===SetColour===
 +
{| 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;" | '''SetColour'''
 +
|-
 +
| colspan="2" | Allows for full RGB colour selection&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | R
 +
|-
 +
| colspan="2" | Colour channel, Range: 0-255&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | G
 +
|-
 +
| colspan="2" | Colour channel, Range: 0-255&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | B
 +
|-
 +
| colspan="2" | Colour channel, Range: 0-255&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''
 +
|}
  
−
This property is of type ''Color picker'' and can be referenced with the variable name ''Colour1''.
 
  
−
''<span style="color:red;">No additional information</span>''
+
===SetColourIdx===
 +
{| 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;" | '''SetColourIdx'''
 +
|-
 +
| colspan="2" | Sets the text colour from the properties selection of colours.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Index
 +
|-
 +
| 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''
 +
|}
  
  
 +
===SetTextLine===
 +
{| 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;" | '''SetTextLine'''
 +
|-
 +
| colspan="2" | Sets the string data from a specific line in the console.&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" | [[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''
 +
|}
  
−
<span style="font-weight: normal;"><u>Colour 2</u></span>
 
  
−
This property is of type ''Color picker'' and can be referenced with the variable name ''Colour2''.
+
===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.&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''
 +
|}
  
−
''<span style="color:red;">No additional information</span>''
 
  
 +
==Property reference==
  
−
 
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
<span style="font-weight: normal;"><u>Colour 3</u></span>
+
|-
−
 
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
This property is of type ''Color picker'' and can be referenced with the variable name ''Colour3''.
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
 
+
|-
−
''<span style="color:red;">No additional information</span>''
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
 
+
| width="90%" | Console Name
−
 
+
|-
−
<span style="font-weight: normal;"><u>New Line After Data</u></span>
+
| colspan="2" | Textual name of the console shown as the tab name at the top of the console window.&nbsp;
−
 
+
|-
−
This property is of type ''True or false'' and can be referenced with the variable name ''NLAfterData''.
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
 
+
| width="90%" | Colour 0
−
''<span style="color:red;">No additional information</span>''
+
|-
−
 
+
| colspan="2" | Used to define a colour channel referenced by the SetColourIdx component macro call.&nbsp;
−
 
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
<span style="font-weight: normal;"><u>Clear On Sim Start</u></span>
+
| width="90%" | Colour 1
−
 
+
|-
−
This property is of type ''True or false'' and can be referenced with the variable name ''ClearOnSimStart''.
+
| colspan="2" | Used to define a colour channel referenced by the SetColourIdx component macro call.&nbsp;
−
 
+
|-
−
Automatically clear the console tab when the simulation is started.
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
 
+
| width="90%" | Colour 2
−
<span style="font-weight: normal;"><u>Add Timestamp</u></span>
+
|-
−
 
+
| colspan="2" | Used to define a colour channel referenced by the SetColourIdx component macro call.&nbsp;
−
This property is of type ''True or false'' and can be referenced with the variable name ''Timestamp''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
−
''<span style="color:red;">No additional information</span>''
+
| width="90%" | Colour 3
−
 
+
|-
−
 
+
| colspan="2" | Used to define a colour channel referenced by the SetColourIdx component macro call.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Date Format</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | New Line After Data
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''TimeStamp1::DateFormat''.
+
|-
−
 
+
| colspan="2" | Automatically append a newline character after any data has been written to the console using the AddString  component macro.&nbsp;
−
Specifies the format of the date string.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Clear On Sim Start
−
 
+
|-
−
No - "DD/MM/YY"  
+
| colspan="2" | Automatically clear the console tab when the simulation is started.&nbsp;
−
 
+
|-
−
Yes - "MM/DD/YY"
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Add Timestamp
−
<span style="font-weight: normal;"><u>Time Separator</u></span>
+
|-
−
 
+
| colspan="2" | Automatically adds a timestamp to the console after a newline character has been received.&nbsp;
−
This property is of type ''Line of text'' and can be referenced with the variable name ''TimeStamp1::TimeSeperator''.
+
|-
−
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
Characters that are used in between the time digits
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Timestamp
−
 
+
|-
−
<span style="font-weight: normal;"><u>Date Separator</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
This property is of type ''Line of text'' and can be referenced with the variable name ''TimeStamp1::DateSeparator''.
+
| width="90%" | Date Format
−
 
+
|-
−
Characters that are used in between the date digits
+
| colspan="2" | Specifies the format of the date string. No - "DD/MM/YY" Yes - "MM/DD/YY" &nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>TimeStamp Separator</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
 
+
| width="90%" | Time Separator
−
This property is of type ''Line of text'' and can be referenced with the variable name ''TimeStamp1::TimeStampSeparator''.
+
|-
−
 
+
| colspan="2" | Characters that are used in between the time digits&nbsp;
−
Characters that are used between the time and date strings when returning a full time stamp.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
<span style="font-weight: normal;"><u>Override Colour</u></span>
+
| width="90%" | Date Separator
−
 
+
|-
−
This property is of type ''True or false'' and can be referenced with the variable name ''OverrideColour''.
+
| colspan="2" | Characters that are used in between the date digits&nbsp;
−
 
+
|-
−
Overrides the current selected colour when writing the timestamp.
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
 
+
| width="90%" | TimeStamp Separator
−
<span style="font-weight: normal;"><u>Timestamp Colour</u></span>
+
|-
−
 
+
| colspan="2" | Characters that are used between the time and date strings when returning a full time stamp.&nbsp;
−
This property is of type ''Color picker'' and can be referenced with the variable name ''TimestampColour''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
''<span style="color:red;">No additional information</span>''
+
| width="90%" | Override Colour
 +
|-
 +
| colspan="2" | Overrides the current selected colour when writing the timestamp.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Timestamp Colour
 +
|-
 +
| colspan="2" | Defines the colour of the time stamp text&nbsp;
 +
|}

Latest revision as of 13:09, 7 February 2023

Author Matrix TSL
Version 1.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.

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

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 console window. 
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


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


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 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Console_Writer_(Indicators)&oldid=37849"