Difference between revisions of "Tags Strobe"

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...")
 
 
Line 1: Line 1:
 
[[Category:Block Docs]]
 
[[Category:Block Docs]]
[[Category:Stub Docs]]
+
Send tags at defined interval.
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.
+
Sends a tag with key 'strobe' and a user-defined value (as a PMT) every  number of samples. Useful for testing/debugging the tags system.
 +
 
 +
Because tags are sent with a data stream, this is a source block that acts identical to a [[Null Source]] block.
  
 
== 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'')
+
; Value (''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 value of the tags to send, as a PMT.
 +
 
 +
; Key (''R'')
 +
: The tag key to send
  
; Param 2
+
; Num. samples (''R'')
: blah blah blah
+
: The number of samples between each tag.
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==

Latest revision as of 15:27, 23 August 2019

Send tags at defined interval.

Sends a tag with key 'strobe' and a user-defined value (as a PMT) every number of samples. Useful for testing/debugging the tags system.

Because tags are sent with a data stream, this is a source block that acts identical to a Null Source block.

Parameters[edit]

(R): Run-time adjustable

Value (R)
The value of the tags to send, as a PMT.
Key (R)
The tag key to send
Num. samples (R)
The number of samples between each tag.

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
TODO
Header files
TODO
Public header files
TODO
Block definition
TODO