Difference between revisions of "Component: Frequency Generator (DSP)"
(XML import of component documentation) |
(XML import of components for release) |
||
| Line 16: | Line 16: | ||
==[[File:Component Icon cbe42abc_5955_44da_a6d0_03e7cbcdcaca.png|Image]] Frequency Generator component== | ==[[File:Component Icon cbe42abc_5955_44da_a6d0_03e7cbcdcaca.png|Image]] Frequency Generator component== | ||
| − | + | A frequency generator component designed to plug into the DSP system component and | |
| + | allow several discreet waveforms to be generated. | ||
==Examples== | ==Examples== | ||
| Line 25: | Line 26: | ||
===<span style="font-weight: normal;"><u><tt>GenerateTick</tt></u></span>=== | ===<span style="font-weight: normal;"><u><tt>GenerateTick</tt></u></span>=== | ||
| − | + | Assigns a single value to the specified buffer from the selected waveform data. Each call will read the next value from the waveform and will wrap correctly at the end of the data period. | |
| − | |||
| − | |||
'''Parameters''' | '''Parameters''' | ||
| Line 40: | Line 39: | ||
===<span style="font-weight: normal;"><u><tt>Generate</tt></u></span>=== | ===<span style="font-weight: normal;"><u><tt>Generate</tt></u></span>=== | ||
| − | + | Fills the specified buffer with the selected waveform data. If the buffer is smaller or larger then the waveform data period then the data passed will follow on correctly for subsequest cycles. | |
| − | |||
| − | |||
'''Parameters''' | '''Parameters''' | ||
| Line 65: | Line 62: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buffer_manager''. | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''buffer_manager''. | ||
| − | + | Selects the DSP buffer manager component | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Output</u></span> | <span style="font-weight: normal;"><u>Output</u></span> | ||
| Line 73: | Line 68: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''input_a''. | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''input_a''. | ||
| − | + | Selects the buffer to assign the waveform data to | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Type</u></span> | <span style="font-weight: normal;"><u>Type</u></span> | ||
| Line 81: | Line 74: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''wave_type''. | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''wave_type''. | ||
| − | + | Waveform type selection | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Amplitude</u></span> | <span style="font-weight: normal;"><u>Amplitude</u></span> | ||
| Line 89: | Line 80: | ||
This property is of type ''Signed integer'' and can be referenced with the variable name ''wave_amplitude''. | This property is of type ''Signed integer'' and can be referenced with the variable name ''wave_amplitude''. | ||
| − | + | Waveform amplitude or volume | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Offset</u></span> | <span style="font-weight: normal;"><u>Offset</u></span> | ||
| Line 97: | Line 86: | ||
This property is of type ''Signed integer'' and can be referenced with the variable name ''wave_offset''. | This property is of type ''Signed integer'' and can be referenced with the variable name ''wave_offset''. | ||
| − | + | Waveform DC offset | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Period</u></span> | <span style="font-weight: normal;"><u>Period</u></span> | ||
| Line 105: | Line 92: | ||
This property is of type ''Signed integer'' and can be referenced with the variable name ''wave_period''. | This property is of type ''Signed integer'' and can be referenced with the variable name ''wave_period''. | ||
| − | + | Waveform period, the number of samples in the cyclic wave | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Phase</u></span> | <span style="font-weight: normal;"><u>Phase</u></span> | ||
| Line 113: | Line 98: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''wave_phase''. | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''wave_phase''. | ||
| − | + | Waveform phase, the point in the wave to start streaming from | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Data</u></span> | <span style="font-weight: normal;"><u>Data</u></span> | ||
| Line 121: | Line 104: | ||
This property is of type ''Line of text'' and can be referenced with the variable name ''wave_data''. | This property is of type ''Line of text'' and can be referenced with the variable name ''wave_data''. | ||
| − | + | The raw waveform data | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Sample Rate (hz)</u></span> | <span style="font-weight: normal;"><u>Sample Rate (hz)</u></span> | ||
| Line 129: | Line 110: | ||
This property is of type ''Floating point'' and can be referenced with the variable name ''sample_rate''. | This property is of type ''Floating point'' and can be referenced with the variable name ''sample_rate''. | ||
| − | + | Allows the sample rate to be entered to allow some basic calculations | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Period (s)</u></span> | <span style="font-weight: normal;"><u>Period (s)</u></span> | ||
| Line 137: | Line 116: | ||
This property is of type ''Floating point'' and can be referenced with the variable name ''calc_period''. | This property is of type ''Floating point'' and can be referenced with the variable name ''calc_period''. | ||
| − | + | The length of time in seconds that the wave period will cover at the specified sample rate | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Frequency (hz)</u></span> | <span style="font-weight: normal;"><u>Frequency (hz)</u></span> | ||
| Line 145: | Line 122: | ||
This property is of type ''Floating point'' and can be referenced with the variable name ''calc_freq''. | This property is of type ''Floating point'' and can be referenced with the variable name ''calc_freq''. | ||
| − | + | The repeat frequency of the wave at the specified sample rate | |
Revision as of 13:34, 2 September 2013
| Author | Matrix Ltd |
| Version | 1.2 |
| Category | DSP |
Contents
Frequency Generator component
A frequency generator component designed to plug into the DSP system component and allow several discreet waveforms to be generated.
Examples
No additional examples
Downloadable macro reference
GenerateTick
Assigns a single value to the specified buffer from the selected waveform data. Each call will read the next value from the waveform and will wrap correctly at the end of the data period.
Parameters
- This macro has no parameters
Return value
- This call does not return a value
Generate
Fills the specified buffer with the selected waveform data. If the buffer is smaller or larger then the waveform data period then the data passed will follow on correctly for subsequest cycles.
Parameters
- This macro has no parameters
Return value
- This call does not return a value
Simulation macro reference
This component does not contain any simulation macros
Property reference
Buffer Manager
This property is of type Fixed list of ints and can be referenced with the variable name buffer_manager.
Selects the DSP buffer manager component
Output
This property is of type Fixed list of ints and can be referenced with the variable name input_a.
Selects the buffer to assign the waveform data to
Type
This property is of type Fixed list of ints and can be referenced with the variable name wave_type.
Waveform type selection
Amplitude
This property is of type Signed integer and can be referenced with the variable name wave_amplitude.
Waveform amplitude or volume
Offset
This property is of type Signed integer and can be referenced with the variable name wave_offset.
Waveform DC offset
Period
This property is of type Signed integer and can be referenced with the variable name wave_period.
Waveform period, the number of samples in the cyclic wave
Phase
This property is of type Fixed list of ints and can be referenced with the variable name wave_phase.
Waveform phase, the point in the wave to start streaming from
Data
This property is of type Line of text and can be referenced with the variable name wave_data.
The raw waveform data
Sample Rate (hz)
This property is of type Floating point and can be referenced with the variable name sample_rate.
Allows the sample rate to be entered to allow some basic calculations
Period (s)
This property is of type Floating point and can be referenced with the variable name calc_period.
The length of time in seconds that the wave period will cover at the specified sample rate
Frequency (hz)
This property is of type Floating point and can be referenced with the variable name calc_freq.
The repeat frequency of the wave at the specified sample rate
