Skip to content

Commit

Permalink
docs: add dynamixel_rdk_manager README
Browse files Browse the repository at this point in the history
- korean support
- how to use
  • Loading branch information
mjlee111 committed Nov 19, 2024
1 parent cc6b331 commit ffb8f85
Show file tree
Hide file tree
Showing 5 changed files with 45 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ This repository contains a ROS2 package for Dynamixel Sync Read and Write based
- Supports **Lifecycle Node** system
- Supports **YAML** file for parameters
- Status & Control messages support - [Dynamixel RDK Messages](dynamixel_rdk_msgs/README.md)
- Simple GUI for Dynamixel RDK - [Dynamixel RDK Manager](dynamixel_rdk_manager/README.md)

## Requirements
To use the packages in this repository, make sure you have the following installed:
Expand Down
1 change: 1 addition & 0 deletions docs/README_ko.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ Dynamixel Sync Read & Write를 위한 ROS Development Kit.
- 라이프사이클 노드 시스템 지원
- 파라미터를 위한 YAML 파일 지원
- 상태 및 제어 메시지 지원 - [Dynamixel RDK Messages](../dynamixel_rdk_msgs/README_ko.md)
- Dynamixel RDK를 위한 간단한 GUI - [Dynamixel RDK Manager](../dynamixel_rdk_manager/README_ko.md)

## 필수 요소
해당 패키지를 사용하기 위해서 다음 요소가 설치되어 있어야 합니다.
Expand Down
Binary file added docs/images/rdk_manager_gui_sample.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 22 additions & 0 deletions dynamixel_rdk_manager/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Dynamixel RDK Manager

Simple GUI for Dynamixel RDK.

## Features
- Supports Sync Read and Sync Write
- Supports Bulk Read and Bulk Write
- Supports Dynamixel RDK Messages

## Requirements
| Component | Version/Distribution | Notes |
|-----------|----------------------|-------|
| ROS2 | Humble or higher | Recommended ROS2 distributions |
| Dynamixel RDK | [github](https://github.com/mjlee111/dynamixel-RDK) | Dynamixel RDK for controlling Dynamixel |
| Qt | 5.15.2 or higher | Qt for GUI |

## How to Use
```bash
$ ros2 run dynamixel_rdk_manager dynamixel_rdk_manager
```

![image](../docs/images/rdk_manager_gui_sample.png)
21 changes: 21 additions & 0 deletions dynamixel_rdk_manager/README_ko.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Dynamixel RDK Manager

Dynamixel RDK를 위한 간단한 GUI입니다.

## Features
- Sync Read 및 Sync Write 지원
- Bulk Read 및 Bulk Write 지원
- Dynamixel RDK 메시지 지원

## Requirements
| Component | Version/Distribution | Notes |
|-----------|----------------------|-------|
| ROS2 | Humble or higher | 권장 ROS2 배포 |
| Qt | 5.15.2 or higher | GUI를 위한 Qt |

## How to Use
```bash
$ ros2 run dynamixel_rdk_manager dynamixel_rdk_manager
```

![image](../docs/images/rdk_manager_gui_sample.png)

0 comments on commit ffb8f85

Please sign in to comment.