Skip to main content

Python SDK for Henschel Robotics HDrive17-ETH servo drives

Project description

HDrive Python SDK

Control Henschel Robotics HDrive17-ETH servo drives from Python. No PLC required.

Features

  • Simple APImotor.move_to(90) and you're done
  • Zero dependencies — uses only the Python standard library
  • Real-time telemetry — live position, velocity, and torque via UDP
  • Thread-safe — send commands from any thread
  • Context manager — automatic connect/disconnect with with statement
  • Object read/write — read and write drive configuration objects over TCP
  • Firmware version check — refuses to connect to outdated firmware (< v266)

Installation

pip install hdrive-eth

Or install from source:

git clone https://github.com/henschel-robotics/python-hdrive17-eth.git
cd python-hdrive17-eth
pip install .

For development (editable install):

pip install -e .

Quickstart

from hdrive import HDrive
import time

with HDrive("192.168.122.102") as motor:
    # Move to 90 degrees
    motor.move_to(90)

    # Read telemetry
    time.sleep(1)
    frame = motor.telemetry
    if frame:
        print(f"Position: {frame.position}, Velocity: {frame.velocity}")

# Motor is automatically stopped and disconnected when leaving the 'with' block

API Reference

Connect

from hdrive import HDrive

# Recommended: use a context manager (auto-connect and auto-disconnect)
with HDrive("192.168.122.102") as motor:
    motor.move_to(90)

# The motor is stopped (mode=0) and the connection is closed automatically.

On connection the driver will:

  1. Open a TCP socket to the drive
  2. Read the firmware version (m3s0) and refuse to connect if < 266
  3. Discover the UDP telemetry port (m4s17)
  4. Configure telemetry: check UDP enabled (m4s19), autosend (m4s34), set binary protocol (m4s22=2)
  5. Start the UDP telemetry receiver

Position Control

# Move to absolute position in degrees
motor.move_to(position=90)

# With custom speed, torque, acceleration, deceleration
motor.move_to(position=90, speed=500, torque=500, acc=3000, decc=3000)

Velocity Control

# Constant speed
motor.set_speed(speed=500)

# With torque limit
motor.set_speed(speed=500, torque=300)

Torque Control

# Direct torque setpoint (0–1000)
motor.set_torque(torque=200)

Stop

# Stop the motor (sets mode to 0)
motor.stop()

Read / Write Objects

# Read a drive object (e.g. firmware version m3s0)
version = motor.read_object(index=3, subindex=0)
print(f"Firmware version: {version}")

# Write a drive object (e.g. set ticket protocol m4s22 = 2)
motor.write_object(index=4, subindex=22, value=2)

Telemetry

# Read the latest telemetry frame
frame = motor.telemetry
if frame:
    print(f"Position:    {frame.position}")
    print(f"Velocity:    {frame.velocity}")
    print(f"Time:        {frame.time_us} µs")
    print(f"Temperature: {frame.temperature}")
    print(f"Motor mode:  {frame.motor_mode}")

# Register a callback for every frame
def on_frame(frame):
    print(f"pos={frame.position} vel={frame.velocity}")

motor.on_telemetry(on_frame)

Raw Command

from hdrive import Mode

# Full control over all parameters
motor.send_raw(
    position=90,
    speed=500,
    torque=200,
    mode=Mode.POSITION_CONTROL,
    acc=5000,
    decc=5000,
)

Control Modes

Constant Value Description
Mode.POSITION_CONTROL 0x87 Position + torque + velocity + enable
Mode.VELOCITY_CONTROL 0x85 Velocity + torque + enable
Mode.TORQUE_CONTROL 0x81 Torque + enable
Mode.DISABLE 0x00 Disable the drive

Telemetry Frame Fields

The binary telemetry frame contains 33 int32 values received via UDP at ~1 kHz:

Index Field Description
0 time_us System time in microseconds
1 position Actual position (degrees)
2 velocity Actual velocity
9 temperature Motor temperature
10 motor_mode Current motor mode
11 motor_voltage Supply voltage
12 demanded_speed Demanded speed
13 demanded_position Demanded position
19 software_version Firmware version
23–30 slave_positions CAN slave positions (list of 8)

See hdrive/telemetry.py for the full list of all 33 fields.

Network Configuration

Parameter Default Description
IP address 192.168.122.102 HDrive default IP
TCP port 1000 Command port (auto-discovered from m4s16)
UDP port 1001 Telemetry port (auto-discovered from m4s17)
# Custom IP (ports are auto-discovered from the drive)
motor = HDrive("192.168.1.50")

Examples

See the examples/ folder:

  • basic_control.py — Connect, move, print telemetry
  • velocity_mode.py — Constant speed control
  • torque_mode.py — Torque control
  • read_object.py — Read a single object via raw TCP

Requirements

  • Python 3.8+
  • HDrive17-ETH firmware version 266 or newer
  • No external dependencies

License

MIT — see LICENSE for details.

Support

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hdrive_eth-0.1.0.tar.gz (15.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hdrive_eth-0.1.0-py3-none-any.whl (12.9 kB view details)

Uploaded Python 3

File details

Details for the file hdrive_eth-0.1.0.tar.gz.

File metadata

  • Download URL: hdrive_eth-0.1.0.tar.gz
  • Upload date:
  • Size: 15.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.8

File hashes

Hashes for hdrive_eth-0.1.0.tar.gz
Algorithm Hash digest
SHA256 51ed86c76da2ae5f527e7b77da2560c0b76304676886d30d6627d9f6be60331b
MD5 8645e78e481bf5e1a92cc1eb8c87e629
BLAKE2b-256 09919b5df3ff01e03932994c8bbcd18ea2c570818145a38e3ff201a2bb4e442e

See more details on using hashes here.

File details

Details for the file hdrive_eth-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: hdrive_eth-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 12.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.8

File hashes

Hashes for hdrive_eth-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ed664dd14dafcb4733d848958702506d37d913c9734c9dad7ab5397c3111d201
MD5 d90b6db638d7717f9336d0d886e36468
BLAKE2b-256 35ced6e5f53460bcf933a3b6893f35dd821e93b5a6020c59a6bc5040118fd0ff

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page