diff options
| author | Alba Mendez <me@alba.sh> | 2019-07-21 02:57:25 +0200 |
|---|---|---|
| committer | Martin Braun <martin.braun@ettus.com> | 2020-01-02 15:07:57 -0800 |
| commit | 2024c428c25cd6832da1a05009bcb59d46ecfc2e (patch) | |
| tree | 629f42a50e451725f96a486499839571763a9e34 | |
| parent | 3e988eeadd61950546bdd765f2296b20aaf06648 (diff) | |
analog: Add some documentation to squelch blocks
4 files changed, 20 insertions, 3 deletions
diff --git a/gr-analog/grc/analog_pwr_squelch_xx.block.yml b/gr-analog/grc/analog_pwr_squelch_xx.block.yml index 310b61d509..af58b60dec 100644 --- a/gr-analog/grc/analog_pwr_squelch_xx.block.yml +++ b/gr-analog/grc/analog_pwr_squelch_xx.block.yml @@ -53,4 +53,18 @@ cpp_templates: True: true False: false +documentation: |- + This will either pass the input unchanged or block it, depending on + whether its envelope is over a certain threshold. The envelope is calculated + by taking the squared magnitude of the signal and lowpassing it with a + single pole IIR filter (with the specified alpha). + + The ramp parameter specifies the attack / release time, in samples. + A sinusodial ramp is used to progressively mute / unmute the input. + If ramp is set to 0, input is muted / unmuted without a ramp. + + For realtime applications you'll want to set the gate parameter to + false, which produces zeros when the input is muted. If it is true, + the block will stop producing samples when in muted state. + file_format: 1 diff --git a/gr-analog/include/gnuradio/analog/ctcss_squelch_ff.h b/gr-analog/include/gnuradio/analog/ctcss_squelch_ff.h index 07663ea7ec..886d7b035c 100644 --- a/gr-analog/include/gnuradio/analog/ctcss_squelch_ff.h +++ b/gr-analog/include/gnuradio/analog/ctcss_squelch_ff.h @@ -51,7 +51,8 @@ public: * \param freq frequency value to use as the squelch tone. * \param level threshold level for the squelch tone. * \param len length of the frequency filters. - * \param ramp sets response characteristic. + * \param ramp attack / release time in samples; a sinusodial ramp + * is used. set to 0 to disable. * \param gate if true, no output if no squelch tone. * if false, output 0's if no squelch tone. */ diff --git a/gr-analog/include/gnuradio/analog/pwr_squelch_cc.h b/gr-analog/include/gnuradio/analog/pwr_squelch_cc.h index 9100904c70..cb38f610ec 100644 --- a/gr-analog/include/gnuradio/analog/pwr_squelch_cc.h +++ b/gr-analog/include/gnuradio/analog/pwr_squelch_cc.h @@ -49,7 +49,8 @@ public: * * \param db threshold (in dB) for power squelch * \param alpha Gain of averaging filter. Defaults to 0.0001. - * \param ramp sets response characteristic. Defaults to 0. + * \param ramp attack / release time in samples; a sinusodial ramp + * is used. set to 0 to disable. * \param gate if true, no output if no squelch tone. * if false, output 0's if no squelch tone (default). * diff --git a/gr-analog/include/gnuradio/analog/pwr_squelch_ff.h b/gr-analog/include/gnuradio/analog/pwr_squelch_ff.h index ebdb049861..979660b6c6 100644 --- a/gr-analog/include/gnuradio/analog/pwr_squelch_ff.h +++ b/gr-analog/include/gnuradio/analog/pwr_squelch_ff.h @@ -49,7 +49,8 @@ public: * * \param db threshold (in dB) for power squelch * \param alpha Gain of averaging filter. Defaults to 0.0001. - * \param ramp sets response characteristic. Defaults to 0. + * \param ramp attack / release time in samples; a sinusodial ramp + * is used. set to 0 to disable. * \param gate if true, no output if no squelch tone. * if false, output 0's if no squelch tone (default). * |