Difference between revisions of "YAML GRC"

From GNU Radio
Jump to: navigation, search
m (Typo in YAML GRC)
 
Line 51: Line 51:
  
 
=== Parameters ===
 
=== Parameters ===
 +
 +
<syntaxhighlight lang="yaml" line="line" >
 +
parameters:
 +
-  id: tr_chan
 +
    label: Trigger Channel
 +
    category: Trigger
 +
    dtype: int
 +
    default: '0'
 +
    hide: part
 +
</syntaxhighlight>
 +
 +
This part describes the parameters to display to the user. A number of keywords is used there:
 +
; id
 +
: A unique name for the parameter, it is not displayed to the user but can be used to reference the parameter inside this file: ${<id>}
 +
; label
 +
: Human readable name to display to the user.
 +
; dtype
 +
: Type of the data handled by the parameter
 +
: This can have many values
 +
:; Numbers
 +
:: raw, complex, real, float, int, hex, bool
 +
:; Vectors of numbers
 +
:: complex_vector, real_vector, float_vector, int_vector
 +
:; Strings
 +
:: string, file_open, file_save, _multiline _mutiline_python_external
 +
:; Other special types
 +
:: gui_hint, import, id, stream_id, name and enum
 +
 +
; default
 +
: A default value for the parameter
 +
; category
 +
: Used to organise a large number of parameters. If set, a new tab will be created and named as the value of the keyword with the parameter inside.
 +
; hide
 +
: If the value is part, the parameter will not be shown on the block representation inside GRC.
 +
: If it's all, it will not be shown at all, even inside the properties window.
 +
; base_key
 +
: Inherit properties from another parameter. The value given is the id of that parameter.
 +
 +
  
 
=== Inputs and Outputs (optional) ===
 
=== Inputs and Outputs (optional) ===

Latest revision as of 17:12, 9 August 2019

Starting with release 3.8, YAML replaces XML as the file format for GNU Radio Companion. This is triggered by switching from Cheetah to Mako as the templating engine, since Cheetah does not support Python 3. Specifically, this will impact .grc files, block descriptions and block tree files. This article won’t focus on the .grc files, because they aren’t meant for manual editing.

The most notable change is of course the absence of XML’s angle brackets in favour of YAML’s colon-separated keys and values, and the change in file names for blocks. The latter is important for GRC to recognise the file. Namely, the “.xml” ending has been replaced with “.block.yml” for block descriptions and the underscore in block tree files has been replaced with a dot. (For example, “qtgui_tree.xml” becomes “qtgui.tree.yml”)

Block Descriptions

The content of the block descriptions is still the same, although it has been shuffled around a bit. The parts are elaborated below, in the order they should appear in the files.

ID

1 id: blocks_multiply_const_vxx
2 label: Multiply Const
3 
4 parameters:
5 -   id: type
6     label: IO Type
7 (...)

The ID is unique for each block and is used to identify it.

Label

1 id: blocks_multiply_const_vxx
2 label: Multiply Const
3 
4 parameters:
5 -   id: type
6     label: IO Type
7 (...)

The label is simply the human-readable name of the block, and will be visible from within GRC. It will not appear in the generated code.

Flags (optional)

1 id: blocks_throttle
2 label: Throttle
3 flags: throttle
4 
5 parameters:
6 -   id: type
7     label: Type
8 (...)

The flags indicate special attributes of the block. The only current example of this is the throttle flag, which is used in the Throttle and hardware blocks. For more information on throttling, see the Guided Tutorial: [1]

Parameters

1 parameters:
2 -   id: tr_chan
3     label: Trigger Channel
4     category: Trigger
5     dtype: int
6     default: '0'
7     hide: part

This part describes the parameters to display to the user. A number of keywords is used there:

id
A unique name for the parameter, it is not displayed to the user but can be used to reference the parameter inside this file: ${<id>}
label
Human readable name to display to the user.
dtype
Type of the data handled by the parameter
This can have many values
Numbers
raw, complex, real, float, int, hex, bool
Vectors of numbers
complex_vector, real_vector, float_vector, int_vector
Strings
string, file_open, file_save, _multiline _mutiline_python_external
Other special types
gui_hint, import, id, stream_id, name and enum
default
A default value for the parameter
category
Used to organise a large number of parameters. If set, a new tab will be created and named as the value of the keyword with the parameter inside.
hide
If the value is part, the parameter will not be shown on the block representation inside GRC.
If it's all, it will not be shown at all, even inside the properties window.
base_key
Inherit properties from another parameter. The value given is the id of that parameter.


Inputs and Outputs (optional)

 1 id: qtgui_freq_sink_x
 2 (...)
 3     default: '1.0'
 4     hide: ${ ('part' if int(nconnections) >= 10 else 'all') }
 5 
 6 inputs:
 7 -   domain: stream
 8     dtype: ${ type.t }
 9     multiplicity: ${ (0 if (type == 'msg_complex' or type == 'msg_float') else nconnections) }
10     optional: true
11 -   domain: message
12     id: freq
13     optional: true
14     hide: ${ showports }
15 
16 outputs:
17 -   domain: message
18 (...)

This describes the input ports. domain can be either stream or message. Stream ports need a type, which usually is specified as a parameter. This is true for our example, the type is specified in type.t. The multiplicity tells us how many "copies" of this port we want. (Yes, this can be zero!) Finally, the optional flag tells us whether this port must be connected or not. (GRC won't generate the flowgraph if a non-optional port isn't connected)

Message ports[2] don't have a specified type here, but they have IDs. This message port can also be hidden, using the "Show message ports" option in the parameters.


The output ports work similarly.

Asserts (optional)

 1 id: blocks_throttle
 2 (...)    
 3     dtype: ${ type }
 4     vlen: ${ vlen }
 5 
 6 asserts:
 7 - ${ vlen > 0 }
 8 
 9 templates:
10     imports: from gnuradio import blocks
11     make: blocks.throttle(${type.size}*${vlen}, ${samples_per_second},${ignoretag})
12 (...)

Asserts (previously known as "checks" for the XML blocks) are expressions that need to be true, otherwise GRC won't let you generate the flowgraph.

Templates

 1 id: blocks_message_strobe_random
 2 (...)
 3     optional: true
 4 
 5 templates:
 6     imports: |-
 7         from gnuradio import blocks
 8         import pmt
 9     make: blocks.message_strobe_random(${msg}, ${dist}, ${mean}, ${std})
10     callbacks:
11     - set_msg(${msg})
12     - set_dist(${dist})
13 (...)

The templates describe the code that is created when GRC generates the flowgraph. This part consists of the imports, the make/initialization statements and the callbacks. The values of these keys often happen to span over multiple lines, in which case you're likely to see the "|-" symbols. This is YAML syntax for a literal block scalar[3] and the hyphen means that the line break at the end is omitted.


Your block probably utilizes parts of GNU Radio or other modules that need to be imported. These are specified as imports.


make holds the initialization code, and often depends on several of the parameters. Some of the more involved blocks may also use the "%" symbol, denoting the use of a YAML directive[4]. This can occur both in imports and make. The snippet below may be helpful:

 1 id: rational_resampler_xxx
 2 (...)
 3     make: |-
 4         filter.rational_resampler_${type}(
 5             interpolation=${interp},
 6             decimation=${decim},
 7         % if taps:
 8             taps=${taps},
 9         % else:
10             taps=None,
11         % endif

Please note that the "${}" is not valid syntax in a directive.

Documentation

1 id: variable_rrc_filter_taps
2 (...)
3 documentation: |-
4     This is a convenience wrapper for calling firdes.root_raised_cosine(...).
5 
6 file_format: 1

documentation simply contains information about the block. This information is displayed in the block's Documentation tab in GRC.

File Format

Others

Variable Make

Variable Value

Block Tree Files

The block tree files are fairly straightforward, and tells GRC how to divide the block tree into categories. The following example snippet from gr-digital (which is part of core GNU Radio) describes two categories, Coding and Equalizers. The blocks are specified using their ids, which should equal their file names without ".block.yml".

1 '[Core]':
2 - Coding:
3   - digital_additive_scrambler_bb
4   - digital_descrambler_bb
5   - digital_scrambler_bb
6 - Equalizers:
7   - digital_cma_equalizer_cc
8   - digital_lms_dd_equalizer_cc
9 (...)