Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
doc:action_recipe_editor [2013/08/22 06:55] – admin | doc:action_recipe_editor [2014/11/28 17:47] (current) – [Format of a RoboEarth action recipe] admin | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Action recipe editor ====== | ====== Action recipe editor ====== | ||
+ | ~~NOTOC~~ | ||
+ | \\ | ||
+ | ^ This page describes the ' | ||
+ | \\ | ||
The manual creation of an action recipe can be tedious task that is prone to errors like incorrect transition specifications or wrong action arguments. The graphical editor for action recipes is intended to speed up the creation and update of action recipes. It further serves as compact visualization of an action recipe and as supervision interface during task execution. | The manual creation of an action recipe can be tedious task that is prone to errors like incorrect transition specifications or wrong action arguments. The graphical editor for action recipes is intended to speed up the creation and update of action recipes. It further serves as compact visualization of an action recipe and as supervision interface during task execution. | ||
- | The following image gives an overview of its interface. In the top row, there are three groups of buttons for loading recipes | + | The following image gives an overview of its interface. In the top row, there are buttons for loading |
< | < | ||
Line 12: | Line 16: | ||
git clone https:// | git clone https:// | ||
| | ||
- | The knowrob_gui directory needs to be in your ROS_PACKAGE_PATH environment variable. You can then compile | + | The knowrob_gui directory needs to be in your catkin workspace. Please compile it using ' |
- | | + | |
| | ||
- | Knowrob_gui depends on the knowrob stack and its dependencies. Please have a look at the [[download|installation instructions]] if you haven' | ||
- | ===== Format of a RoboEarth | + | ===== Format of an action recipe ===== |
There are some important properties of action recipes that should be known to understand the editor and execution system: | There are some important properties of action recipes that should be known to understand the editor and execution system: | ||
Line 32: | Line 35: | ||
===== Functionality ===== | ===== Functionality ===== | ||
- | * drag with the right mouse button pressed: shift the canvas around | + | * Drag with the right mouse button pressed: shift the canvas around |
- | * drag with the left mouse button pressed (after click on action): move the action around | + | * Drag with the left mouse button pressed (after click on action): move the action around |
- | * click on an action or transition: activate that element | + | * Click on an action or transition: activate that element |
- | * double-click on an action or transition: open the properties window for that element | + | * Double-click on an action or transition: open the properties window for that element |
* DELETE key when action or transition is active: delete that element; when deleting an action, incoming and outgoing transitions are also deleted | * DELETE key when action or transition is active: delete that element; when deleting an action, incoming and outgoing transitions are also deleted | ||
Line 42: | Line 45: | ||
===== Create a new recipe ===== | ===== Create a new recipe ===== | ||
- | Before you can start to add actions, you need to create the recipe itself. The main information that is needed here are a unique identifier, usually written in CapitalizedCamelCaseFormat, | + | Before you can start to add actions, you need to create the recipe itself. The main information that is needed here are a unique identifier, usually written in CapitalizedCamelCaseFormat, |
===== Add actions to the recipe ===== | ===== Add actions to the recipe ===== | ||
Line 86: | Line 90: | ||
===== Save actions to and load them from RoboEarth ===== | ===== Save actions to and load them from RoboEarth ===== | ||
- | {{ : | + | The import |
- | The editor GUI is integrated with RoboEarth: Recipes can be loaded from the RoboEarth database by clicking on “Load recipe from RoboEarth”. In the search window pictured below, enter the natural-language label of the action, click on “search” | + | |