ocpigr — command-line tool for generating GNU Radio Companion block files from OpenCPI artifacts
The ocpigr(1) command-line tool is used to generate
GNU Radio Companion (GRC)-compatible files that correspond
to artifacts, the binaries/executables generated from building OpenCPI workers.
The ocpigr tool searches OpenCPI project libraries for artifacts
and generates GRC "block" files that correspond to the
artifacts it discovers. These block files can then be used
with GNU Radio Companion (GRC), the graphical user interface
for developing GNU Radio applications, providing a way to use
OpenCPI component implementations - the workers - in GNU Radio
applications.
The ocpigr tool searches the project libraries specified
in the OCPI_LIBRARY_PATH environment variable; if this variable
is not set, it searches the libraries of projects registered in the
OpenCPI project registry.
For each component specification in a library, it determines
which platforms are implemented by the artifacts it finds,
the authoring model(s) that each platform supports, and
the component-specific and worker-specific properties and ports.
It uses this data to build YAML-formatted,
GRC-structured worker (<worker-id>.block.yml), worker tree (ocpi.tree.yml),
per-platform domain (ocpi_<platform-id>.block.yml), and container
(ocpi_container.yml) block files in the
current directory or the directory specified in
the -D (--directory) option.
In addition to the general-purpose options common
to all OpenCPI tools (see opencpi(1)),
the options described below can be specified for ocpigr operations.
For convenience, options can occur anywhere in the command.
When invoked without any options, ocpigr displays help information.
In the following descriptions, a plus sign (+) after the option indicates that it can be specified more than once on the command line. Arguments to word-form options are preceded by an equal sign (=) (as shown in the following descriptions) or a space. Arguments to letter options are preceded by a space.
-D <output-dir>, --directory=<output-dir>
ocpigr places the
generated block files into the directory in which it runs.
The following environment variables affect ocpigr operation:
OCPI_LIBRARY_PATH
exports/ subdirectory, not its source location.