Skip to content

Commit 7c67289

Browse files
Add .urcap installation tutorial (#6)
* Add step-by-step tutorial for .urcap installation We'll use Github's *Releases* to manage different versions.
1 parent 765c339 commit 7c67289

File tree

7 files changed

+42
-4
lines changed

7 files changed

+42
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,24 @@ Package to support relaying the RS-485 communication device in a UR robot to a r
33

44
Basically, this starts [`socat`](https://linux.die.net/man/1/socat) to relay the tool communication device to the network socket on port 54321.
55

6+
## Installation
7+
First, you need to put an `RS485 URCap` into the `programs` folder of your e-series robot.
8+
You'll find the latest version [here](https://github.com/UniversalRobots/Universal_Robots_ToolComm_Forwarder_URCap/releases) in the *Releases* section.
9+
Copying can be done either via `scp` or via using a USB stick.
10+
Next, go through [these steps](doc/install_urcap.md) to install the URCap in Polyscope.
11+
12+
613
## Usage
7-
Once the daemon is started, connect to the socket from a remote machine, also using `socat`:
14+
Once the daemon is started in Polyscope, establish the connection from a remote machine, using `socat`:
815
```bash
916
# Setup your robot IP here:
1017
export ROBOT_IP=192.168.56.101
11-
# Setup the device name that should be available locally. Make sure that your user can write to that location.
18+
# Setup the name for the device you wish to create. Make sure that your user can write to that location.
1219
export LOCAL_DEVICE_NAME=/tmp/ttyUR
13-
socat socat pty,link=${LOCAL_DEVICE_NAME},raw,ignoreeof,waitslave tcp:${ROBOT_IP}:54321
20+
socat pty,link=${LOCAL_DEVICE_NAME},raw,ignoreeof,waitslave tcp:${ROBOT_IP}:54321
1421
```
1522

16-
After that you should be able to use the device under `${LOCAL_DEVICE_NAME}` just like any local RS-485 tty device.
23+
After that you should be able to use the device under `${LOCAL_DEVICE_NAME}` (in our case `/tmp/ttyUR`) just like any local RS-485 tty device.
1724

1825
## Use inside a ROS application
1926
The [`ur_robot_driver`](http://wiki.ros.org/ur_robot_driver) has a [convenience script](https://github.com/UniversalRobots/Universal_Robots_ROS_Driver/blob/master/ur_robot_driver/scripts/tool_communication) wrapping the above `socat` call. When running the driver, the e-Series launchfiles provide a [flag](https://github.com/UniversalRobots/Universal_Robots_ROS_Driver/blob/master/ur_robot_driver/launch/ur10e_bringup.launch#L14) for automatically activating the tool communication. The launchfiles also allow setting up communication parameters on the robot directly.

doc/install_urcap.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# How to install the RS485 URCap
2+
3+
This is a short step-by-step guide how to install the RS485 URCap in Polyscope.
4+
We assume that you [copied](../README.md#installation) the latest *RS485 URCap* from [here](https://github.com/UniversalRobots/Universal_Robots_ToolComm_Forwarder_URCap/releases) to the `programs` folder of your e-series robot.
5+
6+
## Add the URCap to the system
7+
After startup of the robot, click on the `hamburger` menu item at the top right of
8+
the screen and select `Settings`.
9+
10+
![here](./resources/install_1.png)
11+
12+
In the menu on the left, go down to `System` -> `URCaps` and click the `+` button to add a URCap to the system.
13+
Choose the RS485 URCap file you previously copied to the robot's `programs` folder and open it.
14+
15+
![here](./resources/install_2.png)
16+
17+
Your display should show the `rs485` under `Active URCaps`.
18+
19+
![here](./resources/install_3.png)
20+
21+
You now need to restart Polyscope for the changes to take effect.
22+
23+
## Confirm the installation
24+
After restarting and coming back to this page, you should see the `rs485` URCap marked with a green check.
25+
26+
![here](./resources/install_4.png)
27+
28+
Finally, under the `Installation` tab, confirm that the RS-485 daemon runs.
29+
30+
![here](./resources/install_5.png)
31+

doc/resources/install_1.png

56.5 KB
Loading

doc/resources/install_2.png

53.6 KB
Loading

doc/resources/install_3.png

94.2 KB
Loading

doc/resources/install_4.png

93.8 KB
Loading

doc/resources/install_5.png

54.2 KB
Loading

0 commit comments

Comments
 (0)