Skip to main content

A Python library for communicating with RH56DFTP devices (tactile hand)

Project description

plusml-rh56dftp Python Library

A Python library for communicating with RH56DFTP devices (tactile hand) via Modbus TCP, developed by plusml.

Features

  • Easy-to-use API for communicating with RH56DFTP tactile hand devices
  • Support for reading and writing registers
  • Built-in logging system for monitoring all operations
  • Comprehensive register definitions including force, current, temperature, and error data
  • Support for tactile data acquisition from all fingers and palm
  • Modular design for easy extension

Installation

From PyPI (Recommended)

You can install the library directly from PyPI using pip:

pip install plusml-rh56dftp

From Source

You can also install the library from the GitHub repository:

git clone https://github.com/plus-m-r/RH56DFTP_teach.git
cd RH56DFTP_teach
pip install -e .

From Local Package

After building the package, you can install it from the generated wheel file:

pip install dist/plusml-rh56dftp-0.1.0-py3-none-any.whl

Requirements

  • Python 3.7 or higher
  • pymodbus 3.11.3

Usage

Basic Usage

# First install the library: pip install plusml-rh56dftp
from RH56DFTP.RH56DFTP_TCP import RH56DFTP_TCP

# Initialize connection to the tactile hand
try:
    # Replace with your device's IP address and port
    client = RH56DFTP_TCP(host="192.168.123.210", port=6000)
    print("โœ… Connected successfully to tactile hand")
    
    # Read device ID
    hand_id = client.get("HAND_ID")
    print(f"๐Ÿค– Hand ID: {hand_id}")
    
    # Write to a register (if supported)
    success = client.set("HAND_ID", 2)
    print(f"๐Ÿ”ง Set HAND_ID to 2: {success}")
    
    # Read force values from fingers
    for finger in range(6):
        force = client.get(f"FORCE_ACT({finger})")
        print(f"โœ‹ Finger {finger} force: {force} g")
    
    # Close connection properly
    client.close()
    print("๐Ÿ‘‹ Connection closed")
except Exception as e:
    print(f"โŒ Error: {e}")

Register Categories

The library provides predefined register names organized by function:

Device Configuration

  • HAND_ID: Device ID (1-254)
  • REDU_RATIO: Baud rate setting
  • CLEAR_ERROR: Clear errors command
  • SAVE: Save configuration to flash
  • RESET_PARA: Restore factory settings

Finger Force Data (Read-only)

  • FORCE_ACT(0): Pinky finger force
  • FORCE_ACT(1): Ring finger force
  • FORCE_ACT(2): Middle finger force
  • FORCE_ACT(3): Index finger force
  • FORCE_ACT(4): Thumb bending force
  • FORCE_ACT(5): Thumb rotation force

Actuator Data (Read-only)

  • CURRENT(0-5): Actuator current values (mA)
  • ERROR(0-5): Actuator error codes
  • TEMP(0-5): Actuator temperature values (ยฐC)

Tactile Data (Read-only)

  • Various tactile data registers for all fingers and palm
  • 3x3, 12x8, and 10x8 matrix configurations
  • 16-bit integer values (0-4096)

Register Configuration

Register definitions are located in the Register/config/configFTP directory:

  • ftp_registers.py: Main register configuration
  • ftp_registers_keys.py: Register name constants

The library automatically loads these configurations during initialization.

Logging

The library includes a built-in logging system that records:

  • All get and set operations with timestamps
  • Connection status and errors
  • Register addresses and values

Logs are saved to rh56dftp.log and also printed to the console with the format:

YYYY-MM-DD HH:MM:SS - RH56DFTP - LEVEL - MESSAGE

Project Structure

RH56DFTP_teach/
โ”œโ”€โ”€ RH56DFTP/              # Main library code
โ”‚   โ”œโ”€โ”€ RH56DFTP_base.py   # Abstract base class
โ”‚   โ”œโ”€โ”€ RH56DFTP_base.pyi  # Type hints for base class
โ”‚   โ”œโ”€โ”€ RH56DFTP_TCP.py    # TCP implementation
โ”‚   โ”œโ”€โ”€ RH56DFTP_TCP.pyi   # Type hints for TCP implementation
โ”‚   โ””โ”€โ”€ __init__.py        # Package initialization
โ”œโ”€โ”€ Register/              # Register configuration
โ”‚   โ”œโ”€โ”€ config/            # Configuration files
โ”‚   โ”‚   โ””โ”€โ”€ configFTP/     # FTP register configs
โ”‚   โ”œโ”€โ”€ RegisterKey/       # Register name constants
โ”‚   โ””โ”€โ”€ RegisterSet/       # Register classes
โ”œโ”€โ”€ connect.py             # Example connection script
โ”œโ”€โ”€ LICENSE                # MIT License file
โ”œโ”€โ”€ README.md              # This file
โ”œโ”€โ”€ pyproject.toml         # Modern package configuration
โ”œโ”€โ”€ setup.py               # Package setup (legacy)
โ””โ”€โ”€ requirements.txt       # Dependencies

Development

Building the Package

To build the package for distribution (recommended method):

python -m build

This will generate:

  • dist/plusml-rh56dftp-0.1.0.tar.gz (source distribution)
  • dist/plusml-rh56dftp-0.1.0-py3-none-any.whl (wheel distribution)

License

MIT License

Repository

https://github.com/plus-m-r/RH56DFTP_teach

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

plusml_rh56dftp-0.1.3.tar.gz (21.0 kB view details)

Uploaded Source

Built Distribution

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

plusml_rh56dftp-0.1.3-py3-none-any.whl (23.8 kB view details)

Uploaded Python 3

File details

Details for the file plusml_rh56dftp-0.1.3.tar.gz.

File metadata

  • Download URL: plusml_rh56dftp-0.1.3.tar.gz
  • Upload date:
  • Size: 21.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for plusml_rh56dftp-0.1.3.tar.gz
Algorithm Hash digest
SHA256 2c60122f7edc00137cd0ee1145de531355cd83d0dff082b5a581e68146ac93da
MD5 80c601b56a6daee5e9ee69d18ba97b28
BLAKE2b-256 2ab071f9ab452c80dccb52e77e82d1bb19c361e063f494f5c21152d23e4e63ee

See more details on using hashes here.

File details

Details for the file plusml_rh56dftp-0.1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for plusml_rh56dftp-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 4078b0237ceba3cf4011af2cf3fd61b067a138c7946846a2585ea24b11a16ee2
MD5 9fa2270080e0a7238bc2f98af5384b8f
BLAKE2b-256 e4255c275f72de3f47605dd840b391eea1b8f9ebc81d30c85675d248a4e8fe3f

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