Difference between revisions of "Stream CRC32"

From GNU Radio
Jump to navigation Jump to 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]]
Byte-stream CRC block.
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 bytes, which form a packet. The first byte of the packet has a tag with key "length" and the value being the number of bytes in the packet.
 
; Output: The same bytes as incoming, but trailing a CRC32 of the packet. The tag is re-set to the new length.


== Parameters ==
== Parameters ==
(''R''): <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>


; Param 1 (''R'')
; Mode
: 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).
: Set to true if you want to check CRC, false to create CRC.
 
; Length tag name
: Length tag key for the tagged stream.


; Param 2
; Packed
: blah blah blah
: If the data is packed or unpacked bits.


== Example Flowgraph ==
== Example Flowgraph ==

Revision as of 15:09, 6 September 2019

Byte-stream CRC block.

Input
stream of bytes, which form a packet. The first byte of the packet has a tag with key "length" and the value being the number of bytes in the packet.
Output
The same bytes as incoming, but trailing a CRC32 of the packet. The tag is re-set to the new length.

Parameters

Mode
Set to true if you want to check CRC, false to create CRC.
Length tag name
Length tag key for the tagged stream.
Packed
If the data is packed or unpacked bits.

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