Skip to content

Commit fc4a77f

Browse files
committed
Merge urcap installations into robot setup instructions
1 parent d843a8b commit fc4a77f

File tree

5 files changed

+126
-146
lines changed

5 files changed

+126
-146
lines changed

doc/setup.rst

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,4 @@ Setup a robot
66

77
setup/robot_setup
88
setup/network_setup
9-
setup/install_urcap_cb3
10-
setup/install_urcap_e_series
119
setup/ursim_docker.rst

doc/setup/install_urcap_cb3.rst

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

doc/setup/install_urcap_e_series.rst

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

doc/setup/robot_setup.rst

Lines changed: 125 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,12 @@ In order to use the client library with a robot, that robot has to be setup.
77

88
.. tabs::
99

10-
.. tab:: PolyScope 5
10+
.. group-tab:: CB3
11+
12+
CB3 robots can directly be used with the ur_client_library. No special preparation is needed.
13+
14+
15+
.. group-tab:: PolyScope 5
1116

1217
**Enable remote control:**
1318

@@ -35,7 +40,7 @@ In order to use the client library with a robot, that robot has to be setup.
3540
:alt: Screenshot from PolyScope 5.xx services menu.
3641

3742

38-
.. tab:: PolyScope X
43+
.. group-tab:: PolyScope X
3944

4045
**Enable services:**
4146

@@ -49,6 +54,7 @@ In order to use the client library with a robot, that robot has to be setup.
4954
:width: 600
5055
:alt: Screenshot from PolyScope X screen.
5156

57+
.. _install_urcap:
5258

5359
URCap installation
5460
------------------
@@ -60,29 +66,139 @@ application.
6066

6167
.. tabs::
6268

63-
.. tab:: CB3
69+
.. group-tab:: CB3
6470

6571
.. note::
6672

6773
A minimal PolyScope version of 3.14.3 is required to use this URCap
6874

6975
The latest release can be downloaded from `its own repository <https://github.com/UniversalRobots/Universal_Robots_ExternalControl_URCap/releases>`_.
7076

71-
For installing the necessary URCap and creating a program, please see the individual tutorials on
72-
how to :ref:`setup a CB3 robot <install-urcap-cb3>`.
77+
To install the URCap you first have to copy it to the robot's **programs** folder which can be done either
78+
via scp or using a USB stick.
79+
80+
On the welcome screen select *Setup Robot* and then *URCaps* to enter the URCaps installation
81+
screen.
82+
83+
84+
.. image:: ../images/initial_setup_images/cb3_01_welcome.png
85+
:target: initial_setup_images/cb3_01_welcome.png
86+
:alt: Welcome screen of a CB3 robot
87+
88+
89+
There, click the little plus sign at the bottom to open the file selector. There you should see
90+
all urcap files stored inside the robot's programs folder or a plugged USB drive. Select and open
91+
the **externalcontrol-X.Y.Z.urcap** file and click *open*. Your URCaps view should now show the
92+
**External Control** in the list of active URCaps and a notification to restart the robot. Do that
93+
now.
94+
95+
96+
.. image:: ../images/initial_setup_images/cb3_05_urcaps_installed.png
97+
:target: initial_setup_images/cb3_05_urcaps_installed.png
98+
:alt: URCaps screen with installed urcaps
99+
100+
101+
After the reboot you should find the **External Control** URCaps inside the *Installation* section.
102+
For this select *Program Robot* on the welcome screen, select the *Installation* tab and select
103+
**External Control** from the list.
104+
105+
106+
.. image:: ../images/initial_setup_images/cb3_07_installation_excontrol.png
107+
:target: initial_setup_images/cb3_07_installation_excontrol.png
108+
:alt: Installation screen of URCaps
109+
110+
111+
Here you'll have to setup the IP address of the external PC which will be running the remote
112+
application.
113+
Note that the robot and the external PC have to be in the same network, ideally in a direct
114+
connection with each other to minimize network disturbances. The custom port should be left
115+
untouched for now.
116+
117+
118+
.. image:: ../images/initial_setup_images/cb3_10_prog_structure_urcaps.png
119+
:target: initial_setup_images/cb3_10_prog_structure_urcaps.png
120+
:alt: Insert the external control node
121+
122+
123+
To use the new URCaps, create a new program and insert the **External Control** program node into
124+
the program tree
125+
126+
127+
.. image:: ../images/initial_setup_images/cb3_11_program_view_excontrol.png
128+
:target: initial_setup_images/cb3_11_program_view_excontrol.png
129+
:alt: Program view of external control
130+
73131

74-
.. tab:: e-Series
132+
If you click on the *command* tab again, you'll see the settings entered inside the *Installation*.
133+
Check that they are correct, then save the program. Your robot is now ready to be used together with
134+
this driver
135+
136+
.. group-tab:: PolyScope 5
75137

76138
.. note::
77139

78140
A minimal PolyScope version of 5.9.4 is required to use this URCap
79141

80142
The latest release can be downloaded from `its own repository <https://github.com/UniversalRobots/Universal_Robots_ExternalControl_URCap/releases>`_.
81143

82-
For installing the necessary URCap and creating a program, please see the individual tutorials on
83-
how to :ref:`setup an e-Series robot <install-urcap-e-series>`.
144+
To install it you first have to copy it to the robot's **programs** folder which can be done either
145+
via scp or using a USB stick.
146+
147+
On the welcome screen click on the hamburger menu in the top-right corner and select *Settings* to enter the robot's setup. There select *System* and then *URCaps* to enter the URCaps installation screen.
148+
149+
150+
.. image:: ../images/initial_setup_images/es_01_welcome.png
151+
:target: initial_setup_images/es_01_welcome.png
152+
:alt: Welcome screen of an e-Series robot
153+
154+
155+
There, click the little plus sign at the bottom to open the file selector. There you should see
156+
all urcap files stored inside the robot's programs folder or a plugged USB drive. Select and open
157+
the **externalcontrol-X.Y.Z.urcap** file and click *open*. Your URCaps view should now show the
158+
**External Control** in the list of active URCaps and a notification to restart the robot. Do that
159+
now.
160+
161+
162+
.. image:: ../images/initial_setup_images/es_05_urcaps_installed.png
163+
:target: initial_setup_images/es_05_urcaps_installed.png
164+
:alt: URCaps screen with installed urcaps
165+
166+
167+
After the reboot you should find the **External Control** URCaps inside the *Installation* section.
168+
For this select *Program Robot* on the welcome screen, select the *Installation* tab and select
169+
**External Control** from the list.
170+
171+
172+
.. image:: ../images/initial_setup_images/es_07_installation_excontrol.png
173+
:target: initial_setup_images/es_07_installation_excontrol.png
174+
:alt: Installation screen of URCaps
175+
176+
177+
Here you'll have to setup the IP address of the external PC which will be running the remote
178+
application. Note that the robot and the external PC have to be in the same network, ideally in a
179+
direct connection with each other to minimize network disturbances. The custom port should be left
180+
untouched for now.
181+
182+
183+
.. image:: ../images/initial_setup_images/es_10_prog_structure_urcaps.png
184+
:target: initial_setup_images/es_10_prog_structure_urcaps.png
185+
:alt: Insert the external control node
186+
187+
188+
To use the new URCaps, create a new program and insert the **External Control** program node into
189+
the program tree
190+
191+
192+
.. image:: ../images/initial_setup_images/es_11_program_view_excontrol.png
193+
:target: initial_setup_images/es_11_program_view_excontrol.png
194+
:alt: Program view of external control
195+
196+
197+
If you click on the *command* tab again, you'll see the settings entered inside the *Installation*.
198+
Check that they are correct, then save the program. Your robot is now ready to be used together with
199+
this driver.
84200

85-
.. tab:: PolyScope X
201+
.. group-tab:: PolyScope X
86202

87203
.. warning::
88204

doc/setup/ursim_docker.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ With this, start your URSim containers with the following command:
5858
docker run --rm -it -p 5900:5900 -p 6080:6080 -v ${HOME}/.ursim/urcaps:/urcaps -v ${HOME}/.ursim/programs:/ursim/programs --name ursim universalrobots/ursim_e-series
5959
6060
With this, you should be able to setup the ``external_control`` URCap and create a program as
61-
described in :ref:`URCap setup guide <install-urcap-e-series>`.
61+
described in :ref:`URCap setup guide <install_urcap>`.
6262

6363
Network setup
6464
-------------

0 commit comments

Comments
 (0)