Skip to main content

pyRobotiqGripper

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.

Warning This library is not maintained by Robotiq.

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.

Note The way python is called (python3 vs python) may depend on your system configuration. If the above command does not work, try replacing python3 with python.

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:

pyrobotiqgripper-joystick --help

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.3.8.tar.gz (46.3 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.3.8-py3-none-any.whl (50.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for pyrobotiqgripper-3.3.8.tar.gz
Algorithm Hash digest
SHA256 fb85f023ba692aa521cc31919d920b60742dc9d868d5c1639c5faccb5b486d38
MD5 67982b7eae22e077cfca600e161b5a34
BLAKE2b-256 ed05eb4f26ee10047b6b0382f47a6af46c7f1b2e4f1065f6db8ee039dc0f3cc6

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyrobotiqgripper-3.3.8.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.3.8-py3-none-any.whl.

File metadata

File hashes

Hashes for pyrobotiqgripper-3.3.8-py3-none-any.whl
Algorithm Hash digest
SHA256 6afc3d41dfa0708d2bddb132055820d34d6bbbf62e3d6d0008d5227fab66c209
MD5 3cd7a5412a953d97bcfbf3643a2a4c99
BLAKE2b-256 0fb0276b872f254ffe342fcc0ee8db19e186827ad87c2e51d050eff90669274b

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyrobotiqgripper-3.3.8-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.

Release history Release notifications | RSS feed

3.3.13

2 files

3.3.12

2 files

3.3.10

2 files

3.3.9

2 files

This release

3.3.8 This release

2 files

3.3.5

2 files

3.3.3

2 files

3.3.2

2 files

3.3.1

2 files

3.2.8

2 files

3.2.7

2 files

3.2.6

2 files

3.2.5

2 files

3.2.3

2 files

3.2.2

2 files

3.2.1

2 files

3.2.0

2 files

3.1.9

2 files

3.1.8

2 files

3.1.7

2 files

3.0.7

2 files

3.0.6

2 files

3.0.5

2 files

3.0.4

2 files

3.0.3

2 files

3.0.0

2 files

2.1.0

2 files

2.0.12

2 files

2.0.10

2 files

2.0.9

2 files

2.0.8

2 files

2.0.6

2 files

2.0.5

2 files

2.0.4

2 files

2.0.3

2 files

2.0.2

2 files

2.0.1

2 files

2.0.0

2 files

1.0.1

2 files

1.0.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page