API Reference

The ur_rtde library API consists of the following parts:

RTDE Control Interface API

class ur_rtde::RTDEControlInterface

This class provides the interface to control the robot and to execute robot movements.

Note

Currently the RTDEControlInterface, should not be considered thread safe, since no measures (mutexes) are taken to ensure that a function is done, before another would be executed. It is up to the caller to provide protection using mutexes.

Public Functions

void disconnect()

Return

Can be used to disconnect from the robot. To reconnect you have to call the reconnect() function.

bool reconnect()

Return

Can be used to reconnect to the robot after a lost connection.

bool isConnected()

Return

Connection status for RTDE, useful for checking for lost connection.

void waitPeriod(const std::chrono::steady_clock::time_point &t_cycle_start)

Used for waiting the rest of the control period, set implicitly as dt = 1 / frequency.

A combination of sleeping and spinning are used to achieve the lowest possible jitter. The function is especially useful for a realtime control loop. NOTE: the function is to be used in combination with the initPeriod(). See the realtime_control_example.cpp.

Parameters
  • t_cycle_start: the start of the control period. Typically given as dt = 1 / frequency.

std::chrono::steady_clock::time_point initPeriod()

This function is used in combination with waitPeriod() and is used to get the start of a control period / cycle.

See the realtime_control_example.cpp.

bool reuploadScript()

In the event of an error, this function can be used to resume operation by reuploading the RTDE control script.

This will only happen if a script is not already running on the controller.

bool sendCustomScriptFunction(const std::string &function_name, const std::string &script)

Send a custom ur script to the controller.

Parameters
  • function_name: specify a name for the custom script function

  • script: the custom ur script to be sent to the controller specified as a string, each line must be terminated with a newline. The code will automatically be indented with one tab to fit with the function body.

bool sendCustomScript(const std::string &script)

Send a custom ur script to the controller The function enables sending of short scripts which was defined inline within source code.

So you can write code like this:

const std::string inline_script =
           "def script_test():\n"
                   "\tdef test():\n"
                           "textmsg(\"test1\")\n"
                           "textmsg(\"test2\")\n"
                   "\tend\n"
                   "\twrite_output_integer_register(0, 1)\n"
                   "\ttest()\n"
                   "\ttest()\n"
                   "\twrite_output_integer_register(0, 2)\n"
           "end\n"
           "run program\n";
     bool result = rtde_c.sendCustomScript(inline_script);
Return

Returns true if the script has been executed successfully and false on timeout

bool sendCustomScriptFile(const std::string &file_path)

Send a custom ur script file to the controller.

Parameters
  • file_path: the file path to the custom ur script file

void setCustomScriptFile(const std::string &file_path)

Assign a custom script file that will be sent to device as the main control script.

Setting an empty file_name will disable the custom script loading This eases debugging when modifying the control script because it does not require to recompile the whole library

void stopScript()

This function will terminate the script on controller.

void stopL(double a = 10.0)

Stop (linear in tool space) - decelerate tool speed to zero.

Parameters
  • a: tool acceleration [m/s^2] (rate of deceleration of the tool)

void stopJ(double a = 2.0)

Stop (linear in joint space) - decelerate joint speeds to zero.

Parameters
  • a: joint acceleration [rad/s^2] (rate of deceleration of the leading axis).

bool moveJ(const std::vector<double> &q, double speed = 1.05, double acceleration = 1.4, bool asynchronous = false)

Move to joint position (linear in joint-space)

Parameters
  • q: joint positions

  • speed: joint speed of leading axis [rad/s]

  • acceleration: joint acceleration of leading axis [rad/s^2]

  • asynchronous: a bool specifying if the move command should be asynchronous. If asynchronous is true it is possible to stop a move command using either the stopJ or stopL function. Default is false, this means the function will block until the movement has completed.

bool moveJ(const std::vector<std::vector<double>> &path, bool asynchronous = false)

Move to each joint position specified in a path.

Parameters
  • path: with joint positions that includes acceleration, speed and blend for each position

  • asynchronous: a bool specifying if the move command should be asynchronous. If asynchronous is true it is possible to stop a move command using either the stopJ or stopL function. Default is false, this means the function will block until the movement has completed.

bool moveJ_IK(const std::vector<double> &pose, double speed = 1.05, double acceleration = 1.4, bool asynchronous = false)

Move to pose (linear in joint-space)

Parameters
  • pose: target pose

  • speed: joint speed of leading axis [rad/s]

  • acceleration: joint acceleration of leading axis [rad/s^2]

  • asynchronous: a bool specifying if the move command should be asynchronous. If asynchronous is true it is possible to stop a move command using either the stopJ or stopL function. Default is false, this means the function will block until the movement has completed.

bool moveL(const std::vector<double> &pose, double speed = 0.25, double acceleration = 1.2, bool asynchronous = false)

Move to position (linear in tool-space)

Parameters
  • pose: target pose

  • speed: tool speed [m/s]

  • acceleration: tool acceleration [m/s^2]

  • asynchronous: a bool specifying if the move command should be asynchronous. If asynchronous is true it is possible to stop a move command using either the stopJ or stopL function. Default is false, this means the function will block until the movement has completed.

bool moveL(const std::vector<std::vector<double>> &path, bool asynchronous = false)

Move to each pose specified in a path.

Parameters
  • path: with tool poses that includes acceleration, speed and blend for each position

  • asynchronous: a bool specifying if the move command should be asynchronous. If asynchronous is true it is possible to stop a move command using either the stopJ or stopL function. Default is false, this means the function will block until the movement has completed.

bool moveL_FK(const std::vector<double> &q, double speed = 0.25, double acceleration = 1.2, bool asynchronous = false)

Move to position (linear in tool-space)

Parameters
  • q: joint positions

  • speed: tool speed [m/s]

  • acceleration: tool acceleration [m/s^2]

  • asynchronous: a bool specifying if the move command should be asynchronous. If asynchronous is true it is possible to stop a move command using either the stopJ or stopL function. Default is false, this means the function will block until the movement has completed.

bool speedJ(const std::vector<double> &qd, double acceleration = 0.5, double time = 0.0)

Joint speed - Accelerate linearly in joint space and continue with constant joint speed.

Parameters
  • qd: joint speeds [rad/s]

  • acceleration: joint acceleration [rad/s^2] (of leading axis)

  • time: time [s] before the function returns (optional)

bool speedL(const std::vector<double> &xd, double acceleration = 0.25, double time = 0.0)

Tool speed - Accelerate linearly in Cartesian space and continue with constant tool speed.

The time t is optional;

Parameters
  • xd: tool speed [m/s] (spatial vector)

  • acceleration: tool position acceleration [m/s^2]

  • time: time [s] before the function returns (optional)

bool servoJ(const std::vector<double> &q, double speed, double acceleration, double time, double lookahead_time, double gain)

Servo to position (linear in joint-space)

Parameters
  • q: joint positions [rad]

  • speed: NOT used in current version

  • acceleration: NOT used in current version

  • time: time where the command is controlling the robot. The function is blocking for time t [S]

  • lookahead_time: time [S], range [0.03,0.2] smoothens the trajectory with this lookahead time

  • gain: proportional gain for following target position, range [100,2000]

bool servoL(const std::vector<double> &pose, double speed, double acceleration, double time, double lookahead_time, double gain)

Servo to position (linear in tool-space)

Parameters
  • pose: target pose

  • speed: NOT used in current version

  • acceleration: NOT used in current version

  • time: time where the command is controlling the robot. The function is blocking for time t [S]

  • lookahead_time: time [S], range [0.03,0.2] smoothens the trajectory with this lookahead time

  • gain: proportional gain for following target position, range [100,2000]

bool movePath(const Path &path, bool asynchronous = false)

Move to each waypoint specified in the given path.

Parameters
  • path: The path with waypoints

  • asynchronous: a bool specifying if the move command should be asynchronous. If asynchronous is true it is possible to stop a move command using either the stopJ or stopL function. Default is false, this means the function will block until the movement has completed.

bool servoStop(double a = 10.0)

Stop servo mode and decelerate the robot.

Parameters
  • a: rate of deceleration of the tool [m/s^2]

bool speedStop(double a = 10.0)

Stop speed mode and decelerate the robot.

Parameters
  • a: rate of deceleration of the tool [m/s^2] if using speedL, for speedJ its [rad/s^2] and rate of deceleration of leading axis.

bool servoC(const std::vector<double> &pose, double speed = 0.25, double acceleration = 1.2, double blend = 0.0)

Servo to position (circular in tool-space).

Accelerates to and moves with constant tool speed v.

Parameters
  • pose: target pose

  • speed: tool speed [m/s]

  • acceleration: tool acceleration [m/s^2]

  • blend: blend radius (of target pose) [m]

bool forceMode(const std::vector<double> &task_frame, const std::vector<int> &selection_vector, const std::vector<double> &wrench, int type, const std::vector<double> &limits)

Set robot to be controlled in force mode.

Parameters
  • task_frame: A pose vector that defines the force frame relative to the base frame.

  • selection_vector: A 6d vector of 0s and 1s. 1 means that the robot will be compliant in the corresponding axis of the task frame

  • wrench: The forces/torques the robot will apply to its environment. The robot adjusts its position along/about compliant axis in order to achieve the specified force/torque. Values have no effect for non-compliant axes

  • type: An integer [1;3] specifying how the robot interprets the force frame. 1: The force frame is transformed in a way such that its y-axis is aligned with a vector pointing from the robot tcp towards the origin of the force frame. 2: The force frame is not transformed. 3: The force frame is transformed in a way such that its x-axis is the projection of the robot tcp velocity vector onto the x-y plane of the force frame.

  • limits: (Float) 6d vector. For compliant axes, these values are the maximum allowed tcp speed along/about the axis. For non-compliant axes, these values are the maximum allowed deviation along/about an axis between the actual tcp position and the one set by the program.

bool forceModeStop()

Resets the robot mode from force mode to normal operation.

bool jogStart(const std::vector<double> &speeds, int feature = FEATURE_BASE, const std::vector<double> &custom_frame = {})

Starts jogging with the given speed vector with respect to the given feature.

When jogging has started, it is possible to provide new speed vectors by calling the jogStart() function over and over again. This makes it possible to use a joystick or a 3D Space Navigator to provide new speed vectors if the user moves the joystick or the Space Navigator cap.

Parameters
  • speed: Speed vector for translation and rotation. Translation values are given in mm / s and rotation values in rad / s.

  • feature: Configures to move to move with respect to base frame (FEATURE_BASE), tool frame (FEATURE_TOOL) or custom frame (FEATURE_CUSTOM) If the feature is FEATURE_CUSTOM then the custom_frame parameter needs to be a valid pose.

  • custom_frame: The custom_frame given as pose if the selected feature is FEATURE_CUSTOM

bool jogStop()

Stops jogging that has been started start_jog.

bool zeroFtSensor()

Zeroes the TCP force/torque measurement from the builtin force/torque sensor by subtracting the current measurement from the subsequent.

bool setPayload(double mass, const std::vector<double> &cog = {})

Set payload.

Parameters
  • mass: Mass in kilograms

  • cog: Center of Gravity, a vector [CoGx, CoGy, CoGz] specifying the displacement (in meters) from the toolmount. If not specified the current CoG will be used.

bool teachMode()

Set robot in freedrive mode.

In this mode the robot can be moved around by hand in the same way as by pressing the “freedrive” button. The robot will not be able to follow a trajectory (eg. a movej) in this mode.

bool endTeachMode()

Set robot back in normal position control mode after freedrive mode.

bool forceModeSetDamping(double damping)

Sets the damping parameter in force mode.

A value of 1 is full damping, so the robot will decellerate quickly if no force is present. A value of 0 is no damping, here the robot will maintain the speed.

Parameters
  • damping: Between 0 and 1, default value is 0.005

The value is stored until this function is called again. Call this function before force mode is entered (otherwise default value will be used).

bool forceModeSetGainScaling(double scaling)

Scales the gain in force mode.

A value larger than 1 can make force mode unstable, e.g. in case of collisions or pushing against hard surfaces.

Parameters
  • scaling: scaling parameter between 0 and 2, default is 1.

The value is stored until this function is called again. Call this function before force mode is entered (otherwise default value will be used)

int toolContact(const std::vector<double> &direction)

Detects when a contact between the tool and an object happens.

Return

The returned value is the number of time steps back to just before the contact have started. A value larger than 0 means that a contact is detected. A value of 0 means no contact.

Parameters
  • direction: The first three elements are interpreted as a 3D vector (in the robot base coordinate system) giving the direction in which contacts should be detected. If all elements of the list are zero, contacts from all directions are considered.

double getStepTime()

Returns the duration of the robot time step in seconds.

In every time step, the robot controller will receive measured joint positions and velocities from the robot, and send desired joint positions and velocities back to the robot. This happens with a predetermined frequency, in regular intervals. This interval length is the robot time step.

Return

Duration of the robot step in seconds or 0 in case of an error

std::vector<double> getActualJointPositionsHistory(int steps = 0)

Returns the actual past angular positions of all joints This function returns the angular positions as reported by the function “get_actual_joint_

positions()” which indicates the number of controller time steps occurring before the current time step.

An exception is thrown if indexing goes beyond the buffer size.

Return

The joint angular position vector in rad : [Base, Shoulder, Elbow, Wrist1, Wrist2, Wrist3] that was actual at the provided number of steps before the current time step.

Parameters
  • steps: The number of controller time steps required to go back. 0 corresponds to “get_actual_joint_positions()”

std::vector<double> getTargetWaypoint()

Returns the target waypoint of the active move.

This is different from the target tcp pose which returns the target pose for each time step. The get_target_waypoint() returns the same target pose for movel, movej, movep or movec during the motion. It returns the target tcp pose, if none of the mentioned move functions are running.

This method is useful for calculating relative movements where the previous move command uses blends.

Return

The desired waypoint TCP vector [X, Y, Z, Rx, Ry, Rz] or and empty vector in case of an error.

bool setTcp(const std::vector<double> &tcp_offset)

Sets the active tcp offset, i.e.

the transformation from the output flange coordinate system to the TCP as a pose.

Parameters
  • tcp_offset: A pose describing the transformation of the tcp offset.

std::vector<double> getInverseKinematics(const std::vector<double> &x, const std::vector<double> &qnear = {}, double max_position_error = 1e-10, double max_orientation_error = 1e-10)

Calculate the inverse kinematic transformation (tool space -> jointspace).

If qnear is defined, the solution closest to qnear is returned.Otherwise, the solution closest to the current joint positions is returned. If no tcp is provided the currently active tcp of the controller will be used.

Return

joint positions

Parameters
  • x: tool pose

  • qnear: list of joint positions (Optional)

  • maxPositionError: the maximum allowed positionerror (Optional)

  • maxOrientationError: the maximum allowed orientationerror (Optional)

std::vector<double> poseTrans(const std::vector<double> &p_from, const std::vector<double> &p_from_to)

Pose transformation to move with respect to a tool or w.r.t.

a custom feature/frame The first argument, p_from, is used to transform the second argument, p_from_to, and the result is then returned. This means that the result is the resulting pose, when starting at the coordinate system of p_from, and then in that coordinate system moving p_from_to. This function can be seen in two different views. Either the function transforms, that is translates and rotates, p_from_to by the parameters of p_from. Or the function is used to get the resulting pose, when first making a move of p_from and then from there, a move of p_from_to. If the poses were regarded as transformation matrices, it would look like:

* T_world->to = T_world->from * T_from->to
* T_x->to = T_x->from * T_from->to
*
Return

resulting pose (spatial vector)

Parameters
  • p_from: starting pose (spatial vector)

  • p_from_to: pose change relative to starting pose (spatial vector)

bool triggerProtectiveStop()

Triggers a protective stop on the robot.

Can be used for testing and debugging.

bool isProgramRunning()

Returns true if a program is running on the controller, otherwise it returns false This is just a shortcut for getRobotStatus() & RobotStatus::ROBOT_STATUS_PROGRAM_RUNNING.

uint32_t getRobotStatus()

Return

Robot status Bits 0-3: Is power on | Is program running | Is teach button pressed | Is power button pressed There is a synchronization gap between the three interfaces RTDE Control RTDE Receive and Dashboard Client. RTDE Control and RTDE Receive open its own RTDE connection and so the internal state is not in sync. That means, if RTDE Control reports, that program is running, RTDE Receive may still return that program is not running. The update of the Dashboard Client even needs more time. That means, the dashboard client still returns program not running after some milliseconds have passed after RTDE Control already reports program running.

Note

If you work with RTDE control and receive interface and you need to read the robot status or program running state, then you should always use the getRobotStatus() function from RTDE Control if you need a status that is in sync with the program uploading or reuploading of this object.

int getAsyncOperationProgress()

Reads progress information for asynchronous operations that supports progress feedback (such as movePath).

Return Value
  • <0: Indicates that no async operation is running or that an async operation has finished. The returned values of two consecutive async operations is never equal. Normally the returned values are toggled between -1 and -2. This allows the application to clearly detect the end of an operation even if it is too short to see its start. That means, if the value returned by this function is less than 0 and is different from that last value returned by this function, then a new async operation has finished.

  • 0: Indicates that an async operation has started - progress 0

  • >=: 0 Indicates the progress of an async operation. For example, if an operation has 3 steps, the progress ranges from 0 - 2. The progress value is updated, before a step is executed. When the last step has been executed, the value will change to -1 to indicate the end of the async operation.

bool setWatchdog(double min_frequency = 10.0)

Enable a watchdog for the communication with a specified minimum frequency for which an input update is expected to arrive.

The watchdog is useful for safety critical realtime applications eg. servoing. The default action taken is to shutdown the control, if the watchdog is not kicked with the minimum frequency.

Preferably you would call this function right after the RTDEControlInterface has been constructed.

Parameters
  • min_frequency: The minimum frequency an input update is expected to arrive defaults to 10Hz.

bool kickWatchdog()

Kicks the watchdog safeguarding the communication.

Normally you would kick the watchdog in your control loop. Be sure to kick it as often as specified by the minimum frequency of the watchdog.

bool isPoseWithinSafetyLimits(const std::vector<double> &pose)

Checks if the given pose is reachable and within the current safety limits of the robot.

It checks safety planes limits, TCP orientation deviation limits and range of the robot. If a solution is found when applying the inverse kinematics to the given target TCP pose, this pose is considered reachable.

Return

a bool indicating if the pose is within the safety limits.

Parameters
  • pose: target pose

bool isJointsWithinSafetyLimits(const std::vector<double> &q)

Checks if the given joint position is reachable and within the current safety limits of the robot.

This check considers joint limits (if the target pose is specified as joint positions), safety planes limits, TCP orientation deviation limits and range of the robot. If a solution is found when applying the inverse kinematics to the given target TCP pose, this pose is considered reachable

Return

a bool indicating if the joint positions are within the safety limits.

Parameters
  • q: joint positions

std::vector<double> getJointTorques()

Returns the torques of all joints.

The torque on the joints, corrected by the torque needed to move the robot itself (gravity, friction, etc.), returned as a vector of length 6.

Return

The joint torque vector in Nm: [Base, Shoulder, Elbow, Wrist1, Wrist2, Wrist3]

std::vector<double> getTCPOffset()

Gets the active tcp offset, i.e.

the transformation from the output flange coordinate system to the TCP as a pose.

Return

the TCP offset as a pose

std::vector<double> getForwardKinematics(const std::vector<double> &q = {}, const std::vector<double> &tcp_offset = {})

Calculate the forward kinematic transformation (joint space -> tool space) using the calibrated robot kinematics.

If no joint position vector is provided the current joint angles of the robot arm will be used. If no tcp is provided the currently active tcp of the controller will be used.

NOTICE! If you specify the tcp_offset you must also specify the q.

Return

the forward kinematic transformation as a pose

Parameters
  • q: joint position vector (Optional)

  • tcp_offset: tcp offset pose (Optional)

bool isSteady()

Checks if robot is fully at rest.

True when the robot is fully at rest, and ready to accept higher external forces and torques, such as from industrial screwdrivers.

Note: This function will always return false in modes other than the standard position mode, e.g. false in force and teach mode.

Return

True when the robot is fully at rest. Returns False otherwise.

bool moveUntilContact(const std::vector<double> &xd, const std::vector<double> &direction = {0.0, 0.0, 0.0, 0.0, 0.0, 0.0}, double acceleration = 0.5)

Move the robot until contact, with specified speed and contact detection direction.

The robot will automatically retract to the initial point of contact.

Return

True once the robot is in contact.

Parameters
  • xd: tool speed [m/s] (spatial vector)

  • direction: List of six floats. The first three elements are interpreted as a 3D vector (in the robot base coordinate system) giving the direction in which contacts should be detected. If all elements of the list are zero, contacts from all directions are considered. You can also set direction=get_target_tcp_speed() in which case it will detect contacts in the direction of the TCP movement.

  • acceleration: tool position acceleration [m/s^2]

bool freedriveMode(const std::vector<int> &free_axes = {1, 1, 1, 1, 1, 1}, const std::vector<double> &feature = {0.0, 0.0, 0.0, 0.0, 0.0, 0.0})

Set robot in freedrive mode.

In this mode the robot can be moved around by hand in the same way as by pressing the “freedrive” button.

The robot will not be able to follow a trajectory (eg. a movej) in this mode.

The default parameters enables the robot to move freely in all directions. It is possible to enable constrained freedrive by providing user specific parameters.

Examples:

  • freedrive_mode()

    • Robot can move freely in all directions.

  • freedrive_mode(freeAxes=[1,0,0,0,0,0], feature=p[0.1,0,0,0,0.785])

    • Example Parameters:

      • freeAxes = [1,0,0,0,0,0] -> The robot is compliant in the x direction relative to the feature.

      • feature = p[0.1,0,0,0,0.785] -> This feature is offset from the base frame with 100 mm in the

        x direction and rotated 45 degrees in the rz direction.

Return

true when the robot is in freedrive mode, false otherwise.

Parameters
  • freeAxes: A 6 dimensional vector that contains 0’s and 1’s, these indicates in which axes movement is allowed. The first three values represents the cartesian directions along x, y, z, and the last three defines the rotation axis, rx, ry, rz. All relative to the selected feature

  • feature: A pose vector that defines a freedrive frame relative to the base frame. For base and tool reference frames predefined constants “base”, and “tool” can be used in place of pose vectors.

Note: Immediately before entering freedrive mode, avoid:

  • movements in the non-compliant axes

  • high acceleration in freedrive mode

  • high deceleration in freedrive mode

bool endFreedriveMode()

Set robot back in normal position control mode after freedrive mode.

Return

true when the robot is not in freedrive anymore.

int getFreedriveStatus()

Returns status of freedrive mode for current robot pose.

Constrained freedrive usability is reduced near singularities. Value returned by this function corresponds to distance to the nearest singularity.

It can be used to advice operator to follow different path or switch to unconstrained freedrive.

Return

- 0 = Normal operation.

- 1 = Near singularity.

- 2 = Too close to singularity. High movement resistance in freedrive.

bool setExternalForceTorque(const std::vector<double> &external_force_torque)

Input external wrench when using ft_rtde_input_enable builtin.

Parameters
  • external_force_torque: A 6 dimensional vector that contains the external wrench.

bool ftRtdeInputEnable(bool enable, double sensor_mass = 0.0, const std::vector<double> &sensor_measuring_offset = {0.0, 0.0, 0.0}, const std::vector<double> &sensor_cog = {0.0, 0.0, 0.0})

This function is used for enabling and disabling the use of external F/T measurements in the controller.

Be aware that the following function is impacted:

  • force_mode

  • screw_driving

  • freedrive_mode

The RTDE interface shall be used for feeding F/T measurements into the real-time control loop of the robot using input variable external_force_torque of type VECTOR6D. If no other RTDE watchdog has been configured (using script function rtde_set_watchdog), a default watchdog will be set to a 10Hz minimum update frequency when the external F/T sensor functionality is enabled. If the update frequency is not met the robot program will pause.

Notes: This function replaces the deprecated enable_external_ft_sensor. The TCP Configuration in the installation must also include the weight and offset contribution of the sensor. Only the enable parameter is required; sensor mass, offset and center of gravity are optional (zero if not provided).

Parameters
  • enable: enable or disable feature (bool)

  • sensor_mass: mass of the sensor in kilograms (float)

  • sensor_measuring_offset: [x, y, z] measuring offset of the sensor in meters relative to the tool flange frame

  • sensor_cog: [x, y, z] center of gravity of the sensor in meters relative to the tool flange frame

bool enableExternalFtSensor(bool enable, double sensor_mass = 0.0, const std::vector<double> &sensor_measuring_offset = {0.0, 0.0, 0.0}, const std::vector<double> &sensor_cog = {0.0, 0.0, 0.0})

this function is used for enabling and disabling the use of external F/T measurements in the controller.

(Deprecated, but can be used when ftRtdeInputEnable() is not available)

Be aware that the following function is impacted:

  • force_mode

  • screw_driving

  • freedrive_mode

The RTDE interface shall be used for feeding F/T measurements into the real-time control loop of the robot using input variable external_force_torque of type VECTOR6D. If no other RTDE watchdog has been configured (using script function rtde_set_watchdog), a default watchdog will be set to a 10Hz minimum update frequency when the external F/T sensor functionality is enabled. If the update frequency is not met the robot program will pause.

Notes: When using this function, the sensor position is applied such that the resulting torques are computed with opposite sign. New programs should use ftRtdeInputEnable in place of this. The TCP Configuration in the installation must also include the weight and offset contribution of the sensor. Only the enable parameter is required; sensor mass, offset and center of gravity are optional (zero if not provided).

Parameters
  • enable: enable or disable feature (bool)

  • sensor_mass: mass of the sensor in kilograms (float)

  • sensor_measuring_offset: [x, y, z] measuring offset of the sensor in meters relative to the tool flange frame

  • sensor_cog: [x, y, z] center of gravity of the sensor in meters relative to the tool flange frame

std::vector<double> getActualToolFlangePose()

Returns the current measured tool flange pose.

Returns the 6d pose representing the tool flange position and orientation specified in the base frame, without the Tool Center Point offset. The calculation of this pose is based on the actual robot encoder readings.

Return

the current actual tool flange vector: [X, Y, Z, Rx, Ry, Rz]

RTDE Receive Interface API

class ur_rtde::RTDEReceiveInterface

Public Types

enum SafetyStatus

Values:

enumerator IS_NORMAL_MODE = 0
enumerator IS_REDUCED_MODE = 1
enumerator IS_PROTECTIVE_STOPPED = 2
enumerator IS_RECOVERY_MODE = 3
enumerator IS_SAFEGUARD_STOPPED = 4
enumerator IS_SYSTEM_EMERGENCY_STOPPED = 5
enumerator IS_ROBOT_EMERGENCY_STOPPED = 6
enumerator IS_EMERGENCY_STOPPED = 7
enumerator IS_VIOLATION = 8
enumerator IS_FAULT = 9
enumerator IS_STOPPED_DUE_TO_SAFETY = 10
enum OutputIntRegisters

Values:

enumerator OUTPUT_INT_REGISTER_0 = 0
enumerator OUTPUT_INT_REGISTER_1
enumerator OUTPUT_INT_REGISTER_2
enumerator OUTPUT_INT_REGISTER_3
enumerator OUTPUT_INT_REGISTER_4
enumerator OUTPUT_INT_REGISTER_5
enumerator OUTPUT_INT_REGISTER_6
enumerator OUTPUT_INT_REGISTER_7
enumerator OUTPUT_INT_REGISTER_8
enumerator OUTPUT_INT_REGISTER_9
enumerator OUTPUT_INT_REGISTER_10
enumerator OUTPUT_INT_REGISTER_11
enumerator OUTPUT_INT_REGISTER_12
enumerator OUTPUT_INT_REGISTER_13
enumerator OUTPUT_INT_REGISTER_14
enumerator OUTPUT_INT_REGISTER_15
enumerator OUTPUT_INT_REGISTER_16
enumerator OUTPUT_INT_REGISTER_17
enumerator OUTPUT_INT_REGISTER_18
enumerator OUTPUT_INT_REGISTER_19
enumerator OUTPUT_INT_REGISTER_20
enumerator OUTPUT_INT_REGISTER_21
enumerator OUTPUT_INT_REGISTER_22
enumerator OUTPUT_INT_REGISTER_23
enum OutputDoubleRegisters

Values:

enumerator OUTPUT_DOUBLE_REGISTER_0 = 0
enumerator OUTPUT_DOUBLE_REGISTER_1
enumerator OUTPUT_DOUBLE_REGISTER_2
enumerator OUTPUT_DOUBLE_REGISTER_3
enumerator OUTPUT_DOUBLE_REGISTER_4
enumerator OUTPUT_DOUBLE_REGISTER_5
enumerator OUTPUT_DOUBLE_REGISTER_6
enumerator OUTPUT_DOUBLE_REGISTER_7
enumerator OUTPUT_DOUBLE_REGISTER_8
enumerator OUTPUT_DOUBLE_REGISTER_9
enumerator OUTPUT_DOUBLE_REGISTER_10
enumerator OUTPUT_DOUBLE_REGISTER_11
enumerator OUTPUT_DOUBLE_REGISTER_12
enumerator OUTPUT_DOUBLE_REGISTER_13
enumerator OUTPUT_DOUBLE_REGISTER_14
enumerator OUTPUT_DOUBLE_REGISTER_15
enumerator OUTPUT_DOUBLE_REGISTER_16
enumerator OUTPUT_DOUBLE_REGISTER_17
enumerator OUTPUT_DOUBLE_REGISTER_18
enumerator OUTPUT_DOUBLE_REGISTER_19
enumerator OUTPUT_DOUBLE_REGISTER_20
enumerator OUTPUT_DOUBLE_REGISTER_21
enumerator OUTPUT_DOUBLE_REGISTER_22
enumerator OUTPUT_DOUBLE_REGISTER_23
enum RuntimeState

Values:

enumerator STOPPING = 0
enumerator STOPPED = 1
enumerator PLAYING = 2
enumerator PAUSING = 3
enumerator PAUSED = 4
enumerator RESUMING = 5
enum PausingState

Values:

enumerator PAUSED
enumerator RUNNING
enumerator RAMPUP

Public Functions

RTDEReceiveInterface(std::string hostname, double frequency = -1.0, std::vector<std::string> variables = {}, bool verbose = false, bool use_upper_range_registers = false, int rt_priority = RT_PRIORITY_UNDEFINED)
~RTDEReceiveInterface()
void disconnect()

Return

Can be used to disconnect from the robot. To reconnect you have to call the reconnect() function.

bool reconnect()

Return

Can be used to reconnect to the robot after a lost connection.

void waitPeriod(const std::chrono::steady_clock::time_point &t_cycle_start)

Used for waiting the rest of the control period, set implicitly as dt = 1 / frequency.

A combination of sleeping and spinning are used to achieve the lowest possible jitter. The function is especially useful for a realtime control loop. NOTE: the function is to be used in combination with the initPeriod(). See the realtime_control_example.cpp.

Parameters
  • t_cycle_start: the start of the control period. Typically given as dt = 1 / frequency.

std::chrono::steady_clock::time_point initPeriod()

This function is used in combination with waitPeriod() and is used to get the start of a control period / cycle.

See the realtime_control_example.cpp.

bool startFileRecording(const std::string &filename, const std::vector<std::string> &variables = {})

Return

Can be used to reconnect to the robot after a lost connection.

bool stopFileRecording()

Return

Can be used to reconnect to the robot after a lost connection.

bool isConnected()

Return

Connection status for RTDE, useful for checking for lost connection.

double getTimestamp()

Return

Time elapsed since the controller was started [s]

std::vector<double> getTargetQ()

Return

Target joint positions

std::vector<double> getTargetQd()

Return

Target joint velocities

std::vector<double> getTargetQdd()

Return

Target joint accelerations

std::vector<double> getTargetCurrent()

Return

Target joint currents

std::vector<double> getTargetMoment()

Return

Target joint moments (torques)

std::vector<double> getActualQ()

Return

Actual joint positions

std::vector<double> getActualQd()

Return

Actual joint velocities

std::vector<double> getActualCurrent()

Return

Actual joint currents

std::vector<double> getJointControlOutput()

Return

Joint control currents

std::vector<double> getActualTCPPose()

Return

Actual Cartesian coordinates of the tool: (x,y,z,rx,ry,rz), where rx, ry and rz is a rotation vector representation of the tool orientation

std::vector<double> getActualTCPSpeed()

Return

Actual speed of the tool given in Cartesian coordinates

std::vector<double> getActualTCPForce()

Return

Generalized forces in the TCP

std::vector<double> getTargetTCPPose()

Return

Target Cartesian coordinates of the tool: (x,y,z,rx,ry,rz), where rx, ry and rz is a rotation vector representation of the tool orientation

std::vector<double> getTargetTCPSpeed()

Return

Target speed of the tool given in Cartesian coordinates

uint64_t getActualDigitalInputBits()

Return

Current state of the digital inputs. 0-7: Standard, 8-15: Configurable, 16-17: Tool

std::vector<double> getJointTemperatures()

Return

Temperature of each joint in degrees Celsius

double getActualExecutionTime()

Return

Controller real-time thread execution time

int32_t getRobotMode()

Return

Robot mode -1 = ROBOT_MODE_NO_CONTROLLER 0 = ROBOT_MODE_DISCONNECTED 1 = ROBOT_MODE_CONFIRM_SAFETY 2 = ROBOT_MODE_BOOTING 3 = ROBOT_MODE_POWER_OFF 4 = ROBOT_MODE_POWER_ON 5 = ROBOT_MODE_IDLE 6 = ROBOT_MODE_BACKDRIVE 7 = ROBOT_MODE_RUNNING 8 = ROBOT_MODE_UPDATING_FIRMWARE

uint32_t getRobotStatus()

Return

Robot status Bits 0-3: Is power on | Is program running | Is teach button pressed | Is power button pressed

std::vector<int32_t> getJointMode()

Return

Joint control modes

int32_t getSafetyMode()

Return

Safety mode

uint32_t getSafetyStatusBits()

Return

Safety status bits Bits 0-10: Is normal mode | Is reduced mode | Is protective stopped | Is recovery mode | Is safeguard stopped | Is system emergency stopped | Is robot emergency stopped | Is emergency stopped | Is violation | Is fault | Is stopped due to safety

std::vector<double> getActualToolAccelerometer()

Return

Tool x, y and z accelerometer values

double getSpeedScaling()

Return

Speed scaling of the trajectory limiter

double getTargetSpeedFraction()

Return

Target speed fraction

double getActualMomentum()

Return

Norm of Cartesian linear momentum

double getActualMainVoltage()

Return

Safety Control Board: Main voltage

double getActualRobotVoltage()

Return

Safety Control Board: Robot voltage (48V)

double getActualRobotCurrent()

Return

Safety Control Board: Robot current

std::vector<double> getActualJointVoltage()

Return

Actual joint voltages

uint64_t getActualDigitalOutputBits()

Return

Current state of the digital outputs. 0-7: Standard, 8-15: Configurable, 16-17: Tool

bool getDigitalOutState(std::uint8_t output_id)

Test if a digital output is set ‘high’ or ‘low’ the range is 0-7: Standard, 8-15: Configurable, 16-17: Tool.

Return

a bool indicating the state of the digital output

Parameters
  • output_id: the id of the digital output to test

uint32_t getRuntimeState()

Return

Program state

double getStandardAnalogInput0()

Return

Standard analog input 0 [A or V]

double getStandardAnalogInput1()

Return

Standard analog input 1 [A or V]

double getStandardAnalogOutput0()

Return

Standard analog output 0 [A or V]

double getStandardAnalogOutput1()

Return

Standard analog output 1 [A or V]

bool isProtectiveStopped()

Return

a bool indicating if the robot is in ‘Protective stop’

bool isEmergencyStopped()

Return

a bool indicating if the robot is in ‘Emergency stop’

int getOutputIntRegister(int output_id)

Get the specified output integer register in either lower range [18-22] or upper range [42-46].

Return

an integer from the specified output register

Parameters
  • output_id: the id of the register to read, current supported range is: [18-22] or [42-46], this can be adjusted by changing the RTDEReceiveInterface output recipes and by using the use_upper_range_registers constructor flag to switch between lower and upper range.

double getOutputDoubleRegister(int output_id)

Get the specified output double register in either lower range [18-22] or upper range [42-46].

Return

a double from the specified output register

Parameters
  • output_id: the id of the register to read, current supported range is: [18-22] or [42-46], this can be adjusted by changing the RTDEReceiveInterface output recipes and by using the use_upper_range_registers constructor flag to switch between lower and upper range.

double getSpeedScalingCombined()

Get the combined speed scaling The combined speed scaling is the speed scaling resulting from multiplying the speed scaling with the target speed fraction.

The combined speed scaling takes the runtime_state of the controller into account. If eg. a motion is paused on the teach pendant, and later continued, the speed scaling will be ramped up from zero and return to speed_scaling * target_speed_fraction when the runtime_state is RUNNING again.

This is useful for scaling trajectories with the slider speed scaling currently set on the teach pendant.

Return

the actual combined speed scaling

std::vector<double> getFtRawWrench()

Get the raw force and torque measurement, not compensated for forces and torques caused by the payload.

Return

the raw force and torque measurement

double getPayload()

Get the payload of the robot in [kg].

Return

the payload in [kg]

std::vector<double> getPayloadCog()

Get the payload Center of Gravity (CoGx, CoGy, CoGz)

Return

the payload Center of Gravity (CoGx, CoGy, CoGz) in [m]

std::vector<double> getPayloadInertia()

Get the payload inertia matrix elements (Ixx,Iyy,Izz,Ixy,Ixz,Iyz) expressed in kg*m^2.

Return

the payload inertia matrix elements (Ixx,Iyy,Izz,Ixy,Ixz,Iyz) expressed in kg*m^2

void receiveCallback()
void recordCallback()
const std::shared_ptr<RobotState> &robot_state() const

RTDE IO Interface API

class ur_rtde::RTDEIOInterface

Public Functions

void disconnect()

Can be used to disconnect the RTDE IO client.

bool reconnect()

Can be used to reconnect to the robot after a lost connection.

bool setStandardDigitalOut(std::uint8_t output_id, bool signal_level)

Set standard digital output signal level.

Parameters
  • output_id: The number (id) of the output, integer: [0:7]

  • signal_level: The signal level. (boolean)

bool setConfigurableDigitalOut(std::uint8_t output_id, bool signal_level)

Set configurable digital output signal level.

Parameters
  • output_id: The number (id) of the output, integer: [0:7]

  • signal_level: The signal level. (boolean)

bool setToolDigitalOut(std::uint8_t output_id, bool signal_level)

Set tool digital output signal level.

Parameters
  • output_id: The number (id) of the output, integer: [0:1]

  • signal_level: The signal level. (boolean)

bool setSpeedSlider(double speed)

Set the speed slider on the controller.

Parameters
  • speed: set the speed slider on the controller as a fraction value between 0 and 1 (1 is 100%)

bool setAnalogOutputVoltage(std::uint8_t output_id, double voltage_ratio)

Set Analog output voltage.

Parameters
  • output_id: The number (id) of the output, integer: [0:1]

  • voltage_ratio: voltage set as a (ratio) of the voltage span [0..1], 1 means full voltage.

bool setAnalogOutputCurrent(std::uint8_t output_id, double current_ratio)

Set Analog output current.

Parameters
  • output_id: The number (id) of the output, integer: [0:1]

  • current_ratio: current set as a (ratio) of the current span [0..1], 1 means full current.

bool setInputIntRegister(int input_id, int value)

Set the specified input integer register in either lower range [18-22] or upper range [42-46].

Return

true if the register is successfully set, false otherwise.

Parameters
  • input_id: the id of the register to set, current supported range is: [18-22] or [42-46], this can be adjusted by changing the RTDEControlInterface input recipes and by using the use_upper_range_registers constructor flag to switch between lower and upper range.

  • value: the desired integer value

bool setInputDoubleRegister(int input_id, double value)

Set the specified input double register in either lower range [18-22] or upper range [42-46].

Return

true if the register is successfully set, false otherwise.

Parameters
  • input_id: the id of the register to set, current supported range is: [18-22] or [42-46], this can be adjusted by changing the RTDEControlInterface input recipes and by using the use_upper_range_registers constructor flag to switch between lower and upper range.

  • value: the desired double value

RTDE Class API

class ur_rtde::RTDE

Public Types

enum RTDECommand

Values:

enumerator RTDE_REQUEST_PROTOCOL_VERSION = 86
enumerator RTDE_GET_URCONTROL_VERSION = 118
enumerator RTDE_TEXT_MESSAGE = 77
enumerator RTDE_DATA_PACKAGE = 85
enumerator RTDE_CONTROL_PACKAGE_SETUP_OUTPUTS = 79
enumerator RTDE_CONTROL_PACKAGE_SETUP_INPUTS = 73
enumerator RTDE_CONTROL_PACKAGE_START = 83
enumerator RTDE_CONTROL_PACKAGE_PAUSE = 80
enum ConnectionState

Values:

enumerator DISCONNECTED = 0
enumerator CONNECTED = 1
enumerator STARTED = 2
enumerator PAUSED = 3

Public Functions

RTDE(const std::string hostname, int port = 30004, bool verbose = false)
~RTDE()
void connect()
void disconnect()
bool isConnected()
bool isStarted()
bool isDataAvailable()
bool negotiateProtocolVersion()
std::tuple<std::uint32_t, std::uint32_t, std::uint32_t, std::uint32_t> getControllerVersion()
void receive()
boost::system::error_code receiveData(std::shared_ptr<RobotState> &robot_state)
void send(const RobotCommand &robot_cmd)
void sendAll(const std::uint8_t &command, std::string payload = "")
void sendStart()
void sendPause()
bool sendOutputSetup(const std::vector<std::string> &output_names, double frequency)
bool sendInputSetup(const std::vector<std::string> &input_names)
class RobotCommand

Public Types

enum Type

Values:

enumerator NO_CMD = 0
enumerator MOVEJ = 1
enumerator MOVEJ_IK = 2
enumerator MOVEL = 3
enumerator MOVEL_FK = 4
enumerator FORCE_MODE = 6
enumerator FORCE_MODE_STOP = 7
enumerator ZERO_FT_SENSOR = 8
enumerator SPEEDJ = 9
enumerator SPEEDL = 10
enumerator SERVOJ = 11
enumerator SERVOC = 12
enumerator SET_STD_DIGITAL_OUT = 13
enumerator SET_TOOL_DIGITAL_OUT = 14
enumerator SPEED_STOP = 15
enumerator SERVO_STOP = 16
enumerator SET_PAYLOAD = 17
enumerator TEACH_MODE = 18
enumerator END_TEACH_MODE = 19
enumerator FORCE_MODE_SET_DAMPING = 20
enumerator FORCE_MODE_SET_GAIN_SCALING = 21
enumerator SET_SPEED_SLIDER = 22
enumerator SET_STD_ANALOG_OUT = 23
enumerator SERVOL = 24
enumerator TOOL_CONTACT = 25
enumerator GET_STEPTIME = 26
enumerator GET_ACTUAL_JOINT_POSITIONS_HISTORY = 27
enumerator GET_TARGET_WAYPOINT = 28
enumerator SET_TCP = 29
enumerator GET_INVERSE_KINEMATICS_ARGS = 30
enumerator PROTECTIVE_STOP = 31
enumerator STOPL = 33
enumerator STOPJ = 34
enumerator SET_WATCHDOG = 35
enumerator IS_POSE_WITHIN_SAFETY_LIMITS = 36
enumerator IS_JOINTS_WITHIN_SAFETY_LIMITS = 37
enumerator GET_JOINT_TORQUES = 38
enumerator POSE_TRANS = 39
enumerator GET_TCP_OFFSET = 40
enumerator JOG_START = 41
enumerator JOG_STOP = 42
enumerator GET_FORWARD_KINEMATICS_DEFAULT = 43
enumerator GET_FORWARD_KINEMATICS_ARGS = 44
enumerator MOVE_PATH = 45
enumerator GET_INVERSE_KINEMATICS_DEFAULT = 46
enumerator IS_STEADY = 47
enumerator SET_CONF_DIGITAL_OUT = 48
enumerator SET_INPUT_INT_REGISTER = 49
enumerator SET_INPUT_DOUBLE_REGISTER = 50
enumerator MOVE_UNTIL_CONTACT = 51
enumerator FREEDRIVE_MODE = 52
enumerator END_FREEDRIVE_MODE = 53
enumerator GET_FREEDRIVE_STATUS = 54
enumerator SET_EXTERNAL_FORCE_TORQUE = 55
enumerator FT_RTDE_INPUT_ENABLE = 56
enumerator ENABLE_EXTERNAL_FT_SENSOR = 57
enumerator GET_ACTUAL_TOOL_FLANGE_POSE = 58
enumerator WATCHDOG = 99
enumerator STOP_SCRIPT = 255
enum Recipe

Values:

enumerator RECIPE_1 = 1
enumerator RECIPE_2 = 2
enumerator RECIPE_3 = 3
enumerator RECIPE_4 = 4
enumerator RECIPE_5 = 5
enumerator RECIPE_6 = 6
enumerator RECIPE_7 = 7
enumerator RECIPE_8 = 8
enumerator RECIPE_9 = 9
enumerator RECIPE_10 = 10
enumerator RECIPE_11 = 11
enumerator RECIPE_12 = 12
enumerator RECIPE_13 = 13
enumerator RECIPE_14 = 14
enumerator RECIPE_15 = 15
enumerator RECIPE_16 = 16
enumerator RECIPE_17 = 17
enumerator RECIPE_18 = 18
enumerator RECIPE_19 = 19

Public Functions

RobotCommand()

Public Members

Type type_ = NO_CMD
std::uint8_t recipe_id_
std::int32_t async_
std::int32_t ft_rtde_input_enable_
std::int32_t reg_int_val_
double reg_double_val_
std::vector<double> val_
std::vector<int> selection_vector_
std::vector<int> free_axes_
std::int32_t force_mode_type_
std::uint8_t std_digital_out_
std::uint8_t std_digital_out_mask_
std::uint8_t configurable_digital_out_
std::uint8_t configurable_digital_out_mask_
std::uint8_t std_tool_out_
std::uint8_t std_tool_out_mask_
std::uint8_t std_analog_output_mask_
std::uint8_t std_analog_output_type_
double std_analog_output_0_
double std_analog_output_1_
std::int32_t speed_slider_mask_
double speed_slider_fraction_
std::uint32_t steps_

Script Client API

class ur_rtde::ScriptClient

Public Types

enum ConnectionState

Values:

enumerator DISCONNECTED = 0
enumerator CONNECTED = 1

Public Functions

ScriptClient(std::string hostname, uint32_t major_control_version, uint32_t minor_control_version, int port = 30003, bool verbose = false)
~ScriptClient()
void connect()
void disconnect()
bool isConnected()
void setScriptFile(const std::string &file_name)

Assign a custom script file that will be sent to device if the sendScript() function is called.

Setting an empty file_name will disable the custom script loading This eases debugging when modifying the control script because it does not require to recompile the whole library

bool sendScript()

Send the internal control script that is compiled into the library or the assigned control script file.

bool sendScript(const std::string &file_name)

Send the script file with the given file_name.

bool sendScriptCommand(const std::string &cmd_str)
void setScriptInjection(const std::string &search_string, const std::string &inject_string)
std::string getScript()

Get the corrected rtde_control script as a std::string.

Dashboard Client API

class ur_rtde::DashboardClient

This class provides the interface for access to the UR dashboard server.

Public Types

enum ConnectionState

Values:

enumerator DISCONNECTED = 0
enumerator CONNECTED = 1

Public Functions

DashboardClient(std::string hostname, int port = 29999, bool verbose = false)
~DashboardClient()
void connect(uint32_t timeout_ms = 2000)

Connects to the dashboard server with the given timeout value.

bool isConnected()

Returns true if the dashboard client is connected to the server.

void disconnect()
void send(const std::string &str)
std::string receive()
void loadURP(const std::string &urp_name)

Returns when both program and associated installation has loaded.

The load command fails if the associated installation requires confirmation of safety. In this case an exception with an error message is thrown.

void play()

Throws exception if program fails to start.

void stop()

Throws exception if the program fails to stop.

void pause()

Throws exception if the program fails to pause.

void quit()

Closes connection.

void shutdown()

Shuts down and turns off robot and controller.

bool running()

Execution state enquiry.

Return

Returns true if program is running.

void popup(const std::string &message)

The popup-text will be translated to the selected language, if the text exists in the language file.

void closePopup()

Closes the popup.

void closeSafetyPopup()

Closes a safety popup.

void powerOn()

Powers on the robot arm.

void powerOff()

Powers off the robot arm.

void brakeRelease()

Powers off the robot arm.

void unlockProtectiveStop()

Closes the current popup and unlocks protective stop.

The unlock protective stop command fails with an exception if less than 5 seconds has passed since the protective stop occurred.

void restartSafety()

Use this when robot gets a safety fault or violation to restart the safety.

After safety has been rebooted the robot will be in Power Off.

Attention

You should always ensure it is okay to restart the system. It is highly recommended to check the error log before using this command (either via PolyScope or e.g. ssh connection).

std::string polyscopeVersion()
std::string programState()
std::string robotmode()
std::string getRobotModel()
std::string getLoadedProgram()
std::string safetymode()

Safety mode inquiry.

A Safeguard Stop resulting from any type of safeguard I/O or a configurable I/O three position enabling device result in SAFEGUARD_STOP. This function is deprecated. Instead, use safetystatus().

std::string safetystatus()

Safety status inquiry.

This differs from ‘safetymode’ by specifying if a given Safeguard Stop was caused by the permanent safeguard I/O stop, a configurable I/O automatic mode safeguard stop or a configurable I/O three position enabling device stop. Thus, this is strictly more detailed than safetymode()..

void addToLog(const std::string &message)

Adds log-message to the Log history.

bool isProgramSaved()

Returns the save state of the active program.

bool isInRemoteControl()

Returns the remote control status of the robot.

If the robot is in remote control it returns false and if remote control is disabled or robot is in local control it returns false.

void setUserRole(const UserRole &role)
std::string getSerialNumber()

Returns serial number of the robot.

(Serial number like “20175599999”)

Return

serial number as a std::string

Robotiq Gripper API

class ur_rtde::RobotiqGripper

C++ driver for Robot IQ grippers Communicates with the gripper directly, via socket with string commands, leveraging string names for variables.

  • WRITE VARIABLES (CAN ALSO READ):

    • ACT = ‘ACT’ # act : activate (1 while activated, can be reset to clear fault status)

    • GTO = ‘GTO’ # gto : go to (will perform go to with the actions set in pos, for, spe)

    • ATR = ‘ATR’ # atr : auto-release (emergency slow move)

    • ARD = ‘ARD’ # ard : auto-release direction (open(1) or close(0) during auto-release)

    • FOR = ‘FOR’ # for : force (0-255)

    • SPE = ‘SPE’ # spe : speed (0-255)

    • POS = ‘POS’ # pos : position (0-255), 0 = open

  • READ VARIABLES

    • STA = ‘STA’ # status (0 = is reset, 1 = activating, 3 = active)

    • PRE = ‘PRE’ # position request (echo of last commanded position)

    • OBJ = ‘OBJ’ # object detection (0 = moving, 1 = outer grip, 2 = inner grip, 3 = no object at rest)

    • FLT = ‘FLT’ # fault (0=ok, see manual for errors if not zero)

Public Types

enum eStatus

Gripper status reported by the gripper.

The integer values have to match what the gripper sends.

Values:

enumerator RESET = 0

RESET.

enumerator ACTIVATING = 1

ACTIVATING.

enumerator ACTIVE = 3

ACTIVE.

enum eObjectStatus

Object status reported by the gripper.

The integer values have to match what the gripper sends.

Values:

enumerator MOVING = 0

gripper is opening or closing

enumerator STOPPED_OUTER_OBJECT = 1

outer object detected while opening the gripper

enumerator STOPPED_INNER_OBJECT = 2

inner object detected while closing the gripper

enumerator AT_DEST = 3

requested target position reached - no object detected

enum ConnectionState

Connection status.

Values:

enumerator DISCONNECTED = 0
enumerator CONNECTED = 1
enum eMoveMode

For synchronous or asynchronous moves.

Values:

enumerator START_MOVE

returns immediately after move started

enumerator WAIT_FINISHED

returns if the move finished, that means if an object is gripped or if requested target position is reached

enum eUnit

Unit identifiers for the configuration of the units for position, speed and flow.

Values:

enumerator UNIT_DEVICE

device unit in the range 0 - 255 - 255 meansd fully closed and 0 means fully open

enumerator UNIT_NORMALIZED

normalized value in the range 0.0 - 1.0, for position 0.0 means fully closed and 1.0 means fully open

enumerator UNIT_PERCENT

percent in the range from 0 - 100 % for position 0% means fully closed and 100% means fully open

enumerator UNIT_MM

position value in mm - only for position values

enum eMoveParameter

Identifier for move parameters.

Values:

enumerator POSITION
enumerator SPEED
enumerator FORCE
enum ePostionId

Position identifiers.

Values:

enumerator OPEN = 0
enumerator CLOSE = 1
enum eFaultCode

Fault code set in FLT.

Values:

enumerator NO_FAULT = 0x00

No fault (solid blue LED)

enumerator FAULT_ACTION_DELAYED = 0x05

Action delayed; the activation (re-activation) must be completed prior to perform the action.

enumerator FAULT_ACTIVATION_BIT = 0x07

The activation bit must be set prior to performing the action.

enumerator FAULT_TEMPERATURE = 0x08

Maximum operating temperature exceeded (≥ 85 °C internally); let cool down (below 80 °C).

enumerator FAULT_COMM = 0x09

No communication during at least 1 second.

enumerator FAULT_UNDER_VOLTAGE = 0x0A

Under minimum operating voltage.

enumerator FAULT_EMCY_RELEASE_ACTIVE = 0x0B

Automatic release in progress.

enumerator FAULT_INTERNAL = 0x0C

Internal fault, contact support@robotiq.com.

enumerator FAULT_ACTIVATION = 0x0D

Activation fault, verify that no interference or other error occurred.

enumerator FAULT_OVERCURRENT = 0x0E

Overcurrent triggered.

enumerator FAULT_EMCY_RELEASE_FINISHED = 0x0F

Automatic release completed.

Public Functions

RobotiqGripper(const std::string &Hostname, int Port = 63352, bool verbose = false)

Constructor - creates a RobotiqGripper object with the given Hostname/IP and Port.

Parameters
  • Hostname: The hostname or ip address to use for connection

  • Port: The port to use for connection

  • verbose: Prints additional debug information if true

void connect(uint32_t timeout_ms = 2000)

Connects to the gripper server with the given millisecond timeout.

void disconnect()

Disconnects from the gripper server.

bool isConnected() const

Returns true if connected.

void activate(bool auto_calibrate = false)

Resets the activation flag in the gripper, and sets it back to one, clearing previous fault flags.

This is required after an emergency stop or if you just powered on your robot.

Parameters
  • auto_calibrate: Whether to calibrate the minimum and maximum positions based on actual motion.

void autoCalibrate(float Speed = -1.0)

Attempts to calibrate the open and closed positions, by closing and opening the gripper.

The function returns if calibration has been finished.

Parameters
  • [in] Speed: Optional speed parameter. If the speed parameter is less than 0, then is ignored and the calibration move is executed with default calibration speed (normally 1/4 of max speed).

bool isActive()

Returns whether the gripper is active.

If the function returns false, you need to activate the gripper via the activate() function.

See

activate()

float getOpenPosition() const

Returns the fully open position in the configured position unit.

If you work with UNIT_DEVICE, then the open position is the position value near 0. If you work with any other unit, then the open position is the bigger value (that means 1.0 for UNIT_NORMALIZED, 100 for UNIT_PERCENT or the opening in mm for UNIT_MM).

float getClosedPosition() const

Returns what is considered the closed position for gripper in the configured position unit.

If you work with UNIT_DEVICE, then the closed position is the position value near 255. If you work with any other unit, then the closed position is always 0. That means the position value defines the opening of the gripper.

float getCurrentPosition()

Returns the current position as returned by the physical hardware in the configured position unit.

bool isOpen()

Returns whether the current position is considered as being fully open.

bool isClosed()

Returns whether the current position is considered as being fully closed.

int move(float Position, float Speed = -1.0, float Force = -1.0, eMoveMode MoveMode = START_MOVE)

Sends command to start moving towards the given position, with the specified speed and force.

If the Speed and Force parameters are -1.0, then they are ignored and the pre configured speed and force parameters set via setSpeed() and setForce() function are used. So this gives you the option to pass in the speed parameter each time or to use preset speed and force parameters.

Return

: Returns the object detection status.

Parameters
  • Position: Position to move to [getClosedPosition() to getOpenPosition()]

  • Speed: Speed to move at [min_speed, max_speed]

  • Force: Force to use [min_force, max_force]

  • MoveMode: START_MOVE - starts the move and returns immediately WAIT_FINISHED - waits until the move has finished

int open(float Speed = -1.0, float Force = -1.0, eMoveMode MoveMode = START_MOVE)

Moves the gripper to its fully open position.

See

See move() function for a detailed description of all other parameters

int close(float Speed = -1.0, float Force = -1.0, eMoveMode MoveMode = START_MOVE)

Moves the gripper to its fully closed position.

See

See move() function for a detailed description of all other parameters

void emergencyRelease(ePostionId Direction, eMoveMode MoveMode = WAIT_FINISHED)

The emergency release is meant to disengage the gripper after an emergency stop of the robot.

The emergency open is not intended to be used under normal operating conditions.

Parameters
  • Direction: OPEN - moves to fully open position, CLOSE - moves to

  • MoveMode: WAIT_FINISHED - waits until emergency release has finished START_MOVE - returns as soon as the emergency release has started Use faultStatus() function o check when emergency release has finished. (faultStatus() == FAULT_EMCY_RELEASE_FINISHED) fully close position

int faultStatus()

Returns the current fault status code.

See

eFaultCode

void setUnit(eMoveParameter Param, eUnit Unit)

Set the units to use for passing position, speed and force values to the gripper functions and for reading back values like current position.

The default unit for position is UNIT_NORM (0.0 - 1.0). That means gripper closed is 0.0 and gripper fully open is 1.0 The default unit for speed and force is also UNIT_NORM (0.0 - 1.0). That means 1.0 means maximum force and maximum speed and 0.5 means half speed and half force.

See

eUnit

void setPositionRange_mm(int Range)

Configure the position range of your gripper.

If you would like to use the unit UNIT_MM for position values, then you need to properly configure the position range of your gripper for proper value conversion.

Parameters
  • [in] Range: The position range in mm from the device position 0 to the device position 255

float setSpeed(float Speed)

Sets the speed to use for future move commands in the configured speed unit.

Return

Returns the adjusted speed value.

See

move()

float setForce(float Force)

Sets the force for future move commands in the configured force unit.

Return

Returns the adjusted force value

See

move()

eObjectStatus objectDetectionStatus()

Returns the current object detection status if a move is active.

Use this function for polling the state.

eObjectStatus waitForMotionComplete()

Call this function after a move command to wait for completion of the commanded move.

bool setVars(const std::vector<std::pair<std::string, int>> Vars)

Sends the appropriate command via socket to set the value of n variables, and waits for its ‘ack’ response.

Return

: True on successful reception of ack, false if no ack was received, indicating the set may not have been effective.

Parameters
  • Vars: Dictionary of variables to set (variable_name, value).

bool setVar(const std::string &Var, int Value)

Sends the appropriate command via socket to set the value of a variable, and waits for its ‘ack’ response.

Return

: True on successful reception of ack, false if no ack was received, indicating the set may not have been effective.

Parameters
  • Var: Variable to set.

  • Value: Value to set for the variable.

int getVar(const std::string &var)

Sends the appropriate command to retrieve the value of a variable from the gripper, blocking until the response is received or the socket times out.

Return

: Value of the variable as integer.

Parameters
  • var: Name of the variable to retrieve.

std::vector<int> getVars(const std::vector<std::string> &Vars)

This function enables the reading of a number of variables into a vector of values:

std::vector<std::string> Vars{"STA", "OBJ", "ACT", "POS"};
auto Result = Gripper.getVars(Vars);
for (int i = 0; i < Vars.size(); ++i)
{
   std::cout << Vars[i] << ": " << Result[i] << std::endl;
}

void getNativePositionRange(int &MinPosition, int &MaxPosition)

Returns the native positions range in device units.

The native position range is properly initialized after an auto calibration.

Parameters
  • [out] MinPosition: Returns the detected minimum position

  • [out] MaxPosition: Returns the detected maximum position

void setNativePositionRange(int MinPosition, int MaxPosition)

Sets the native position range in device units.

Normally the native position range is properly initialized after an auto calibration. If you would like to avoid a calibration move and if you have previously determined or calculated the naticve position range then you can set it via this function.

Parameters
  • [in] MinPosition: Returns the detected minimum position

  • [in] MaxPosition: Returns the detected maximum position