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 1: / Line 1: @@
+{| style="width:50%"
-{| width="50%"
 |-
-| width="20%" style="color: gray;" | Author
+| width="20%" style="color:gray;" | Author
 | 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
 | 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: [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==
-==[[File:Component Icon 51ad4fb4_3b45_4cd0_a74c_87311de8d3a2.png|Image]] Tone Generator component==
-A component to generate simple mono tone audio tones for use in alarms or other audible feedback.
+''No detailed description exists yet for this component''
 ==Examples==
-''<span style="color:red;">No additional examples</span>''
-==Downloadable macro reference==
-''This component does not contain any downloadable macros''
-==Simulation macro reference==
-===<span style="font-weight: normal;"><u><tt>PlayTone</tt></u></span>===
-Blocking call that plays a tone for a specific period of time.
-'''Parameters'''
-:[[Variable Types|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
-:[[Variable Types|UINT]] ''Delay''
-::delay in milliseconds
-'''Return value'''
-:''This call does not return a value''
-===<span style="font-weight: normal;"><u><tt>SetTone</tt></u></span>===
-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.
-'''Parameters'''
-:[[Variable Types|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
-'''Return value'''
-:''This call does not return a value''
+''<span style="color:red;">No additional examples</span>''
+==Macro reference==
+===PlayTone===
+{| class="mtx-class-macrotable wikitable"
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''PlayTone'''
+|-
+| colspan="2" | Blocking call that plays a tone for a specific period of time.&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Tone
+|-
+| colspan="2" | 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&nbsp;
+|-
+| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
+| width="90%" | Delay
+|-
+| colspan="2" | delay in milliseconds&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''
+|}
+===SetTone===
+{| class="mtx-class-macrotable wikitable"
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| 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;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" | Tone
+|-
+| colspan="2" | 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&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==
-''This component does not contain any properties''
+{| class="mtx-class-macrotable wikitable"
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
+|-
+|}

SteveT (talk | contribs)