Random PDU 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...")
 
(add note for 3.10)
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
Sends a random PDU once at startup and then every time it receives a message.
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>


; Param 1 (''R'')
; Min Bytes
: 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).
: Minimum number of bytes to output


; Param 2
; Max Bytes
: blah blah blah
: Maximum number of bytes to output.
 
; Byte mask
: The output bytes are the result of an AND operation between the generated numbers and this mask.
 
; Length Modulo
: Makes the length of the output PDU to be a multiple of the specified number. The length also cannot be lower than that number.


== 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/main/gr-pdu/examples/pdu_tools_demo.grc]
 
[[File:Pdu_tools_demo_fg.png|800px]]


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


; C++ files
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-pdu/lib/random_pdu_impl.cc random_pdu_impl.cc]


; Header files
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-pdu/lib/random_pdu_impl.h random_pdu_impl.h]


; Public header files
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-pdu/include/gnuradio/pdu/random_pdu.h random_pdu.h]


; Block definition
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-pdu/grc/pdu_random_pdu.block.yml pdu_random_pdu.block.yml]

Latest revision as of 14:40, 27 January 2022

Sends a random PDU once at startup and then every time it receives a message.

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

Min Bytes
Minimum number of bytes to output
Max Bytes
Maximum number of bytes to output.
Byte mask
The output bytes are the result of an AND operation between the generated numbers and this mask.
Length Modulo
Makes the length of the output PDU to be a multiple of the specified number. The length also cannot be lower than that number.

Example Flowgraph

This flowgraph can be found at [1]

Pdu tools demo fg.png

Source Files

C++ files
random_pdu_impl.cc
Header files
random_pdu_impl.h
Public header files
random_pdu.h
Block definition
pdu_random_pdu.block.yml
Retrieved from "https://wiki.gnuradio.org/index.php?title=Random_PDU_Generator&oldid=10910"