Editing Default Header Format Obj.

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]]
Default header formatter for PDU formatting. Used to handle the default packet header.
+
[[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.
  
See the parent class header_format_base for details of how these classes operate.
+
As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.
 
 
The default header created in this base class consists of an access code and the packet length. The length is encoded as a 16-bit value repeated twice:
 
 
 
  | access code | hdr | payload |
 
 
 
Where the access code is <= 64 bits and hdr is:
 
 
 
  |  0 -- 15 | 16 -- 31 |
 
  | pkt len  | pkt len  |
 
 
 
The access code and header are formatted for network byte order.
 
 
 
This header generator does not calculate or append a CRC to the packet. Use the CRC32 Async block for that before adding the header. The header's length will then measure the payload plus the CRC length (4 bytes for a CRC32).
 
 
 
The default header parser produces a PMT dictionary that contains the following keys. All formatter blocks MUST produce these two values in any dictionary.
 
 
 
See [https://www.gnuradio.org/doc/doxygen/classgr_1_1digital_1_1header__format__default.html] for more info.
 
  
 
== Parameters ==
 
== Parameters ==
; Access Code
+
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
: An access code that is used to find and synchronize the start of a packet. Used in the parser and in other blocks like a corr_est block that helps trigger the receiver. Can be up to 64-bits long.
 
  
; Threshold
+
; Param 1 (''R'')
: How many bits can be wrong in the access code and still count as correct.  
+
: 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).
  
; Payload Bits per Symbol
+
; Param 2
: The number of bits per symbol used in the payload's modulator.
+
: blah blah blah
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==

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)