Component: Serial Monitor (Runtime Tools): Difference between revisions

Latest revision as of 14:23, 13 July 2026

Author	Matrix Ltd
Version	1.0
Category	Runtime Tools

Serial Monitor component

Allows data from a COM port to be piped through to the console window for easy program status and debugging.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

Here is a simple example showing how to pass data from a device such as an Arduino back into Flowcode for debugging purposes. The example is designed to run on an Arduino Uno R3 with an LED connected to pin D2 and a potentiometer connected to pin A0. The program loops switching the LED on and off and reporting the status to the console, the ADC is also sampled as a voltage string and this is also passed back to the console.

Serial Monitor Demo

The incoming data can be seen on the Flowcode console even when the simulation is not running.

Outgoing data can be sent back to the embedded hardware by typing data directly into the RX Queue tab of the console.

Macro reference

GetProp

	GetProp
Allows the property filter for the COM port list to be copied to a parent component.
- STRING	PropName

- STRING	Return

SetProp

	SetProp
Allows the COM port property to be set from a parent component.
- STRING	PropName

- ULONG	PropVal

- VOID	Return

Property reference

	Properties
	COM Port
Selects which port to communicate with, only lists ports which are currently available.
	Refresh COM Ports
When set to yes the COM port list is rescanned for newly connected or available ports. Note that refreshing the ports list may take a few seconds depending on the number of connected ports.
	Baud
Baud rate passed to the COM port to control the rate of data.
	Connection Type
Decides how to work with the COM port. Manual - Port needs to be manually opened and closed by the user. Port may become locked if left open. Port is automatically closed when programming. Automatic - Port handling is automatic but port may be left open when closing the project. Port is automatically closed when programming and reopened after 20 seconds.
	Connection
Port connection status. Closed - Port is unavailable and not in use. Open - Port is available for data communications.

@@ Line 68: / Line 68: @@
 [[File:ArdOutData.png]]
@@ Line 75: / Line 81: @@
 ==Macro reference==
-===SetProp===
+===GetProp===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetProp'''
+| width="90%" class="mtx-class-macrohead" | '''GetProp'''
 |-
-| colspan="2" | Allows the COM port property to be set from a parent component.&nbsp;
+| colspan="2" | Allows the property filter for the COM port list to be copied to a parent component.&nbsp;
 |-
 |-
@@ Line 89: / Line 95: @@
 | colspan="2" | &nbsp;
 |-
-| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
-| width="90%" | PropVal
-|-
-| 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''
 |}
-===GetProp===
+===SetProp===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetProp'''
+| width="90%" class="mtx-class-macrohead" | '''SetProp'''
 |-
-| colspan="2" | Allows the property filter for the COM port list to be copied to a parent component.&nbsp;
+| colspan="2" | Allows the COM port property to be set from a parent component.&nbsp;
 |-
 |-
@@ Line 113: / Line 114: @@
 | colspan="2" | &nbsp;
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="90%" | PropVal
+|-
+| 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''
 |}
 ==Property reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
 |-

SteveT (talk | contribs)