Skip to content

Commit abcc8a8

Browse files
authored
Docs: Make default group tab point to PolyScope X (#502)
By default landing on CB3 doesn't really make sense.
1 parent 6a0d7dc commit abcc8a8

1 file changed

Lines changed: 90 additions & 91 deletions

File tree

doc/setup/robot_setup.rst

Lines changed: 90 additions & 91 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,19 @@ The robot needs to be prepared before it can be used with the client library.
99

1010
.. tabs::
1111

12-
.. group-tab:: CB3
12+
.. group-tab:: PolyScope X
1313

14-
CB3 robots can directly be used with the ur_client_library. No special preparation is needed.
14+
**Enable services:**
1515

16+
#. Go to the hamburger menu -> settings.
17+
#. Go to Security -> Services.
18+
#. Unlock the menu using the admin password.
19+
#. Enable the Primary Client Interface and Real-Time Data Exchange (RTDE) interfaces.
20+
#. Lock the menu and press exit.
21+
22+
.. image:: ../images/initial_setup_images/services_polyscopex.png
23+
:width: 600
24+
:alt: Screenshot from PolyScope X screen.
1625

1726
.. group-tab:: PolyScope 5
1827

@@ -46,20 +55,10 @@ The robot needs to be prepared before it can be used with the client library.
4655
:width: 600
4756
:alt: Screenshot from PolyScope 5.xx services menu.
4857

58+
.. group-tab:: CB3
4959

50-
.. group-tab:: PolyScope X
51-
52-
**Enable services:**
53-
54-
#. Go to the hamburger menu -> settings.
55-
#. Go to Security -> Services.
56-
#. Unlock the menu using the admin password.
57-
#. Enable the Primary Client Interface and Real-Time Data Exchange (RTDE) interfaces.
58-
#. Lock the menu and press exit.
60+
CB3 robots can directly be used with the ur_client_library. No special preparation is needed.
5961

60-
.. image:: ../images/initial_setup_images/services_polyscopex.png
61-
:width: 600
62-
:alt: Screenshot from PolyScope X screen.
6362

6463
.. _install_urcap:
6564

@@ -73,72 +72,65 @@ application.
7372

7473
.. tabs::
7574

76-
.. group-tab:: CB3
77-
78-
.. note::
79-
80-
A minimal PolyScope version of 3.14.3 is required to use this URCap
81-
82-
The latest release can be downloaded from `its own repository <https://github.com/UniversalRobots/Universal_Robots_ExternalControl_URCap/releases>`_.
75+
.. group-tab:: PolyScope X
8376

84-
To install the URCap you first have to copy it to the robot's **programs** folder which can be done either
85-
via scp or using a USB stick.
77+
The latest release can be downloaded from `GitHub (URCapX)
78+
<https://github.com/UniversalRobots/Universal_Robots_ExternalControl_URCapX/releases>`_.
8679

87-
On the welcome screen select *Setup Robot* and then *URCaps* to enter the URCaps installation
88-
screen.
80+
To install it you first have to copy it to a USB stick and plug that into the robot's teach
81+
pendant.
8982

83+
On the welcome screen click on the hamburger menu in the top-left corner and select *System
84+
Manager* to enter the robot's setup. There select *URCaps* to enter the URCaps installation
85+
screen. You'll have to press *unlock* and enter the admin password to be able to install new
86+
URCaps.
9087

91-
.. image:: ../images/initial_setup_images/cb3_01_welcome.png
92-
:target: initial_setup_images/cb3_01_welcome.png
93-
:alt: Welcome screen of a CB3 robot
9488

89+
.. image:: ../images/initial_setup_images/px_01_welcome.png
90+
:target: initial_setup_images/px_01_welcome.png
91+
:alt: Welcome screen of a PolyScope X robot
9592

96-
There, click the little plus sign at the bottom to open the file selector. There you should see
97-
all urcap files stored inside the robot's programs folder or a plugged USB drive. Select and open
98-
the **externalcontrol-X.Y.Z.urcap** file and click *open*. Your URCaps view should now show the
99-
**External Control** in the list of active URCaps and a notification to restart the robot. Do that
100-
now.
10193

94+
There, click the "+URCap" button at the top-right to open the file selector. There you should see
95+
all urcap files stored on a plugged USB drive. Select and open
96+
the **external-control-X.Y.Z.urcapx** file and click *Confirm*. A popup should ask you to
97+
confirm the installation.
10298

103-
.. image:: ../images/initial_setup_images/cb3_05_urcaps_installed.png
104-
:target: initial_setup_images/cb3_05_urcaps_installed.png
99+
.. image:: ../images/initial_setup_images/px_05_urcaps_installed.png
100+
:target: initial_setup_images/px_05_urcaps_installed.png
105101
:alt: URCaps screen with installed urcaps
106102

103+
Upon confirmation, the external-control URCap should be listed as installed.
107104

108-
After the reboot you should find the **External Control** URCaps inside the *Installation* section.
109-
For this select *Program Robot* on the welcome screen, select the *Installation* tab and select
110-
**External Control** from the list.
111-
105+
After the robot rebooted you should find the **External Control** URCapX on the *Application*
106+
Screen. If you open it, you will get to its configuration screen.
112107

113-
.. image:: ../images/initial_setup_images/cb3_07_installation_excontrol.png
114-
:target: initial_setup_images/cb3_07_installation_excontrol.png
115-
:alt: Installation screen of URCaps
108+
.. image:: ../images/initial_setup_images/px_07_installation_excontrol.png
109+
:target: initial_setup_images/px_07_installation_excontrol.png
110+
:alt: Configuration screen of External Control URCapX
116111

117112

118113
Here you'll have to setup the IP address of the external PC which will be running the remote
119-
application.
120-
Note that the robot and the external PC have to be in the same network, ideally in a direct
121-
connection with each other to minimize network disturbances. The custom port should be left
114+
application. Note that the robot and the external PC have to be in the same network, ideally in a
115+
direct connection with each other to minimize network disturbances. The custom port should be left
122116
untouched for now.
123117

124-
125-
.. image:: ../images/initial_setup_images/cb3_10_prog_structure_urcaps.png
126-
:target: initial_setup_images/cb3_10_prog_structure_urcaps.png
127-
:alt: Insert the external control node
128-
129-
130118
To use the new URCaps, create a new program and insert the **External Control** program node into
131119
the program tree
132120

121+
.. image:: ../images/initial_setup_images/px_10_prog_structure_urcaps.png
122+
:target: initial_setup_images/px_10_prog_structure_urcaps.png
123+
:alt: Insert the external control node
133124

134-
.. image:: ../images/initial_setup_images/cb3_11_program_view_excontrol.png
135-
:target: initial_setup_images/cb3_11_program_view_excontrol.png
125+
126+
.. image:: ../images/initial_setup_images/px_11_program_view_excontrol.png
127+
:target: initial_setup_images/px_11_program_view_excontrol.png
136128
:alt: Program view of external control
137129

138130

139-
If you click on the *command* tab again, you'll see the settings entered inside the *Installation*.
140-
Check that they are correct, then save the program. Your robot is now ready to be used together with
141-
this driver
131+
If you select the External Control program node, you'll see a button "Update program"
132+
appearing next to it. With the external application started, press it to receive the script
133+
code.
142134

143135
.. group-tab:: PolyScope 5
144136

@@ -205,62 +197,69 @@ application.
205197
Check that they are correct, then save the program. Your robot is now ready to be used together with
206198
this driver.
207199

208-
.. group-tab:: PolyScope X
200+
.. group-tab:: CB3
209201

210-
The latest release can be downloaded from `GitHub (URCapX)
211-
<https://github.com/UniversalRobots/Universal_Robots_ExternalControl_URCapX/releases>`_.
202+
.. note::
212203

213-
To install it you first have to copy it to a USB stick and plug that into the robot's teach
214-
pendant.
204+
A minimal PolyScope version of 3.14.3 is required to use this URCap
215205

216-
On the welcome screen click on the hamburger menu in the top-left corner and select *System
217-
Manager* to enter the robot's setup. There select *URCaps* to enter the URCaps installation
218-
screen. You'll have to press *unlock* and enter the admin password to be able to install new
219-
URCaps.
206+
The latest release can be downloaded from `its own repository <https://github.com/UniversalRobots/Universal_Robots_ExternalControl_URCap/releases>`_.
220207

208+
To install the URCap you first have to copy it to the robot's **programs** folder which can be done either
209+
via scp or using a USB stick.
221210

222-
.. image:: ../images/initial_setup_images/px_01_welcome.png
223-
:target: initial_setup_images/px_01_welcome.png
224-
:alt: Welcome screen of a PolyScope X robot
211+
On the welcome screen select *Setup Robot* and then *URCaps* to enter the URCaps installation
212+
screen.
225213

226214

227-
There, click the "+URCap" button at the top-right to open the file selector. There you should see
228-
all urcap files stored on a plugged USB drive. Select and open
229-
the **external-control-X.Y.Z.urcapx** file and click *Confirm*. A popup should ask you to
230-
confirm the installation.
215+
.. image:: ../images/initial_setup_images/cb3_01_welcome.png
216+
:target: initial_setup_images/cb3_01_welcome.png
217+
:alt: Welcome screen of a CB3 robot
231218

232-
.. image:: ../images/initial_setup_images/px_05_urcaps_installed.png
233-
:target: initial_setup_images/px_05_urcaps_installed.png
219+
220+
There, click the little plus sign at the bottom to open the file selector. There you should see
221+
all urcap files stored inside the robot's programs folder or a plugged USB drive. Select and open
222+
the **externalcontrol-X.Y.Z.urcap** file and click *open*. Your URCaps view should now show the
223+
**External Control** in the list of active URCaps and a notification to restart the robot. Do that
224+
now.
225+
226+
227+
.. image:: ../images/initial_setup_images/cb3_05_urcaps_installed.png
228+
:target: initial_setup_images/cb3_05_urcaps_installed.png
234229
:alt: URCaps screen with installed urcaps
235230

236-
Upon confirmation, the external-control URCap should be listed as installed.
237231

238-
After the robot rebooted you should find the **External Control** URCapX on the *Application*
239-
Screen. If you open it, you will get to its configuration screen.
232+
After the reboot you should find the **External Control** URCaps inside the *Installation* section.
233+
For this select *Program Robot* on the welcome screen, select the *Installation* tab and select
234+
**External Control** from the list.
240235

241-
.. image:: ../images/initial_setup_images/px_07_installation_excontrol.png
242-
:target: initial_setup_images/px_07_installation_excontrol.png
243-
:alt: Configuration screen of External Control URCapX
236+
237+
.. image:: ../images/initial_setup_images/cb3_07_installation_excontrol.png
238+
:target: initial_setup_images/cb3_07_installation_excontrol.png
239+
:alt: Installation screen of URCaps
244240

245241

246242
Here you'll have to setup the IP address of the external PC which will be running the remote
247-
application. Note that the robot and the external PC have to be in the same network, ideally in a
248-
direct connection with each other to minimize network disturbances. The custom port should be left
243+
application.
244+
Note that the robot and the external PC have to be in the same network, ideally in a direct
245+
connection with each other to minimize network disturbances. The custom port should be left
249246
untouched for now.
250247

251-
To use the new URCaps, create a new program and insert the **External Control** program node into
252-
the program tree
253248

254-
.. image:: ../images/initial_setup_images/px_10_prog_structure_urcaps.png
255-
:target: initial_setup_images/px_10_prog_structure_urcaps.png
249+
.. image:: ../images/initial_setup_images/cb3_10_prog_structure_urcaps.png
250+
:target: initial_setup_images/cb3_10_prog_structure_urcaps.png
256251
:alt: Insert the external control node
257252

258253

259-
.. image:: ../images/initial_setup_images/px_11_program_view_excontrol.png
260-
:target: initial_setup_images/px_11_program_view_excontrol.png
254+
To use the new URCaps, create a new program and insert the **External Control** program node into
255+
the program tree
256+
257+
258+
.. image:: ../images/initial_setup_images/cb3_11_program_view_excontrol.png
259+
:target: initial_setup_images/cb3_11_program_view_excontrol.png
261260
:alt: Program view of external control
262261

263262

264-
If you select the External Control program node, you'll see a button "Update program"
265-
appearing next to it. With the external application started, press it to receive the script
266-
code.
263+
If you click on the *command* tab again, you'll see the settings entered inside the *Installation*.
264+
Check that they are correct, then save the program. Your robot is now ready to be used together with
265+
this driver

0 commit comments

Comments
 (0)