Difference between revisions of "Burst Tagger"

From GNU Radio
Jump to: navigation, 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...")
 
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
 
[[Category:Block Docs]]
 
[[Category:Block Docs]]
[[Category:Stub Docs]]
+
Sets a burst on/off tag based on the value of the trigger input.  This block takes two inputs, a signal stream on the input stream 0 and a trigger stream of shorts on input stream 1. If the trigger stream goes above 0, a tag with the key "burst" will be transmitted as a pmt::PMT_T. When the trigger signal falls below 0, the "burst" tag will be transmitted as pmt::PMT_F. The signal on stream 0 is retransmitted to output stream 0.
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.
 
  
 
== 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'')
+
; True KeyID (''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).
+
: Change the key from "burst" to a custom string, for the True tag.  
 +
 
 +
; True Value (''R'')
 +
: Whether the tag's value should be True or False
 +
 
 +
; False KeyID (''R'')
 +
: Change the key from "burst" to a custom string, for the False tag.
  
; Param 2
+
; False Value (''R'')
: blah blah blah
+
: Whether the tag's value should be True or False
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==
Line 21: Line 24:
  
 
; C++ files
 
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/lib/burst_tagger_impl.cc]
  
 
; Header files
 
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/include/gnuradio/blocks/burst_tagger.h]
  
 
; Public header files
 
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/include/gnuradio/blocks/burst_tagger.h]
  
 
; Block definition
 
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
+
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/grc/blocks_burst_tagger.block.yml]

Latest revision as of 03:55, 21 July 2019

Sets a burst on/off tag based on the value of the trigger input. This block takes two inputs, a signal stream on the input stream 0 and a trigger stream of shorts on input stream 1. If the trigger stream goes above 0, a tag with the key "burst" will be transmitted as a pmt::PMT_T. When the trigger signal falls below 0, the "burst" tag will be transmitted as pmt::PMT_F. The signal on stream 0 is retransmitted to output stream 0.

Parameters[edit]

(R): Run-time adjustable

True KeyID (R)
Change the key from "burst" to a custom string, for the True tag.
True Value (R)
Whether the tag's value should be True or False
False KeyID (R)
Change the key from "burst" to a custom string, for the False tag.
False Value (R)
Whether the tag's value should be True or False

Example Flowgraph[edit]

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[edit]

C++ files
[1]
Header files
[2]
Public header files
[3]
Block definition
[4]