HDLC Deframer: Difference between revisions

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...")
 
No edit summary
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
HDLC deframer which takes in unpacked bits, and outputs PDU binary blobs. Frames which do not pass CRC are rejected. This block also unstuffs the bits in the HDLC frame.
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.
This block goes with [[HDLC Framer]]


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


; Param 1 (''R'')
; Min length
: 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).
: Minimum frame size (bytes)


; Param 2
; Max length
: blah blah blah
: Maximum frame size (bytes)


== Example Flowgraph ==
== 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.
[[File:Hdlc_demo_fg.png|800px]]


== Source Files ==
== Source Files ==


; C++ files
; C++ files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-digital/lib/hdlc_deframer_bp_impl.cc hdlc_deframer_bp_impl.cc]


; Header files
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-digital/lib/hdlc_deframer_bp_impl.h hdlc_deframer_bp_impl.h]


; Public header files
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-digital/include/gnuradio/digital/hdlc_deframer_bp.h hdlc_deframer_bp.h]


; Block definition
; Block definition
: [https://github.com/gnuradio/gnuradio TODO]
: [https://github.com/gnuradio/gnuradio/blob/main/gr-digital/grc/digital_hdlc_deframer_bp.block.yml digital_hdlc_deframer_bp.block.yml]

Latest revision as of 14:50, 5 October 2023

HDLC deframer which takes in unpacked bits, and outputs PDU binary blobs. Frames which do not pass CRC are rejected. This block also unstuffs the bits in the HDLC frame.

This block goes with HDLC Framer

Parameters

Min length
Minimum frame size (bytes)
Max length
Maximum frame size (bytes)

Example Flowgraph

Hdlc demo fg.png

Source Files

C++ files
hdlc_deframer_bp_impl.cc
Header files
hdlc_deframer_bp_impl.h
Public header files
hdlc_deframer_bp.h
Block definition
digital_hdlc_deframer_bp.block.yml
Retrieved from "https://wiki.gnuradio.org/index.php?title=HDLC_Deframer&oldid=13460"