diff --git a/etc/doxygen/pages/0.Overview.dox b/etc/doxygen/pages/0.Overview.dox index 9e8ac500136d8ea6f9cda76004155e0ac69fed40..3b0d419766a00dfb5eee98e448ff04fce7a1057d 100644 --- a/etc/doxygen/pages/0.Overview.dox +++ b/etc/doxygen/pages/0.Overview.dox @@ -1,27 +1,36 @@ /** \defgroup RobotAPI RobotAPI Overview -The ArmarX project RobotAPI is based on the ArmarXCore Framework. +\brief The RobotAPI package provides a robot-intependent API that other ArmarX packages can use for accessing central functionality of a robot. -\par Components -RobotAPI provides the following components -- armarx::ComponentX: ComponentX description - -Each component can provide several properties which are set on command line or via a configuration file. -See \ref componentproperties for an overview of properties. +Central aspects of RobotAPI include: -\par Applications -- armarx::ApplicationY: Description of ApplicationY +\par Intelligent Coordinates +RobotAPI provides datatypes for intelligent coordinates that refer to a robot coordinate frame and can be conveniently transformed between different frames. +Datatypes are available for positions, orientations, directions and poses. -\par interface Interface Documentation -Documentation of interfaces available in ArmarXCore is available on the \ref slicedocumentation "Slice Documentation" page. +\par +\link RobotAPI-FramedPose Read more \endlink +\par Interfaces +RobotAPI provides robot-independent interface definitions that are implemented and used by components in other ArmarX packages. +Important interfaces in RobotAPI for instance provide access to the kinematic robot state, different sensor modalities, inverse kinematics computations or the robot visualization. +\par +\link slicedocumentation Read more \endlink +\par Components +RobotAPI not only provides interfaces, but also implementations of robot-independent components. +This includes components for management of the robot state or inverse kinematics computations as well as sensor-actor units. +\par +\link RobotAPI-Components Read more \endlink -\defgroup RobotAPI-Statecharts Statecharts -\ingroup RobotAPI -Generic robot indepedent low level statecharts. +\par GUI-Plugins +RobotAPI contains several robot-independent GUI-plugins that refer to the above components. +Available GUI-plugins provide access to the kinematic robot state, end effectors, inverse kinematics computations or different sensor modalities. +RobotAPI also provides a GUI-plugin for robot visualization. +\par +\link RobotAPI-GuiPlugins Read more \endlink */