PDU Set: 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...")
 
(add note for 3.10)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
Set a Key-Value pair in PDU's meta field and pass on.
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.
<b>Note for 3.10</b> This block has been moved from gr-blocks to gr-pdu, which causes a name change of the id. See [[Porting_Existing_Flowgraphs_to_a_Newer_Version#PDU_blocks_moved_from_gr-blocks_to_gr-pdu]] for details.


== Parameters ==
== Parameters ==
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>


; Param 1 (''R'')
; Key (''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).
: The Key to set


; Param 2
; Value (''R'')
: blah blah blah
: The value to set


== 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://raw.githubusercontent.com/gnuradio/gnuradio/master/gr-pdu/examples/pdu_tools_demo.grc]
 
[[File:Pdu_tools_demo_fg.png|800px]]
 
== Example Output ==
 
[[File:Pdu_tools_demo_out.png|800px]]


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

Latest revision as of 14:27, 27 January 2022

Set a Key-Value pair in PDU's meta field and pass on.

Note for 3.10 This block has been moved from gr-blocks to gr-pdu, which causes a name change of the id. See Porting_Existing_Flowgraphs_to_a_Newer_Version#PDU_blocks_moved_from_gr-blocks_to_gr-pdu for details.

Parameters

(R): Run-time adjustable

Key (R)
The Key to set
Value (R)
The value to set

Example Flowgraph

This flowgraph can be found at [1]

Pdu tools demo fg.png

Example Output

Pdu tools demo out.png

Source Files

C++ files
TODO
Header files
TODO
Public header files
TODO
Block definition
TODO