meta_forest.ros_packages module

class meta_forest.ros_packages.MessagePackage[source]

Bases: object

Class to create a package of ROS2 custom message

_configure_params(args)[source]

Configure parameters to create a ROS2 package

Parameters: args (argparse.Namespace) –
Returns: params
Return type: Params

_create(params)[source]

Create a custom message package

Parameters: params (Params) –
Return type: None

_create_msg_file(params)[source]

Create custom messages

Parameters: params (Params) –
Return type: None

_get_msg_files(ip)[source]

Get ROS2 message file names

Parameters: ip (List) –
Returns: msg_files – List of ROS2 message file names
Return type: List[str]

_process_msg_file(filename, io, io_type)[source]

Create the contents of custom messages

Parameters

filename (str) –
io (List) –
io_type (List) –

Return type

None

_render(params)[source]

Render custom message packages

Parameters: params (Params) –
Return type: None

class meta_forest.ros_packages.NodePackage[source]

Bases: object

Class to create a packages of ROS2-FPGA nodes

_configure_params(args)[source]

Configure parameters to create a ROS2 package

Parameters: args (argparse.Namespace) –
Returns: params
Return type: Params

_create(params)[source]

Create a ROS2-FPGA nodes package

Parameters: params (Params) –
Return type: None

_get_all_ip_names(io_maps)[source]

Get IP core names with suffix

Parameters: io_maps (List) –
Returns: ip_names – IP core names
Return type: List

_get_ip_msg_table(ip_names_2d)[source]

Table containing IP core names and ROS2 message file suffix

Parameters: ip_names_2d (List) –
Returns: table
Return type: Dict

_render(params)[source]

Render ROS2-FPGA nodes packages

Parameters: params (Params) –
Return type: None

meta_forest.ros_packages._build_packages_with_colcon(dev_ws, packages_list)[source]

Generate a Vivado block design

Parameters

dev_ws (str) – Workspace of ROS2 packages
packages_list (List[str]) – Names of ROS2 package to build

Return type

None

meta_forest.ros_packages.generate_packages(args)[source]

Generate ROS2 package

Parameters: args (argparse.Namespace) –
Return type: None