Skip to content

Commit 57c4bc8

Browse files
committed
Modified the description of package
Signed-off-by: Pyo <[email protected]>
1 parent 8f3ccce commit 57c4bc8

File tree

1 file changed

+5
-38
lines changed

1 file changed

+5
-38
lines changed

README.md

Lines changed: 5 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44

55
ROS 2 package providing a hardware interface for controlling [Dynamixel](https://www.dynamixel.com/) motors via the [ros2_control framework](https://github.com/ros-controls/ros2_control). This repository includes the **dynamixel_hardware_interface plugin** for seamless integration with ROS 2 control, along with the [dynamixel_interfaces](https://github.com/ROBOTIS-GIT/dynamixel_interfaces) package containing custom message definitions used by the interface
66

7-
---
87

98
## 2. **Prerequisites**
109

@@ -25,7 +24,6 @@ This package currently supports ROS 2 Humble only. Ensure that ROS 2 Humble is p
2524
- USB2 Dynamixel or U2D2 adapter
2625
- Proper power supply for Dynamixel motors
2726

28-
---
2927

3028
## **3. Installation**
3129

@@ -50,7 +48,6 @@ This package currently supports ROS 2 Humble only. Ensure that ROS 2 Humble is p
5048
source ~/${WORKSPACE}/install/setup.bash
5149
```
5250

53-
---
5451

5552
## 4. Currently Used Packages
5653

@@ -62,9 +59,6 @@ This project integrates with the following ROS 2 packages to provide extended fu
6259
- **[open_manipulator_y](https://github.com/ROBOTIS-GIT/open_manipulator_y)**
6360
A ROS-based package tailored for the **Open Manipulator-Y**, a 6-DOF robotic arm. This package offers enhanced compatibility and extended functionalities for advanced manipulator control and operations.
6461

65-
----
66-
67-
6862

6963
## 5. Configuration
7064

@@ -85,8 +79,6 @@ These parameters define how the interface communicates with the Dynamixel motors
8579

8680
- **`error_timeout_sec`**: Timeout for communication errors.
8781

88-
------
89-
9082
#### **2. Hardware Configuration**
9183

9284
These parameters define the hardware setup:
@@ -97,8 +89,6 @@ These parameters define the hardware setup:
9789

9890
- **Transmission Matrices**: Define joint-to-transmission mappings.
9991

100-
------
101-
10292
#### **3. Joint Configuration**
10393

10494
Joints define the control and state interfaces for robot movement:
@@ -124,22 +114,19 @@ Joints define the control and state interfaces for robot movement:
124114
<state_interface name="effort"/>
125115
```
126116

127-
---
128117

129-
### **4. GPIO Configuration**
118+
#### **4. GPIO Configuration**
130119

131120
The GPIO tag is used to define the configuration of Dynamixel motors in a robotics system. It serves as a declarative structure to set up motor-specific parameters, command interfaces, and state monitoring capabilities. This allows seamless integration of Dynamixel hardware with software frameworks.
132121

133-
------
134122

135-
#### **Key Attributes**
123+
##### **Key Attributes**
136124

137125
- **`name`**: A unique identifier for the motor configuration (e.g., `dxl1`).
138126
- **`ID`**: The unique ID assigned to the motor in the Dynamixel network (e.g., `11`).
139127

140-
------
141128

142-
#### **Sub-Elements**
129+
##### **Sub-Elements**
143130

144131
1. **`<param>`**: Specifies motor-specific settings. These parameters correspond to the properties of the Dynamixel motor, such as its type, control mode, or PID gain values.
145132

@@ -161,9 +148,7 @@ The GPIO tag is used to define the configuration of Dynamixel motors in a roboti
161148
<state_interface name="Present Current"/>
162149
```
163150
164-
------
165-
166-
#### **Example GPIO Configuration**
151+
##### **Example GPIO Configuration**
167152
168153
Below is an example of a fully defined GPIO configuration for a Dynamixel motor. This example demonstrates how to configure a motor with ID `11`, define command interfaces, monitor state data, and set additional parameters such as PID gains and drive mode.
169154
@@ -182,9 +167,7 @@ Below is an example of a fully defined GPIO configuration for a Dynamixel motor.
182167
</gpio>
183168
```
184169
185-
------
186-
187-
#### **Dynamixel Control Table Reference**
170+
##### **Dynamixel Control Table Reference**
188171
189172
The Dynamixel hardware interface uses control tables, defined in model-specific files such as `xm430_w350.model`, to configure and interact with the motor's internal settings. These control tables map hardware parameters to specific memory addresses and data types, enabling fine-grained control and monitoring.
190173
@@ -210,7 +193,6 @@ These settings can be defined within the GPIO configuration or dynamically updat
210193
This professional explanation highlights the flexibility and precision of the Dynamixel hardware interface, empowering developers to fully utilize their motor's capabilities within a structured framework. For further details, refer to the [official Dynamixel e-Manual](https://emanual.robotis.com/docs/en/dxl/x/xm430-w350/#control-table-of-eeprom-area).
211194
212195
213-
214196
## **6. Usage**
215197
216198
Ensure the parameters are configured correctly in your `ros2_control` YAML file or XML launch file.
@@ -227,8 +209,6 @@ Ensure the parameters are configured correctly in your `ros2_control` YAML file
227209
</ros2_control>
228210
```
229211

230-
------
231-
232212
#### Topic and Service Descriptions
233213

234214
##### 1. **dynamixel_state_pub_msg_name**
@@ -237,50 +217,37 @@ Ensure the parameters are configured correctly in your `ros2_control` YAML file
237217

238218
- **Default Value**: `dynamixel_hardware_interface/dxl_state`
239219

240-
------
241220

242221
##### 2. **get_dynamixel_data_srv_name**
243222

244223
- **Description**: Specifies the service name for retrieving Dynamixel data.
245224

246225
- **Default Value**: `dynamixel_hardware_interface/get_dxl_data`
247226

248-
------
249-
250227
##### 3. **set_dynamixel_data_srv_name**
251228

252229
- **Description**: Specifies the service name for setting Dynamixel data.
253230

254231
- **Default Value**: `dynamixel_hardware_interface/set_dxl_data`
255232

256-
------
257-
258233
##### 4. **reboot_dxl_srv_name**
259234

260235
- **Description**: Specifies the service name for rebooting Dynamixel motors.
261236

262237
- **Default Value**: `dynamixel_hardware_interface/reboot_dxl`
263238

264-
------
265-
266239
##### 5. **set_dxl_torque_srv_name**
267240

268241
- **Description**: Specifies the service name for enabling or disabling torque on Dynamixel motors.
269242

270243
- **Default Value**: `dynamixel_hardware_interface/set_dxl_torque`
271244

272245

273-
274-
---
275-
276246
## **7. Contributing**
277247

278248
We welcome contributions! Please follow the guidelines in [CONTRIBUTING.md](CONTRIBUTING.md) to submit issues or pull requests.
279249

280-
---
281250

282251
## **8. License**
283252

284253
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
285-
286-
---

0 commit comments

Comments
 (0)