Skip to content

Commit

Permalink
Use relative links in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AdamPettinger committed Aug 17, 2020
1 parent 5eb9b7a commit 6ad7833
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions moveit_ros/moveit_servo/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Moveit Servo

See the [Running the Demos](https://github.com/AdamPettinger/moveit2/blob/pr-rebase_on_foxy/moveit_ros/moveit_servo/doc/running_the_demos.md) guide for installation instructions and quick-start guide
See the [Running the Demos](doc/running_the_demos.md) guide for installation instructions and quick-start guide

See the [Servo Tutorial](https://github.com/AdamPettinger/moveit2/blob/pr-rebase_on_foxy/moveit_ros/moveit_servo/doc/servo_tutorial.md) to get an overview about `moveit_servo` and learn how to set it up on your robot.
See the [Servo Tutorial](doc/servo_tutorial.md) to get an overview about `moveit_servo` and learn how to set it up on your robot.
6 changes: 3 additions & 3 deletions moveit_ros/moveit_servo/doc/running_the_demos.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ ros2 launch moveit_servo servo_cpp_interface_demo.launch.py
```

#### Expected Output
![Alt Text](https://github.com/AdamPettinger/moveit2/blob/pr-rebase_on_foxy/moveit_ros/moveit_servo/doc/Images/C%2B%2B_Interface_Demo.gif)
![Alt Text](Images/C%2B%2B_Interface_Demo.gif)

## Component Demo
`moveit_servo` is also offered as a composable node that may be run in a container with other components.
Expand All @@ -69,7 +69,7 @@ ros2 run moveit_servo fake_command_publisher
```

#### Expected ouput
![Alt Text](https://github.com/AdamPettinger/moveit2/blob/pr-rebase_on_foxy/moveit_ros/moveit_servo/doc/Images/Servo_Component_Demo.gif)
![Alt Text](Images/Servo_Component_Demo.gif)

## Teleoperation Demo
`moveit_servo` is a versatile tool for teleoperating a manipulator. Inputs can include generic `TwistStamped` or `JointJog` commands, collisions can be detected and avoided, and singular positions can be avoided.
Expand All @@ -89,6 +89,6 @@ ros2 launch moveit_servo servo_teleop.launch.py
You should now be able to input commands via the controller. Default supported actions include Cartesian and joint commands, and switching the frame of the Cartiesian commands.

#### Expected output
![Alt Text](https://github.com/AdamPettinger/moveit2/blob/pr-rebase_on_foxy/moveit_ros/moveit_servo/doc/Images/Servo_Teleop_Demo.gif)
![Alt Text](Images/Servo_Teleop_Demo.gif)

Please note the controller overlay is for demonstration purposes and is not part of the actual demonstration.
12 changes: 6 additions & 6 deletions moveit_ros/moveit_servo/doc/servo_tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,16 +45,16 @@ The C++ API is offered as the `Servo` class, defined in `include/moveit_servo/se
3) Creating a `planning_scene_monitor` (if you don't already have one) and `ServoParameters` and passing both to a new `Servo` object.
4) Calling `start()` on the `Servo` instance and publishing commands.

See the [C++ interface demo](https://github.com/AdamPettinger/moveit2/blob/pr-rebase_on_foxy/moveit_ros/moveit_servo/src/ros2_demo/servo_cpp_interface_demo.cpp) as an example, and the [Setting Up a New Robot](#Setting-Up-a-New-Robot) section later for details on getting your specific robot up and running.
See the [C++ interface demo](../src/cpp_interface_demo/servo_cpp_interface_demo.cpp) as an example, and the [Setting Up a New Robot](#Setting-Up-a-New-Robot) section later for details on getting your specific robot up and running.

The C++ API can be visualized with:
![Alt Text](https://github.com/AdamPettinger/moveit2/blob/pr-rebase_on_foxy/moveit_ros/moveit_servo/doc/Images/Servo_Interface.png)
![Alt Text](Images/Servo_Interface.png)

#### Composable Node Interface
A standalone component is also offered as a `ServoServer`. This allows you include starting a `ServoServer` in your launch file, and interact with `Servo` only through ROS topics and services. See the [servo server demo](https://github.com/AdamPettinger/moveit2/blob/pr-rebase_on_foxy/moveit_ros/moveit_servo/launch/servo_server_demo.launch.py) as an example.
A standalone component is also offered as a `ServoServer`. This allows you include starting a `ServoServer` in your launch file, and interact with `Servo` only through ROS topics and services. See the [servo server demo](../launch/servo_server_demo.launch.py) as an example.

The composable node interface can be visualized with:
![Alt Text](https://github.com/AdamPettinger/moveit2/blob/pr-rebase_on_foxy/moveit_ros/moveit_servo/doc/Images/Servo_Servo_Interface.png)
![Alt Text](Images/Servo_Servo_Interface.png)

# Setting Up a New Robot

Expand All @@ -70,10 +70,10 @@ Because the kinematics are handled by the core parts of `moveit`, it is reccomen
#### A note on controllers
As of now, there is no [ros2_controls controller](https://github.com/ros-controls/ros2_controllers) that can work with `moveit_servo`. ROS1 controllers that worked include `position_controllers/JointGroupPositionControllers` and `velocity_controllers/JointGroupVelocityControllers`.

A simulated controller, [fake_joint_driver](https://github.com/JafarAbdi/fake_joint/tree/foxy) is used in the `moveit_servo` examples, and should at least be able to get `moveit_servo` working with a simulated version of your robot. Please see [the example config file](https://github.com/AdamPettinger/moveit2/blob/pr-rebase_on_foxy/moveit_ros/moveit_servo/config/panda_controllers.yaml) and [launch file](https://github.com/AdamPettinger/moveit2/blob/0387902b9a81cfd8d09888f90a02a1540c9e02da/moveit_ros/moveit_servo/launch/servo_cpp_interface_demo.launch.py#L73-L78) for an example of how to set that up for your robot.
A simulated controller, [fake_joint_driver](https://github.com/JafarAbdi/fake_joint/tree/foxy) is used in the `moveit_servo` examples, and should at least be able to get `moveit_servo` working with a simulated version of your robot. Please see [the example config file](../config/panda_controllers.yaml) and [launch file](../launch/servo_cpp_interface_demo.launch.py#L73-L78) for an example of how to set that up for your robot.

### Installation
Please see the [Running the Demos](https://github.com/AdamPettinger/moveit2/blob/pr-rebase_on_foxy/moveit_ros/moveit_servo/doc/running_the_demos.md) guide for installation instructions. Running at least the C++ Interface Demo will make sure `moveit_servo` is properly installed.
Please see the [Running the Demos](running_the_demos.md) guide for installation instructions. Running at least the C++ Interface Demo will make sure `moveit_servo` is properly installed.

### Input devices
The two primary inputs to `moveit_servo` are Cartesian commands and joint commands. These come into `moveit_servo` as [TwistStamped](http://docs.ros.org/melodic/api/geometry_msgs/html/msg/TwistStamped.html) and [JointJog](http://docs.ros.org/api/control_msgs/html/msg/JointJog.html) messages respectively. The source of the commands can be almost anything including: gamepads, voice commands, a SpaceNav mouse, or PID nodes (e.g. for visual servoing).
Expand Down

0 comments on commit 6ad7833

Please sign in to comment.