Skip to content

Commit 45dcfd7

Browse files
authored
Move some documentation to client_library (UniversalRobots#1245)
* Update robot_setup that has been moved to client_library * Update labels that are used in the client_library as well The dashboard client and script_command_interface have ROS 2 specific documentation. That docs get attached a _ros2 suffix in the ROS 2 documentation. * Update to merged robot_setup instructions
1 parent 024e500 commit 45dcfd7

File tree

11 files changed

+15
-338
lines changed

11 files changed

+15
-338
lines changed

ur_robot_driver/doc/dashboard_client.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _dashboard_client:
1+
.. _dashboard_client_ros2:
22

33
Dashboard client
44
================

ur_robot_driver/doc/installation/install_urcap_cb3.rst

Lines changed: 0 additions & 67 deletions
This file was deleted.

ur_robot_driver/doc/installation/install_urcap_e_series.rst

Lines changed: 0 additions & 66 deletions
This file was deleted.

ur_robot_driver/doc/installation/robot_setup.rst

Lines changed: 4 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -1,98 +1,11 @@
1-
.. _robot_setup:
2-
31
Setting up a UR robot for ur_robot_driver
42
=========================================
53

6-
Network setup
7-
-------------
8-
9-
There are many possible ways to connect a UR robot. This section describes a good example using static IP addresses and a direct connection from the PC to the Robot to minimize latency introduced by network hardware. Though a good network switch usually works fine, as well.
10-
11-
12-
#.
13-
Connect the UR control box directly to the remote PC with an ethernet cable.
14-
15-
#.
16-
Open the network settings from the UR teach pendant (Setup Robot -> Network) and enter these settings:
17-
18-
.. code-block::
19-
20-
IP address: 192.168.1.102
21-
Subnet mask: 255.255.255.0
22-
Default gateway: 192.168.1.1
23-
Preferred DNS server: 192.168.1.1
24-
Alternative DNS server: 0.0.0.0
25-
26-
* Enable remote control (Not applicable on PolyScope X versions)
27-
#. Go to the hamburger menu -> settings.
28-
#. Go to System -> Remote control.
29-
#. Unlock the menu using the admin password, and enable Remote Control.
30-
#. Press exit.
31-
#. The robot can now be toggled between local and remote control in the upper right hand corner.
32-
33-
.. image:: initial_setup_images/remote_control.png
34-
:width: 600
35-
:alt: Screenshot showing remote control toggle.
36-
37-
* **If using PolyScope 5.10 or greater:**
38-
#. Go to the hamburger menu -> settings.
39-
#. Go to Security -> Services.
40-
#. Unlock the menu using the admin password.
41-
#. Enable the Dashboard Server (Not applicable on PolyScope X versions), Primary Client Interface, Secondary Client Interface and Real-Time Data Exchange (RTDE) interfaces.
42-
#. Lock the menu and press exit.
43-
44-
* PolyScope 5 screen:
45-
46-
.. image:: initial_setup_images/services_polyscope5.png
47-
:width: 600
48-
:alt: Screenshot from PolyScope 5.xx services menu.
49-
50-
* PolyScope X screen:
51-
52-
.. image:: initial_setup_images/services_polyscopex.jpg
53-
:width: 600
54-
:alt: Screenshot from PolyScope X screen.
55-
56-
Remote PC Setup
57-
~~~~~~~~~~~~~~~
58-
#.
59-
On the remote PC, turn off all network devices except the "wired connection", e.g. turn off wifi.
60-
61-
#.
62-
Open Network Settings and create a new Wired connection with these settings. You may want to name this new connection ``UR`` or something similar:
63-
64-
.. code-block::
65-
66-
IPv4
67-
Manual
68-
Address: 192.168.1.101
69-
Netmask: 255.255.255.0
70-
Gateway: 192.168.1.1
71-
72-
73-
#. Verify the connection from the PC with e.g. ping.
74-
75-
.. code-block::
76-
77-
ping 192.168.1.102
78-
79-
Prepare the robot
80-
-----------------
81-
82-
This section describes installation and launching of the URCap program from the pendant. It allows ROS to control the robot externally. Generally, you will launch the driver via ROS then start URCap from the pendant.
83-
84-
For using the *ur_robot_driver* with a real robot you need to install the
85-
**externalcontrol urcap**. The latest release can be downloaded from `its own repository <https://github.com/UniversalRobots/Universal_Robots_ExternalControl_URCap/releases>`_.
86-
87-
**Note**: For installing this URCap a minimal PolyScope version of 3.14.3 or 5.9.4 (in case of e-Series) is
88-
necessary.
89-
90-
For installing the necessary URCap and creating a program, please see the individual tutorials on
91-
how to :ref:`setup a cb3 robot <install-urcap-cb3>` or how to
92-
:ref:`setup an e-Series robot <install-urcap-e-series>`.
4+
Prepare robot and network connection
5+
------------------------------------
936

94-
To setup the tool communication on an e-Series robot, please consider the :ref:`tool communication setup
95-
guide <setup-tool-communication>`.
7+
Before you can use the ``ur_robot_driver`` you need to prepare the robot and the network
8+
connection as described in the :ref:`robot_setup` and :ref:`network_setup` section of the UR Client Library documentation.
969

9710
Prepare the ROS PC
9811
------------------

ur_robot_driver/doc/installation/toc.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,3 @@ This chapter explains how to install the ``ur_robot_driver``
1111

1212
installation
1313
robot_setup
14-
install_urcap_cb3
15-
install_urcap_e_series
16-
ursim_docker

ur_robot_driver/doc/installation/ursim_docker.rst

Lines changed: 0 additions & 99 deletions
This file was deleted.

ur_robot_driver/doc/operation_modes.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ E-series robots can operate in different command modes: It can be either in *loc
1717
The remote control mode is needed for many aspects of this driver such as
1818

1919
- :ref:`headless_mode`
20-
- :ref:`Sending script code to the robot<script_command_interface>`
21-
- Many :ref:`dashboard<dashboard_client>` functionalities such as
20+
- :ref:`Sending script code to the robot<script_command_interface_ros2>`
21+
- Many :ref:`dashboard<dashboard_client_ros2>` functionalities such as
2222

2323
- restarting the robot after protective / EM-Stop
2424
- powering on the robot and do brake release
@@ -29,16 +29,16 @@ Driver's operation modes
2929
------------------------
3030

3131
There are two fundamentally different control modes of the UR ROS driver to control a UR robot or the URSim robot simulator:
32-
- *Teach Pendant mode* using the :ref:`External Control URCap<install-urcap-e-series>`
32+
- *Teach Pendant mode* using the :ref:`External Control URCap<install_urcap>`
3333
- *Headless mode* that works without interacting with Teach pendant, when *remote control mode* has been selected on the teach pendant.
3434

3535
.. _teach_pendant_mode:
3636

3737
Teach Pendant Mode
3838
^^^^^^^^^^^^^^^^^^^^^
3939

40-
In Teach Pendant mode you will need the :ref:`External Control URCap<install-urcap-e-series>`
41-
installed on the robot. Please follow the installation guidelines for the :ref:`CB3<install-urcap-cb3>` or :ref:`E-series<install-urcap-e-series>`. Remember to set the correct IP address for the ROS driver host computer, and ensure the configured port number matches the ``script_sender_port`` defined in the ROS driver's launch arguments, default is 50002.
40+
In Teach Pendant mode you will need the :ref:`External Control URCap<install_urcap>`
41+
installed on the robot. Remember to set the correct IP address for the ROS driver host computer, and ensure the configured port number matches the ``script_sender_port`` defined in the ROS driver's launch arguments, default is 50002.
4242

4343
With that, create a program containing the *External Control* program node and press "play" on the teach pendant to start the program.
4444
Hereafter the URCap will request script code from the ROS driver and execute it, once the program enters that node. In addition, the ROS driver can return the control to the Teach pendent program. This gives the possibility to combine the teach pendant program and the use of the ROS driver.

ur_robot_driver/doc/setup_tool_communication.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Robot setup
2626
-----------
2727

2828
For setting up the robot, please install the **rs485-1.0.urcap** found in the **resources** folder.
29-
Installing a URCap is explained in the :ref:`setup guide <install-urcap-e-series>` for the **external-control** URCap.
29+
Installing a URCap is explained in the :ref:`setup guide <install_urcap>` for the **external-control** URCap.
3030

3131
After installing the URCap the robot will expose its tool communication device to the network.
3232

ur_robot_driver/doc/usage/script_code.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Sending URScript code to the robot
22
==================================
33

4-
.. _script_command_interface:
4+
.. _script_command_interface_ros2:
55

66
Custom URScript commands
77
------------------------

0 commit comments

Comments
 (0)