Skip to main content

Install SDK

📦 Get Started with Installation
Follow these steps to complete the installation and configuration of pyvitaisdk, and begin your vision-based tactile sensor development journey.

📋 Prerequisites​

Before installing the SDK, please ensure your system meets the following requirements:

✅ Python Environment

  • Python 3.10 or 3.12 (3.12 recommended)
  • pip package manager

✅ System Requirements

  • Ubuntu 20.04/22.04/24.04 or Windows 10/11 or MacOS 15
  • At least 4GB available memory recommended

✅ Dependency Tools

  • conda (recommended) or venv
  • USB drivers (for connecting sensor devices)

🚀 Installation Steps​

💡 Recommended Approach
Using Conda provides better management of Python environments and dependency packages, avoiding version conflicts.

# Step 1: Create Python environment
conda create -n py312 python=3.12

# Step 2: Activate Python environment
conda activate py312

# Step 3: Install pyvitaisdk
pip install pyvitaisdk-*.whl

Method 2: Using venv​

If you don't use Conda, you can also use Python's built-in venv:

# Step 1: Create virtual environment
python3.12 -m venv vitai_env

# Step 2: Activate virtual environment
# Linux/MacOS:
source vitai_env/bin/activate
# Windows:
vitai_env\Scripts\activate

# Step 3: Install pyvitaisdk
pip install pyvitaisdk-*.whl

✅ Verify Installation​

After installation, run the following command to verify the installation was successful:

create a simple test script:

from pyvitaisdk import VTSDeviceFinder, GF225

# Find devices
finder = VTSDeviceFinder()
devices = finder.get_devices()

if devices:
    print(f"✅ Successfully found {len(devices)} device(s)")
else:
    print("⚠️ No devices detected, please check connection")

🔧 Common Issues​

❓ Cannot Find .whl File​

Get Installation Package

The pyvitaisdk .whl file can be obtained through:

❓ Permission Error​

If you encounter a permission error, try using this command:

pip install --user pyvitaisdk-*.whl

❓ Dependency Package Conflicts​

Resolving Dependency Conflicts

If dependency version conflicts occur:

  1. Install in a fresh virtual environment
  2. Update pip using pip install --upgrade pip
  3. Check if Python version is 3.10 or 3.12

❓ Device Not Recognized on Windows​

USB Driver Installation

Windows users need to ensure:

  • Device appears normally in Device Manager
  • Try a different USB port