vassar-feetech-servo-sdk 1.5.0

Vassar Robotics' Python SDK for Feetech servo control

Vassar Feetech Servo SDK

A comprehensive Python SDK for controlling Feetech servos (STS/HLS series).

Features

• 🔌 Auto-detection of serial ports
• 🎯 Support for STS and HLS servos (HLS includes torque control)
• 📖 Read positions from single or multiple servos
• ⚡ Read voltage from servos for monitoring power status
• 🎯 Set middle position - Calibrate servos to position 2048
• 💪 Write torque targets - HLS servos only with automatic mode switching
• 🔧 Set operating modes - Configure servo behavior (position/speed/torque/PWM)

Installation

From PyPI

pip install vassar-feetech-servo-sdk

From Source

git clone https://github.com/vassar-robotics/feetech-servo-sdk.git
cd feetech-servo-sdk
pip install -e .

Dependencies

• Python >= 3.7
• pyserial >= 3.5

Note: The scservo_sdk is bundled with this package, so no separate installation is needed.

Quick Start

from vassar_feetech_servo_sdk import ServoController

# Initialize controller with your servo configuration
servo_ids = [1, 2, 3, 4, 5, 6]
controller = ServoController(servo_ids=servo_ids, servo_type="sts")  # or "hls"
controller.connect()

# Read all configured servos
positions = controller.read_all_positions()
for motor_id, pos in positions.items():
    print(f"Motor {motor_id}: {pos} ({pos/4095*100:.1f}%)")

# Set servos to middle position
success = controller.set_middle_position()
if success:
    print("All servos calibrated to middle position!")

controller.disconnect()

# Using context manager
with ServoController([1, 2, 3], "sts") as controller:
    positions = controller.read_all_positions()
    print(positions)

Changing Servo IDs

from vassar_feetech_servo_sdk import ServoController

# Connect to a servo with current ID 1
controller = ServoController(servo_ids=[1], servo_type="sts")
controller.connect()

# Change its ID from 1 to 10
success = controller.set_motor_id(
    current_id=1,
    new_id=10,
    confirm=True  # Will ask for user confirmation
)

if success:
    print("ID changed! Power cycle the servo to apply.")
    
controller.disconnect()

# After power cycling, connect with new ID
controller = ServoController(servo_ids=[10], servo_type="sts")
controller.connect()

Position Control

from vassar_feetech_servo_sdk import ServoController

# Connect to servos (STS or HLS)
controller = ServoController(servo_ids=[1, 2, 3], servo_type="hls")
controller.connect()

# Write position values (automatically switches to position mode)
positions = {
    1: 1024,   # ~90° (position 0-4095)
    2: 2048,   # ~180° (middle position)
    3: 3072    # ~270°
}

results = controller.write_position(positions)  # Uses default speed=32767 (max forward speed)
print(f"Position write results: {results}")

# Position control with speed and acceleration
results = controller.write_position(
    positions, 
    speed=60,        # 60 * 0.732 = ~44 RPM
    acceleration=50  # 50 * 8.7 = 435°/s²
)

# For HLS servos only: Position control with torque limit
if controller.servo_type == "hls":
    positions_with_limit = {1: 2048, 2: 2048}
    torque_limits = {1: 0.5, 2: 0.8}  # 50% and 80% torque limit
    
    results = controller.write_position(positions_with_limit, torque_limits, speed=40)
    print(f"Position write with torque limit: {results}")

controller.disconnect()

Voltage Reading

from vassar_feetech_servo_sdk import ServoController

# Connect to servos
with ServoController([1, 2, 3, 4, 5, 6], "sts") as controller:
    # Read voltage from single servo
    voltage = controller.read_voltage(1)
    print(f"Servo 1 voltage: {voltage:.1f}V")
    
    # Read voltages from all servos
    voltages = controller.read_voltages()
    for motor_id, v in sorted(voltages.items()):
        print(f"Servo {motor_id}: {v:.1f}V")
    
    # Detect leader/follower arms based on voltage
    if voltages[1] < 9.0:
        print("Servo 1 is on the leader arm (< 9V)")
    else:
        print("Servo 1 is on the follower arm (> 9V)")

Torque Control (HLS Only)

from vassar_feetech_servo_sdk import ServoController

# Connect to HLS servos
controller = ServoController(servo_ids=[1, 2, 3], servo_type="hls")
controller.connect()

# Write torque values (automatically switches to torque mode)
torque_values = {
    1: 0.04,   # 4% forward torque
    2: -0.06,  # 6% reverse torque  
    3: 0       # No torque
}

results = controller.write_torque(torque_values)
print(f"Torque write results: {results}")

# You can also manually set operating modes
controller.set_operating_mode(1, 0)  # Position mode
controller.set_operating_mode(2, 1)  # Speed mode
controller.set_operating_mode(3, 2)  # Torque mode

controller.disconnect()

Advanced Usage

# Initialize with specific configuration
controller = ServoController(
    servo_ids=[1, 2, 3, 4, 5, 6],
    servo_type="hls",  # 'sts' or 'hls'
    port="/dev/ttyUSB0",
    baudrate=1000000
)

# Error handling
from vassar_feetech_servo_sdk import ServoReaderError, PortNotFoundError

try:
    controller = ServoController([1, 2, 3], "sts")
    controller.connect()
    positions = controller.read_all_positions()
except PortNotFoundError:
    print("No servo port found!")
except ServoReaderError as e:
    print(f"Error: {e}")

API Reference

ServoController Class

Constructor

ServoController(servo_ids, servo_type="sts", port=None, baudrate=1000000)

• servo_ids: List of servo IDs to control (e.g., [1, 2, 3, 4, 5, 6])
• servo_type: Type of servo - 'sts' or 'hls' (default: 'sts')
• port: Serial port path (auto-detect if None)
• baudrate: Communication speed (default: 1000000)

Methods

• connect(): Establish connection to servos (automatically sets phase to 0 for all servos)
• disconnect(): Close connection
• read_position(motor_id): Read single motor position
• read_positions(motor_ids=None): Read multiple motor positions
• read_all_positions(): Read all configured servo positions
• read_voltage(motor_id): Read voltage from single servo (returns float in volts)
• read_voltages(motor_ids=None): Read voltages from multiple servos (returns dict of voltages)
• read_phase(motor_id): Read phase value from servo (returns int 0-254)
• set_phase(motor_id, phase_value): Set phase value for servo (phase value: 0-254)
• set_middle_position(motor_ids=None): Calibrate servos to middle position (2048)
• set_motor_id(current_id, new_id, confirm=True): Change a servo's ID (requires power cycle)
• set_operating_mode(motor_id, mode): Set servo operating mode (0-3)
• write_position(position_dict, torque_limit_dict=None, speed=32767, acceleration=0): Write position values to servos (auto-switches to position mode)
• write_torque(torque_dict): Write torque values to HLS servos (auto-switches to torque mode)
• disable_all_servos(): Disable torque on all servos (called automatically on cleanup)

Note: The controller automatically disables all servos when the object is destroyed or when using context manager (with statement).

Utility Functions

find_servo_port

find_servo_port(return_all=False)

Auto-detect servo serial port(s) based on operating system.

• return_all (bool): If True, return all available ports. If False, return only the first port (default: False)
• Returns: Single port string (if return_all=False) or list of all ports (if return_all=True)
• Raises: PortNotFoundError if no suitable ports are found

Example:

from vassar_feetech_servo_sdk import find_servo_port

# Get first available port
port = find_servo_port()
print(f"Using port: {port}")

# Get all available ports
ports = find_servo_port(return_all=True)
print(f"Available ports: {ports}")

Servo Types

• STS: Standard Feetech servos (default) - position and speed control
  • Middle position calibration uses torque=128 method
• HLS: High-end servos with additional torque control capabilities
  • Middle position calibration uses offset calibration (reOfsCal) method

Troubleshooting

Port Not Found

If auto-detection fails, you can:

1. List available ports to see what's detected:

from vassar_feetech_servo_sdk import find_servo_port

try:
    ports = find_servo_port(return_all=True)
    print(f"Available ports: {ports}")
except Exception as e:
    print(f"No ports found: {e}")

2. Specify the port manually:

# Linux
controller = ServoController(servo_ids=[1,2,3], port="/dev/ttyUSB0")

# macOS
controller = ServoController(servo_ids=[1,2,3], port="/dev/tty.usbserial-XXXXX")

# Windows
controller = ServoController(servo_ids=[1,2,3], port="COM3")

Permission Denied (Linux)

Option 1: Add your user to the dialout group (recommended):

sudo usermod -a -G dialout $USER
# Log out and back in for changes to take effect

Option 2: Grant permissions to the serial port (temporary):

sudo chmod 666 /dev/ttyUSB0
# Replace /dev/ttyUSB0 with your actual serial port

Connection Failed

1. Check servo power supply
2. Verify baudrate matches servo configuration (default: 1000000)
3. Ensure proper wiring (TX/RX not swapped)

Examples

The package includes several example scripts in the examples/ directory:

• continuous_reading.py - Real-time monitoring with custom callbacks
• set_middle_position.py - Shows how to calibrate servos to middle position
• position_control.py - Comprehensive position control examples
• torque_control.py - HLS torque control examples
• change_servo_id.py - How to change servo IDs
• read_voltage.py - Reading voltage from servos
• phase_control.py - Reading and setting servo phase values
• teleoperation.py - Leader-follower arm control with voltage-based auto-detection
• list_ports.py - Detect and list available servo ports

Testing

Run the test suite:

./run_tests.sh  # Installs dev dependencies and runs tests with coverage
# or
pip install -r requirements-dev.txt
python -m pytest tests/ -v

Acknowledgments

Built on top of the excellent scservo_sdk library for Feetech servo communication.