Skip to content

Commit 388a155

Browse files
committed
Updated
1 parent 17ac52b commit 388a155

1 file changed

Lines changed: 22 additions & 16 deletions

File tree

docs/index.html

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -690,16 +690,14 @@ <h3>Notes</h3>
690690
</div>
691691
</script>
692692

693-
694-
695693
<div>
696694
<script type="text/x-red" data-help-name="AudioFilterFIRGeneral_F32">
697695
<!-- ============ AudioFilterFIRGeneral_F32 ========= -->
698696
<h3>Summary</h3>
699697
<div class=tooltipinfo>
700698
<p>Uses flat-delay FIR filtering to generate Low Pass, High Pass,
701-
Band Pas and Band Reject Filters, do the filtering and compute the
702-
response.</p>
699+
Band Pass and Band Reject Filters. This class performs the FIR filtering.
700+
It also can compute the frequency response of the FIR.</p>
703701
</div>
704702
<h3>Boards Supported</h3>
705703
<ul>
@@ -735,7 +733,7 @@ <h3>Functions</h3>
735733
</p>
736734

737735
<p class=func><span class=keyword>getResponse</span>(<strong>uint16_t</strong> nFreq, <strong>float</strong> *rdb);</p>
738-
<p class=desc>Calculates the response of the equalizer in dB at nFreq equally spaced
736+
<p class=desc>Calculates the response of the filter in dB at nFreq equally spaced
739737
frequencies. rdb is a pointer to an array of nFreq floats where the response can be put.</p>
740738

741739
<h3>Examples</h3>
@@ -769,12 +767,10 @@ <h3>Notes</h3>
769767
used because of the latency it creates. Note that if constant delay is needed, the FIR
770768
implementation does this with minimum latency.</p>
771769

772-
<p>AudioFilterFIR_F32 in this OpenAudio_ArduinoLibrary handles 32-bit floating point
773-
data and a maximum of 200 taps. This class requires the INO to provide the working
770+
<p>This class requires the INO to provide the working
774771
space and thereby puts no limit on the number of FIR taps (coefficients) being used.
775772
The processor does run out of time, and that limits Teensy 3.6 to about 6000 taps
776-
and Teensy 4.x to about 6000. As a starting spot for huge FIR filters, one might use
777-
1/2 or 1/3 of those numbers.</p>
773+
and Teensy 4.x to many times that.</p>
778774

779775
<p>It is practical to switch filter coefficient arrays on-the-fly.
780776
See the LoadCoeffs() function. This class is initialized to a 4 coefficient
@@ -4091,14 +4087,11 @@ <h3>Functions</h3>
40914087
when manual CW is enabled. No return value. </p>
40924088

40934089
<p class=func><span class=keyword><strong>bool</strong> getmanualCW</span>();</p>
4094-
<p class=desc>Returns the manual CW status./p>
4090+
<p class=desc>Returns the manual CW status.</p>
40954091

40964092
<p class=func><span class=keyword>manualCWKey</span>(<strong>bool</strong>keyDown);</p>
40974093
<p class=desc>When keyDown is true, the CW tone output is sent until
4098-
keyDown is false. No return value. </p>
4099-
4100-
<p class=func><span class=keyword><strong>getBufferSpace</strong></span>();</p>
4101-
<p class=desc>Returns the number of places (of 512) left in the character buffer.</p>
4094+
keyDown is false. No return value.</p>
41024095

41034096
<p class=func><span class=keyword>amplitude</span>(<strong>float32_t</strong> a);</p>
41044097
<p class=desc>Sets a, the zero-to-peak amplitude of the transmit signal. The default is 1.0.
@@ -5589,10 +5582,16 @@ <h3>Audio Connections</h3>
55895582
</table>
55905583
<h3>Functions</h3>
55915584
<p class=func><span class=keyword>available</span>();</p>
5592-
<p class=desc>Returns true each time new peak data is available.
5585+
<p class=desc>Returns true each time new peak data is available.</p>
5586+
5587+
<p class=func><span class=keyword>getCount</span>();</p>
5588+
<p class=desc>Returns the number of blocks that have been included in the peak
5589+
data that is currently available. Each block is many measurements, typically 128.
55935590
</p>
5591+
55945592
<p class=func><span class=keyword>read</span>();</p>
5595-
<p class=desc>Read the highest peak amplitude value since the last read.
5593+
<p class=desc>Read the highest peak amplitude value since the last read. Calling
5594+
this function also starts a new peak analysis, and can be used for that.
55965595
</p>
55975596
<p class=func><span class=keyword>readPeakToPeak</span>();</p>
55985597
<p class=desc>Read the highest peak-to-peak amplitude since the last read.
@@ -5632,6 +5631,13 @@ <h3>Functions</h3>
56325631
<p class=func><span class=keyword>available</span>();</p>
56335632
<p class=desc>Returns true if new RMS data is available.
56345633
</p>
5634+
5635+
<p class=func><span class=keyword>getCount</span>();</p>
5636+
<p class=desc>Returns the number of blocks that have been averaged in the rms
5637+
data that is currently available. Each block is many measurements, typically 128.
5638+
</p>
5639+
5640+
56355641
<p class=func><span class=keyword>read</span>();</p>
56365642
<p class=desc>Read the new RMS value.
56375643

0 commit comments

Comments
 (0)