Message Strobe: 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...")
 
mNo edit summary
 
(12 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
Send message at defined interval.
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.
Takes a PMT message and sends it out every  milliseconds. Useful for testing/debugging the message system.


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


; Param 1 (''R'')
; Message PMT (''R'')
: 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).
: The message to send as a PMT. For example, the following message creates a payload of a simple vector of 16 bytes that contains all 1's.


; Param 2
  pmt.cons(pmt.PMT_NIL, pmt.make_u8vector(16, 0xFF))
: blah blah blah
 
; Period (ms) (''R'')
: The specified time interval after which data is sent at the output repeatedly.


== 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.
=== Example 1 ===
In this example, a Message Strobe block sends the string "Demo" once per second.
 
[[File:PUB_SUB_msg_demo.png]]
 
=== Example 2 ===
 
In another example, we change the frequency of a signal source to 1kHz after 5 seconds.
 
[[File:Signal_source_freq_msg_port.PNG]]
 
The message strobe settings in the above example are as follows:
 
[[File:Message_strobe_settings.PNG | 400px]]
 
=== Example 3 ===
Another example that uses a Message Strobe block can be found in [https://github.com/gnuradio/gnuradio/blob/master/gr-blocks/examples/msg_passing gr-blocks/examples/msg_passing].


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


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


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


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


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

Latest revision as of 13:39, 6 May 2024

Send message at defined interval.

Takes a PMT message and sends it out every milliseconds. Useful for testing/debugging the message system.

Parameters

(R): Run-time adjustable

Message PMT (R)
The message to send as a PMT. For example, the following message creates a payload of a simple vector of 16 bytes that contains all 1's.
 pmt.cons(pmt.PMT_NIL, pmt.make_u8vector(16, 0xFF))
Period (ms) (R)
The specified time interval after which data is sent at the output repeatedly.

Example Flowgraph

Example 1

In this example, a Message Strobe block sends the string "Demo" once per second.

PUB SUB msg demo.png

Example 2

In another example, we change the frequency of a signal source to 1kHz after 5 seconds.

Signal source freq msg port.PNG

The message strobe settings in the above example are as follows:

Message strobe settings.PNG

Example 3

Another example that uses a Message Strobe block can be found in gr-blocks/examples/msg_passing.

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_Strobe&oldid=14247"