diff options
| author | Solomon Tan <solomonbstoner@yahoo.com.au> | 1970-01-01 07:30:00 +0730 |
|---|---|---|
| committer | mormj <34754695+mormj@users.noreply.github.com> | 2021-09-02 08:27:05 -0400 |
| commit | 6c06dc9a8fb835cebd40f0aacacf268388748ecc (patch) | |
| tree | 6958eecf00b314da73236f26fc528fa6ba09e4ea /gr-digital/python/digital | |
| parent | aa0efa5dc62a99d79bb608fa6c8bb5175c57e204 (diff) | |
gr-digital: fix gfsk documentation
The gfsk hier block documentation is shifted so it will be shown in the
documentation tab of the block. It is otherwise not shown.
Signed-off-by: Solomon Tan <solomonbstoner@yahoo.com.au>
Diffstat (limited to 'gr-digital/python/digital')
| -rw-r--r-- | gr-digital/python/digital/gfsk.py | 69 |
1 files changed, 34 insertions, 35 deletions
diff --git a/gr-digital/python/digital/gfsk.py b/gr-digital/python/digital/gfsk.py index 4f47aebea1..2cc8f69c97 100644 --- a/gr-digital/python/digital/gfsk.py +++ b/gr-digital/python/digital/gfsk.py @@ -46,6 +46,20 @@ _def_omega_relative_limit = 0.005 # ///////////////////////////////////////////////////////////////////////////// class gfsk_mod(gr.hier_block2): + """ + Hierarchical block for Gaussian Frequency Shift Key (GFSK) + modulation. + + The input is a byte stream (unsigned char) and the + output is the complex modulated signal at baseband. + + Args: + samples_per_symbol: samples per baud >= 2 (integer) + bt: Gaussian filter bandwidth * symbol time (float) + verbose: Print information about modulator? (bool) + debug: Print modualtion data to files? (bool) + unpack: Unpack input byte stream? (bool) + """ def __init__(self, samples_per_symbol=_def_samples_per_symbol, @@ -54,20 +68,6 @@ class gfsk_mod(gr.hier_block2): verbose=_def_verbose, log=_def_log, do_unpack=_def_do_unpack): - """ - Hierarchical block for Gaussian Frequency Shift Key (GFSK) - modulation. - - The input is a byte stream (unsigned char) and the - output is the complex modulated signal at baseband. - - Args: - samples_per_symbol: samples per baud >= 2 (integer) - bt: Gaussian filter bandwidth * symbol time (float) - verbose: Print information about modulator? (bool) - debug: Print modualtion data to files? (bool) - unpack: Unpack input byte stream? (bool) - """ gr.hier_block2.__init__(self, "gfsk_mod", gr.io_signature(1, 1, gr.sizeof_char), # Input signature @@ -165,6 +165,26 @@ class gfsk_mod(gr.hier_block2): # ///////////////////////////////////////////////////////////////////////////// class gfsk_demod(gr.hier_block2): + """ + Hierarchical block for Gaussian Minimum Shift Key (GFSK) + demodulation. + + The input is the complex modulated signal at baseband. + The output is a stream of bits packed 1 bit per byte (the LSB) + + Args: + samples_per_symbol: samples per baud (integer) + verbose: Print information about modulator? (bool) + log: Print modualtion data to files? (bool) + + Clock recovery parameters. These all have reasonable defaults. + + Args: + gain_mu: controls rate of mu adjustment (float) + mu: unused but unremoved for backward compatibility (unused) + omega_relative_limit: sets max variation in omega (float, typically 0.000200 (200 ppm)) + freq_error: bit rate error as a fraction + """ def __init__(self, samples_per_symbol=_def_samples_per_symbol, @@ -175,27 +195,6 @@ class gfsk_demod(gr.hier_block2): freq_error=_def_freq_error, verbose=_def_verbose, log=_def_log): - """ - Hierarchical block for Gaussian Minimum Shift Key (GFSK) - demodulation. - - The input is the complex modulated signal at baseband. - The output is a stream of bits packed 1 bit per byte (the LSB) - - Args: - samples_per_symbol: samples per baud (integer) - verbose: Print information about modulator? (bool) - log: Print modualtion data to files? (bool) - - Clock recovery parameters. These all have reasonable defaults. - - Args: - gain_mu: controls rate of mu adjustment (float) - mu: unused but unremoved for backward compatibility (unused) - omega_relative_limit: sets max variation in omega (float, typically 0.000200 (200 ppm)) - freq_error: bit rate error as a fraction - float: - """ gr.hier_block2.__init__(self, "gfsk_demod", gr.io_signature(1, 1, gr.sizeof_gr_complex), # Input signature |