Skip to content

Commit 7c02879

Browse files
committed
Fix README
1 parent af8d7fd commit 7c02879

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
44
[![DOI](https://zenodo.org/badge/898628878.svg)](https://doi.org/10.5281/zenodo.15047949)
55

6-
Package for controlling the [Robotiq Hand-E gripper](https://robotiq.com/products/adaptive-grippers#Hand-E) using the [ROS 2 Control](https://control.ros.org/humble/doc/getting_started/getting_started.html) framework. It uses the [robotiq_hande_description](https://github.com/AGH-CEAI/robotiq_hande_description) package for URDF definitions. Originally developed for integration with Universal Robots e-Series (UR5e) and ROS 2 Humble, it is possible to modify this repository to fit your needs. **PRs are welcome!**
6+
Package for controlling the [Robotiq Hand-E gripper](https://robotiq.com/products/adaptive-grippers#Hand-E) using the [ROS 2 Control](https://control.ros.org/humble/doc/getting_started/getting_started.html) framework. It uses the [robotiq_hande_description](https://github.com/AGH-CEAI/robotiq_hande_description) package for URDF definitions. Originally developed for integration with Universal Robots e-Series (UR5e) and ROS 2 Humble, but can be modified to fit other setups. **PRs are welcome!**
77

88

99
![Control preview](docs/gripper_control.webp)
@@ -64,7 +64,7 @@ If you want to work with the real gripper via direct serial communication, the c
6464

6565
Computer → USB adapter ↔ RS485 ↔ Hand-E gripper
6666

67-
In this case, you need to set `use_fake_hardware:=false` and provide serial port to establish connection using `tty_port`:
67+
In this case, set `use_fake_hardware:=false` and provide serial port to establish connection using `tty_port`:
6868
```bash
6969
ros2 launch robotiq_hande_driver gripper_controller_preview.launch.py use_fake_hardware:=false tty_port:=/dev/ttyUSB0
7070
```
@@ -115,7 +115,8 @@ socat pty,link=/tmp/ttyUR,raw,ignoreeof,waitslave tcp:192.168.100.10:54321
115115
> [!WARNING]
116116
> Do not use both the `use_tool_communication:=true` flag for the **ur_driver** and the `create_socat_tty:=true` flag for the **robotiq_hande_driver**!
117117
> Both options will invoke the `socat` command to create the `/tmp/ttyUR` virtual serial port.
118-
> However, the initialization of the Hand-E driver may suffer from a race condition: **the tty link must exist before initialization**.
118+
> However, the initialization of the Hand-E driver may suffer from a race condition.
119+
> The TTY link must exist **before** initialization.
119120
> It is recommended to use the provided `create_socat_tty` option.
120121
121122
## Integration with (other) robots
@@ -130,7 +131,7 @@ An example of including it in a robot Xacro can be found [here](https://github.c
130131

131132
The included robotiq_hande_gripper macro automatically sets up the `<ros2_control>` block pointing to the Robotiq Hand-E driver plugin. This ensures that your robot can control the gripper via the standard ROS 2 control interfaces.
132133

133-
You can easliy dig into the `ros2_control` concepts with [its documentation](https://control.ros.org/rolling/doc/ros2_control/doc/index.html#concepts). There is also a [plenty of examples](https://control.ros.org/humble/doc/ros2_control_demos/doc/index.html#examples)
134+
You can easliy explore the `ros2_control` concepts in the [documentation](https://control.ros.org/rolling/doc/ros2_control/doc/index.html#concepts). There are also [plenty of examples](https://control.ros.org/humble/doc/ros2_control_demos/doc/index.html#examples).
134135

135136
> [!IMPORTANT]
136137
> The `robotiq_hande_driver` currently provides only a **hardware component** (i.e. _hardware interface_) to control the fingers' joints.
@@ -140,15 +141,15 @@ The included `robotiq_hande_gripper` macro automatically sets up the `<ros2_cont
140141
---
141142
## Development notes
142143

143-
This project uses various tools for aiding the quality of the source code. Currently most of them are executed by the `pre-commit`. Please make sure to enable its hooks:
144+
This project uses various tools to aid code quality. Currently most of them are executed by `pre-commit`. Enable hooks with:
144145

145146
```bash
146147
pre-commit install
147148
```
148149

149150
### Test Serial Connection
150151

151-
There is an additional test tool with hardcoded parameters to test the connection with the Hand-E without any ROS dependencies.
152+
There is an additional test tool with hardcoded parameters for testing the connection with the Hand-E without any ROS dependencies.
152153
Before build, change the hardcoded parameters in the beginning of the `robotiq_hande_driver/test/communication_test.cpp` file.
153154

154155
To run test:

0 commit comments

Comments
 (0)