ARX X5 SDK
Python bindings for the ARX X5 robot arm. Control ARX X5 arms via CAN interface.
Why This Package?
- Easy Installation:
pip install arx-x5-sdk(no complex build steps for users) - Minimal System Dependencies: Only needs
liborocos-kdlandliburdfdom- no full ROS installation required - Clean API: Modular, better-documented Python interface
- Production Ready: Proper package structure with comprehensive documentation
Installation
Prerequisites
# Runtime dependencies (required even when installing from PyPI)
sudo apt install liborocos-kdl-dev liburdfdom-dev
# CAN interface tools (for USB-CAN adapters)
sudo apt install can-utils
Note: The KDL URDF parser (
libkdl_parser.so) is bundled in the wheel, but its dependencies (liborocos-kdl,liburdfdom) must be installed system-wide. No full ROS installation is needed.
Install from PyPI
pip install arx-x5-sdk
Install from Source
# Additional build dependencies
sudo apt install build-essential cmake python3-dev patchelf
git clone https://github.com/uma-robots/arx-x5-sdk.git
cd arx-x5-sdk
pip install .
Note: Due to CMake build requirements, editable mode (
pip install -e .) is not recommended. Reinstall after changes withpip install --force-reinstall .
Quick Start
from arx_x5_sdk import ArxInterface, ArmType
# Connect to arm
arm = ArxInterface("can0", ArmType.X5_2025)
See examples/ for complete tutorials (joint control, Cartesian control, gripper, teleoperation)
Available Arm Types
ArmType.FOLLOWER # Follower arm
ArmType.LEADER # Leader/master arm
ArmType.X5_2025 # X5 2025 model (default)
ArmType.X5_2025_LOWER_MASS_LINK6 # X5 2025 with corrected gravity compensation
Advanced Usage
Custom URDF
from arx_x5_sdk import C_ArxInterface, get_urdf_path
urdf_path = get_urdf_path("x5_2025_lower_mass_link6.urdf")
arm = C_ArxInterface(urdf_path, "can0", 2)
Get URDF Path
from arx_x5_sdk import get_urdf_path, get_urdf_path_by_type, ArmType
# By filename
path = get_urdf_path("x5_2025.urdf")
# By arm type
path = get_urdf_path_by_type(ArmType.LEADER)
Architecture Support
- Linux x86_64: Fully supported
- macOS (Apple Silicon): Works via Rosetta 2 translation
- ARM64 (Linux) / Windows: Not currently supported
Development & Publishing
This project uses GitHub Actions for CI/CD:
.github/workflows/build.yml- CI testing on every push/PR.github/workflows/publish.yml- Publish releases to PyPI (triggered by version tags).github/workflows/test-publish.yml- Test publishing to TestPyPI (manual)
See each workflow file for detailed documentation on triggers, usage, and requirements.
Documentation
- Examples:
examples/README.md- Getting started tutorials - URDF files:
arx_x5_sdk/urdf/README.md- Gravity compensation fixes - Pre-built libraries:
lib/arx_x5_src/README.md- Binary details
Development
Pre-commit Hooks
This project uses pre-commit hooks to maintain code quality:
# Install with dev dependencies (use uv if available for faster installs)
pip install ".[dev]"
# Run on all files
pre-commit run --all-files
The hooks automatically:
- Whitespace: Remove trailing whitespace, fix line endings (LF), ensure newlines at EOF
- File validation: Check YAML/TOML/JSON syntax, prevent large files (>1MB), detect merge conflicts
- Python code quality: Lint and format with Ruff (fast, modern alternative to black/flake8/isort)
- Security: Detect accidentally committed private keys
Troubleshooting
CAN interface setup:
sudo bash scripts/setup_can.sh /dev/ttyACM0 can0
Gravity compensation issues: Use ArmType.X5_2025_LOWER_MASS_LINK6
Author
Remi Cadene - remi@uma.bot - UMA
Acknowledgments
Based on the official ARX X5 Python SDK. Special thanks to the ARX Robotics team!
Metadata
Release files for arx-x5-sdk 0.1.7
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| arx_x5_sdk-0.1.7.tar.gz | 7.8 MB | Without provenance | Details for arx_x5_sdk-0.1.7.tar.gz |
Built distributions (wheels)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| arx_x5_sdk-0.1.7-cp312-cp312-manylinux_2_39_x86_64.whl | CPython 3.12 | CPython 3.12 | Linux glibc 2.39+ x86-64 | Details for arx_x5_sdk-0.1.7-cp312-cp312-manylinux_2_39_x86_64.whl |
| arx_x5_sdk-0.1.7-cp311-cp311-manylinux_2_39_x86_64.whl | CPython 3.11 | CPython 3.11 | Linux glibc 2.39+ x86-64 | Details for arx_x5_sdk-0.1.7-cp311-cp311-manylinux_2_39_x86_64.whl |
| arx_x5_sdk-0.1.7-cp310-cp310-manylinux_2_39_x86_64.whl | CPython 3.10 | CPython 3.10 | Linux glibc 2.39+ x86-64 | Details for arx_x5_sdk-0.1.7-cp310-cp310-manylinux_2_39_x86_64.whl |
Total release size: 17.4 MB
Release files / arx_x5_sdk-0.1.7.tar.gz
| Download URL | arx_x5_sdk-0.1.7.tar.gz |
|---|---|
| Size | 7.8 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6e3bafb0ba3523bf44e374c980d3e182729a2617270c624c2be128a49e1a2069
|
|
BLAKE2b-256 checksum How to use checksums |
783c72ba5662be7d46b36ae291973062e30bf5b9ea4afb157b471b2080238fcf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.12
|
Release files / arx_x5_sdk-0.1.7-cp312-cp312-manylinux_2_39_x86_64.whl
| Download URL | arx_x5_sdk-0.1.7-cp312-cp312-manylinux_2_39_x86_64.whl |
|---|---|
| Size | 3.2 MB |
| Tags | CPython 3.12 Linux glibc 2.39+ x86-64 |
|
SHA-256 checksum How to use checksums |
143be6acebe8ed45b58167eb477631efdd781d081692527f863899631097a0fd
|
|
BLAKE2b-256 checksum How to use checksums |
d980ab8d91d0885a11ada13b04468d82a2d6cb37ff221dff464064685c9b2308
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.12
|
Release files / arx_x5_sdk-0.1.7-cp311-cp311-manylinux_2_39_x86_64.whl
| Download URL | arx_x5_sdk-0.1.7-cp311-cp311-manylinux_2_39_x86_64.whl |
|---|---|
| Size | 3.2 MB |
| Tags | CPython 3.11 Linux glibc 2.39+ x86-64 |
|
SHA-256 checksum How to use checksums |
5ae02ce9a563838671e8cb0ca757a5f48ef5cdb3d6872392ad82688243c07aa8
|
|
BLAKE2b-256 checksum How to use checksums |
36ef0e64dd832dc23a51c9ccd07c77c321f24b9807ee6b4b087048a264322b57
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.12
|
Release files / arx_x5_sdk-0.1.7-cp310-cp310-manylinux_2_39_x86_64.whl
| Download URL | arx_x5_sdk-0.1.7-cp310-cp310-manylinux_2_39_x86_64.whl |
|---|---|
| Size | 3.2 MB |
| Tags | CPython 3.10 Linux glibc 2.39+ x86-64 |
|
SHA-256 checksum How to use checksums |
2294eb99155eabb8088db87ab7585c5830729b2766661540e8d525cf59a4df55
|
|
BLAKE2b-256 checksum How to use checksums |
2e53a3e2c59c950157f236fd3aeebbfc11a0d9925cf25139f8aacb738f9aaf89
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.12.12
|
Security for arx-x5-sdk 0.1.7
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.