Get Target TCP Speed

SUMMARY

Get Target TCP Speed returns the controller-commanded TCP twist [vx, vy, vz, ωx, ωy, ωz] - linear in m/s, angular in deg/s, expressed in the robot base frame.

Reads from the manipulator state - live controller setpoint when connected, zero-filled offline.

SUPPORTED ROBOTS

Available on all supported manipulators in offline mode. Live hardware readings are currently supported only on Universal Robots.

UNITS

Returns target TCP twist [vx, vy, vz, ωx, ωy, ωz] - linear in m/s, angular in deg/s.

The Skill

speed = robot.get_target_tcp_speed()

The Code

"""
Read target (commanded) TCP velocity example for the Synapse SDK.

Returns the target/commanded TCP twist
``[vx, vy, vz (m/s), ωx, ωy, ωz (deg/s)]``. With ``--ip``, reads live
hardware state. Without ``--ip``, reads from the internal commanded cache
(no connection made) and logs a warning.

Illustrated using Universal Robots (UR10e), supported on all robots.

Usage:
    python get_target_tcp_speed.py [--ip <ROBOT_IP>]
"""

import argparse
from loguru import logger

from telekinesis.synapse.robots.manipulators import universal_robots


def main(ip: str | None = None):
    """Log the current target TCP velocity [m/s, deg/s]."""

    robot = universal_robots.UniversalRobotsUR10E()

    if ip is not None:
        robot.connect(ip=ip)
    else:
        logger.warning(
            "No --ip provided; reading offline commanded-cache state, "
            "not live hardware readings."
        )

    try:
        logger.success(f"target_tcp_speed [m/s, deg/s]: {robot.get_target_tcp_speed()}")
    finally:
        if ip is not None:
            robot.disconnect()


if __name__ == "__main__":
    parser = argparse.ArgumentParser(description="Read target TCP velocity Synapse example")
    parser.add_argument("--ip", type=str, default=None, help="UR robot IP address (optional)")
    args = parser.parse_args()

    main(ip=args.ip)

The Explanation of the Code

from telekinesis.synapse.robots.manipulators import universal_robots

robot = universal_robots.UniversalRobotsUR10E()

Create the robot. UR10e is used here for illustration; the same pattern works for every supported brand.

if ip is not None:
    robot.connect(ip=ip)

Connect to the robot at the given IP. When no --ip is passed, no connection is made and the getter returns from the offline commanded-cache (zero-filled) instead of the live controller setpoint.

logger.success(f"target_tcp_speed [m/s, deg/s]: {robot.get_target_tcp_speed()}")

Read the controller-commanded TCP twist [vx, vy, vz, ωx, ωy, ωz] in the base frame. When connected this is the live setpoint, distinct from the measured get_tcp_speed; offline the cache is zero-filled.

finally:
    if ip is not None:
        robot.disconnect()

Always release the controller link in a finally block so a failure mid-read still cleans up the connection.

Return Value

Type	Description
list[float]	Controller-commanded TCP twist [vx, vy, vz, ωx, ωy, ωz]. Linear in m/s, angular in deg/s, expressed in the robot base frame. Zero-filled offline.

Where to Use the Skill

• Velocity tracking error - Compare against measured TCP twist from Get TCP Speed.
• Trajectory analysis - Monitor the commanded velocity profile during motion.

When Not to Use the Skill

• You need the measured TCP velocity - use Get TCP Speed instead.