Packet Header Generator: 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
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
Generates a header for a tagged, streamed packet.
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.


As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.
Input: A tagged stream of bytes. This is consumed entirely, it is not appended to the output stream.
 
Output: A tagged stream containing the header. The details on the header are set in a header formatter object (of type packet_header_default or a subclass thereof). To use a default header, see [[Packet Header Generator (Default)]].


== Parameters ==
== Parameters ==
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
; Formatter Object
 
: A header formatter object.
; Param 1 (''R'')
: 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).


; Param 2
; Length Tag Name
: blah blah blah
: Length Tag Key. Note that it is irrelevant which tag names are set in the formatter object. Only this value is relevant.


== Example Flowgraph ==
== Example Flowgraph ==
Line 21: Line 20:


; C++ files
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-digital/lib/packet_headergenerator_bb_impl.cc]


; Header files
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-digital/lib/packet_headergenerator_bb_impl.h]


; Public header files
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-digital/include/gnuradio/digital/packet_headergenerator_bb.h]


; Block definition
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-digital/grc/digital_packet_headergenerator_bb_default.block.yml]

Latest revision as of 13:43, 8 August 2023

Generates a header for a tagged, streamed packet.

Input: A tagged stream of bytes. This is consumed entirely, it is not appended to the output stream.

Output: A tagged stream containing the header. The details on the header are set in a header formatter object (of type packet_header_default or a subclass thereof). To use a default header, see Packet Header Generator (Default).

Parameters

Formatter Object
A header formatter object.
Length Tag Name
Length Tag Key. Note that it is irrelevant which tag names are set in the formatter object. Only this value is relevant.

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.

Source Files

C++ files
[1]
Header files
[2]
Public header files
[3]
Block definition
[4]
Retrieved from "https://wiki.gnuradio.org/index.php?title=Packet_Header_Generator&oldid=13300"