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 /gr-analog/grc | |
| parent | 3e988eeadd61950546bdd765f2296b20aaf06648 (diff) | |
analog: Add some documentation to squelch blocks
Diffstat (limited to 'gr-analog/grc')
| -rw-r--r-- | gr-analog/grc/analog_pwr_squelch_xx.block.yml | 14 |
1 files changed, 14 insertions, 0 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 |