Skip to content

Commit

Permalink
teleop docs completed
Browse files Browse the repository at this point in the history
  • Loading branch information
javilinos committed Jul 4, 2024
1 parent ec87b25 commit 2d4353f
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion docs/_06_user_interfaces/_keyboard_teleoperation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,27 @@ Example of keyboard teleoperation tool launch command:

.. code-block:: bash
ros2 launch as2_keyboard_teleoperation as2_keyboard_teleoperation_launch.py namespace:=drone_sim_0,drone_sim_1,drone_sim_2 use_sim_time:=true
ros2 launch as2_keyboard_teleoperation as2_keyboard_teleoperation_launch.py namespace:=drone_sim_0,drone_sim_1,drone_sim_2 use_sim_time:=true config_file:=/path/to/config/file.yaml
This will open keyboard teleoperation interface for drones with namespace: ``drone_sim_0``, ``drone_sim_1`` and ``drone_sim_2``.

.. note::

The ``config_file`` parameter is optional. If not provided, default values will be used.

An example of a configuration file is shown below:

.. code-block:: yaml
/**:
ros__parameters:
speed_value: 0.5
altitude_speed_value: 0.5
turn_speed_value: 0.5
position_value: 1.00
altitude_value: 1.00
turn_angle_value: 0.78
------------
Instructions
------------
Expand All @@ -52,6 +69,8 @@ When the previous launch command is executed, a window like the following will o

Keyboard teleoperation initial window.

When in **speed mode**, motion key needs to be pressed and held to move the drone. When in **pose mode**, motion key needs to be pressed and released to move the drone.

Interface Components
####################

Expand Down

0 comments on commit 2d4353f

Please sign in to comment.