[轉]GNU Radio Companion - GRC

cmake ..
make
sudo make install

./configure --enable-doxygen
make
sudo make install

cd <prefix>/libexec/gnuradio/
sudo grc_setup_freedesktop install

---

網柵格的定位 - Grid Positioning

GRC 提供若幹個圖形信宿及構建 wx-gui 風格的流程圖用的圖形化控製構件（範圍 - scope sink、FFT - fft sink、數目 - number sink、 瀑布圖 - waterfall sink、 星雲圖 - constellation sink、 滑動窗口控件 - slider control, 及選擇器控件 - chooser control）。這些圖形元素都有柵格定位參數用於其精確定位。

柵格定位參數是以 4 個整數數組（行坐標, 列坐標, 行大小, 列大小）為單位的。行坐標和列坐標定義了該圖形元素的左上角的定位坐標。最小數值的位置，（0，0），便是柵格的右上角。

If left blank, the grid parameter specifies that the graphical element will be automatically stacked into a vertical sizer. The vertical sizer is positioned directly above the grid sizer. If you do not want any elements to be added to the vertical sizer, leave no grid parameters blank.

行及列的大小描述網柵的延伸程度，或者圖形元素可以延伸的行數及列數。行大小描述自網柵原點向下延伸的行數，列大小描述網柵向右延伸的列數。這種延伸必須以（1， 1）為單元占據最少一個柵格。

例子 - Example

用戶

The user wishes to place a slider, centered directly above a graphical sink. The slider will be positioned at the 2nd column of the top row and with a column span of 2. The sink will be positioned on the 2nd row, and with a row span of 2 and a column span of 4. Notice the grid parameters below, and the resulting gui layout:

元素 - The Elements:

• Slider Control: (0, 1, 1, 2)
• Graphical Sink: (1, 0, 2, 4)

The Resulting GUI:

	0,0		0,1		0,2		0,3
	1,0		1,1		1,2		1,3
	2,0		2,1		2,2		2,3

 

---

階梯形功能塊 - Hierarchical Blocks

GRC can create hierarchical blocks out of the built-in blocks. Hierarchical blocks can be instantiated inside of other grc flow graphs. The python code generated from a hierarchical block can itself be used in non-GRC flow graphs. Four important blocks are used in the creation of a hierarchical block: The options block, parameter blocks, and the pad source and pad sink.

選項功能塊 - The Options Block

In order to make a hierarchical block, the parameters in the options block must be set properly. The id of the options block sets the module name, and must be unique among the entire library of blocks (built-in and custom). The title parameter sets the display name for the block. The generate options must be set to "Hier Block". The category parameter sets the category for the new block. This category can be an existing category in the block selection window or a new category. Categories may be nested by specifying a name with slashes, ex: Custom/Filters. To put blocks into the root category, specify a single slash "/" (a blank category will hide your block).

參數功能塊 - Parameter Blocks

Parameter blocks specify variables in your hierarchical block that should be configurable in the top level block. Parameter blocks work much like variable blocks with a few exceptions: Parameters blocks cannot depend on variable blocks or other parameter blocks. Parameter blocks have a label parameter for display purposes. Parameter blocks take the place of a variable block, do not try to create a variable block with the same id as your parameter block.

Pad Source and Sink Blocks

The pad source and sink blocks create inputs and outputs for the hierarchical block. The pad blocks have configurable data types, vector lengths, and number of ports. A flow graph can have at most, one pad source, and one pad sink. A hierarchical block may have one pad sink and no pad source or no pad sink and one pad source, but it must have at least one pad block.

生成及實例化 - Creating and Instantiating

• Start with a blank slate and create a new (empty) flow graph.
• Setup the options block as described above, with the id, title, generate options, and category.
• Add parameter blocks for all variables you wish to configure/control outside of the block.
• Create at most one pad source and one pad sink to match the IO type and connect them.
• When finished, click the generate button, and close/reopen GRC.
• The hierarchical block will appear in the block selection window.
• Add the hierarchical block to a flow graph as your would any other block.

注解 - Notes

• After making changes to your hierarchical block, make sure to regenerate, and reopen GRC before usage.
• The ID parameter of the block must be unique. If two blocks share the same ID, the last one to be generated will overwrite the other.
• Custom hierarchical blocks may instantiate other custom hierarchical blocks. Just don't have a block instantiate itself!

---

添加定製功能塊 - Adding Custom Blocks

Every block in GRC corresponds to an XML file that describes the block's parameters, inputs, outputs, and other attributes. Adding a custom block into GRC is simply a matter of creating one of these XML block definition files. A few caveats:

The block should be accessible from the python path. Meaning that the block can be accessed via an import statement.

The block follows the block diagram model: it has parameters, inputs, and outputs. If the block requires some kind of listening thread, or special callback methods to move the data (as in the blks2 packet stuff), it cannot be used in GRC (unless this "special" functionality can be encapsulated into a block that is block-diagram-safe).

If GRC is missing a block definition for a block that is currently in the trunk, or one of the block definitions is missing functionality, please mail the list. The block definitions in the GRC trunk must stay in sync with the actual GNU Radio blocks.

XML 功能塊定義文件的生成 - Creating the XML Block Definition

The best way to learn how to create the xml file is to learn by example. See the block definitions (source:grc/blocks) packaged with GRC, and read through a few files. Essentially, all block definitions are structured as follows:

<?xml version="1.0"?>
<block>
    <name>My Block Name</name>
    <key>my_package_my_block_ff</key>
        <category>Filters</category>
    <import>from gnuradio import my_package</import>
    <make>my_package.my_block_ff($param1, $param2)</make>
        <callback>set_param1($param1)</callback>
    <param>
        <name>Parameter 1</name>
        <key>param1</key>
        <type>real</type>
    </param>
    <param>
        <name>Parameter 2</name>
        <key>param2</key>
        <value>1</value>
        <type>int</type>
    </param>
    <sink>
        <name>in</name>
        <type>float</type>
    </sink>
    <source>
        <name>out</name>
        <type>float</type>
    </source>
        <source>
        <name>out</name>
        <type>float</type>
    </source>
</block>

• The example above will make a block with 2 parameters, 1 input, and 2 outputs.
• The ordering of the tags is important, if tags are not ordered properly, the block will fail validation. See [/trac/browser/gnuradio/trunk/grc/data/platforms/python/block.dtd block.dtd] for specifics.
• The name tags dictate the label text for the block, parameters, and ports.
• The key tags are unique identifiers, they may not contain spaces. The block key must be globally unique among all blocks in GRC. The parameter keys must be unique only within the block.
• The category tag is a unix-style path that represents the location of the block inside the block selection window. The path can be a new category (Custom), or represent a sub-category (Filters/Custom). To put a block into the root category, just use a single slash (/) for the root path.
• The import tag (there can be multiple) must be a valid python import statement to the module containing your block.
• The make tag contains the code necessary to construct your block. This code is essentially a cheetah template nested inside an xml tag. Upon code generation, the template performs a text substitution on the "quot; parameters. For more advanced capabilities, see thecheetah template documentation.
• The callback tag registers a set-method from your custom block. Once the set-method is registered, the set-method can be called at runtime when a variable is changed. There can be any number of callback tags, one for each set-method of your block. Or no callback tags if this is not applicable.
• For the param tags, the commonly used values for the type tags are: complex, real, int, complex_vector, real_vector, int_vector, string, and raw. The raw type allows any value to be used without performing type checking. The real type should be used for single and double precision floating point numbers. The int type should be used for longs, ints, shorts, and chars.
• The sink tag represents an input port, and the source tag represents an output port. The allowed values for the type tags are: complex, float, int, short, and byte. For ports with a vector length, specify a vlen tag after the type tag.

一些定義文件的例子 - Some Example Definitions

• Simple Example: "Complex to Real"source:grc/blocks/gr_complex_to_real.xml
• Multiple Callbacks: "Costas Loop"source:grc/blocks/gr_costas_loop_cc.xml
• Vlen Example: "Throttle"source:grc/blocks/gr_throttle.xml
• Advanced Make: "FFT"source:grc/blocks/gr_fft_vxx.xml

安裝 XML 功能定義文件 - Installing the XML Block Definition

有諸多方式可以讓 GRC 知悉最新生成的 xml 文件。下麵是一些可選的途徑之一 ...

方法1: Default Hier Block Location

Create the .xml file inside *~/.grc_gnuradio/ where ~ is your home directory. If the directory does not exist, create it: mkdir ~/.grc_gnuradio/

方法2: 配置文件

構建或者編輯 ~/.gnuradio/config.conf 然後添加下麵內容：

[grc]
local_blocks_path=/path/to/my/blocks

The local_blocks_path can contain multiple paths separated by colons: local_blocks_path=/path/to/blocks1:/path/to/blocks2

方法 3: 環境變量

配置

Set the GRC_BLOCKS_PATH environment variable to a path that contains your custom block wrapper. The GRC_BLOCKS_PATH can contain multiple paths separated by colons: GRC_BLOCKS_PATH=/path/to/blocks1:/path/to/blocks2

---

特別感謝 - Special Thanks

• CER Technology Fellowship: initial funding
• A. Brinton Cooper: starting the project
• Patrick Mulligan: starting the project
• William R. Kenan Jr. Fund: usrp & computers
• Patrick Strasser: the GRC icon

---

截圖 - Screen Shots

Screen Shots

Feel free to submit your own screen shots or flow graphs.

注：GNU Radio Companion（原文出處，翻譯整理僅供參考!）