Skip to content

Commit 2599436

Browse files
committed
updated readme
1 parent bb1a0cd commit 2599436

File tree

1 file changed

+23
-5
lines changed

1 file changed

+23
-5
lines changed

README.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,22 +19,40 @@ This package contains meshes and URDF description of [Robotiq Hand-E gripper](ht
1919
2020
![hande_model](docs/hande_rviz.gif)
2121

22-
*(Errata: The minus width range in the animation above is outdated)*
2322

2423
## Usage
2524

26-
In your URDF (Xacro) file include the Hand-E definition. Provide a parent link (for instance `tool0`) as the parameter:
25+
In your URDF (Xacro) file include the Hand-E definition. Provide an unique name and the parent link (for instance `tool0`) as the parameters:
2726

2827
```xml
2928
<xacro:include filename="$(find robotiq_hande_description)/urdf/robotiq_hande_gripper.xacro" />
3029
<!-- ... -->
31-
<xacro:robotiq_hande_gripper parent="PARENT_LINK" prefix="" />
30+
<xacro:robotiq_hande_gripper name="robotiq_hande_gripper" parent="PARENT_LINK" prefix="" />
3231
```
3332

34-
An example usage can be find in the [urdf/hande_preview.urdf.xacro](./urdf/robotiq_hande_gripper.urdf.xacro) file.
33+
For estabilishg a connection with [robotiq_hande_driver](https://github.com/AGH-CEAI/robotiq_hande_driver) there is also need to provide more parameters:
34+
```xml
35+
<xacro:robotiq_hande_gripper
36+
name="robotiq_hande_gripper"
37+
prefix=""
38+
parent="tool0"
39+
grip_pos_min="0.0"
40+
grip_pos_max="0.025"
41+
tty="/tmp/ttyUR"
42+
baudrate="115200"
43+
parity="N"
44+
data_bits="8"
45+
stop_bit="1"
46+
slave_id="9"
47+
use_fake_hardware="false"
48+
/>
49+
```
3550

3651
> [!NOTE]
37-
> The TF frame of the end tip of the gripper is called `${prefix}hande_end`, where `${prefix}` evaluates as the second macro parameter.
52+
> The TF frame of the end tip of the gripper is called `${prefix}hande_end`, where `${prefix}` evaluates as the `prefix` macro parameter.
53+
54+
### Examples
55+
**An example usage can be find** in the [urdf/hande_preview.urdf.xacro](./urdf/robotiq_hande_gripper.urdf.xacro) file. Furthermore, an integration with whole ROS 2 project example can be find in the [AGH-CEAI/aegis_ros](https://github.com/AGH-CEAI/aegis_ros) repository.
3856

3957

4058
## Preview

0 commit comments

Comments
 (0)