Component: Tone Generator (Runtime Tools): Difference between revisions

Latest revision as of 14:23, 13 July 2026

Author	Matrix TSL
Version	1.0
Category	Runtime Tools

Tone Generator component

A component to generate simple mono tone audio tones for use in alarms or other audible feedback.

Component Source Code

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

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

PlayTone

	PlayTone
Blocking call that plays a tone for a specific period of time.
- BYTE	Tone
0=Off, 1=C, 2=C#, 3=D, 4=D#, 5=E, 5=F, 6=F#, 7=G, 8=G#, 9=A, 10=A#, 11=B, 12=C
- UINT	Delay
delay in milliseconds
- VOID	Return

SetTone

	SetTone
Sets the output tone without blocking for the tone to end To end the note the macro must be called again with the tone paramete set to 0.
- BYTE	Tone
0=Off, 1=C, 2=C#, 3=D, 4=D#, 5=E, 5=F, 6=F#, 7=G, 8=G#, 9=A, 10=A#, 11=B, 12=C
- VOID	Return

Property reference

	Properties

@@ Line 15: / Line 15: @@
 A component to generate simple mono tone audio tones for use in alarms or other audible feedback.
-==Component Pack==
+==Component Source Code==
-FREE
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_ToneOutput.fcfx FC_Comp_Source_ToneOutput.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_ToneOutput.fcfx FC_Comp_Source_ToneOutput.fcfx]
 ==Detailed description==
@@ Line 32: / Line 48: @@
 ==Examples==
@@ Line 45: / Line 75: @@
-==Downloadable macro reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+==Macro reference==
+===PlayTone===
+{| 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;" | '''PlayTone'''
+| width="90%" class="mtx-class-macrohead" | '''PlayTone'''
 |-
 | colspan="2" | Blocking call that plays a tone for a specific period of time.&nbsp;
@@ Line 70: / Line 111: @@
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+===SetTone===
+{| 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;" | '''SetTone'''
+| width="90%" class="mtx-class-macrohead" | '''SetTone'''
 |-
 | colspan="2" | Sets the output tone without blocking for the tone to end To end the note the macro must be called again with the tone paramete set to 0.&nbsp;
@@ Line 86: / Line 128: @@
 | 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="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
-|-
-|-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Connections'''
-|-
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Simulations'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
 |}

SteveT (talk | contribs)