Skip to content

Commit

Permalink
Merge urcap installations into robot setup instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
urfeex committed Jan 21, 2025
1 parent d843a8b commit fc4a77f
Show file tree
Hide file tree
Showing 5 changed files with 126 additions and 146 deletions.
2 changes: 0 additions & 2 deletions doc/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,4 @@ Setup a robot

setup/robot_setup
setup/network_setup
setup/install_urcap_cb3
setup/install_urcap_e_series
setup/ursim_docker.rst
68 changes: 0 additions & 68 deletions doc/setup/install_urcap_cb3.rst

This file was deleted.

66 changes: 0 additions & 66 deletions doc/setup/install_urcap_e_series.rst

This file was deleted.

134 changes: 125 additions & 9 deletions doc/setup/robot_setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,12 @@ In order to use the client library with a robot, that robot has to be setup.

.. tabs::

.. tab:: PolyScope 5
.. group-tab:: CB3

CB3 robots can directly be used with the ur_client_library. No special preparation is needed.


.. group-tab:: PolyScope 5

**Enable remote control:**

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


.. tab:: PolyScope X
.. group-tab:: PolyScope X

**Enable services:**

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

.. _install_urcap:

URCap installation
------------------
Expand All @@ -60,29 +66,139 @@ application.

.. tabs::

.. tab:: CB3
.. group-tab:: CB3

.. note::

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

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

For installing the necessary URCap and creating a program, please see the individual tutorials on
how to :ref:`setup a CB3 robot <install-urcap-cb3>`.
To install the URCap you first have to copy it to the robot's **programs** folder which can be done either
via scp or using a USB stick.

On the welcome screen select *Setup Robot* and then *URCaps* to enter the URCaps installation
screen.


.. image:: ../images/initial_setup_images/cb3_01_welcome.png
:target: initial_setup_images/cb3_01_welcome.png
:alt: Welcome screen of a CB3 robot


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


.. image:: ../images/initial_setup_images/cb3_05_urcaps_installed.png
:target: initial_setup_images/cb3_05_urcaps_installed.png
:alt: URCaps screen with installed urcaps


After the reboot you should find the **External Control** URCaps inside the *Installation* section.
For this select *Program Robot* on the welcome screen, select the *Installation* tab and select
**External Control** from the list.


.. image:: ../images/initial_setup_images/cb3_07_installation_excontrol.png
:target: initial_setup_images/cb3_07_installation_excontrol.png
:alt: Installation screen of URCaps


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


.. image:: ../images/initial_setup_images/cb3_10_prog_structure_urcaps.png
:target: initial_setup_images/cb3_10_prog_structure_urcaps.png
:alt: Insert the external control node


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


.. image:: ../images/initial_setup_images/cb3_11_program_view_excontrol.png
:target: initial_setup_images/cb3_11_program_view_excontrol.png
:alt: Program view of external control


.. tab:: e-Series
If you click on the *command* tab again, you'll see the settings entered inside the *Installation*.
Check that they are correct, then save the program. Your robot is now ready to be used together with
this driver

.. group-tab:: PolyScope 5

.. note::

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

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

For installing the necessary URCap and creating a program, please see the individual tutorials on
how to :ref:`setup an e-Series robot <install-urcap-e-series>`.
To install it you first have to copy it to the robot's **programs** folder which can be done either
via scp or using a USB stick.

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.


.. image:: ../images/initial_setup_images/es_01_welcome.png
:target: initial_setup_images/es_01_welcome.png
:alt: Welcome screen of an e-Series robot


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


.. image:: ../images/initial_setup_images/es_05_urcaps_installed.png
:target: initial_setup_images/es_05_urcaps_installed.png
:alt: URCaps screen with installed urcaps


After the reboot you should find the **External Control** URCaps inside the *Installation* section.
For this select *Program Robot* on the welcome screen, select the *Installation* tab and select
**External Control** from the list.


.. image:: ../images/initial_setup_images/es_07_installation_excontrol.png
:target: initial_setup_images/es_07_installation_excontrol.png
:alt: Installation screen of URCaps


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


.. image:: ../images/initial_setup_images/es_10_prog_structure_urcaps.png
:target: initial_setup_images/es_10_prog_structure_urcaps.png
:alt: Insert the external control node


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


.. image:: ../images/initial_setup_images/es_11_program_view_excontrol.png
:target: initial_setup_images/es_11_program_view_excontrol.png
:alt: Program view of external control


If you click on the *command* tab again, you'll see the settings entered inside the *Installation*.
Check that they are correct, then save the program. Your robot is now ready to be used together with
this driver.

.. tab:: PolyScope X
.. group-tab:: PolyScope X

.. warning::

Expand Down
2 changes: 1 addition & 1 deletion doc/setup/ursim_docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ With this, start your URSim containers with the following command:
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
With this, you should be able to setup the ``external_control`` URCap and create a program as
described in :ref:`URCap setup guide <install-urcap-e-series>`.
described in :ref:`URCap setup guide <install_urcap>`.

Network setup
-------------
Expand Down

0 comments on commit fc4a77f

Please sign in to comment.