diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index b234fdcf..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,26 +0,0 @@ -# Contribution Guide - -本リポジトリへのコントリビュート方法について記載しています。 - -## Issues - -リポジトリの品質向上にご協力頂きありがとうございます。 - -Issueの作成を簡単にするテンプレートを用意しているので活用してください。 - -## Pull Requests - -Pull Requestの作成ありがとうございます。 -提出したPull Request（PR）には次のルールが適用されます。 - -- PRの内容には本リポジトリのライセンス（[LICENSE](./LICENSE)と[README.md](./README.md)に記載されています）が適用されます -- PRは`rt-net`のメンバーによるレビューを経てからマージされます - - すべてのPRがマージされるわけではなく、希望に添えない場合もありますのでご容赦ください -- リポジトリにテストが設定されている場合はできるだけテストを通してください - - 何かしらの理由（テストに間違いがある場合など）でテストを通さずPRを出す場合はその旨をPRに記載してください -- マージする際にはPR内の全コミットが1つのコミットに`squash`されます - - [コミットをスカッシュしてマージする | GitHub Docs](https://docs.github.com/ja/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squash-and-merge-your-commits) -- 1つのPRでリクエストする変更はできるだけシンプルにしてください - - 異なる内容の変更を含む場合はPRを分割してください - - 例えば、複数の機能追加したり、機能追加とリファクタリングを同時にする場合はそれぞれ別々のPRとしてください - - squashマージしても履歴を辿りやすくするためです \ No newline at end of file diff --git a/README.en.md b/README.en.md index cb3b6bdd..59b6795f 100644 --- a/README.en.md +++ b/README.en.md @@ -4,47 +4,41 @@ [![industrial_ci](https://github.com/rt-net/sciurus17_ros/actions/workflows/industrial_ci.yml/badge.svg?branch=ros2)](https://github.com/rt-net/sciurus17_ros/actions/workflows/industrial_ci.yml) -ROS 2 package suite of Sciurus17. +This is a ROS 2 package suite for the Sciurus17. -![sciurus17_gazebo](https://rt-net.github.io/images/sciurus17/sciurus17_gazebo2.png "sciurus17_gazebo") +![sciurus17\_gazebo](https://rt-net.github.io/images/sciurus17/sciurus17_gazebo2.png "sciurus17_gazebo") ## Table of Contents - [sciurus17\_ros](#sciurus17_ros) - [Table of Contents](#table-of-contents) - [Supported ROS 2 distributions](#supported-ros-2-distributions) - - [ROS 1](#ros-1) - [Requirements](#requirements) - [Installation](#installation) - - [Build from source](#build-from-source) - - [Device setup](#device-setup) - [Quick Start](#quick-start) - [Packages](#packages) + - [How ot Use Examples](#how-to-use-examples) - [License](#license) + - [Contributing](#contributing) ## Supported ROS 2 distributions -- [Humble](https://github.com/rt-net/sciurus17_ros/tree/humble) -- [Jazzy](https://github.com/rt-net/sciurus17_ros/tree/jazzy) - -### ROS 1 - -- [Melodic](https://github.com/rt-net/sciurus17_ros/tree/master) -- [Noetic](https://github.com/rt-net/sciurus17_ros/tree/master) +- [Humble Hawksbill](https://github.com/rt-net/sciurus17_ros/tree/humble) +- [Jazzy Jalisco](https://github.com/rt-net/sciurus17_ros/tree/jazzy) ## Requirements - Sciurus17 - [Product page](https://www.rt-net.jp/products/sciurus17) - - [Web Shop](https://www.rt-shop.jp/index.php?main_page=product_info&products_id=3895&language=en) + - [Web shop](https://www.rt-shop.jp/index.php?main_page=product_info&products_id=3895) - Linux OS - Ubuntu 24.04 -- ROS +- ROS 2 - [Jazzy Jalisco](https://docs.ros.org/en/jazzy/Installation.html) ## Installation -### Build from source +### Source Build ```sh # Download packages @@ -55,6 +49,7 @@ git clone -b $ROS_DISTRO https://github.com/rt-net/sciurus17_description.git # Install dependencies rosdep install -r -y -i --from-paths . +sudo apt install libpcl-dev # Build & Install cd ~/ros2_ws @@ -62,9 +57,11 @@ colcon build --symlink-install source ~/ros2_ws/install/setup.bash ``` -### Device setup +## Quick Start + +### Device Setup -Apply udev rules with the following commands to enable communication between `sciurus17_control` and Sciurus17. +Sample programs are available in both C++ and Python. See the links below for details. ```sh ros2 run sciurus17_tools create_udev_rules @@ -73,15 +70,15 @@ ros2 run sciurus17_tools create_udev_rules Reboot the PC after running the script to update the udev rules. After rebooting, the new device `/dev/sciurus17spine` will be created. -## Quick Start +### Run + +The following command makes Sciurus17 open and close its gripper. ```sh # Connect Sciurus17 to PC, then source ~/ros2_ws/install/setup.bash ros2 launch sciurus17_examples demo.launch.py -``` -```sh # Terminal 2 source ~/ros2_ws/install/setup.bash ros2 launch sciurus17_examples example.launch.py example:='gripper_control' @@ -89,28 +86,39 @@ ros2 launch sciurus17_examples example.launch.py example:='gripper_control' # Press [Ctrl-c] to terminate. ``` -Please refer to [./sciurus17_examples/README.md](./sciurus17_examples/README.md). - ## Packages - sciurus17_control - [README](./sciurus17_control/README.md) - - This package includes a hardware driver for Sciurus17. + - This package provides a hardware driver for Sciurus17. + - The procedure for configuring the USB communication port is described in the README. - sciurus17_examples - [README](./sciurus17_examples/README.md) - - This package includes example codes for Sciurus17. + - This package provides C++ examples for Sciurus17. +- sciurus17_examples_py + - [README](./sciurus17_examples_py/README.md) + - This package provides Python examples for Sciurus17. - sciurus17_gazebo - - This package includes Gazebo simulation environments for Sciurus17. + - This package provides Gazebo simulation environments for Sciurus17. - sciurus17_moveit_config - - This package includes configuration files for `moveit2`. + - This package provides configuration files for `MoveIt 2`. - sciurus17_tools - - This package includes option tools for Sciurus17. + - This package provides optional tools for Sciurus17. - sciurus17_vision - - This package includes launch files for camera nodes. - - [chest_camera_info.yaml](./sciurus17_vision/config/chest_camera_info.yaml) is the chest camera calibration parameter. + - This package provides launch files for camera nodes. + - [chest_camera_info.yaml](./sciurus17_vision/config/chest_camera_info.yaml) containes the chest camera calibration parameter. - sciurus17_description (external package) - - [README](https://github.com/rt-net/sciurus17_description/blob/ros2/README.en.md) - - This package includes a model data (xacro) of Sciurus17. + - [README](https://github.com/rt-net/sciurus17_description/blob/ros2/README.md) + - This package provides the model data (xacro) of Sciurus17. + +## How to Use Examples + +Sample programs are available in both C++ and Python. See the links below for details. + +- C++ + - [sciurus17\_examples](./sciurus17_examples/README.md) +- Python + - [sciurus17\_examples\_py](./sciurus17_examples_py/README.md) ## License @@ -121,3 +129,10 @@ Unless attributed otherwise, everything in this repository is under the Apache L The sciurus17_ros depends on [sciurus17_description](https://github.com/rt-net/sciurus17_description) package. The RT Corporation's [NON-COMMERCIAL LICENSE](https://github.com/rt-net/sciurus17_description/blob/main/LICENSE) applies to the package. + +## Contributing + +- This software is open source, but its development is not open. +- This software is essentially provided as open source software on an “AS IS” (in its current state) basis. +- No free support is available for this software. +- Requests for bug fixes and corrections of typographical errors are always accepted; however, requests for additional features will be subject to our internal guidelines. For further details, please refer to the [Contribution Guidelines](https://github.com/rt-net/.github/blob/master/CONTRIBUTING.md#contribution-guide-en). diff --git a/README.md b/README.md index 4bbce954..d491c4f0 100644 --- a/README.md +++ b/README.md @@ -4,34 +4,27 @@ [![industrial_ci](https://github.com/rt-net/sciurus17_ros/actions/workflows/industrial_ci.yml/badge.svg?branch=ros2)](https://github.com/rt-net/sciurus17_ros/actions/workflows/industrial_ci.yml) -ROS 2 package suite of Sciurus17. +ROS 2でSciurusS17を動作させるパッケージです。 -![sciurus17_gazebo](https://rt-net.github.io/images/sciurus17/sciurus17_gazebo2.png "sciurus17_gazebo") +![sciurus17\_gazebo](https://rt-net.github.io/images/sciurus17/sciurus17_gazebo2.png "sciurus17_gazebo") ## Table of Contents - [sciurus17\_ros](#sciurus17_ros) - [Table of Contents](#table-of-contents) - [Supported ROS 2 distributions](#supported-ros-2-distributions) - - [ROS 1](#ros-1) - [Requirements](#requirements) - [Installation](#installation) - - [Build from source](#build-from-source) - - [Device setup](#device-setup) - [Quick Start](#quick-start) - [Packages](#packages) + - [How ot Use Examples](#how-to-use-examples) - [License](#license) - - [開発について](#開発について) + - [Contributing](#contributing) ## Supported ROS 2 distributions -- [Humble](https://github.com/rt-net/sciurus17_ros/tree/humble) -- [Jazzy](https://github.com/rt-net/sciurus17_ros/tree/jazzy) - -### ROS 1 - -- [Melodic](https://github.com/rt-net/sciurus17_ros/tree/master) -- [Noetic](https://github.com/rt-net/sciurus17_ros/tree/master) +- [Humble Hawksbill](https://github.com/rt-net/sciurus17_ros/tree/humble) +- [Jazzy Jalisco](https://github.com/rt-net/sciurus17_ros/tree/jazzy) ## Requirements @@ -40,12 +33,12 @@ ROS 2 package suite of Sciurus17. - [ウェブショップ](https://www.rt-shop.jp/index.php?main_page=product_info&products_id=3895) - Linux OS - Ubuntu 24.04 -- ROS +- ROS 2 - [Jazzy Jalisco](https://docs.ros.org/en/jazzy/Installation.html) ## Installation -### Build from source +### Source Build ```sh # Download packages @@ -64,9 +57,11 @@ colcon build --symlink-install source ~/ros2_ws/install/setup.bash ``` -### Device setup +## Quick Start + +### Device Setup -次の方法で`sciurus17_control`が実機と通信するために用いるUSBシリアル変換デバイス名を固定します。 +以下のコマンドで`sciurus17_control`が実機と通信するために用いるUSBシリアル変換デバイス名を固定します。 ```sh ros2 run sciurus17_tools create_udev_rules @@ -74,15 +69,15 @@ ros2 run sciurus17_tools create_udev_rules 実行後に再起動しSciurus17を接続すると`/dev/sciurus17spine`が作成されるようになります。 -## Quick Start +### Run + +以下のコマンドを実行すると、Sciurus17がグリッパ開閉動作をします。 ```sh # Connect Sciurus17 to PC, then source ~/ros2_ws/install/setup.bash ros2 launch sciurus17_examples demo.launch.py -``` -```sh # Terminal 2 source ~/ros2_ws/install/setup.bash ros2 launch sciurus17_examples example.launch.py example:='gripper_control' @@ -90,13 +85,12 @@ ros2 launch sciurus17_examples example.launch.py example:='gripper_control' # Press [Ctrl-c] to terminate. ``` -詳細は[sciurus17_examples](./sciurus17_examples/README.md)を参照してください。 - ## Packages - sciurus17_control - [README](./sciurus17_control/README.md) - Sciurus17の制御を行うパッケージです + - USB通信ポートの設定方法をREAMDEに記載しています - sciurus17_examples - [README](./sciurus17_examples/README.md) - Sciurus17のサンプルコード集です @@ -106,7 +100,7 @@ ros2 launch sciurus17_examples example.launch.py example:='gripper_control' - sciurus17_gazebo - Sciurus17のGazeboシミュレーションパッケージです - sciurus17_moveit_config - - Sciurus17の`moveit2`設定ファイルです + - Sciurus17の`MoveIt 2`設定ファイルです - sciurus17_tools - Sciurus17を活用するためのオプションツールをまとめたパッケージです - sciurus17_vision @@ -116,22 +110,30 @@ ros2 launch sciurus17_examples example.launch.py example:='gripper_control' - [README](https://github.com/rt-net/sciurus17_description/blob/ros2/README.md) - Sciurus17のモデルデータ（xacro）を定義するパッケージです +## How to Use Examples + +サンプルプログラムは、C++とPythonの両方を用意しています。詳しくは、以下のリンクをご覧ください。 + +- C++ + - [sciurus17\_examples](./sciurus17_examples/README.md) +- Python + - [sciurus17\_examples\_py](./sciurus17_examples_py/README.md) + ## License (C) 2018 RT Corporation \ -各ファイルはライセンスがファイル中に明記されている場合、そのライセンスに従います。 -特に明記されていない場合は、Apache License, Version 2.0に基づき公開されています。 +各ファイルにライセンスが明記されている場合、そのライセンスに従います。 +特に明記がない場合は、Apache License, Version 2.0に基づいて公開されています。 ライセンスの全文は[LICENSE](./LICENSE)または[https://www.apache.org/licenses/LICENSE-2.0](https://www.apache.org/licenses/LICENSE-2.0)から確認できます。 本パッケージが依存する[sciurus17_description](https://github.com/rt-net/sciurus17_description/tree/ros2)には株式会社アールティの非商用ライセンスが適用されています。 詳細は[sciurus17_description/LICENSE](https://github.com/rt-net/sciurus17_description/blob/ros2/LICENSE)を参照してください。 -## 開発について +## Contributing - 本ソフトウェアはオープンソースですが、開発はオープンではありません。 - 本ソフトウェアは基本的にオープンソースソフトウェアとして「AS IS」（現状有姿のまま）で提供しています。 - 本ソフトウェアに関する無償サポートはありません。 -- バグの修正や誤字脱字の修正に関するリクエストは常に受け付けていますが、 -それ以外の機能追加等のリクエストについては社内のガイドラインを優先します。 -詳しくは[コントリビューションガイドライン](./CONTRIBUTING.md)に従ってください。 +- バグの修正や誤字脱字の修正に関するリクエストは常に受け付けていますが、それ以外の機能追加等のリクエストについては社内のガイドラインを優先します。 +詳しくは[コントリビューションガイドライン](https://github.com/rt-net/.github/blob/master/CONTRIBUTING.md#contribution-guide-ja)に従ってください。 diff --git a/sciurus17_control/README.md b/sciurus17_control/README.md index 13fd9dae..fc0e27f6 100644 --- a/sciurus17_control/README.md +++ b/sciurus17_control/README.md @@ -3,7 +3,22 @@ このパッケージは[ros2_control](https://github.com/ros-controls/ros2_control) をベースにした、Sciurus17 のコントローラパッケージです。 -## ros2_control関連ファイル +## Table of Contents + +- [sciurus17\_control](#sciurus17_control) +- [Setup](#setup) + - [USB Port Configuration](#usb-port-configuration) +- [How to Launch Nodes](#how-to-launch-nodes) +- [Controller Manager Parameters](#controller-manager-parameters) + - [Control Cycle](#control-cycle) + - [Controllers](#controllers) +- [sciurus17\_hardware Parameters](#sciurus17_hardware-parameters) + - [USB Port](#usb-port) + - [Baudrate](#baudrate) + - [Communication Timeout](#communication-timeout) + - [Configuration File Paths for RT Manipulator C++ Library](#configuration-file-paths-for-rt-manipulator-c-library) + +## ros2_control Files - `sciurus17_control::Sciurus17Hardware (sciurus17_hardware)` - 本パッケージがエクスポートする[Hardware Components](https://control.ros.org/master/doc/getting_started/getting_started.html#hardware-components)です @@ -14,12 +29,12 @@ - [config/sciurus17_controllers.yaml](./config/sciurus17_controllers.yaml) - Controller Managerのパラメータファイルです -## 実機のセットアップ +## Setup `sciurus17_hardware`がSciurus17実機と通信するために、 PCとSciurus17の設定が必要です。 -### USB通信ポートの設定 +### USB Port Configuration 次の方法で`sciurus17_control`が実機と通信するために用いるUSBシリアル変換デバイス名を固定します。 @@ -29,7 +44,7 @@ ros2 run sciurus17_tools create_udev_rules 実行後に再起動しSciurus17を接続すると`/dev/sciurus17spine`が作成されるようになります。 -## ノードの起動 +## How to Launch Nodes `sciurus17_control.launch.py`を実行すると、`Controller Manager`ノードが起動し、 以下のコントローラが読み込まれます。 @@ -49,7 +64,7 @@ ros2 run sciurus17_tools create_udev_rules ros2 topic echo /joint_states ``` -## Controller Managerのパラメータ +## Controller Manager Parameters `Controller Manager`のパラメータは [config/sciurus17_controllers.yaml](./config/sciurus17_controllers.yaml) @@ -66,11 +81,11 @@ controller_manager: type: position_controllers/GripperActionController ``` -### 制御周期 +### Control Cycle `update_rate`は制御周期を設定します。 -### コントローラ +### Controllers Sciurus17の各関節を制御するコントローラの設定ができます。コントローラの名称と役割の対応は以下のとおりです。 @@ -87,7 +102,7 @@ Sciurus17の各関節を制御するコントローラの設定ができます - waist_yaw_controller - 腰制御用コントローラ -## sciurus17_hardwareのパラメータ +## sciurus17_hardware Parameters `sciurus17_hardware`のパラメータは `sciurus17_description/urdf/sciurus17.urdf.xacro` @@ -100,17 +115,17 @@ Sciurus17の各関節を制御するコントローラの設定ができます ``` -### USB通信ポート +### USB Port `port_name`はSciurus17との通信に使用するUSB通信ポートを設定します。 -### ボーレート +### Baudrate `baudrate`はSciurus17に搭載したDynamixelとの通信ボーレートを設定します。 デフォルト値には`3000000` (3 Mbps)を設定しています。 -### 通信タイムアウト +### Communication Timeout `timeout_seconds`は通信タイムアウト時間（秒）を設定します。 @@ -118,7 +133,7 @@ Sciurus17の各関節を制御するコントローラの設定ができます read/write動作を停止します。 USBケーブルや電源ケーブルが抜けた場合等に有効です。 -### RTマニピュレータC++ライブラリ用の設定ファイルパス +### Configuration File Paths for RT Manipulator C++ Library `sciurus17_hardware`は、Sciurus17と通信するために [RTマニピュレータC++ライブラリ](https://github.com/rt-net/rt_manipulators_cpp) @@ -130,4 +145,4 @@ USBケーブルや電源ケーブルが抜けた場合等に有効です。 --- -[back to top](#sciurus17_control) +[Back to top](#sciurus17_control) diff --git a/sciurus17_examples/README.md b/sciurus17_examples/README.md index e585da49..7955bbbc 100644 --- a/sciurus17_examples/README.md +++ b/sciurus17_examples/README.md @@ -3,16 +3,11 @@ このパッケージはSciurus17 ROS 2パッケージのサンプルコード集です。 - [sciurus17\_examples](#sciurus17_examples) - - [準備（実機を使う場合）](#準備実機を使う場合) - - [1. Sciurus17本体をPCに接続する](#1-sciurus17本体をpcに接続する) - - [2. USB通信ポートの接続を確認する](#2-usb通信ポートの接続を確認する) - - [3. move\_groupとcontrollerを起動する](#3-move_groupとcontrollerを起動する) - - [準備 (Gazeboを使う場合)](#準備-gazeboを使う場合) - - [1. move\_groupとGazeboを起動する](#1-move_groupとgazeboを起動する) - - [準備（Mock Componentsを使う場合）](#準備mock-componentsを使う場合) - - [1. move\_groupとcontrollerを起動する](#1-move_groupとcontrollerを起動する) - - [サンプルプログラムを実行する](#サンプルプログラムを実行する) - - [Gazeboでサンプルプログラムを実行する場合](#gazeboでサンプルプログラムを実行する場合) + - [Setup](#setup) + - [Using Sciurus17](#using-sciurus17) + - [Using Gazebo](#using-gazebo) + - [Using Mock Components](#using-mock-components) + - [How to Run](#how-to-run) - [Examples](#examples) - [gripper\_control](#gripper_control) - [neck\_control](#neck_control) @@ -23,55 +18,55 @@ - [chest\_camera\_tracking](#chest_camera_tracking) - [point\_cloud\_detection](#point_cloud_detection) -## 準備（実機を使う場合） +## Setup + +### Using Sciurus17 + +#### 1. Sciurus17本体をPCに接続する -### 1. Sciurus17本体をPCに接続する Sciurus17本体をPCに接続します。 接続方法は製品マニュアルを参照してください。 -**※Sciurus17本体が接触しないように、十分なスペースを確保してください。** +> [!NOTE] +> Sciurus17本体が接触しないように、十分なスペースを確保してください。 -### 2. USB通信ポートの接続を確認する +#### 2. USB通信ポートの接続を確認する -USB通信ポートの設定については`sciurus17_control`の -[README](../sciurus17_control/README.md) -を参照してください。 +USB通信ポートの設定については`sciurus17_control`の[README](../sciurus17_control/README.md)を参照してください。 -**正しく設定できていない場合、Sciurus17が動作しないので注意してください** +> [!NOTE] +> 正しく設定できていない場合、Sciurus17が動作しないので注意してください。 -### 3. move_groupとcontrollerを起動する +#### 3. move_groupとcontrollerを起動する -次のコマンドでmove_group (`sciurus17_moveit_config`)と -controller (`sciurus17_control`)を起動します。 +次のコマンドでmove_group (`sciurus17_moveit_config`)とcontroller (`sciurus17_control`)を起動します。 ```sh ros2 launch sciurus17_examples demo.launch.py ``` -## 準備 (Gazeboを使う場合) +### Using Gazebo -### 1. move_groupとGazeboを起動する +#### 1. move_groupとGazeboを起動する -次のコマンドでmove_group (`sciurus17_moveit_config`)と -Gazeboを起動します。 +次のコマンドでmove_group (`sciurus17_moveit_config`)とGazeboを起動します。 ```sh ros2 launch sciurus17_gazebo sciurus17_with_table.launch.py ``` -頭部カメラや胸部カメラのシミュレーションを行わない場合は、 -`use_head_camera`、`use_chest_camera`オプションを`false`に設定します。 +> [!NOTE] +> 頭部カメラや胸部カメラのシミュレーションを行わない場合は、`use_head_camera`、`use_chest_camera`オプションを`false`に設定します。 +> +> ```sh +> ros2 launch sciurus17_gazebo sciurus17_with_table.launch.py use_head_camera:=false use_chest_camera:=false +> ``` -```sh -ros2 launch sciurus17_gazebo sciurus17_with_table.launch.py use_head_camera:=false use_chest_camera:=false -``` +### Using Mock Components -## 準備（Mock Componentsを使う場合） +#### 1. move_groupとcontrollerを起動する -### 1. move_groupとcontrollerを起動する - -次のコマンドでmove_group (`sciurus17_moveit_config`)と -controller (`sciurus17_control`)を起動します。 +次のコマンドでmove_group (`sciurus17_moveit_config`)とcontroller (`sciurus17_control`)を起動します。 ```sh ros2 launch sciurus17_examples demo.launch.py use_mock_components:=true @@ -79,7 +74,7 @@ ros2 launch sciurus17_examples demo.launch.py use_mock_components:=true Mock Componentsではカメラを使ったサンプルを実行することはできません。 -## サンプルプログラムを実行する +## How to Run 準備ができたらサンプルプログラムを実行します。 例えばグリッパを開閉するサンプルは次のコマンドで実行できます。 @@ -90,13 +85,13 @@ ros2 launch sciurus17_examples example.launch.py example:='gripper_control' 終了するときは`Ctrl+c`を入力します。 -### Gazeboでサンプルプログラムを実行する場合 - -Gazeboでサンプルプログラムを実行する場合は`use_sim_time`オプションを付けます。 -```sh -ros2 launch sciurus17_examples example.launch.py example:='gripper_control' use_sim_time:='true' -``` +> [!NOTE] +> Gazeboでサンプルプログラムを実行する場合は`use_sim_time`オプションを付けます。 +> +> ```sh +> ros2 launch sciurus17_examples example.launch.py example:='gripper_control' use_sim_time:='true' +> ``` ## Examples @@ -127,7 +122,7 @@ ros2 launch sciurus17_examples example.launch.py -s ros2 launch sciurus17_examples example.launch.py example:='gripper_control' ``` -[back to example list](#examples) +[Back to example list](#examples) --- @@ -141,7 +136,7 @@ ros2 launch sciurus17_examples example.launch.py example:='gripper_control' ros2 launch sciurus17_examples example.launch.py example:='neck_control' ``` -[back to example list](#examples) +[Back to example list](#examples) --- @@ -155,7 +150,7 @@ ros2 launch sciurus17_examples example.launch.py example:='neck_control' ros2 launch sciurus17_examples example.launch.py example:='waist_control' ``` -[back to example list](#examples) +[Back to example list](#examples) --- @@ -169,7 +164,7 @@ ros2 launch sciurus17_examples example.launch.py example:='waist_control' ros2 launch sciurus17_examples example.launch.py example:='pick_and_place_right_arm_waist' ``` -[back to example list](#examples) +[Back to example list](#examples) --- @@ -183,7 +178,7 @@ ros2 launch sciurus17_examples example.launch.py example:='pick_and_place_right_ ros2 launch sciurus17_examples example.launch.py example:='pick_and_place_left_arm' ``` -[back to example list](#examples) +[Back to example list](#examples) --- @@ -191,16 +186,17 @@ ros2 launch sciurus17_examples example.launch.py example:='pick_and_place_left_a 頭部カメラ映像を用いてオレンジ色の物体を追従するコード例です。 -Gazeboで実行する場合は動作環境によってうまく追従しない場合があります。 -カメラ解像度やサンプルコード内の追従速度ゲインを調整してください。 - 次のコマンドを実行します。 ```sh ros2 launch sciurus17_examples head_camera_tracking.launch.py ``` -[back to example list](#examples) +> [!NOTE] +> Gazeboで実行する場合は動作環境によってうまく追従しない場合があります。 +> カメラ解像度やサンプルコード内の追従速度ゲインを調整してください。 + +[Back to example list](#examples) --- @@ -208,16 +204,17 @@ ros2 launch sciurus17_examples head_camera_tracking.launch.py 胸部カメラ映像を用いてオレンジ色の物体を追従するコード例です。 -Gazeboで実行する場合は動作環境によってうまく追従しない場合があります。 -カメラ解像度やサンプルコード内の追従速度ゲインを調整してください。 - 次のコマンドを実行します。 ```sh ros2 launch sciurus17_examples chest_camera_tracking.launch.py ``` -[back to example list](#examples) +> [!NOTE] +> Gazeboで実行する場合は動作環境によってうまく追従しない場合があります。 +> カメラ解像度やサンプルコード内の追従速度ゲインを調整してください。 + +[Back to example list](#examples) --- @@ -225,16 +222,17 @@ ros2 launch sciurus17_examples chest_camera_tracking.launch.py 点群から物体を検出して掴むコード例です。 -検出された物体位置はtfのフレームとして配信されます。 -tfの`frame_id`は検出された順に`target_0`、`target_1`、`target_2`…に設定されます。 -掴む対象はSciurus17前方の0.3 mの範囲にある`target_0`に設定されています。 -物体検出には[Point Cloud Library](https://pointclouds.org/)を使用しています。 +- 検出された物体位置はtfのフレームとして配信されます。 +- tfの`frame_id`は検出された順に`target_0`、`target_1`、`target_2`…に設定されます。 +- 掴む対象はSciurus17前方の0.3 mの範囲にある`target_0`に設定されています。 +- 物体検出には[Point Cloud Library](https://pointclouds.org/)を使用しています。 + +次のコマンドを実行します。 -次のコマンドを実行します ```sh ros2 launch sciurus17_examples camera_example.launch.py example:='point_cloud_detection' ``` -[back to example list](#examples) +[Back to example list](#examples) --- diff --git a/sciurus17_examples_py/README.md b/sciurus17_examples_py/README.md index 78f2f77c..aa0a3d54 100644 --- a/sciurus17_examples_py/README.md +++ b/sciurus17_examples_py/README.md @@ -2,10 +2,12 @@ このパッケージはSciurus17 ROS 2パッケージのPythonサンプルコード集です。 +## Table of Contents + - [sciurus17\_examples](#sciurus17_examples) - - [起動方法](#起動方法) - - [サンプルプログラムを実行する](#サンプルプログラムを実行する) - - [Gazeboでサンプルプログラムを実行する場合](#gazeboでサンプルプログラムを実行する場合) + - [Table of Contents](#table-of-contents) + - [Setup](#setup) + - [How to Run](#how-to-run) - [Examples](#examples) - [gripper\_control](#gripper_control) - [neck\_control](#neck_control) @@ -13,10 +15,11 @@ - [pick\_and\_place\_right\_arm\_waist](#pick_and_place_right_arm_waist) - [pick\_and\_place\_left\_arm](#pick_and_place_left_arm) -## 起動方法 +## Setup + Sciurus17の起動方法は[sciurus17_examplesのREADME](../sciurus17_examples/README.md)を参照してください。 -## サンプルプログラムを実行する +## How to Run 準備ができたらサンプルプログラムを実行します。 例えばグリッパを開閉するサンプルは次のコマンドで実行できます。 @@ -27,13 +30,12 @@ ros2 launch sciurus17_examples_py example.launch.py example:='gripper_control' 終了するときは`Ctrl+c`を入力します。 -### Gazeboでサンプルプログラムを実行する場合 - -Gazeboでサンプルプログラムを実行する場合は`use_sim_time`オプションを付けます。 - -```sh -ros2 launch sciurus17_examples_py example.launch.py example:='gripper_control' use_sim_time:='true' -``` +> [!NOTE] +> Gazeboでサンプルプログラムを実行する場合は`use_sim_time`オプションを付けます。 +> +> ```sh +> ros2 launch sciurus17_examples_py example.launch.py example:='gripper_control' use_sim_time:='true' +> ``` ## Examples @@ -45,11 +47,12 @@ ros2 launch sciurus17_examples_py example.launch.py example:='gripper_control' u - [pick\_and\_place\_right\_arm\_waist](#pick_and_place_right_arm_waist) - [pick\_and\_place\_left\_arm](#pick_and_place_left_arm) -実行できるサンプルの一覧は、`example.launch.py`にオプション`-s`を付けて実行することで表示できます。 - -```sh -ros2 launch sciurus17_examples_py example.launch.py -s -``` +>[!NOTE] +> 実行できるサンプルの一覧は、`example.launch.py`にオプション`-s`を付けて実行することで表示できます。 +> +> ```sh +> ros2 launch sciurus17_examples_py example.launch.py -s +> ``` ### gripper_control @@ -61,7 +64,7 @@ ros2 launch sciurus17_examples_py example.launch.py -s ros2 launch sciurus17_examples_py example.launch.py example:='gripper_control' ``` -[back to example list](#examples) +[Back to example list](#examples) --- @@ -75,7 +78,7 @@ ros2 launch sciurus17_examples_py example.launch.py example:='gripper_control' ros2 launch sciurus17_examples_py example.launch.py example:='neck_control' ``` -[back to example list](#examples) +[Back to example list](#examples) --- @@ -89,7 +92,7 @@ ros2 launch sciurus17_examples_py example.launch.py example:='neck_control' ros2 launch sciurus17_examples_py example.launch.py example:='waist_control' ``` -[back to example list](#examples) +[Back to example list](#examples) --- @@ -103,7 +106,7 @@ ros2 launch sciurus17_examples_py example.launch.py example:='waist_control' ros2 launch sciurus17_examples_py example.launch.py example:='pick_and_place_right_arm_waist' ``` -[back to example list](#examples) +[Back to example list](#examples) --- @@ -117,6 +120,6 @@ ros2 launch sciurus17_examples_py example.launch.py example:='pick_and_place_rig ros2 launch sciurus17_examples_py example.launch.py example:='pick_and_place_left_arm' ``` -[back to example list](#examples) +[Back to example list](#examples) ---