Universal Robots SDK documentation

Connect your application to Universal Robots robots with a few lines of code.

Nothing to install on the robot

The SDK uses the network protocols of the controller.

.NET · Python · LabVIEW · Matlab

Same features and same API in each language.

30-day free trial

Then a perpetual license, no subscription.

Download Prices

A question?

About the SDK: contact us
About the robot: Universal Robots Forum

Ask an AI about the Universal Robots SDK

Universal Robots SDK documentation

Ask ChatGPTChatGPT Ask Claude WebClaude Web Ask Claude DesktopClaude Desktop Ask GrokGrok Ask PerplexityPerplexity Ask MistralMistral

The AI can make mistakes. Check its answer in the documentation.

Get started

Get started with .NET

Add the Universal Robots SDK to a C#, VB.NET or F# project from NuGet or from the zip, and write a first program. .NET Framework 3.5 to .NET 10, Windows, Linux and macOS.

Get started with Python

Install the Universal Robots SDK from PyPI and write a first Python program. Python 3.7 to 3.13 on Windows, Linux and macOS, with pythonnet.

Get started with LabVIEW

Read and control a UR cobot from LabVIEW 2010 and later with the VIs of UniversalRobots.vi: Primary Interface, RTDE, Dashboard Server and SFTP.

Get started with Matlab

Load the .NET DLL of the Universal Robots SDK in Matlab with NET.addAssembly, and read and control a UR cobot from a Matlab script.

Try the SDK with the demo application

Download the Windows demo application of the Universal Robots SDK and try every interface on your robot or on URSim, without writing code. Its C# sources are on GitHub.

Connect to the robot

Enable the interfaces of the UR cobot, set the network and the remote control, then connect with ConnectParameters. Ports, settings and errors.

Develop without a robot (URSim)

Install URSim, the simulator of Universal Robots, in VirtualBox for PolyScope 5 or in Docker for PolyScope X, and connect the SDK to it.

Licensing

The 30 day trial of the Universal Robots SDK, the license key, the license states, the maintenance and the source license.

Communication protocols

RTDE: Real-Time Data Exchange

Exchange data with a UR cobot up to 500 Hz with RTDE: choose the outputs and the inputs, receive the data, write the inputs, pause and resume.

Primary Interface: data streaming

Receive the state of a UR cobot at 10 Hz with the Primary Interface: robot mode, joints, tool, I/O, Cartesian position, kinematics and configuration.

Send URScript

Send URScript to a UR cobot with the Primary Interface: a line, a program or a secondary program, and their effect on the running program.

Dashboard Server: remote commands

Power, brakes, programs, popups, robot mode and safety status of a UR cobot with the Dashboard Server of PolyScope 5. All the commands of the SDK.

REST API (PolyScope X)

Control a UR cobot with PolyScope X over HTTP: power, brakes, load, play and stop programs, read the program state. Replaces the Dashboard Server.

SFTP file handling

Download, upload, list, rename and delete the files of a UR controller with SFTP: programs, installations and any other file.

SSH Linux commands

Run Linux commands on the controller of a UR cobot with SSH, one by one or in a shell that keeps its session.

XML-RPC

Answer the XML-RPC calls of a UR robot program from your application: positions, numbers, text. The SDK is the server.

Interpreter Mode

Send URScript statements to a running UR program in interpreter_mode(), follow their execution, skip or clear the buffer, end the mode.

Socket communication

Exchange your own messages with a UR robot program through the socket functions of URScript. The SDK is the socket server.

Offline Toolbox

How-To Articles

Get the robot position

Read the joint positions and the TCP position of a UR cobot in C# or Python, with RTDE up to 500 Hz or with the Primary Interface.

Read and write I/O

Read and write the digital and analog I/O of a UR cobot in C# or Python, with RTDE and its masks, or with the Primary Interface.

Read and write variables

Read the program and installation variables of a UR cobot in C# or Python with the Primary Interface or the Dashboard Server, and how to change them.

Read and write registers

Exchange values between a UR robot program and a PC with the boolean, integer and float registers, with RTDE up to 500 Hz.

Run a program

Power on a UR cobot, release the brakes, load a program and play it from a PC in C# or Python, then follow it until its end.

Read and reset alarms

Read the error messages, the program errors and the safety status of a UR cobot in C# or Python, and reset a protective stop or a safety fault.

Transfer files and backups

Copy the programs of a UR cobot to a PC for a backup, send a program to the robot and load it, in C# or Python with SFTP.

Monitor the state of the robot

Follow the robot mode, the program, the stops, the safety status and the connection of a UR cobot in C# or Python.

Move the robot from a PC

Move a UR cobot from a PC in C# or Python with URScript, the Interpreter Mode, registers or a program, and check the position reached.

Legal notice and acknowledgements

Legal notice and acknowledgements for the UnderAutomation Universal Robots SDK.

View as Markdown

Any question?

.css-cx2r30{width:26px;height:26px;-webkit-flex-shrink:0;-ms-flex-negative:0;flex-shrink:0;display:-webkit-inline-box;display:-webkit-inline-flex;display:-ms-inline-flexbox;display:inline-flex;color:var(--palette-primary-main);}Ask an AI about the Universal Robots SDK