Skip to main content

URInterface

Overview

This library facilitates data acquisition and commands of the UR Robot e-series. It establishes a TCP/IP connection to the UR robot and allows to execute UR script commands, log data, etc. Please note, that the robot should be configured in Remote Control mode. The UR robot can be controlled remotely in various ways:

  1. Dashboard server (port 29999): https://www.universal-robots.com/articles/ur/dashboard-server-e-series-port-29999/ Allows for commands like power on, load <program.urp>, play, stop, pause, etc.
  2. Send script commands (port 30001 or 30002): https://www.universal-robots.com/articles/ur/remote-control-via-tcpip/ Allows for commands like movej([0.1,0.2,0.3,0.4,0.5,0.6],v=1.0,a=2.0) and many more, see https://www.universal-robots.com/download/?option=77326#section77085 Frequency: 10 Hz
  3. Real-Time Data Exchange (RTDE): https://www.universal-robots.com/articles/ur/real-time-data-exchange-rtde-guide/ Allows to send and receive data with up to 500 Hz

Installing URInterface from pip

pip install urinterface

Installing URInterface locally (for development and local use)

Change to the root directory of this project and:

pip install -e .

Setting up dev environment in PyCharm.

  1. Open the root of this repo as a new project from sources in PyCharm.
  2. Make sure that most root folders are set as project source folders (Settings > Project Structure > Mark the folders as source folders )
  3. Run the tests and install missing dependencies

Installing UR Robot Simulator

If using virtual box, then follow the instructions in https://www.universal-robots.com/download/

If using Hyper-V, then install ubuntu VM and then install the UR Robot simulator. Make use to use the quick create menu, so that you get clipboard and all that stuff for free (see https://superuser.com/questions/734880/hyper-v-clipboard-and-integration-services-in-ubuntu)

This package has been tested with UR Sim for Linux 5.9.1.

Publishing this package on pypi

Instructions adapted from: https://packaging.python.org/tutorials/packaging-projects/

Delete generated directories.

Make sure to install dependencies:

pip install setuptools wheel twine

Create source distribution

python setup.py sdist

Create binary distribtion

python setup.py bdist_wheel

Upload package:

python -m twine upload dist/*
set user and password according to pypi's api token

Common Errors

Failure to boot from ISO file

with the following error:

No operating system was loaded. Your virtual machine may be configured incorrectly. Exit and re-configure...

The solution is to follow this guide: https://www.thomasmaurer.ch/2018/06/how-to-install-ubuntu-in-a-hyper-v-generation-2-virtual-machine/

Error when running the unit tests from PyCharm

Error:

Testing started at 08:54 ...
H:\srcctrl\gitlab\urinterface\venv\Scripts\python.exe "C:\Program Files\JetBrains\PyCharm Community Edition 2020.1.1\plugins\python-ce\helpers\pycharm\_jb_pytest_runner.py" --target robot_connection_tests.py::MyTestCase.test_dummy_start_stop_record
Traceback (most recent call last):
  File "C:\Program Files\JetBrains\PyCharm Community Edition 2020.1.1\plugins\python-ce\helpers\pycharm\_jb_pytest_runner.py", line 4, in <module>
    import pytest
ModuleNotFoundError: No module named 'pytest'

Process finished with exit code 1

Solution:

  1. Clear all run configurations, and create a new one using unittest.

Metadata

Release files for urinterface 0.0.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for urinterface 0.0.5
File Size Uploaded Provenance Actions
urinterface-0.0.5.tar.gz 20.9 kB Without provenance Details for urinterface-0.0.5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for urinterface 0.0.5
File Interpreter ABI Platform Actions
urinterface-0.0.5-py3-none-any.whl Python 3 none any Details for urinterface-0.0.5-py3-none-any.whl

Total release size: 48.4 kB

Release files / urinterface-0.0.5.tar.gz

Download URL urinterface-0.0.5.tar.gz
Size 20.9 kB
Tags Source
SHA-256 checksum
How to use checksums
43f91269f9616512c4a4268bcfe8c7734bb20a735bad24bdc1cc7152ba616675
BLAKE2b-256 checksum
How to use checksums
ed3dd1e88c15bb1bd1381858b4c010dcb070c5785b680e5af26827dbdf0dc3cc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.3

Release files / urinterface-0.0.5-py3-none-any.whl

Download URL urinterface-0.0.5-py3-none-any.whl
Size 27.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
1a2d676d9c2cd6d859fa4f3a2739b50697c2d840826bdbe4fac41aef590b0a71
BLAKE2b-256 checksum
How to use checksums
102fb05d9ca32b005d4734489f2e91417e3edd6ba748df862569127cae6bdba6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.3

Security for urinterface 0.0.5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page