FEC Extended Tagged Encoder: 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...")
 
No edit summary
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
<!-- FEC_Extended_Tagged_Encoder.mediawiki -->
[[Category:Stub Docs]]
This block encodes an unpacked stream using a variety of Encoder Definition blocks, such as Repetition, CC, Polar, etc. The output stream also is unpacked.
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.
 
== Parameters ==


As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.
; Encoder Objects
: Encoder Definition blocks are used to define the encoder function.


== Parameters ==
; MTU (bytes)
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
: The Maximum Transmission Unit (MTU) of the input frame that the block will be able to process. Specified in bytes and defaults to 1500.


; Param 1 (''R'')
; Puncture Pattern
: 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).
: a puncture pattern of '11' defines 'no puncture'.


; Param 2
; Length Tag Name
: blah blah blah
: Key name of the tagged stream frame size, typically "packet_len".


== 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 can be found at [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/examples/fecapi_polar_encoders.grc]
 
[[File:Fecapi_polar_encoders_fg.png|800px]]


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


; C++ files
; Python files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-fec/python/fec/extended_tagged_encoder.py extended_tagged_encoder.py]


; Header files
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-fec/grc/fec_extended_tagged_encoder.block.yml fec_extended_tagged_encoder.block.yml]


; Public header files
[[Category:Block Docs]]
: [https://github.com/gnuradio/gnuradio TODO]
 
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]

Latest revision as of 23:37, 26 May 2023

This block encodes an unpacked stream using a variety of Encoder Definition blocks, such as Repetition, CC, Polar, etc. The output stream also is unpacked.

Parameters

Encoder Objects
Encoder Definition blocks are used to define the encoder function.
MTU (bytes)
The Maximum Transmission Unit (MTU) of the input frame that the block will be able to process. Specified in bytes and defaults to 1500.
Puncture Pattern
a puncture pattern of '11' defines 'no puncture'.
Length Tag Name
Key name of the tagged stream frame size, typically "packet_len".

Example Flowgraph

This flowgraph can be found at [1]

Fecapi polar encoders fg.png

Source Files

Python files
extended_tagged_encoder.py
Block definition
fec_extended_tagged_encoder.block.yml
Retrieved from "https://wiki.gnuradio.org/index.php?title=FEC_Extended_Tagged_Encoder&oldid=13137"