Skip to main content

Getting Started

From the box to your first movement in five steps. Pick your setup once in the tabs below: the choice is remembered across the page.

You need
A PC with Ubuntu (24.04 recommended) or Windows 11x86_64 or aarch64
Internet access and admin rightsfor the installation
A free, stable table, 30–50 mm thickfor the clamp
Three rules before you start
  1. The arm has no brakes. When the motors are disabled, the power is cut or the emergency stop is pressed, it falls.
  2. Stopping your program does not stop the motors. They keep executing the last command.
  3. Keep out of reach of the arm (≈ 0.9 m around the shoulder) while it is powered. The emergency stop is your way to cut power.

1. Set up the hardware​

Mount. Clamp the arm on the table, lifting it only by the base and the links (not by the cables or the gripper). Tighten the clamp before letting go, then place the arm in its resting position. Every session starts and ends here.

Stable resting position

Wire. With the emergency-stop button pressed, connect in this order:

  1. robot → Power Box (orange M12 cable, fits one way, screw it in);
  2. Power Box → PC (USB-C);
  3. Power Box → mains socket with earth.

Wiring of robot, Power Box and PC

Switch on. Turn the emergency-stop button clockwise to release it, then press the green start button. The button lights up and the motor LEDs turn solid red: the motors are powered but disabled, so the arm does not move yet.

2. Prepare your computer​

Check that the arm's USB port is visible:

ls /dev/ttyACM0

Allow your user to use it (once), then log out and back in:

sudo usermod -aG dialout $USER

3. Install the API​

Not sure which one? Choose Python: one command installs everything.

Run as a normal user (not with sudo):

curl -fsSL https://itacarobotics.com/install.sh | bash

It asks for your password once, installs the build tools, a conda environment called ulixenv (Python 3.10) and ulixpy, then checks that it works. It takes a few minutes; run it again any time to update.

In every new terminal, activate the environment first:

conda activate ulixenv

If conda is not found, open a new terminal or run source ~/.bashrc.

Install into your own Python environment instead (pip)

Requires Python ≥ 3.10.

sudo apt install -y build-essential cmake git pkg-config libeigen3-dev libserialport-dev
pip install "git+https://github.com/itacarobotics/ulixpy.git"
python -c "import ulixpy; ulixpy.UlixArm()" # check
Uninstall
conda env remove -n ulixenv # environment and ulixpy
rm -rf /opt/itacarobotics/ulixpy # source code
rm -rf ~/miniforge3 # only if the installer installed Miniforge

4. First program: move the arm by hand​

This runs gravity compensation: the motors cancel the arm's weight, so it floats and you can guide it by hand. It is the safest first test, because it applies no stiffness.

Before running: arm in the resting position, Power Box switched on, nobody near the arm.

gravity.py
import numpy as np
from ulixpy import UlixArm

robot = UlixArm(gripper=True)
robot.connect("/dev/ttyACM0")
robot.enable()
robot.refresh()

zero = np.zeros(6)
try:
while True:
# kp = kd = 0: no stiffness, only gravity compensation
robot.control(zero, zero, zero, zero, zero, True)
except KeyboardInterrupt:
pass
finally:
robot.hold() # keep the current pose
robot.disconnect()
conda activate ulixenv
python gravity.py

More examples are in /opt/itacarobotics/ulixpy/examples.

Press Ctrl+C to stop: the arm holds its current pose.

5. Operate safely​

A typical session, every time:

StepWhy
1Arm in resting position, then switch onenable() gives no holding torque until the first command
2connect(), enable(), then hold() or control() right awaythe arm is only supported once a command is sent
3Move in small steps (≤ 0.2 rad per command)larger jumps are rejected; interpolate motions
4Watch the arm, hand near the emergency stopthere is no collision detection
5Bring the arm back to the resting positionit falls when disabled
6disable(), then press the emergency stopcuts power to the arm
7Unplug the mains if unused for a while
If something goes wrong

Press the emergency stop: power is cut and the arm falls, so keep hands and objects away from below it. To restart, release the button and press the green start button.

Next: the Python API or C++ API reference.