+file(GLOB yml_files "*.yml")

+macro(REPLACE_IN_FILE _yml_block match replace)

+ set(yml_block_src "${CMAKE_CURRENT_SOURCE_DIR}/${_yml_block}")

+ set(yml_block "${CMAKE_CURRENT_BINARY_DIR}/${_yml_block}")

+ list(REMOVE_ITEM yml_files "${yml_block_src}")

+ file(READ "${yml_block_src}" yml_block_src_text)

+ yml_block_text "${yml_block_src_text}")

+ file(WRITE "${yml_block}" "${yml_block_text}")

+ list(APPEND generated_yml_files "${yml_block}")

+macro(GEN_BLOCK_YML _generator _yml_block)

+ set(yml_block ${CMAKE_CURRENT_BINARY_DIR}/${_yml_block})

+ list(APPEND generated_yml_files ${yml_block})

+ DEPENDS ${generator} OUTPUT ${yml_block}

+ COMMAND ${PYTHON_EXECUTABLE} ${generator} ${yml_block}

+GEN_BLOCK_YML(variable_struct.block.yml.py variable_struct.block.yml)

+ REPLACE_IN_FILE(options.yml PyQt5 PyQt4)

+add_custom_target(grc_generated_yml ALL DEPENDS ${generated_yml_files})

+ FILES ${yml_files} ${generated_yml_files}

+'[Core]':

+- Misc:

+ - pad_source

+ - pad_sink

+ - virtual_source

+ - virtual_sink

+ - epy_module

+ - note

+ - import

+- Variables:

+ - variable

+ - variable_struct

+ - variable_config

+ - variable_function_probe

+ - parameter

+id: import_

+label: Import

+

+parameters:

+- id: imports

+ label: Import

+ dtype: import

+

+templates:

+ imports: ${imports}

+

+documentation: |-

+ Import additional python modules into the namespace.

+

+ Examples:

+ from gnuradio.filter import firdes

+ import math,cmath

+ from math import pi

+

+file_format: 1

+id: message

+label: Message

+color: "#FFFFFF"

+

+multiple_connections_per_input: true

+multiple_connections_per_output: true

+

+templates:

+- type: [message, message]

+ connect: self.msg_connect(${ make_port_sig(source) }, ${ make_port_sig(sink) })

+id: note

+label: Note

+

+parameters:

+- id: note

+ label: Note

+ dtype: string

+

+file_format: 1

+id: options

+label: Options

+

+parameters:

+- id: title

+ label: Title

+ dtype: string

+ hide: ${ ('none' if title else 'part') }

+- id: author

+ label: Author

+ dtype: string

+ hide: ${ ('none' if author else 'part') }

+- id: description

+ label: Description

+ dtype: string

+ hide: ${ ('none' if description else 'part') }

+- id: window_size

+ label: Canvas Size

+ dtype: int_vector

+ hide: part

+- id: generate_options

+ label: Generate Options

+ dtype: enum

+ default: qt_gui

+ options: [qt_gui, bokeh_gui, no_gui, hb, hb_qt_gui]

+ option_labels: [QT GUI, Bokeh GUI, No GUI, Hier Block, Hier Block (QT GUI)]

+- id: category

+ label: Category

+ dtype: string

+ default: '[GRC Hier Blocks]'

+ hide: ${ ('none' if generate_options.startswith('hb') else 'all') }

+- id: run_options

+ label: Run Options

+ dtype: enum

+ default: prompt

+ options: [run, prompt]

+ option_labels: [Run to Completion, Prompt for Exit]

+ hide: ${ ('none' if generate_options == 'no_gui' else 'all') }

+- id: placement

+ label: Widget Placement

+ dtype: int_vector

+ default: (0,0)

+ hide: ${ ('part' if generate_options == 'bokeh_gui' else 'all') }

+- id: sizing_mode

+ label: Sizing Mode

+ dtype: enum

+ default: fixed

+ options: [fixed, stretch_both, scale_width, scale_height, scale_both]

+ option_labels: [Fixed, Stretch Both, Scale Width, Scale Height, Scale Both]

+ hide: ${ ('part' if generate_options == 'bokeh_gui' else 'all') }

+- id: run

+ label: Run

+ dtype: bool

+ default: 'True'

+ options: ['True', 'False']

+ option_labels: [Autostart, 'Off']

+ hide: ${ ('all' if generate_options not in ('qt_gui', 'bokeh_gui') else ('part'

+ if run else 'none')) }

+- id: max_nouts

+ label: Max Number of Output

+ dtype: int

+ default: '0'

+ hide: ${ ('all' if generate_options.startswith('hb') else ('none' if max_nouts

+ else 'part')) }

+- id: realtime_scheduling

+ label: Realtime Scheduling

+ dtype: enum

+ options: ['', '1']

+ option_labels: ['Off', 'On']

+ hide: ${ ('all' if generate_options.startswith('hb') else ('none' if realtime_scheduling

+ else 'part')) }

+- id: qt_qss_theme

+ label: QSS Theme

+ dtype: file_open

+ hide: ${ ('all' if generate_options != 'qt_gui' else ('none' if qt_qss_theme else

+ 'part')) }

+- id: thread_safe_setters

+ label: Thread-safe setters

+ category: Advanced

+ dtype: enum

+ options: ['', '1']

+ option_labels: ['Off', 'On']

+ hide: part

+- id: run_command

+ label: Run Command

+ category: Advanced

+ dtype: string

+ default: '{python} -u {filename}'

+ hide: ${ ('all' if generate_options.startswith('hb') else 'part') }

+- id: hier_block_src_path

+ label: Hier Block Source Path

+ category: Advanced

+ dtype: string

+ default: '.:'

+ hide: part

+

+asserts:

+- ${ not window_size or len(window_size) == 2 }

+- ${ not window_size or 300 <= window_size[0] <= 4096 }

+- ${ not window_size or 300 <= window_size[1] <= 4096 }

+- ${ len(placement) == 4 or len(placement) == 2 }

+- ${ all(i >= 0 for i in placement) }

+

+templates:

+ imports: |-

+ from gnuradio import gr

+ from gnuradio.filter import firdes

+ % if generate_options == 'qt_gui':

+ from PyQt5 import Qt

+ import sys

+ % endif

+ % if generate_options == 'bokeh_gui':

+ import time

+ import signal

+ import functools

+ from bokeh.client import push_session

+ from bokeh.plotting import curdoc

+ % endif

+ % if not generate_options.startswith('hb'):

+ from argparse import ArgumentParser

+ from gnuradio.eng_arg import eng_float, intx

+ from gnuradio import eng_notation

+ % endif

+ callbacks:

+ - 'if ${run}: self.start()

+

+ else: self.stop(); self.wait()'

+

+documentation: |-

+ The options block sets special parameters for the flow graph. Only one option block is allowed per flow graph.

+

+ Title, author, and description parameters are for identification purposes.

+

+ The window size controls the dimensions of the flow graph editor. The window size (width, height) must be between (300, 300) and (4096, 4096).

+

+ The generate options controls the type of code generated. Non-graphical flow graphs should avoid using graphical sinks or graphical variable controls.

+

+ In a graphical application, run can be controlled by a variable to start and stop the flowgraph at runtime.

+

+ The id of this block determines the name of the generated file and the name of the class. For example, an id of my_block will generate the file my_block.py and class my_block(gr....

+

+ The category parameter determines the placement of the block in the block selection window. The category only applies when creating hier blocks. To put hier blocks into the root category, enter / for the category.

+

+ The Max Number of Output is the maximum number of output items allowed for any block in the flowgraph; to disable this set the max_nouts equal to 0.Use this to adjust the maximum latency a flowgraph can exhibit.

+

+file_format: 1

+id: pad_sink

+label: Pad Sink

+

+parameters:

+- id: label

+ label: Label

+ dtype: string

+ default: out

+- id: type

+ label: Input Type

+ dtype: enum

+ options: [complex, float, int, short, byte, bit, message, '']

+ option_labels: [Complex, Float, Int, Short, Byte, Bits, Message, Wildcard]

+ option_attributes:

+ size: [gr.sizeof_gr_complex, gr.sizeof_float, gr.sizeof_int, gr.sizeof_short,

+ gr.sizeof_char, gr.sizeof_char, '0', '0']

+ hide: part

+- id: vlen

+ label: Vec Length

+ dtype: int

+ default: '1'

+ hide: ${ 'part' if vlen == 1 else 'none' }

+- id: num_streams

+ label: Num Streams

+ dtype: int

+ default: '1'

+ hide: part

+- id: optional

+ label: Optional

+ dtype: bool

+ default: 'False'

+ options: ['True', 'False']

+ option_labels: [Optional, Required]

+ hide: part

+

+inputs:

+- domain: stream

+ dtype: ${ type }

+ vlen: ${ vlen }

+ multiplicity: ${ num_streams }

+

+asserts:

+- ${ vlen > 0 }

+- ${ num_streams > 0 }

+

+documentation: |-

+ The inputs of this block will become the outputs to this flow graph when it is instantiated as a hierarchical block.

+

+ Pad sink will be ordered alphabetically by their ids. The first pad sink will have an index of 0.

+

+file_format: 1

+id: pad_source

+label: Pad Source

+

+parameters:

+- id: label

+ label: Label

+ dtype: string

+ default: in

+- id: type

+ label: Output Type

+ dtype: enum

+ options: [complex, float, int, short, byte, bit, message, '']

+ option_labels: [Complex, Float, Int, Short, Byte, Bits, Message, Wildcard]

+ option_attributes:

+ size: [gr.sizeof_gr_complex, gr.sizeof_float, gr.sizeof_int, gr.sizeof_short,

+ gr.sizeof_char, gr.sizeof_char, '0', '0']

+ hide: part

+- id: vlen

+ label: Vec Length

+ dtype: int

+ default: '1'

+ hide: ${ 'part' if vlen == 1 else 'none' }

+- id: num_streams

+ label: Num Streams

+ dtype: int

+ default: '1'

+ hide: part

+- id: optional

+ label: Optional

+ dtype: bool

+ default: 'False'

+ options: ['True', 'False']

+ option_labels: [Optional, Required]

+ hide: part

+

+outputs:

+- domain: stream

+ dtype: ${ type }

+ vlen: ${ vlen }

+ multiplicity: ${ num_streams }

+

+asserts:

+- ${ vlen > 0 }

+- ${ num_streams > 0 }

+

+documentation: |-

+ The outputs of this block will become the inputs to this flow graph when it is instantiated as a hierarchical block.

+

+ Pad sources will be ordered alphabetically by their ids. The first pad source will have an index of 0.

+

+file_format: 1

+id: parameter

+label: Parameter

+

+parameters:

+- id: label

+ label: Label

+ dtype: string

+ hide: ${ ('none' if label else 'part') }

+- id: value

+ label: Value

+ dtype: ${ type.type }

+ default: '0'

+- id: type

+ label: Type

+ dtype: enum

+ options: ['', complex, eng_float, intx, long, str]

+ option_labels: [None, Complex, Float, Int, Long, String]

+ option_attributes:

+ type: [raw, complex, real, int, int, string]

+ hide: ${ ('none' if type else 'part') }

+- id: short_id

+ label: Short ID

+ dtype: string

+ hide: ${ 'all' if not type else ('none' if short_id else 'part') }

+- id: hide

+ label: Show

+ dtype: enum

+ options: [none, part]

+ option_labels: [Always, Only in Properties]

+ hide: part

+

+asserts:

+- ${ len(short_id) in (0, 1) }

+- ${ short_id == '' or short_id.isalpha() }

+

+templates:

+ var_make: self.${id} = ${id}

+ make: ${value}

+

+documentation: |-

+ This block represents a parameter to the flow graph. A parameter can be used to pass command line arguments into a top block. Or, parameters can pass arguments into an instantiated hierarchical block.

+

+ The parameter value cannot depend on any variables.

+

+ Leave the label blank to use the parameter id as the label.

+

+ When type is not None, this parameter also becomes a command line option of the form:

+

+ -[short_id] --[id] [value]

+

+ The Short ID field may be left blank.

+

+ To disable showing the parameter on the hierarchical block in GRC, use Only in Properties option in the Show field.

+

+file_format: 1

+id: stream

+label: Stream

+color: "#000000"

+

+multiple_connections_per_input: false

+multiple_connections_per_output: true

+

+templates:

+- type: [stream, stream]

+ connect: self.connect(${ make_port_sig(source) }, ${ make_port_sig(sink) })

+id: variable

+label: Variable

+

+parameters:

+- id: value

+ label: Value

+ dtype: raw

+ default: '0'

+value: ${ value }

+

+templates:

+ var_make: self.${id} = ${id} = ${value}

+ callbacks:

+ - self.set_${id}(${value})

+

+documentation: |-

+ This block maps a value to a unique variable. This variable block has no graphical representation.

+

+file_format: 1

+id: variable_config

+label: Variable Config

+

+parameters:

+- id: value

+ label: Default Value

+ dtype: ${ type }

+ default: '0'

+- id: type

+ label: Type

+ dtype: enum

+ default: real

+ options: [real, int, bool, string]

+ option_labels: [Float, Int, Bool, String]

+ option_attributes:

+ get: [getfloat, getint, getboolean, get]

+- id: config_file

+ label: Config File

+ dtype: file_open

+ default: default

+- id: section

+ label: Section

+ dtype: string

+ default: main

+- id: option

+ label: Option

+ dtype: string

+ default: key

+- id: writeback

+ label: WriteBack

+ dtype: raw

+ default: None

+value: ${ value }

+

+templates:

+ imports: import ConfigParser

+ var_make: 'self._${id}_config = ConfigParser.ConfigParser()

+

+ self._${id}_config.read(${config_file})

+

+ try: ${id} = self._${id}_config.${type.get}(${section}, ${option})

+

+ except: ${id} = ${value}

+

+ self.${id} = ${id}'

+ callbacks:

+ - self.set_${id}(${value})

+ - "self._${id}_config = ConfigParser.ConfigParser()\nself._${id}_config.read(${config_file})\n\

+ if not self._${id}_config.has_section(${section}):\n\tself._${id}_config.add_section(${section})\n\

+ self._${id}_config.set(${section}, ${option}, str(${writeback}))\nself._${id}_config.write(open(${config_file},\

+ \ 'w'))"

+

+documentation: |-

+ 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.

+

+file_format: 1

+id: variable_function_probe

+label: Function Probe

+

+parameters:

+- id: block_id

+ label: Block ID

+ dtype: string

+ default: my_block_0

+- id: function_name

+ label: Function Name

+ dtype: string

+ default: get_number

+- id: function_args

+ label: Function Args

+ dtype: string

+ hide: ${ ('none' if function_args else 'part') }

+- id: poll_rate

+ label: Poll Rate (Hz)

+ dtype: real

+ default: '10'

+- id: value

+ label: Initial Value

+ dtype: raw

+ default: '0'

+ hide: part

+value: ${ value }

+

+templates:

+ imports: |-

+ import time

+ import threading

+ var_make: self.${id} = ${id} = ${value}

+ make: "\ndef _${id}_probe():\n while True:\n <% obj = 'self' + ('.'\

+ \ + block_id if block_id else '') %>\n val = ${obj}.${function_name}(${function_args})\n\

+ \ try:\n self.set_${id}(val)\n except AttributeError:\n\

+ \ pass\n time.sleep(1.0 / (${poll_rate}))\n_${id}_thread\

+ \ = threading.Thread(target=_${id}_probe)\n_${id}_thread.daemon = True\n_${id}_thread.start()\n\

+ \ "

+ callbacks:

+ - self.set_${id}(${value})

+

+documentation: |-

+ Periodically probe a function and set its value to this variable.

+

+ Set the values for block ID, function name, and function args appropriately: Block ID should be the ID of another block in this flow graph. An empty Block ID references the flow graph itself. Function name should be the name of a class method on that block. Function args are the parameters passed into that function. For a function with no arguments, leave function args blank. When passing a string for the function arguments, quote the string literal: '"arg"'.

+

+ The values will used literally, and generated into the following form:

+ self.block_id.function_name(function_args)

+ or, if the Block ID is empty,

+ self.function_name(function_args)

+

+ To poll a stream for a level, use this with the probe signal block.

+

+file_format: 1

+#!/usr/bin/env python

+

+MAX_NUM_FIELDS = 20

+

+HEADER = """\

+id: variable_struct

+label: Struct Variable

+

+parameters:

+"""

+

+TEMPLATES = """\

+

+templates:

+ imports: "def struct(data): return type('Struct', (object,), data)()"

+ var_make: |-

+ self.${{id}} = ${{id}} = struct({{

+ % for i in range({0}):

+ <%

+ field = getVar('field' + str(i))

+ %>

+ % if len(str(field)) > 2:

+ ${{field}}: getVar('value' + str(i)),

+ % endif

+ % endfor

+ }})

+ var_value: |-

+ struct({{

+ % for i in range({0}):

+ <%

+ field = getVar('field' + str(i))

+ %>

+ % if len(str(field)) > 2:

+ ${{field}}: getVar('field' + str(i)),

+ % endif

+ % endfor

+ }})

+"""

+

+FIELD0 = """\

+- id: field0

+ label: Field 0

+ category: Fields

+ dtype: string

+ default: ${field0}

+ hide: part

+"""

+

+FIELDS = """\

+- id: field{0}

+ label: Field {0}

+ category: Fields

+ dtype: string

+ hide: part

+"""

+

+VALUES = """\

+- id: value{0}

+ label: ${{field{0}}}

+ dtype: raw

+ default: '0'

+ hide: ${{ 'none' if field{0} else 'all' }}

+"""

+

+ASSERTS = """\

+- ${{ (str(field{0}) or "a")[0].isalpha() }}

+- ${{ (str(field{0}) or "a").isalnum() }}

+"""

+

+FOOTER = """\

+

+documentation: |-

+ This is a simple struct/record like variable.

+

+ Attribute/field names can be specified in the tab 'Fields'.

+ For each non-empty field a parameter with type raw is shown.

+ Value access via the dot operator, e.g. "variable_struct_0.field0"

+

+file_format: 1

+"""

+

+

+def make_yml(num_fields):

+ return ''.join((

+ HEADER.format(num_fields),

+ FIELD0, ''.join(FIELDS.format(i) for i in range(1, num_fields)),

+ ''.join(VALUES.format(i) for i in range(num_fields)),

+ 'value: ${value}\n\nasserts:\n',

+ ''.join(ASSERTS.format(i) for i in range(num_fields)),

+ ''.join(TEMPLATES.format(num_fields)),

+ FOOTER

+ ))

+

+

+if __name__ == '__main__':

+ import sys

+ try:

+ filename = sys.argv[1]

+ except IndexError:

+ filename = __file__[:-3]

+

+ data = make_yml(MAX_NUM_FIELDS)

+

+ with open(filename, 'wb') as fp:

+ fp.write(data.encode())