Difference between revisions of "Correlate Access Code - Tag Stream"

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]]
+
Examine input for specified access code, one bit at a time.
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: stream of floats (generally, soft decisions)
 +
 
 +
output: a tagged stream set of samples from the payload following the access code and header. See [[Correlate Access Code]] for a stream output.
 +
 
 +
This block searches for the given access code by slicing the soft decision symbol inputs. Once found, it expects the following 32 samples to contain a header that includes the frame length (16 bits for the length, repeated). It decodes the header to get the frame length in order to set up the the tagged stream key information.
 +
 
 +
The output of this block is appropriate for use with tagged stream blocks.
  
 
== Parameters ==
 
== Parameters ==
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
+
; Access Code
 +
: is represented with 1 byte per bit, e.g., "010101010111000100"
  
; Param 1 (''R'')
+
; Threshold
: 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).
+
: maximum number of bits that may be wrong
  
; Param 2
+
; Tag Name
: blah blah blah
+
: key of the tag inserted into the tag stream
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==

Revision as of 04:51, 3 August 2019

Examine input for specified access code, one bit at a time.

input: stream of floats (generally, soft decisions)

output: a tagged stream set of samples from the payload following the access code and header. See Correlate Access Code for a stream output.

This block searches for the given access code by slicing the soft decision symbol inputs. Once found, it expects the following 32 samples to contain a header that includes the frame length (16 bits for the length, repeated). It decodes the header to get the frame length in order to set up the the tagged stream key information.

The output of this block is appropriate for use with tagged stream blocks.

Parameters

Access Code
is represented with 1 byte per bit, e.g., "010101010111000100"
Threshold
maximum number of bits that may be wrong
Tag Name
key of the tag inserted into the tag stream

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