Skip to main content

Python Driver for Robotiq Grippers

Project description

PyPI Downloads PyPI Monthly Downloads GitHub Stars

Python Driver for Robotiq Grippers.

PyRobotiqGripper Logo

Python Driver for Robotiq Grippers.

pyRobotiqGripper is a Python library designed to facilitate control of Robotiq grippers using Modbus RTU communication via serial port or over ethernet. It is compatible with 2F85, 2F140, and Hande.

Documentation: pyRobotiqGripper Documentation

1-Disclaimer

This library can be seen as a starting point for a Robotiq integration project. You are responsible for what you do with this library. The author takes no responsibility for any malfunction.

2-How to Install

Install the pyRobotiqGripper python package using PIP.

python3 -m pip install "pyRobotiqGripper[all]"

The all extra includes the optional dependencies used by the joystick CLI and history/data helper methods.

3-Typical Usage:

3-1-Robotiq gripper connected at PC USB port via a USB to RS485 converter

import pyrobotiqgripper as rq

#Create a Robotiq gripper object.
gripper = rq.RobotiqGripper()

By default, the serial port on which the gripper is connected is automatically detected. However, you can manually specify the serial port name if you want to. Refer to the API documentation for more information.

3-2-Robotiq gripper connected to a UR robot with RS485 URCAP installed

Replace <UR_ROBOT_IP> with the actual IP address of your UR robot.

import pyrobotiqgripper as rq

#Create a Robotiq gripper object.
gripper = rq.RobotiqGripper(connection_type="RTU_VIA_TCP", tcp_host=<UR_ROBOT_IP>)

3-3-Gripper control

Activate the gripper and do whatever you want with the gripper: open, close, get position feedback, etc.

gripper.activate()
gripper.calibrate(closemm=0, openmm=40)
gripper.open()
gripper.close()
gripper.move(100)
position_in_bit = gripper.position()
print(position_in_bit)
gripper.move_mm(25)
position_in_mm = gripper.positionmm()
print(position_in_mm)

Note: During activation, the gripper is going to fully open and close. Do not disturb this process. Do not place an object inside the gripper.

Note: Position, Speed and Force varie from 0 to 255. It is coded on 8 bits.

You can print the current status of gripper registers using printStatus().

gripper.printStatus()

For realtime control use the realTimeMove method.

gripper.realTimeMove(requestedPosition=100)

The realTimeMove method is designed to be called in a loop with a high frequency. It will move the gripper to the requested position with a speed that depends on the distance to the target position. This allows for a smooth and responsive control of the gripper.

4-Joystick CLI Feature

pyRobotiqGripper includes a command-line interface (CLI) tool for controlling the gripper using a joystick or gamepad.

This CLI requires the all extra.

To use the Joystick CLI, run:

pyrobotiqgripper-joystick

You can also check the available options: .. code-block:: bash

pyrobotiqgripper-joystick –help

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

pyrobotiqgripper-3.2.7.tar.gz (25.5 kB view details)

Uploaded Source

Built Distribution

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

pyrobotiqgripper-3.2.7-py3-none-any.whl (28.4 kB view details)

Uploaded Python 3

File details

Details for the file pyrobotiqgripper-3.2.7.tar.gz.

File metadata

  • Download URL: pyrobotiqgripper-3.2.7.tar.gz
  • Upload date:
  • Size: 25.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pyrobotiqgripper-3.2.7.tar.gz
Algorithm Hash digest
SHA256 b87b9ec309cc2c3f69057db71e090932e17249af5a29db14f957249a66c2ea47
MD5 a1d99e535162b2e3027fd5a08d86042c
BLAKE2b-256 13d1bc76093e0402fcfa90edd7c304b42221bb103c6ff865e1d404d4e3d3510e

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyrobotiqgripper-3.2.7.tar.gz:

Publisher: release.yaml on castetsb/pyRobotiqGripper

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyrobotiqgripper-3.2.7-py3-none-any.whl.

File metadata

File hashes

Hashes for pyrobotiqgripper-3.2.7-py3-none-any.whl
Algorithm Hash digest
SHA256 9dde189411f3efb3634a7187a19b1e15cfaa86bbf59060b5703fa81919d5ad92
MD5 a2802fa546974acdc636277897baf1f4
BLAKE2b-256 0e99b47b0fcd9cd883853cdd68e67b8f7ae4b32d17e6af2650675794e5e48350

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyrobotiqgripper-3.2.7-py3-none-any.whl:

Publisher: release.yaml on castetsb/pyRobotiqGripper

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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