Simple Squelch: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
(Created page with "Category:Block Docs Category:Stub Docs This is the template for the "Page-per-block Docs". This first section should describe what the block...")
 
(Add details: What is the output; what kind of filter is used. Also, added C++ link.)
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
Simple squelch block based on average signal power and threshold in dB. The output equals the input if the average input is >= the threshold, and zero otherwise.
This is the template for the [[:Category:Block_Docs|"Page-per-block Docs"]].  This first section should describe what the block does and how to use it, using however many paragraphs necessary. Note that the title of the wiki page should match the block's name in GRC, i.e. the one defined in the block's .grc file.  Look at the [[FFT]] Block for a good example.


As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.
The average is computed using a Single Pole IIR filter. It uses the magnitude squared for both averaging and for comparing to the threshold.


== Parameters ==
== Parameters ==
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>


; Param 1 (''R'')
; Threshold (''R'')
: Description of parameter, provide any tips or recommended values.  Note that the name of the parameter above should match the param's label that shows up in grc (e.g. Sample Rate).
: Threshold for muting.


; Param 2
; Alpha
: blah blah blah
: Gain parameter for the running average filter.


== Example Flowgraph ==
== Example Flowgraph ==


Insert description of flowgraph here, then show a screenshot of the flowgraph and the output if there is an interesting GUI.  Currently we have no standard method of uploading the actual flowgraph to the wiki or git repo, unfortunately.  The plan is to have an example flowgraph showing how the block might be used, for every block, and the flowgraphs will live in the git repo.
This flowgraph shows a Simple Squelch block in a working 2 meter receiver.
 
[[File:FunCube_2_meter_NB_FM_fg.png|800px]]


== Source Files ==
== Source Files ==


; C++ files
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-analog/lib/simple_squelch_cc_impl.cc]


; Header files
; Header files

Revision as of 19:38, 21 September 2021

Simple squelch block based on average signal power and threshold in dB. The output equals the input if the average input is >= the threshold, and zero otherwise.

The average is computed using a Single Pole IIR filter. It uses the magnitude squared for both averaging and for comparing to the threshold.

Parameters

(R): Run-time adjustable

Threshold (R)
Threshold for muting.
Alpha
Gain parameter for the running average filter.

Example Flowgraph

This flowgraph shows a Simple Squelch block in a working 2 meter receiver.

FunCube 2 meter NB FM fg.png

Source Files

C++ files
[1]
Header files
TODO
Public header files
TODO
Block definition
TODO