Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Last revision Both sides next revision
doc:action_recipe_editor [2014/11/28 17:40]
admin
doc:action_recipe_editor [2014/11/28 17:45]
admin
Line 2: Line 2:
 ~~NOTOC~~ ~~NOTOC~~
 \\ \\
-^ This page describes the '​catkinized'​ version of KnowRob that uses the [[http://​wiki.ros.org/​catkin/​|catkin buildsystem]] and the pure Java-based [[http://​wiki.ros.org/​rosjava|rosjava]]. The documentation for the older version, which was based on the rosbuild buildsystem and rosjava_jni,​ can be found [[/​doc/​action_recipe_editor?​rev=1417090277|here]].^+^ This page describes the '​catkinized'​ version of KnowRob that uses the [[http://​wiki.ros.org/​catkin/​|catkin buildsystem]] and the pure Java-based [[http://​wiki.ros.org/​rosjava|rosjava]]. The documentation for the older version, which was based on the rosbuild buildsystem and rosjava_jni,​ can be found [[/​doc/​action_recipe_editor?​rev=1401968329|here]].^
 \\ \\
  
 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 ​from RoboEarth, for saving them back, and for starting the execution on the UNR Platform. The bottom left area visualizes the task specification,​ i.e. the single actions, their respective properties, and the transitions between them (whose type is visualized by different colors — green for ‘OK’, red for ‘ERROR’). The two groups of form elements on the right-hand side describe properties of the recipe as a whole. The base IRI defines the name space of the OWL elements that are part of the recipe; the default value can be kept here. The other forms are described below.+The following image gives an overview of its interface. In the top row, there are buttons for loading ​and saving ​recipes. The bottom left area visualizes the task specification,​ i.e. the single actions, their respective properties, and the transitions between them (whose type is visualized by different colors — green for ‘OK’, red for ‘ERROR’). The two groups of form elements on the right-hand side describe properties of the recipe as a whole. The base IRI defines the name space of the OWL elements that are part of the recipe; the default value can be kept here. The other forms are described below.
  
 <​html><​iframe src="​http://​player.vimeo.com/​video/​70096978"​ width="​900"​ height="​506"​ frameborder="​0"​ webkitAllowFullScreen mozallowfullscreen allowFullScreen></​iframe></​html>​ <​html><​iframe src="​http://​player.vimeo.com/​video/​70096978"​ width="​900"​ height="​506"​ frameborder="​0"​ webkitAllowFullScreen mozallowfullscreen allowFullScreen></​iframe></​html>​
Line 16: Line 16:
   git clone https://​github.com/​knowrob/​knowrob_gui.git   git clone https://​github.com/​knowrob/​knowrob_gui.git
   ​   ​
-The knowrob_gui directory needs to be in your ROS_PACKAGE_PATH environment variableYou can then compile ​the program ​using rosmake: +The knowrob_gui directory needs to be in your catkin workspacePlease ​compile ​it using '​catkin_make'​ after checking out the repository. ​Knowrob_gui depends on the knowrob stack and its dependencies. Please have a look at the [[/​installation|installation instructions]] if you haven'​t installed knowrob yet. You can then start the editor with the following command:
-  rosmake knowrob_gui +
-   +
-Knowrob_gui depends on the knowrob stack and its dependencies. Please have a look at the [[/​installation|installation instructions]] if you haven'​t installed knowrob yet. You can then start the editor with the following command:+
   rosrun knowrob_gui KnowRobGUI   rosrun knowrob_gui KnowRobGUI
 +  ​
 +
 ===== Format of a RoboEarth action recipe ===== ===== Format of a RoboEarth action recipe =====
  
Line 36: 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 46: 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,​ and an arbitrary natural-language label. The latter is used to search for recipes in the RoboEarth DB, so it should describe briefly which task the recipe is supposed to accomplish. After entering this information,​ click on &​quot;​create’. A box with the natural-language label will appear in the top left corner, indicating the recipe you are currently editing.+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,​ and an arbitrary natural-language label. After entering this information,​ click on &​quot;​create’. A box with the natural-language label will appear in the top left corner, indicating the recipe you are currently editing. 
  
 ===== Add actions to the recipe ===== ===== Add actions to the recipe =====
Line 90: Line 90:
  
 ===== Save actions to and load them from RoboEarth ===== ===== Save actions to and load them from RoboEarth =====
-{{ :​roboearth-recipe-search.png?​350|}} +The import ​and export ​from/to RoboEarth ​is deprecated since the RoboEarth ​project has ended and the availability of the server infrastructure is not guaranteed any more.
-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” ​and select one of the results ​from the list. After editing, recipes can be uploaded ​to RoboEarth ​using the “Save recipe to RoboEarth”, which works both for updated ​and new recipe definitions.+