diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..79f4ffcddf8d917d0728bc8ad7c31178358bc568 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# Description + +This package contains some launch files to perform simple operations with the Ana robot. At the moment the included lauch files are: + + * keyboard_teleop.launch: used to operate the robot using the keyboard. + +# Dependencies + +This node has the following dependencies: + + * [teleop_twist_keyboard](http://wiki.ros.org/teleop_twist_keyboard) + +All dependencies can be installed using the [rosdep tool](http://wiki.ros.org/rosdep). + +# Install + +This package, as well as all IRI dependencies, can be installed by cloning the +repository inside the active workspace: + +``` +roscd +cd ../src +git clone https://gitlab.iri.upc.edu/labrobotica/ros/robots/ana/iri_ana_launch.git +``` + +However, this package is normally used as part of a wider installation (i.e. a +robot, an experiment or a demosntration) which will normally include a complete +rosinstall file to be used with the [wstool](http://wiki.ros.org/wstool) tool. + +# How to use it + +To teleoperate the robot with a keyboard go [here](./docs/keyboard_teleop.md); diff --git a/docs/keyboard_teleop.md b/docs/keyboard_teleop.md new file mode 100644 index 0000000000000000000000000000000000000000..264a2ebe3eb586ce1bff1b27ad6e6d48377c2a34 --- /dev/null +++ b/docs/keyboard_teleop.md @@ -0,0 +1,27 @@ +# Keyboard teleopration + +To teleoperate the robot with the keyboard, either the real or the simulated robots must be running. + +To use the real robot, execute: + +``` +roslaunch iri_ana_bribgup ana_test.launch +``` + +More information on how to use the real robot is available [here](). + +To use the simulated robot, execute: + +``` +roslaunch iri_ana_gazebo sim_sample.launch +``` + +More information on how to use the simulated robot is available [here](). + +To start teleoprating the robot with the keyboard, execute: + +``` +roslaunch iri_ana_launch keyboard_teleop.launch. +``` + +See the onscreen information to change the maximum translational and rotational speed and also to send motion commands to the robot. More information can be found in the [telop_twist_keyboard wiki page](http://wiki.ros.org/teleop_twist_keyboard).