Editing FEC Async Encoder

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]]
Encodes frames received as async messages or as a PDU over a message port. This encoder works off a full message as one frame or block to encode. The message length is used as the frame length. To support this, the encoder variable used will have had its frame_size set. This block treats that initial frame_size value as the maximum transmission unit (MTU) and will not process frames larger than that.
+
[[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 fileLook at the [[FFT]] Block for a good example.
This deployment works off messages and expects them to either be messages full of unpacked bits or PDU messages, which means full bytes of a frame from the higher layers, including things like headers, tails, CRC check bytes, etc. For handling PDUs, set the packed option of this deployment block to True. The block will then use the FEC API to properly unpack the bits from the PDU, pass it through the encoder, and repack them to output the PDUs for the next stage of processing.
+
 
   
+
As this is a basic template, it's also in the [[:Category:Stub_Docs|"Stub Docs category"]]. Please improve it.
The packed PDU form of this deployment is designed to work well with other PDU-based blocks to operate within the processing flow of data packets or frames.
 
 
Due to differences in how data is packed and processed, this block also offers the ability to change the direction of how bits are unpacked and packed, where reading or writing from the LSB or MSB. By default, the rev_unpack and rev_pack modes are set to True. Using this setup allows the async block to behave with PDUs in the same operation and format as the tagged stream encoders. That is, putting the same data into both the tagged stream encoder deployment and this with these default settings should produce the same data.
 
  
 
== Parameters ==
 
== Parameters ==
  
 
; Encoder Obj.
 
; Encoder Obj.
: An FECAPI encoder object child of the generic_encoder class.
+
: 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).
  
 
; MTU (bytes)
 
; MTU (bytes)
: The Maximum Transmission Unit (MTU) of the input frame that the block will be able to process. Specified in bytes and defaults to 1500.
+
: blah blah blah
  
 
; Packed
 
; Packed
: True if working on packed bytes (like PDUs).
+
:  
  
 
; Rev. Unpacking
 
; Rev. Unpacking
: Reverse the unpacking order from input bytes to bits.
+
:  
  
 
; Rev. Packing
 
; Rev. Packing
: Reverse the packing order from bits to output bytes.
+
:  
  
 
== Example Flowgraph ==
 
== Example Flowgraph ==
Line 34: Line 31:
  
 
; C++ files
 
; C++ files
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/lib/async_encoder_impl.cc]
+
: [https://github.com/gnuradio/gnuradio TODO]
  
 
; Header files
 
; Header files
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/lib/async_encoder_impl.h]
+
: [https://github.com/gnuradio/gnuradio TODO]
  
 
; Public header files
 
; Public header files
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/include/gnuradio/fec/async_encoder.h]
+
: [https://github.com/gnuradio/gnuradio TODO]
  
 
; Block definition
 
; Block definition
 
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/grc/fec_async_encoder.block.yml]
 
: [https://github.com/gnuradio/gnuradio/blob/master/gr-fec/grc/fec_async_encoder.block.yml]

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)