Metadata-Version: 2.3
Name: pyrobotiqgripper
Version: 3.3.13
Summary: Python Driver for Robotiq Grippers
Author: Benoit CASTETS
Author-email: Benoit CASTETS <opensourceeng@gmail.com>
License: MIT License
         
         Copyright (c) [2024] [Benoit CASTETS]
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
         in the Software without restriction, including without limitation the rights
         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
         copies of the Software, and to permit persons to whom the Software is
         furnished to do so, subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all
         copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Dist: pymodbus>=3.12.1
Requires-Dist: pyserial>=3.5
Requires-Dist: numpy>=1.28
Requires-Dist: pandas>=1.5 ; extra == 'all'
Requires-Dist: pygame-ce>=2.5.2 ; extra == 'all'
Requires-Dist: pynput>=1.7.6 ; extra == 'all'
Requires-Dist: pyautogui>=0.9.54 ; extra == 'all'
Requires-Dist: pyside6>=6.5 ; extra == 'all'
Requires-Dist: sounddevice>=0.4.6 ; extra == 'all'
Requires-Dist: mkdocs ; extra == 'docs'
Requires-Dist: mkdocs-material ; extra == 'docs'
Requires-Dist: mkdocstrings[python] ; extra == 'docs'
Requires-Python: >=3.10.0
Project-URL: homepage, https://github.com/castetsb/pyRobotiqGripper
Project-URL: tracker, https://github.com/castetsb/pyRobotiqGripper/issues
Provides-Extra: all
Provides-Extra: docs
Description-Content-Type: text/markdown

<p align="center">
  <a href="https://pyrobotiqgripper.readthedocs.io/en/latest/">
    <img src="https://img.shields.io/badge/Full%20Documentation-00B0F0?style=for-the-badge&logo=readthedocs&logoColor=white" alt="Full Documentation">
  </a>
  <br>
  <sub>👉 <a href="https://pyrobotiqgripper.readthedocs.io/en/latest/">pyrobotiqgripper.readthedocs.io</a> -- installation, usage guides and the full API reference live there, this README is just a quick overview.</sub>
</p>

<!-- --8<-- [start:intro] -->
# pyRobotiqGripper
<p style="margin-top: -15px; color: var(--md-typeset-color); font-size: 1.1em; font-style: italic;">Python Driver for Robotiq Grippers.</p>

<p align="center">
  <a href="https://pepy.tech/projects/pyrobotiqgripper"><img src="https://static.pepy.tech/personalized-badge/pyrobotiqgripper?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=GREEN&left_text=downloads" alt="PyPI Downloads"></a>
  <img src="https://img.shields.io/pypi/dm/pyrobotiqgripper" alt="PyPI Monthly Downloads">
  <img src="https://img.shields.io/github/stars/castetsb/pyrobotiqgripper" alt="GitHub Stars">
</p>

<p align="center">
  <img src="https://raw.githubusercontent.com/castetsb/pyRobotiqGripper/master/docs/_static/logo.png" alt="pyRobotiqGripper logo">
</p>

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.
<!-- --8<-- [end:intro] -->

<!-- GitHub strips <iframe>, so a clickable thumbnail is used here instead;
     the docs site embeds the video inline (see docs/index.md). -->
<p align="center">
  <a href="https://www.youtube.com/watch?v=82S5LgefvJo">
    <img src="https://raw.githubusercontent.com/castetsb/pyRobotiqGripper/master/docs/_static/intro_video.jpg" alt="pyRobotiqGripper introduction video">
  </a>
</p>

<!-- --8<-- [start:disclaimer] -->

## 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.
<!-- --8<-- [end:disclaimer] -->

> [!NOTE]
> This python package is in constant evolution. Some breaking change may happen from one version to another. This can mainly impact the high level functions.

> [!TIP]
> **Other related software tool**
> C++, ROS2 and other software tools are available on the Robotiq GitHub page: [Robotiq GitHub Repository](https://github.com/robotiq).
