Difference between revisions of "Component: Simulation External Input (Runtime Tools)"

From Flowcode Help
Jump to navigationJump to search
Line 17: Line 17:
 
==Component Source Code==
 
==Component Source Code==
  
−
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_Sim_External_Input.fcfx FC_Comp_Source_Sim_External_Input.fcfx]
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/Sim_External_Input.fcfx FC_Comp_Source_temp/Sim_External_Input.fcfx]
  
−
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_Sim_External_Input.fcfx FC_Comp_Source_Sim_External_Input.fcfx]
+
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/Sim_External_Input.fcfx FC_Comp_Source_temp/Sim_External_Input.fcfx]
  
 
==Detailed description==
 
==Detailed description==
Line 73: Line 73:
  
 
''<span style="color:red;">No additional examples</span>''
 
''<span style="color:red;">No additional examples</span>''
 +
 +
  
  
Line 114: Line 116:
  
  
−
===Set_Space===
+
===Set_Frequency===
 
{| 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;" | '''Set_Space'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Set_Frequency'''
 
|-
 
|-
−
| colspan="2" | Overrides the component property setting allowing for a variable frequency input or adjustable Space timings.&nbsp;
+
| colspan="2" | Allows the frequency to be changed on the fly&nbsp;
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
−
| width="90%" | Delay
+
| width="90%" | Frequency
 
|-
 
|-
−
| colspan="2" | Delay between transitiions in milliseconds.&nbsp;
+
| colspan="2" | &nbsp;
 
|-
 
|-
 
| 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 133: Line 135:
  
  
−
===Set_Pulse_Count===
+
===Set_Mark===
 
{| 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;" | '''Set_Pulse_Count'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Set_Mark'''
 
|-
 
|-
−
| colspan="2" | Overrides the number of pulses. The Pulse Count property needs to have an initial value > 0 to switch on the pulse counting mode.&nbsp;
+
| colspan="2" | Overrides the component property setting allowing for a variable frequency input or adjustable Mark timings.&nbsp;
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
+
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
−
| width="90%" | PulseCount
+
| width="90%" | Delay
 
|-
 
|-
−
| colspan="2" | Number of pulses to output&nbsp;
+
| colspan="2" | Delay between transitiions in milliseconds.&nbsp;
 
|-
 
|-
 
| 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 152: Line 154:
  
  
−
===Set_Frequency===
+
===Set_Pulse_Count===
 
{| 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;" | '''Set_Frequency'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Set_Pulse_Count'''
 
|-
 
|-
−
| colspan="2" | Allows the frequency to be changed on the fly&nbsp;
+
| colspan="2" | Overrides the number of pulses. The Pulse Count property needs to have an initial value > 0 to switch on the pulse counting mode.&nbsp;
 
|-
 
|-
 
|-
 
|-
−
| width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT
+
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
−
| width="90%" | Frequency
+
| width="90%" | PulseCount
 
|-
 
|-
−
| colspan="2" | &nbsp;
+
| colspan="2" | Number of pulses to output&nbsp;
 
|-
 
|-
 
| 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 171: Line 173:
  
  
−
===Set_Mark===
+
===Set_Space===
 
{| 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;" | '''Set_Mark'''
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Set_Space'''
 
|-
 
|-
−
| colspan="2" | Overrides the component property setting allowing for a variable frequency input or adjustable Mark timings.&nbsp;
+
| colspan="2" | Overrides the component property setting allowing for a variable frequency input or adjustable Space timings.&nbsp;
 
|-
 
|-
 
|-
 
|-

Revision as of 12:03, 3 February 2023

Author Matrix TSL
Version 1.1
Category Runtime Tools


Simulation External Input component

A simulation only component designed to allow a single digital pin to be toggled at a set frequency. Allows things like switch presses or external square waves to be used with the simulation.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_temp/Sim_External_Input.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/Sim_External_Input.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples





Macro reference

Control_Pulse

Fc9-comp-macro.png Control_Pulse
Controls if the toggle input is enabled or disabled allowing you to stop and start the waveform. 
Fc9-u8-icon.png - BYTE State
0=Disabled, 1=Enabled 
Fc9-void-icon.png - VOID Return


Get_Pulse_Count

Fc9-comp-macro.png Get_Pulse_Count
Reads the number of pulses remaining in the current run. The Pulse Count property needs to have an initial value > 0 to switch on the pulse counting mode. 
Fc9-u32-icon.png - ULONG Return


Set_Frequency

Fc9-comp-macro.png Set_Frequency
Allows the frequency to be changed on the fly 
Fc9-f32-icon.png - FLOAT Frequency
 
Fc9-void-icon.png - VOID Return


Set_Mark

Fc9-comp-macro.png Set_Mark
Overrides the component property setting allowing for a variable frequency input or adjustable Mark timings. 
Fc9-u16-icon.png - UINT Delay
Delay between transitiions in milliseconds. 
Fc9-void-icon.png - VOID Return


Set_Pulse_Count

Fc9-comp-macro.png Set_Pulse_Count
Overrides the number of pulses. The Pulse Count property needs to have an initial value > 0 to switch on the pulse counting mode. 
Fc9-u32-icon.png - ULONG PulseCount
Number of pulses to output 
Fc9-void-icon.png - VOID Return


Set_Space

Fc9-comp-macro.png Set_Space
Overrides the component property setting allowing for a variable frequency input or adjustable Space timings. 
Fc9-u16-icon.png - UINT Delay
Delay between transitiions in milliseconds. 
Fc9-void-icon.png - VOID Return



Property reference

Fc9-prop-icon.png Properties
Fc9-type-5-icon.png Pin
Pin to toggle - connected to the external waveform on the target hardware. 
Fc9-type-16-icon.png Startup Mode
Controls if the pulses start when the simulation is started or when the simulation Control_Pulse macro is called. 
Fc9-type-16-icon.png Mode
 
Fc9-type-15-icon.png Frequency (Hz)
Frequency to try and acheive. 
Fc9-type-21-icon.png Period Delay (ms)
Delay in milliseconds for a whole period of 0 and 1. 
Fc9-type-21-icon.png Mark Delay (ms)
Delay in milliseconds to wait to toggle the pin. Note that Windows can only acheive timings of 10ms or more. 
Fc9-type-21-icon.png Space Delay (ms)
 
Fc9-type-21-icon.png Pulse Count
Number of pulses to output. 0 = Run forever. > 0 = Output the selected number of pulses 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Simulation_External_Input_(Runtime_Tools)&oldid=36814"