Editing Protocol Parser

Jump to: navigation, search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 1: Line 1:
 
[[Category:Block Docs]]
 
[[Category:Block Docs]]
Block that synchronizes to a header based on a header format object class. Designed to accept hard bits and produce PDUs with packed bytes (pmt::u8vector).
+
[[Category:Stub Docs]]
 +
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.
  
This block takes in hard bits (unpacked bytes; 1's and 0's as the LSB) and finds the access code as a sync word to find the start of a frame.
+
As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.
  
Once the frame is detected (usually through the use of an access code), the block uses the format object's parser function to decode the remaining header. Generally, as in the default header case, the header will contain the length of the frame's payload. That and anything else in the header will generally go into the PDU's meta-data dictionary.
+
== Parameters ==
 +
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
  
The block will output a PDU that contains frame's header info in the meta-data portion of the PDU and the payload itself. The payload is packed hard bits as taken from the input stream.
+
; Param 1 (''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).
== Parameters ==
 
  
; Format Obj.
+
; Param 2
: The format object to use when reading the header. This block uses a format object derived from a header_format_base class.
+
: blah blah blah
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==
Line 22: Line 23:
  
 
; C++ files
 
; C++ files
: [https://github.com/gnuradio/gnuradio/blob/master/gr-digital/lib/protocol_parser_b_impl.cc]
+
: [https://github.com/gnuradio/gnuradio TODO]
  
 
; Header files
 
; Header files
: [https://github.com/gnuradio/gnuradio/blob/master/gr-digital/lib/protocol_parser_b_impl.h]
+
: [https://github.com/gnuradio/gnuradio TODO]
  
 
; Public header files
 
; Public header files
: [https://github.com/gnuradio/gnuradio/blob/master/gr-digital/include/gnuradio/digital/protocol_parser_b.h]
+
: [https://github.com/gnuradio/gnuradio TODO]
  
 
; Block definition
 
; Block definition
: [https://github.com/gnuradio/gnuradio/blob/master/gr-digital/grc/digital_protocol_parser_b.block.yml]
+
: [https://github.com/gnuradio/gnuradio TODO]

Please note that all contributions to GNU Radio are considered to be released under the Creative Commons Attribution-ShareAlike (see GNU Radio:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel | Editing help (opens in new window)