Skip to content

Commit 873ffbf

Browse files
Update documentation (#655)
* Remove references to melodic * Reference master branch of urcl * Remove extra note for UR16 * Complete content list * Add note about preferring binary installation of the driver Co-authored-by: Felix Exner (fexner) <[email protected]>
1 parent 28548b1 commit 873ffbf

File tree

2 files changed

+16
-18
lines changed

2 files changed

+16
-18
lines changed

README.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -85,38 +85,36 @@ This repository contains the new **ur_robot_driver** and a couple of helper pack
8585

8686
* **ur_calibration**: Package around extracting and converting a robot's factory calibration
8787
information to make it usable by the robot_description.
88+
* **ur_dashboard_msgs**: Message definitions used for interacting with the dashboard node.
8889
* **ur_robot_driver**: The actual driver package.
8990

9091
## Requirements
91-
This driver requires a system setup with ROS. It is recommended to use **Ubuntu 18.04 with ROS
92-
melodic**, however using Ubuntu 20.04 with ROS noetic should also work.
92+
This driver requires a system setup with ROS. It is recommended to use **Ubuntu 20.04 with ROS
93+
noetic**.
9394

9495
To make sure that robot control isn't affected by system latencies, it is highly recommended to use
9596
a real-time kernel with the system. See the [real-time setup guide](ur_robot_driver/doc/real_time.md)
9697
on information how to set this up.
9798

98-
## Preliminary UR16e support
99-
This driver supports all UR variants including the UR16e. However, upstream support for the UR16e is
100-
not finished, yet. When using the UR16e there is currently no support for gazebo or MoveIt!.
99+
## Install from binary packages
101100

102-
See [#97](https://github.com/UniversalRobots/Universal_Robots_ROS_Driver/pull/97) for details on
103-
using the latest upstream develop branch of
104-
[ros_industrial/universal_robot](https://github.com/ros-industrial/universal_robot) which includes
105-
gazebo support for the ur16e, but no working MoveIt! support at the time of writing.
101+
1. [Install ROS](http://wiki.ros.org/noetic/Installation/Ubuntu). This package only supports ROS
102+
noetic. If you want to use a UR robot arm with ROS 2, please see the
103+
[ROS 2 driver](https://github.com/UniversalRobots/Universal_Robots_ROS2_Driver/).
104+
2. Install the driver using
105+
```bash
106+
sudo apt install ros-${ROS_DISTRO}-ur-robot-driver
107+
```
108+
## Building from source
106109

107-
## Building
110+
Before building from source make sure that you actually need to do that. We recommend you install the driver from its binary packages unless you want to join development and submit changes.
108111

109112
**Note:** The driver consists of a [C++
110113
library](https://github.com/UniversalRobots/Universal_Robots_Client_Library) that abstracts the
111114
robot's interfaces and a ROS driver on top of that. As the library can be built without ROS support,
112115
it is not a catkin package and therefore requires a different treatment when being built inside the
113116
workspace. See The alternative build method below if you'd like to build the library from source.
114117

115-
If you don't want to build the library from source, it is available as a binary package through the
116-
ROS distribution of ROS melodic and noetic. It will be installed automatically if you
117-
follow the steps below. If you'd like to also build the library from source, please follow the steps
118-
explained in the [next section](#alternative-all-source-build).
119-
120118
```bash
121119
# source global ros
122120
$ source /opt/ros/<your_ros_version>/setup.bash
@@ -150,7 +148,7 @@ build`](https://catkin-tools.readthedocs.io/en/latest/verbs/catkin_build.html).
150148
```bash
151149
$ source /opt/ros/<your_ros_version>/setup.bash
152150
$ mkdir -p catkin_ws/src && cd catkin_ws
153-
$ git clone -b boost https://github.com/UniversalRobots/Universal_Robots_Client_Library.git src/Universal_Robots_Client_Library
151+
$ git clone https://github.com/UniversalRobots/Universal_Robots_Client_Library.git src/Universal_Robots_Client_Library
154152
$ git clone https://github.com/UniversalRobots/Universal_Robots_ROS_Driver.git src/Universal_Robots_ROS_Driver
155153
$ git clone -b melodic-devel https://github.com/ros-industrial/universal_robot.git src/universal_robot
156154
$ sudo apt update -qq

ur_robot_driver/doc/controllers.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,14 +47,14 @@ not the actual *efforts* in a physical sense.
4747
**Type:** [`industrial_robot_status_controller/IndustrialRobotStatusController`](http://wiki.ros.org/industrial_robot_status_controller)
4848

4949
Controller that publishes robot/controller state (e-stopped, in motion, etc) as
50-
[`industrial_msgs/RobotStatus`](http://docs.ros.org/en/melodic/api/industrial_msgs/html/msg/RobotStatus.html)
50+
[`industrial_msgs/RobotStatus`](http://docs.ros.org/en/noetic/api/industrial_msgs/html/msg/RobotStatus.html)
5151
messages on the `/robot_status` topic.
5252

5353
### `force_torque_sensor_controller`
5454
**Type:** [`force_torque_sensor_controller/ForceTorqueSensorController`](http://wiki.ros.org/force_torque_sensor_controller)
5555

5656
This controller publishes the wrench measured from the robot at its TCP as
57-
[`geometry_msgs/WrenchStamped`](http://docs.ros.org/en/melodic/api/geometry_msgs/html/msg/WrenchStamped.html)
57+
[`geometry_msgs/WrenchStamped`](http://docs.ros.org/en/noetic/api/geometry_msgs/html/msg/WrenchStamped.html)
5858
on the topic `/wrench`. Note that the wrench can be tared to 0 using the
5959
`zero_ftsensor`(https://github.com/UniversalRobots/Universal_Robots_ROS_Driver/blob/master/ur_robot_driver/doc/ROS_INTERFACE.md#zero_ftsensor-std_srvstrigger)
6060
service.

0 commit comments

Comments
 (0)