welcome: please sign in
location: Diff for "HATP/hatpconsole"
Differences between revisions 12 and 14 (spanning 2 versions)
⇤ ← Revision 12 as of 2015-02-20 13:28:41 →
Size: 8310
Editor: rlalleme
Comment: Add comment on issue related to QMake
← Revision 14 as of 2016-08-08 13:46:14 → ⇥
Size: 4348
Editor: rlalleme
Comment: Remove part about dependencies that is useless
Deletions are marked like this. Additions are marked like this.
Line 12: Line 12:
/!\ There are several methods to install hatpconsole, we advise you to use the robotpkg method.
Line 15: Line 13:

{i} '''A quick setup guide (working with robotpkg) can be found [[HATP/run#quick_setup|here]].'''
Line 22: Line 18:
== Prepare dependencies ==

hatpconsole depends on:
 * '''qt4'''
 * '''boost''' (thread, system and regex)
 * '''libgvc''' (provided by the package libgraphviz-dev on most of common linux distributions)
 * '''msgconnector''' (available in robotpkg, otherwise go to [[HATP/msgconnector]] page to see how to install it)
 * '''libhatp''' (available in robotpkg, otherwise go to [[HATP/libhatp]] page to see how to install it)

''If you are not used to install via commands, see the short summary in this [[HATP/install#appendix|Appendix]].''

If you use robotpkg (see below and recommended solution) all dependencies are correctly tackled.
Line 38: Line 20:
=== Using robotpkg (recommended) ===
<<Anchor(robotpkg_install)>>		 To get a detailed install instructions on how to install hatpconsole please refer the the [[HATP/install|install page]].
Line 41: Line 22:
`robotpkg` is a set of build and packaging tools, inspired by [[http://pkgsrc.se/|pkgsrc]], designed to build and install [[http://www.openrobots.org/wiki/OpenRobotsFrontPage|OpenRobots]] packages.

To get complete documentation on how-to use `robotpkg` please refer to: [[http://robotpkg.openrobots.org/install.html]].

As of now (March 2014) HATP's main modules are in robotpkg/wip: see [[http://robotpkg.openrobots.org/robotpkg-wip.html]].

To install hatpconsole just do:

{{{
cd <robotpkg>/wip/hatpconsole
make update
}}}

All missing dependencies will either :
 * be reported if there are system dependencies
 * or automatically installed if they exist in robotpkg.

=== From archive package ===

Install hatpconsole with archive package

The archive is available at : http://www.openrobots.org/distfiles/hatpconsole/hatpconsole-LAST.tar.gz

{{{
tar -xzf hatpconsole-LAST.tar.gz
cd hatpconsole-<version>
mkdir build
cd build
cmake .. [-DCMAKE_INSTALL_PREFIX=<some/install/path>] [-DCMAKE_MODULE_PATH=<install/prefix>] [-DmsgconnectorROOT=<msgconnector/root/directory>] [-DlibhatpROOT=<libhatp/directory>]
make
make install
}}}

''N.B. You may need root privileges to do make install if you did not use the `-DCMAKE_INSTALL_PREFIX`''

''N.B. If you encounter problems with Qt4 not being found, it is most likely due to QMake. You can specify its location using `-DQT_QMAKE_EXECUTABLE=<path/to/qmake>`''

If you used '''robotpkg''' to install all HATP modules (libhatp and msgconnector), you can directly use '''`-DCMAKE_MODULE_PATH`''' and set it to '''${ROBOTPKG_BASE}/share/cmake/Modules'''.

If the modules are in different folders then use separate variable. The `-DmsgconnectorROOT` (resp. `-DlibhatpROOT`) specifies the folder where CMake can find the files (header files and libraries) for msgconnector (resp. libhatp). It can be the Openrobots install directory (environment variable : ${ROBOTPKG_BASE}).


=== From GIT ===

You might want to improve the hatpconsole then get it from GIT:

{{{
git clone git://git.openrobots.org/robots/hatp/hatpconsole.git
cd hatpconsole
mkdir build
cd build
cmake .. [-DCMAKE_INSTALL_PREFIX=<some/install/path>] [-DCMAKE_MODULE_PATH=<install/prefix>] [-DmsgconnectorROOT=<msgconnector/root/directory>] [-DlibhatpROOT=<libhatp/directory>]
make
make install
}}}

''N.B. You may need root privileges to do make install if you did not use the `-DCMAKE_INSTALL_PREFIX`''

''N.B. If you encounter problems with Qt4 not being found, it is most likely due to QMake. You can specify its location using `-DQT_QMAKE_EXECUTABLE=<path/to/qmake>`''

If you used '''robotpkg''' to install all HATP modules (libhatp and msgconnector), you can directly use '''`-DCMAKE_MODULE_PATH`''' and set it to '''${ROBOTPKG_BASE}/share/cmake/Modules'''.

If the modules are in different folders then use separate variable. The `-DmsgconnectorROOT` (resp. `-DlibhatpROOT`) specifies the folder where CMake can find the files (header files and libraries) for msgconnector (resp. libhatp). It can be the Openrobots install directory (environment variable : ${ROBOTPKG_BASE}).
 To install hatpconsole with the old way, using msgconnector, please see the page about the [[HATP/hatpconsole-old|deprecated version]].
Line 118: Line 36:
To start hatpconsole you need !MsgServer (from msgconnector package) running. See [[HATP#startMsgServer|how to start MsgServer]].

Then you can call:		 To start hatpconsole simply call:
Line 123: Line 39:
hatpconsole [<server_address>] [<server_port>] rosrun hatpconsole hatpconsole
Line 125: Line 41:
For instance the default call is:
{{{
hatpconsole
}}}
''N.B. The default value for the server address and port are respectively `localhost` and `5500`.''
It has one parameter, the mode, which you can set to normal (this section) or minimal (next section). To change it use the traditional ROS parameter (see [[HATP/run#ros_param|here]]). The parameter is called `/hatpconsole/mode`, see the `--help` output for more details.
Line 153: Line 67:
To start hatpconsole you need !MsgServer (from msgconnector package) running. See [[HATP#startMsgServer|how to start MsgServer]]. To start hatpconsole in minimal mode, you can call:
{{{
rosrun hatpconsole hatpconsole _mode:=minimal
}}}
Line 155: Line 72:
Then you can call:

{{{
hatpconsole [<server_address>] [<server_port>] --minimal
}}}
For instance the default call is:
{{{
hatpconsole --minimal
}}}
''N.B. The default value for the server address and port are respectively `localhost` and `5500`.''		 Another way to change the mode is to use the traditionnal ROS parameter (see [[HATP/run#ros_param|here]]).
Line 215: Line 123:
=== Version 2.1.1 ===

 * INTEGRATION IN ROS

hatpconsole, the plan dispalyer

This page presents hatpconsole, a module of HATP to display the plan found to a request.

Contents

  1. Install hatpconsole
  2. Use hatpconsole
    1. Normal mode
    2. Minimal mode
  3. Changelog
    1. Version 0.6
    2. Version 1.0.0
    3. Version 1.0.1
    4. Version 1.1.0
    5. Version 1.1.1
    6. Version 1.2.0
    7. Version 2.0.0
    8. Version 2.1.1
  4. License, Troubleshooting and Maintainer

1. Install hatpconsole

To get a detailed install instructions on how to install hatpconsole please refer the the install page.

To install hatpconsole with the old way, using msgconnector, please see the page about the deprecated version.

2. Use hatpconsole

2.1. Normal mode

To start hatpconsole simply call: 

rosrun hatpconsole hatpconsole

It has one parameter, the mode, which you can set to normal (this section) or minimal (next section). To change it use the traditional ROS parameter (see here). The parameter is called /hatpconsole/mode, see the --help output for more details.

hatpconsole looks like:

  • position=middle

The left panel is dedicated to the ontology requests, it displays all the value from the ontology server.

The top-right panel, called "System messages" displays several informations from HATP. Like:

  • Invalid requests
  • The planning process to answer a plan request
  • ...

Finally the bottom-right panel, "Plan result", is composed of three tabs:

  • The "Plan" tab shows the text plan almost as it is sent to the program that did the request.
  • The "Streams" tab displays all streams of the plan, affected to every agent of the system. Each colour represent a different agent.
  • The "Tree" tab gives the tree decomposition of the plan.

The last two tabs use vectorial pictures where it is possible to zoom in and out to get more details.

To have a better view over the plan you can get its content from the folder where you are running the hatpconsole. There should be two files: planStreams.svg and planTree.svg. The files are svg files (.dat extension for old version of hatpconsole) so you can display them with viewer programs (for instance Inkscape).

2.2. Minimal mode

To start hatpconsole in minimal mode, you can call: 

rosrun hatpconsole hatpconsole _mode:=minimal

Another way to change the mode is to use the traditionnal ROS parameter (see here).

The minimal mode outputs:

  • position=middle

The viewer shows the last computed plan and it is possible to zoom in and out.

3. Changelog

3.1. Version 0.6

  • Link hatpconsole to libhatp

3.2. Version 1.0.0

  • Generate plan as SVG files
  • Improve plan output
  • Display nodes
  • Add targets: install, uninstall and package
  • Software now called: hatpconsole (instead of HATPConsole)

3.3. Version 1.0.1

  • Improving packaging system
  • Change name used to register the console to the server

3.4. Version 1.1.0

  • Change the plan output files: now plans are stored in planTree.svg and planStreams.svg
  • Fix compilation issue for Fedora

3.5. Version 1.1.1

  • Fix a version problem for Graphviz (depends on the platform now)

3.6. Version 1.2.0

  • Same colour is now used for the actions of an agent on both the tree and its stream
  • On EXIT command now the interface is updated (instead of quitting)

3.7. Version 2.0.0

  • Allow to zoom in and out on the two plan views (stream and tree)
  • Offer "minimal" mode which starts an interface only showing the stream view

3.8. Version 2.1.1

  • INTEGRATION IN ROS

4. License, Troubleshooting and Maintainer

HATP is distributed under 2-clause BSD license. (See here for details.)

The page to report problems or for pull request: Openrobots/hatpconsole.

Current maintainer(s):

OpenrobotsWiki: HATP/hatpconsole (last edited 2016-08-08 13:46:14 by rlalleme)