ur_robot_driver

This package contains the actual driver for UR robots. It is part of the universal_robots_driver repository and requires other packages from that repository. Also, see the main repository’s README for information on how to install and startup this driver.

ROS-API

The ROS API is documented in a standalone document. It is auto-generated using catkin_doc.

Technical details

The following image shows a very coarse overview of the driver’s architecture.

Upon connection to the primary interface the robot sends version and calibration information which is consumed by the calibration_check. If the calibration reported by the robot doesn’t match the one configured (See calibration guide) an error will be printed to Roslog.

Real-time data from the robot is read through the RTDE interface. This is done automatically as soon as a connection to the robot could be established. Thus joint states and IO data will be immediately available.

To actually control the robot, a program node from the External Control URCap must be running on the robot interpreting commands sent from an external source. When this program is not running, no controllers moving the robot around will be available, which is handled by the controller_stopper. Please see the initial setup guide on how to install and start this on the robot.

The URScript that will be running on the robot is requested by the External Control program node from the remote ROS PC. The robot ur_control.launch file has a parameter called urscript_file to select a different program than the default one that will be sent as a response to a program request.

Custom script snippets can be sent to the robot on a topic basis. By default, they will interrupt other programs (such as the one controlling the robot). For a certain subset of functions, it is however possible to send them as secondary programs. See UR documentation on details.
Note to e-Series users: The robot won’t accept script code from a remote source unless the robot is put into remote_control-mode. However, if put into remote_control-mode, the program containing the External Control program node can’t be started from the panel. For this purpose, please use the dashboard services to load, start and stop the main program running on the robot. See the ROS-API documentation for details on the dashboard services.

For using the tool communication interface on e-Series robots, a socat script is prepared to forward the robot’s tool communication interface to a local device on the ROS PC. See the tool communication setup guide for details.

This driver is using ROS-Control for any control statements. Therefore, it can be used with all position-based controllers available in ROS-Control. However, we recommend using the controllers from the ur_controllers package. See it’s documentation for details. Note: Speed scaling support will only be available using the controllers from ur_controllers

A note about modes

The term mode is used in different meanings inside this driver.

Remote control mode

On the e-series the robot itself can operate in different command modes: It can be either in local control mode where the teach pendant is the single point of command or in remote control mode, where motions from the TP, starting & loading programs from the TP activating the freedrive mode are blocked. Note that the remote control mode has to be explicitly enabled in the robot’s settings under Settings -> System -> Remote Control. See the robot’s manual for details.

The remote control mode is needed for many aspects of this driver such as

• headless mode (see below)
• sending script code to the robot
• many dashboard functionalities such as
  • restarting the robot after protective / EM-Stop
  • powering on the robot and do brake release
  • loading and starting programs
• the set_mode action, as it uses the dashboard calls mentioned above

Headless mode

Inside this driver, there’s the headless mode, which can be either enabled or not. When the headless mode is activated, required script code for external control will be sent to the robot directly when the driver starts. As soon as other script code is sent to the robot either by sending it directly through this driver or by pressing any motion-related button on the teach pendant, the script will be overwritten by this action and has to be restarted by using the resend_robot_program service. If this is necessary, you will see the output Connection to robot dropped, waiting for new connection. from the driver. Note that pressing “play” on the TP won’t start the external control again, but whatever program is currently loaded on the controller. This mode doesn’t require the “External Control” URCap being installed on the robot as the program is sent to the robot directly. However, we recommend to use the non-headless mode and leverage the set_mode action to start program execution without the teach pendant. The headless mode might be removed in future releases.

Note for the e-Series: In order to leverage the headless mode on the e-Series the robot must be in remote_control_mode as explained above.

controller_stopper

A small helper node that stops and restarts ROS controllers based on a boolean status topic. When the status goes to false, all running controllers except a set of predefined consistent_controllers gets stopped. If status returns to true the stopped controllers are restarted. This is done by Subscribing to a robot’s running state topic. Ideally this topic is latched and only publishes on changes. However, this node only reacts on state changes, so a state published each cycle would also be fine.

2.0.2 (2022-12-07)

2.0.1 (2022-08-01)

• added ur_bringup to test_depend of ur_robot_driver (#454)
• Contributors: Felix Exner

2.0.0 (2022-06-20)

• Updated package dependencies (#399)
• Foxy controller stopper (#324)
• Backport: Change driver constructor and change calibration check (#282) (#302)
• Moved registering publisher and service to on_active (#151)
• Converted io_test and switch_on_test to ROS2 (#124)
• Added loghandler to handle log messages from the Client Library with … (#126)
• Removed dashboard client from hardware interface
• [WIP] Updated feature list (#102)
• Moved Async check out of script running check (#112)
• Fix gpio controller (#103)
• Fixed speed slider service call (#100)
• Adding missing backslash and only setting workdir once (#108)
• Added dockerfile for the driver (#105)
• Using official Universal Robot Client Library (#101)
• Reintegrating missing ur_client_library dependency since the break the building process (#97)
• Fix readme hardware setup (#91)
• Fix move to home bug (#92)
• Using modern python
• Some intermediate commit
• Remove obsolete and unused files and packages. (#80)
• Review CI by correcting the configurations (#71)
• Add support for gpios, update MoveIt and ros2_control launching (#66)
• Quickfix against move home bug
• Added missing initialization
• Use GitHub Actions, use pre-commit formatting (#56)
• Put dashboard services into corresponding namespace
• Start dashboard client from within the hardware interface
• Added try catch blocks for service calls
• Removed repeated declaration of timeout parameter which lead to connection crash
• Removed static service name in which all auto generated services where mapped
• Removed unused variable
• Fixed clang-format issue
• Removed all robot status stuff
• Exchanged hardcoded value for RobotState msgs enum
• Removed currently unused controller state variables
• Added placeholder for industrial_robot_status_interface
• Fixed clang issues
• Added checks for internal robot state machine
• Only load speed scaling interface
• Changed state interface to combined speed scaling factor
• Added missing formatting in hardware interface
• Initial version of the speed_scaling_state_controller Controller is base on the current joint_state_controller of ros2 control
• Fix clang tidy in multiple pkgs.
• Clang tidy fix.
• Update force torque state controller.
• Prepare for testing.
• Fix decision breaker for position control. Make decision effect instantaneous.
• Use only position interface.
• Update hardware interface for ROS2 (#8)
• Update the dashboard client for ROS2 (#5)
• Hardware interface framework (#3)
• Add XML schema to all package.xml files Better enable ament_xmllint to check validity.
• Silence ament_lint_cmake errors
• Update packaging for ROS2
• Update package.xml files so ros2 pkg list shows all pkgs
• Clean out ur_robot_driver for initial ROS2 compilation
• Compile ur_dashboard_msgs for ROS2
• Delete all launch/config files with no UR5 relation
• Initial work toward compiling ur_robot_driver

File truncated at 100 lines see the full file