ZMQ SUB Source: 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...")
 
(the template didn't work. use plain HTML formatting)
 
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
Receive messages on ZMQ SUB socket and source stream.
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 will connect to a ZMQ PUB socket, then produce all incoming messages as streaming output.


== 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'')
; Address
: 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).
: ZMQ socket address specifier. The format of the address is <code>tcp://*:port</code> where * should be 127.0.0.1 for localhost.<br>
: <b>Note:</b> If the Source and Sink blocks are on two different computers on the same LAN, then the IP and port number of the Sink block must be specified on each end of that connection. For example, if the Sink is on IP 192.168.2.14:5678 and the Source is on IP 192.168.2.5, both Source and Sink blocks must specify the Sink IP and port (192.168.2.14:5678).
: <span style="color:red;font-weight:bold;">WARNING:</span> ZMQ endpoints <b>look</b> like URLs but they are not. A "tcp" endpoint specifies an IP address or a <i>network adapter</i> (e.g., <code>lo</code> or <code>eth0</code>). Do not use hostnames, like "localhost".


; Param 2
; Timeout
: blah blah blah
: Receive timeout in milliseconds, default is 100ms.
; Pass Tags
: Whether source will look for and deserialize tags.
; Hign Watermark
: High Watermark to configure the socket to (-1 => zmq's default)


== 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.
This is a flowgraph of an Amplitude Modulation receiver. The signal from the transmitter section is received by the ZMQ SUB Source. It is a 48khz carrier with a sample rate of 768khz. For complete details, see [[Simulation_example:_AM_transmitter_and_receiver#AM_receiver]].
 
[[File:AM_receive_fg.png|900px]]


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

Latest revision as of 03:57, 12 August 2022

Receive messages on ZMQ SUB socket and source stream.

This block will connect to a ZMQ PUB socket, then produce all incoming messages as streaming output.

Parameters

(R): Run-time adjustable

Address
ZMQ socket address specifier. The format of the address is tcp://*:port where * should be 127.0.0.1 for localhost.
Note: If the Source and Sink blocks are on two different computers on the same LAN, then the IP and port number of the Sink block must be specified on each end of that connection. For example, if the Sink is on IP 192.168.2.14:5678 and the Source is on IP 192.168.2.5, both Source and Sink blocks must specify the Sink IP and port (192.168.2.14:5678).
WARNING: ZMQ endpoints look like URLs but they are not. A "tcp" endpoint specifies an IP address or a network adapter (e.g., lo or eth0). Do not use hostnames, like "localhost".
Timeout
Receive timeout in milliseconds, default is 100ms.
Pass Tags
Whether source will look for and deserialize tags.
Hign Watermark
High Watermark to configure the socket to (-1 => zmq's default)

Example Flowgraph

This is a flowgraph of an Amplitude Modulation receiver. The signal from the transmitter section is received by the ZMQ SUB Source. It is a 48khz carrier with a sample rate of 768khz. For complete details, see Simulation_example:_AM_transmitter_and_receiver#AM_receiver.

AM receive fg.png

Source Files

C++ files
TODO
Header files
TODO
Public header files
TODO
Block definition
TODO
Retrieved from "https://wiki.gnuradio.org/index.php?title=ZMQ_SUB_Source&oldid=12422"