Skip to content

Commit de21074

Browse files
urfeexURJala
andauthored
Add noetic-eol specific instructions to installation sections (#760)
* Add noetic-eol specific instructions to installation sections covering - ROS 1 is EOL - Updates on how to build from source (rosdep) - Reference to ROS-O * Clarify the term "binary" and clearly state that ROS-O publishes binary packages Co-authored-by: URJala <159417921+URJala@users.noreply.github.com>
1 parent 0fddf3b commit de21074

File tree

1 file changed

+30
-22
lines changed

1 file changed

+30
-22
lines changed

README.md

Lines changed: 30 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,14 @@
11
[![Build badge](https://github.com/UniversalRobots/Universal_Robots_ROS_Driver/workflows/Industrial%20CI%20pipeline/badge.svg?branch=master&event=push)](https://github.com/UniversalRobots/Universal_Robots_ROS_Driver/actions)
22

33
# Universal_Robots_ROS_Driver
4+
5+
> [!IMPORTANT]
6+
> ROS 1 is End Of Life since end of May 2025. This repository isn't further developed anymore.
7+
> Bugfixes may or may not be added to this repository. There are no further binary releases for any
8+
> ROS 1 distribution from the ROS repositories. If you want to use a newer version than the last
9+
> one released, please either build from source or use the binary packages from the [ROS-O
10+
> project](https://github.com/ros-o).
11+
412
Universal Robots have become a dominant supplier of lightweight, robotic manipulators for industry, as well as for scientific research and education. The Robot Operating System (ROS) has developed from a community-centered movement to a mature framework and quasi standard, providing a rich set of powerful tools for robot engineers and researchers, working in many different domains.
513

614
<div align="center"><img src="ur_robot_driver/doc/initial_setup_images/family_photo.png" alt="Universal Robot e-Series family" style="width: 90%;"/></div>
@@ -17,24 +25,24 @@ Developed in collaboration between:
1725
[<img height="60" alt="Universal Robots A/S" src="ur_robot_driver/doc/resources/ur_logo.jpg">](https://www.universal-robots.com/) &nbsp; and &nbsp;
1826
[<img height="60" alt="FZI Research Center for Information Technology" src="ur_robot_driver/doc/resources/fzi-logo_transparenz.png">](https://www.fzi.de).
1927

20-
<!--
28+
<!--
2129
ROSIN acknowledgement from the ROSIN press kit
2230
@ https://github.com/rosin-project/press_kit
2331
-->
2432

2533
<a href="http://rosin-project.eu">
26-
<img src="https://raw.githubusercontent.com/rosin-project/press_kit/master/img/rosin_ack_logo_wide.png"
34+
<img src="https://raw.githubusercontent.com/rosin-project/press_kit/master/img/rosin_ack_logo_wide.png"
2735
alt="rosin_logo" height="60" >
2836
</a>
2937

30-
Supported by ROSIN - ROS-Industrial Quality-Assured Robot Software Components.
38+
Supported by ROSIN - ROS-Industrial Quality-Assured Robot Software Components.
3139
More information: <a href="http://rosin-project.eu">rosin-project.eu</a>
3240

33-
<img src="https://raw.githubusercontent.com/rosin-project/press_kit/master/img/rosin_eu_flag.jpg"
34-
alt="eu_flag" height="45" align="left" >
41+
<img src="https://raw.githubusercontent.com/rosin-project/press_kit/master/img/rosin_eu_flag.jpg"
42+
alt="eu_flag" height="45" align="left" >
3543

36-
This project has received funding from the European Union’s Horizon 2020
37-
research and innovation programme under grant agreement no. 732287.
44+
This project has received funding from the European Union’s Horizon 2020
45+
research and innovation programme under grant agreement no. 732287.
3846

3947

4048
## How to report an issue
@@ -43,7 +51,7 @@ Before creating an issue, please have a look at the [Troubleshooting section](#T
4351
To create an issue on the [Issue Board](https://github.com/UniversalRobots/Universal_Robots_ROS_Driver/issues/new) please use the default template.
4452

4553
## How to get help
46-
If you need help using this driver, please see the ROS-category in the [UR+ Developer Forum](https://forum.universal-robots.com/c/ros).
54+
If you need help using this driver, please see the ROS-category in the [UR+ Developer Forum](https://forum.universal-robots.com/c/ros).
4755

4856
## Features
4957
* Works for all **CB3 (with software version >= 3.14.3) and e-Series (software >= 5.9.4)** robots and uses the RTDE interface for communication, whenever possible.
@@ -105,6 +113,15 @@ noetic. If you want to use a UR robot arm with ROS 2, please see the
105113
```bash
106114
sudo apt install ros-${ROS_DISTRO}-ur-robot-driver ros-${ROS_DISTRO}-ur-calibration
107115
```
116+
117+
> [!NOTE]
118+
> ROS 1 is end of life since End of May 2025. Please consider switching to ROS 2 instead.
119+
> The ROS noetic binary packages will not receive any updates anymore. Even if bugfixes are
120+
> commited to this repository (or other packages), they will not end up in the ROS binary packages.
121+
> However, the [ROS-O project](https://github.com/ros-o) builds binary packages for ROS 1. See
122+
> their website for further information.
123+
> Alternatively, you can build the driver from source (see below).
124+
108125
## Building from source
109126

110127
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.
@@ -117,25 +134,16 @@ workspace. See The alternative build method below if you'd like to build the lib
117134

118135
```bash
119136
# source global ros
120-
$ source /opt/ros/<your_ros_version>/setup.bash
137+
$ source /opt/ros/noetic/setup.bash
121138

122139
# create a catkin workspace
123140
$ mkdir -p catkin_ws/src && cd catkin_ws
124141

125142
# clone the driver
126143
$ git clone https://github.com/UniversalRobots/Universal_Robots_ROS_Driver.git src/Universal_Robots_ROS_Driver
127144

128-
# Install vcstool
129-
$ sudo apt update -qq
130-
$ sudo apt install python3-vcstool
131-
132-
# clone the direct dependencies. As the latest version might require the latest upstream version,
133-
# we'll build things from source. Note: This does not include the client library. If there are API
134-
# changes there, you might have to use the all-source build as explained below.
135-
$ vcs import --input src/Universal_Robots_ROS_Driver/.noetic.rosinstall src
136-
137145
# install dependencies
138-
$ rosdep update
146+
$ rosdep update --include-eol-distros
139147
$ rosdep install --from-paths src --ignore-src -y
140148

141149
# build the workspace
@@ -151,7 +159,7 @@ well and build it using either `catkin_make_isolated` or [`catkin
151159
build`](https://catkin-tools.readthedocs.io/en/latest/verbs/catkin_build.html).
152160

153161
```bash
154-
$ source /opt/ros/<your_ros_version>/setup.bash
162+
$ source /opt/ros/noetic/setup.bash
155163
$ mkdir -p catkin_ws/src && cd catkin_ws
156164
$ git clone https://github.com/UniversalRobots/Universal_Robots_Client_Library.git src/Universal_Robots_Client_Library
157165
$ sudo apt update -qq
@@ -243,7 +251,7 @@ Use this with any client interface such as [MoveIt!](https://moveit.ros.org/) or
243251
rosrun rqt_joint_trajectory_controller rqt_joint_trajectory_controller
244252
```
245253

246-
You may need to install rqt_joint_trajectory_controller by running:
254+
You may need to install rqt_joint_trajectory_controller by running:
247255
```
248256
sudo apt install ros-<ROS-DISTRO>-rqt-joint-trajectory-controller
249257
```
@@ -311,7 +319,7 @@ save installation and program, then no exception is raised when no connection
311319
to the fieldbus scanner can be established (note: This is only to get the
312320
`External Control` running. You probably want to make sure that a connection to
313321
the fieldbus scanner can indeed be made). If you don't use EtherNet/IP
314-
fieldbusses at all, you can disable it in the same installation screen.
322+
fieldbusses at all, you can disable it in the same installation screen.
315323

316324
### When starting the driver, it crashes with `Variable 'speed_slider_mask' is currently controlled by another RTDE client`
317325
Probably, you are running into [#204](../../issues/204). Currently, this driver cannot be used together with an enabled

0 commit comments

Comments
 (0)