Message Debug: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
No edit summary
(add parameter; reorganize)
(One intermediate revision by the same user not shown)
Line 1: Line 1:
[[Category:Block Docs]]
<span data-vad="gr_vad"></span>
Debug block for the message passing system.
Debug block for the message passing system.


The message debug block is used to capture and print or store messages as they are received. Any block that generates a message may connect that message port to one or more of the three message input ports of this debug block.
The message debug block is used to capture and print or store messages as they are received. Any block that generates a message may connect that message port to one or more of the three message input ports of this debug block.


The message ports are:
== Parameters ==
<b>(''R''):</b> <span class="plainlinks">[https://wiki.gnuradio.org/index.php/GNURadioCompanion#Variable_Controls ''Run-time adjustable'']</span>
 
<code>Added in 3.9</code>
; PDU Vectors (''R'')
: On or Off - determines if the uniform vector is printed or not.


* print: prints the message directly to standard out.
== Messages ==
* store: stores the message in an internal vector. It works in conjunction with a message_debug::get_message(size_t i) call that allows us to retrieve message i afterward.
* print_pdu: specifically designed to handle formatted PDUs (see pdu.h). It discards messages that aren't PDU pairs (or are null).


== Parameters ==
=== Inputs ===
<div data-vad="3.9">
==== Version 3.9 ====
----
; print
: Prints all messages to standard out. If the message is a PDU, it will receive special formatting and the <code>PDU Vectors</code> block parameter will determine if the uniform vector is printed or not.
; store
: Stores the message in an internal vector. It works in conjunction with a message_debug::get_message(size_t i) call that allows us to retrieve message i afterward.
; print_pdu
: PDU messages are redirected to the <code>print</code> port. This is included for compatibility and is no longer recommended for use.
</div>


None
<div data-vad="3.8">
==== Version 3.8 ====
----
; print
: Prints the message to standard out.
; store
: Stores the message in an internal vector. It works in conjunction with a message_debug::get_message(size_t i) call that allows us to retrieve message i afterward.
; print_pdu
: Specifically designed to handle formatted PDUs (see pdu.h). It discards messages that aren't PDU pairs (or are null).
</div>


== Example Flowgraph ==
== Example Flowgraph ==
Line 32: Line 54:
; Block definition
; Block definition
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/grc/blocks_message_debug.block.yml]
: [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/grc/blocks_message_debug.block.yml]
[[Category:Block Docs]]

Revision as of 20:27, 5 December 2022

Debug block for the message passing system.

The message debug block is used to capture and print or store messages as they are received. Any block that generates a message may connect that message port to one or more of the three message input ports of this debug block.

Parameters

(R): Run-time adjustable

Added in 3.9

PDU Vectors (R)
On or Off - determines if the uniform vector is printed or not.

Messages

Inputs

Version 3.9

print
Prints all messages to standard out. If the message is a PDU, it will receive special formatting and the PDU Vectors block parameter will determine if the uniform vector is printed or not.
store
Stores the message in an internal vector. It works in conjunction with a message_debug::get_message(size_t i) call that allows us to retrieve message i afterward.
print_pdu
PDU messages are redirected to the print port. This is included for compatibility and is no longer recommended for use.

Version 3.8

print
Prints the message to standard out.
store
Stores the message in an internal vector. It works in conjunction with a message_debug::get_message(size_t i) call that allows us to retrieve message i afterward.
print_pdu
Specifically designed to handle formatted PDUs (see pdu.h). It discards messages that aren't PDU pairs (or are null).

Example Flowgraph

In this example, a Message Strobe block sends the string "Demo" once per second. It is displayed on the user terminal by the Message Debug block.

PUB SUB msg demo.png

Source Files

C++ files
[1]
Header files
[2]
Public header files
[3]
Block definition
[4]
Retrieved from "https://wiki.gnuradio.org/index.php?title=Message_Debug&oldid=12693"