XMLRPC Client: 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...")
 
 
(12 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:Block Docs]]
[[Category:Block Docs]]
[[Category:Stub Docs]]
This block will create an XMLRPC client. The client will execute the callback on the server when the variable is changed.  
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.
The callback should be a the name of a function registered on the server. The variable should be an expression containing a the name of a variable in flow graph.


== 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).
: Address of the server (default: localhost)


; Param 2
; Port
: blah blah blah
: Port of the server (default: 8080)


== Example Flowgraph ==
; Callback (''R'')
: Name of the distant function (default: set_)


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.
; Variable (''R'')
: Name of the local variable (default: empty)


== Source Files ==
==Example Flowgraph==
 
This flowgraph is for version 3.9+


; C++ files
The 'siggen_controller_xmlrpc_client.grc' flowgraph should be used in conjunction with the 'siggen_xmlrpc_server.grc' flowgraph. Both are located in the 'gr-blocks/examples/xmlrpc' directory in GNURadio.
: [https://github.com/gnuradio/gnuradio TODO]
Upon execution this flowgraph opens a GUI window with a single GUI Range slider. When the slider in the client flowgraph is moved, the XMLRPC Client Block sends SET messages to the specified XMLRPC server. If the server is running and can be accessed on the specified IP address/port, the SET commands will change the value of the frequency ('rmt_freq') variable in the server flowgraph. This will be reflected in the GUI window on the server flowgraph (see [[XMLRPC_Server]]).


; Header files
[[File:Xmlrpc_client.png]]
: [https://github.com/gnuradio/gnuradio TODO]


; Public header files
== Source Files ==
: [https://github.com/gnuradio/gnuradio TODO]


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

Latest revision as of 18:07, 21 November 2021

This block will create an XMLRPC client. The client will execute the callback on the server when the variable is changed.

The callback should be a the name of a function registered on the server. The variable should be an expression containing a the name of a variable in flow graph.

Parameters

(R): Run-time adjustable

Address
Address of the server (default: localhost)
Port
Port of the server (default: 8080)
Callback (R)
Name of the distant function (default: set_)
Variable (R)
Name of the local variable (default: empty)

Example Flowgraph

This flowgraph is for version 3.9+

The 'siggen_controller_xmlrpc_client.grc' flowgraph should be used in conjunction with the 'siggen_xmlrpc_server.grc' flowgraph. Both are located in the 'gr-blocks/examples/xmlrpc' directory in GNURadio. Upon execution this flowgraph opens a GUI window with a single GUI Range slider. When the slider in the client flowgraph is moved, the XMLRPC Client Block sends SET messages to the specified XMLRPC server. If the server is running and can be accessed on the specified IP address/port, the SET commands will change the value of the frequency ('rmt_freq') variable in the server flowgraph. This will be reflected in the GUI window on the server flowgraph (see XMLRPC_Server).

Xmlrpc client.png

Source Files

Block definition
[1]
Retrieved from "https://wiki.gnuradio.org/index.php?title=XMLRPC_Client&oldid=9127"