Skip to main content
arXiv Discord Twitter Follow Website
GitHub stars Tests

Orca Core is the core control package of the ORCA Hand. It's used to abstract hardware, provide scripts for calibration, tensioning and to control the hand with simple high-level control methods in joint space. While working directly with core will let you interact with your ORCA Hand on a deep level, the Orca Ui repository (found at: https://github.com/orcahand/orca_ui) can let users get started right away, helping you setup/maintain your hand, tune its performance, and better understand its capabilities.

Get Started

To get started with Orca Core, follow these steps:

Pre-installation steps

  1. Git clone the orca_core repository:

    #use any preferred method, ssh clone shown here
    git clone git@github.com:orcahand/orca_core.git
    
  2. Install uv (found at: https://docs.astral.sh/uv/getting-started/)

Installing the repository

  1. Sync a local development environment with uv:

    uv sync --group dev
    

    This creates a local .venv and installs the package plus development dependencies.

  2. Run commands through uv:

    uv run pytest
    

    If you prefer an activated shell, you can still use:

    source .venv/bin/activate      # macOS / Linux
    .venv\Scripts\activate         # Windows
    

    End users who do not use uv can still install the package with:

    pip install .
    

Post-installation sample usage scripts

  1. Check the configuration file:

    • Review the config file (e.g., orca_core/models/v2/orcahand-right/config.yaml) and make sure it matches your hardware setup.
  2. Run the tension and calibration scripts:

    uv run python scripts/tension.py orca_core/models/v2/orcahand-right/config.yaml
    uv run python scripts/calibrate.py orca_core/models/v2/orcahand-right/config.yaml
    

    Replace the path with your specific hand model folder if needed.

  3. Move the hand to the neutral position:

    uv run python scripts/neutral.py orca_core/models/v2/orcahand-right/config.yaml
    

Troubleshooting

Serial Port Permissions (Linux)

On Linux, the serial port (e.g., /dev/ttyACM0) is owned by the dialout group. If your user is not in this group, you will get a permission denied error and motors won't be detected.

Permanent fix (requires re-login):

sudo usermod -aG dialout $USER

Temporary fix (resets on reboot/replug):

sudo chmod 666 /dev/ttyACM0

Windows

Supported on Windows 10 and 11; no permission setup is needed. Ports are named COM3, COM4, ... and are listed with:

uv run python -m serial.tools.list_ports -v

Driver notes, latency settings and the first-connection checklist: Running on Windows.

Serial port, baudrate, and motor type

By default these are all auto-detected at connect time.

However, you can declare them explicitly in config.yaml. Useful when:

  • multiple hands are connected at once → port disambiguates which one
  • motors run at a non-default baudrate → baudrate skips the probe sweep
  • the auto-detection picks the wrong family → motor_type forces a specific one
# Optional overrides:   auto-detected if omitted
port: /dev/ttyACM0      # /dev/cu.usbmodemXXXX on macOS, COM3 on Windows
baudrate: 1000000       # 1M for v2; 3M for v1
motor_type: dynamixel   # or 'feetech'

Metadata

Release files for orca-core 0.8.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for orca-core 0.8.0
File Size Uploaded Provenance
orca_core-0.8.0.tar.gz 644.4 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for orca-core 0.8.0
File Interpreter ABI Platform
orca_core-0.8.0-py3-none-any.whl Python 3 none any Details

Total release size: 955.5 kB

Release files / orca_core-0.8.0.tar.gz

Download URL orca_core-0.8.0.tar.gz
Size 644.4 kB
Tags Source
SHA-256 checksum
How to use checksums
f9630b9c204097c4468a3db8e438b5586e982c350c7d98368ecf9b72b506f3eb
BLAKE2b-256 checksum
How to use checksums
a5b6830b32cb67f84062a6d3e031000324f178f98b6161f8a7ea9b5e77ef3a56
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 19, 2026.

Transparency log

Release files / orca_core-0.8.0-py3-none-any.whl

Download URL orca_core-0.8.0-py3-none-any.whl
Size 311.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
64d71d16ab018a62afe6049b163bb922029d02157e1e87f57c20a3cadb9f12ef
BLAKE2b-256 checksum
How to use checksums
86dbe25a8bd52ee1c72ffe98bdd7467e5e5b15e5174899a8570096297d849b7a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 19, 2026.

Transparency log

Security for orca-core 0.8.0

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.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for orca_core-0.8.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 19, 2026.

Transparency log

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.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page