diff options
| author | Marcus Müller <Marcus.Mueller@ettus.com> | 2015-04-22 20:32:04 +0200 |
|---|---|---|
| committer | Marcus Müller <Marcus.Mueller@ettus.com> | 2015-04-23 19:52:36 +0200 |
| commit | 93a35f0bda8319a569e3a34a31f047dda793597a (patch) | |
| tree | 0d60d20609f96b064dd4106bf80e8356318418ef /gr-analog/include/gnuradio | |
| parent | fdfece16643f4f997cdbbd14a8646ae5f417e258 (diff) | |
analog: Power Squelch now emit tags on start/end of bursts
The block will emit a tag with the key pmt::intern("squelch_sob")
with the value of pmt::PMT_NIL on the first item it passes, and with
the key pmt::intern("squelch:eob") on the last item it passes.
Added this to the `make` documentation.
Also: made the GRC XML's defaults reflect the C++ default args.
Also: indentation was mixed; unified the paragraphs I worked on.
Diffstat (limited to 'gr-analog/include/gnuradio')
| -rw-r--r-- | gr-analog/include/gnuradio/analog/pwr_squelch_cc.h | 10 | ||||
| -rw-r--r-- | gr-analog/include/gnuradio/analog/pwr_squelch_ff.h | 10 |
2 files changed, 14 insertions, 6 deletions
diff --git a/gr-analog/include/gnuradio/analog/pwr_squelch_cc.h b/gr-analog/include/gnuradio/analog/pwr_squelch_cc.h index 6913d62934..324743d965 100644 --- a/gr-analog/include/gnuradio/analog/pwr_squelch_cc.h +++ b/gr-analog/include/gnuradio/analog/pwr_squelch_cc.h @@ -49,10 +49,14 @@ namespace gr { * \brief Make power-based squelch block. * * \param db threshold (in dB) for power squelch - * \param alpha Gain of averaging filter - * \param ramp sets response characteristic. + * \param alpha Gain of averaging filter. Defaults to 0.0001. + * \param ramp sets response characteristic. Defaults to 0. * \param gate if true, no output if no squelch tone. - * if false, output 0's if no squelch tone. + * if false, output 0's if no squelch tone (default). + * + * The block will emit a tag with the key pmt::intern("squelch_sob") + * with the value of pmt::PMT_NIL on the first item it passes, and with + * the key pmt::intern("squelch:eob") on the last item it passes. */ static sptr make(double db, double alpha=0.0001, int ramp=0, bool gate=false); diff --git a/gr-analog/include/gnuradio/analog/pwr_squelch_ff.h b/gr-analog/include/gnuradio/analog/pwr_squelch_ff.h index 46046eae07..a65cedaa57 100644 --- a/gr-analog/include/gnuradio/analog/pwr_squelch_ff.h +++ b/gr-analog/include/gnuradio/analog/pwr_squelch_ff.h @@ -49,10 +49,14 @@ namespace gr { * \brief Make power-based squelch block. * * \param db threshold (in dB) for power squelch - * \param alpha Gain of averaging filter - * \param ramp sets response characteristic. + * \param alpha Gain of averaging filter. Defaults to 0.0001. + * \param ramp sets response characteristic. Defaults to 0. * \param gate if true, no output if no squelch tone. - * if false, output 0's if no squelch tone. + * if false, output 0's if no squelch tone (default). + * + * The block will emit a tag with the key pmt::intern("squelch_sob") + * with the value of pmt::PMT_NIL on the first item it passes, and with + * the key pmt::intern("squelch:eob") on the last item it passes. */ static sptr make(double db, double alpha=0.0001, int ramp=0, bool gate=false); |