Component: Tone Generator (Runtime Tools): Difference between revisions
No edit summary |
No edit summary |
||
| Line 16: | Line 16: | ||
==Component Source Code== | ==Component Source Code== | ||
Please click here to download the component source project: [https://www.flowcode.co.uk/wikicopy/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] | 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== | ==Detailed description== | ||
| Line 40: | Line 44: | ||
==Examples== | ==Examples== | ||
| Line 62: | Line 68: | ||
==Macro reference== | ==Macro reference== | ||
{| 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;" | '''PlayTone''' | |||
|- | |||
| colspan="2" | Blocking call that plays a tone for a specific period of time. | |||
|- | |||
|- | |||
| 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 | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | |||
| width="90%" | Delay | |||
|- | |||
| colspan="2" | delay in milliseconds | |||
|- | |||
| 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'' | |||
|} | |||
{| 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;" | '''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. | |||
|- | |||
|- | |||
| 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 | |||
|- | |||
| 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;" | |||
|- | |||
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | |||
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' | |||
|- | |||
|}==Macro reference== | |||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 15:25, 20 January 2023
| 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 |
| 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 |
| 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 |
==Macro reference==
|
|
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 |
| 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 |
==Macro reference==
|
|
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 |
| 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 |