Variable Config: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
No edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 3: Line 3:


To save the value back into the config file: enter the name of another variable into the writeback param. When the other variable is changed at runtime, the config file will be re-written.
To save the value back into the config file: enter the name of another variable into the writeback param. When the other variable is changed at runtime, the config file will be re-written.
The config files are INI files, with a file structure described [https://docs.python.org/3/library/configparser.html#supported-ini-file-structure here] and that basically look like this, parameters named (the key, or option parameter in the block) and organised in sections (the square-bracketed name).
  [Transmission]
  frequency = 2410000000
  gain = 10
  [Runtime]
  samp_rate = 1000000
  # Parameters for the low-pass filter
  [Filtering]
  cutoff = 10000
  width = 5000


== Parameters ==
== Parameters ==
Line 11: Line 23:


; Default value (''R'')
; Default value (''R'')
: Default value
: Default value to be used if the value cannot be read


; Config file (''R'')
; Config file (''R'')
Line 30: Line 42:


== Source Files ==
== Source Files ==
; C++ fileshttps://wiki.gnuradio.org/index.php/SISO
: [https://github.com/gnuradio/gnuradio TODO]
; Header files
: [https://github.com/gnuradio/gnuradio TODO]
; Public header files
: [https://github.com/gnuradio/gnuradio TODO]


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

Latest revision as of 10:41, 22 April 2020

This block represents a variable that can be read from a config file.

To save the value back into the config file: enter the name of another variable into the writeback param. When the other variable is changed at runtime, the config file will be re-written.

The config files are INI files, with a file structure described here and that basically look like this, parameters named (the key, or option parameter in the block) and organised in sections (the square-bracketed name).

 [Transmission]
 frequency = 2410000000
 gain = 10
 [Runtime]
 samp_rate = 1000000
 # Parameters for the low-pass filter
 [Filtering]
 cutoff = 10000
 width = 5000

Parameters

(R): Run-time adjustable

Id (R)
Id of the block, used to reference the variable in other blocks
Default value (R)
Default value to be used if the value cannot be read
Config file (R)
The file that stores the value
Section (R)
Section in the file containing the key/value pair of the variable
Option (R)
Key of the value in the file
WriteBack (R)
Variable to write in place of the current one

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.

Source Files

Block definition
[1]