READMEの更新 (#12)

* GitHubのCIを手動から自動に変更

* READMEにCIステータスバッジを追加

* READMEに動画を追加

* linix64をLinux 64bitに修正

* yaml-cpp は0.5.0以上を推奨する

* rt_manipulators_cppをクローンする前にホームディレクトリに移動する

* googletestをGoogleTestに修正

* S17のタイムアウト機能の注意書きを修正

* linuxをLinuxに修正

Author: Shota Aoki

.github/workflows/build_test.yaml

@@ -1,6 +1,14 @@
 name: BuildAndTest
 
-on: workflow_dispatch # 手動トリガー
+on:
+  push:
+    paths-ignore:
+      - '**.md'
+  pull_request:
+    paths-ignore:
+      - '**.md'
+  schedule:
+    - cron: "0 2 * * 0" # Weekly on Sundays at 02:00
 
 jobs:
   lint:

README.md

@@ -1,5 +1,7 @@
 # RTマニピュレータC++ライブラリとサンプル集（rt_manipulators_cpp）
 
+[![BuildAndTest](https://github.com/rt-net/rt_manipulators_cpp/actions/workflows/build_test.yaml/badge.svg)](https://github.com/rt-net/rt_manipulators_cpp/actions/workflows/build_test.yaml)
+
 本リポジトリは、株式会社アールティが販売している
 [アームロボット**CRANE-X7(クラインエックスセブン)**](https://rt-net.jp/products/crane-x7/)
 と
@@ -12,8 +14,8 @@
 
 - CMake (>= 3.1.0)
 - g++ (>= 7.5.0)
-- [DYNAMIXEL SDK](https://github.com/ROBOTIS-GIT/DynamixelSDK) (linux64向けにビルド&インストール)
-- [yaml-cpp](https://github.com/jbeder/yaml-cpp)
+- [DYNAMIXEL SDK](https://github.com/ROBOTIS-GIT/DynamixelSDK) (Linux 64bit向けにビルド&インストール)
+- [yaml-cpp (>= 0.5.0)](https://github.com/jbeder/yaml-cpp)
 - Eigen (>= 3.3.4)
 - Linux OS
     - Ubuntu 18.04
@@ -27,7 +29,7 @@
 ### DYNAMIXEL SDKのインストール
 
 [DYNAMIXEL SDKのe-manual](https://emanual.robotis.com/docs/en/software/dynamixel/dynamixel_sdk/library_setup/cpp_linux/#cpp-linux)
-を参考に、linux 64bit環境用にDYNAMIXEL SDKをビルド＆インストールします。
+を参考に、Linux 64bit環境用にDYNAMIXEL SDKをビルド＆インストールします。
 
 ```sh
 $ sudo apt install build-essential
@@ -51,6 +53,7 @@ $ sudo apt install libyaml-cpp-dev libeigen3-dev
 詳細は[rt_manipulators_lib/README.md](./rt_manipulators_lib/README.md)を参照してください。
 
 ```sh
+$ cd ~
 $ git clone https://github.com/rt-net/rt_manipulators_cpp
 $ cd rt_manipuators_cpp/rt_manipulators_lib
 $ ./build_install_library.bash
@@ -84,6 +87,8 @@ hand
 ...
 ```
 
+[![](https://img.youtube.com/vi/cA_3HU3HfcM/sddefault.jpg)](https://youtu.be/cA_3HU3HfcM)
+
 ## 免責事項
 
 当該製品および当ソフトウェアの使用中に生じたいかなる損害も株式会社アールティでは一切の責任を負いかねます。

rt_manipulators_lib/README.md

@@ -62,7 +62,7 @@ $ ./uninstall_library.bash
 
 ## ライブラリのテスト
 
-### googletestのインストール
+### GoogleTestのインストール
 
 ```sh
 $ mkdir ~/gtest

samples/samples01/README.md

@@ -4,18 +4,25 @@
   - [サンプルのビルド](#サンプルのビルド)
   - [通信設定](#通信設定)
   - [サーボモータのトルクをON/OFFする](#サーボモータのトルクをonoffする)
+    - [動画](#動画)
     - [解説](#解説)
   - [サーボモータの現在角度を読み取る](#サーボモータの現在角度を読み取る)
+    - [動画](#動画-1)
     - [解説](#解説-1)
   - [サーボモータの目標角度を書き込む](#サーボモータの目標角度を書き込む)
+    - [動画](#動画-2)
     - [解説](#解説-2)
   - [スレッドでサーボモータの角度を読み書きする](#スレッドでサーボモータの角度を読み書きする)
+    - [動画](#動画-3)
     - [解説](#解説-3)
   - [サーボモータの速度、電流、入力電圧、温度を読み取る](#サーボモータの速度電流入力電圧温度を読み取る)
+    - [動画](#動画-4)
     - [解説](#解説-4)
   - [サーボモータの目標速度を書き込む](#サーボモータの目標速度を書き込む)
+    - [動画](#動画-5)
     - [解説](#解説-5)
   - [サーボモータの目標電流を書き込む](#サーボモータの目標電流を書き込む)
+    - [動画](#動画-6)
     - [解説](#解説-6)
 
 ## サンプルのビルド
@@ -41,7 +48,7 @@ Sciurus17を使用する場合は、
 [Sciurus17入門ガイド](https://rt-net.jp/products/sciurus17/)に記載されている手順で
 Sciurus17制御基板の通信タイムアウト機能を解除してください。
 
-サンプル内にスリープ処理によって通信タイムアウト機能が働き、サーボが脱力します。
+解除しない場合はサンプル実行中のスリープ処理によって通信タイムアウト機能が働き、サーボが脱力します。
 
 ## サーボモータのトルクをON/OFFする
 
@@ -80,6 +87,10 @@ hand
 CRANE-X7との接続を解除します.
 ```
 
+### 動画
+
+[![](https://img.youtube.com/vi/cA_3HU3HfcM/sddefault.jpg)](https://youtu.be/cA_3HU3HfcM)
+
 ### 解説
 
 RTマニピュレータC++ライブラリを使用する場合は`rt_manipulators_cpp/hardware.hpp`をincludeします。
@@ -182,6 +193,10 @@ armグループの6番目のサーボ角度は0.961806radです.
 ...
 ```
 
+### 動画
+
+[![](https://img.youtube.com/vi/c0dBK2sj2Dw/sddefault.jpg)](https://youtu.be/c0dBK2sj2Dw)
+
 ### 解説
 
 サーボモータの現在角度を取得するため、
@@ -273,6 +288,10 @@ arm、handグループのサーボ位置制御PIDゲインに(5, 0, 0)を書き
 CRANE-X7との接続を解除します.
 ```
 
+### 動画
+
+[![](https://img.youtube.com/vi/JLKXTyUJo1A/sddefault.jpg)](https://youtu.be/JLKXTyUJo1A)
+
 ### 解説
 
 サーボモータに目標角度を書き込むため、
@@ -409,6 +428,10 @@ armグループの4番目のサーボ角度は-0.684155radです.
 ...
 ```
 
+### 動画
+
+[![](https://img.youtube.com/vi/r7ssEHS-jIk/sddefault.jpg)](https://youtu.be/r7ssEHS-jIk)
+
 ### 解説
 
 サーボモータのデータを読み書きするスレッドを起動するため、`Hardware.start_thread(group_names, update_cycle_ms)`を実行します。
@@ -464,6 +487,10 @@ joint_hand: position[rad], velocity[rad/s], current[A], voltage[V], temperature[
 ...
 ```
 
+### 動画
+
+[![](https://img.youtube.com/vi/NbhPIo9yL1A/sddefault.jpg)](https://youtu.be/NbhPIo9yL1A)
+
 ### 解説
 
 サーボモータの現在値を取得するため、
@@ -595,6 +622,10 @@ wristグループにはvelocityのsync_writeが設定されています.
 安全のため, disconnect()関数内で目標速度 0 rad/sを書き込みます.
 ```
 
+### 動画
+
+[![](https://img.youtube.com/vi/JxJ_BFnzJqc/sddefault.jpg)](https://youtu.be/JxJ_BFnzJqc)
+
 ### 解説
 
 サーボモータに目標速度を書き込むため、
@@ -735,6 +766,10 @@ wristグループにはcurrentのsync_writeが設定されています.
 安全のため, disconnect()関数内で目標速度 0 Aを書き込みます.
 ```
 
+### 動画
+
+[![](https://img.youtube.com/vi/Qc3TnaccRmc/sddefault.jpg)](https://youtu.be/Qc3TnaccRmc)
+
 ### 解説
 
 サーボモータに目標電流を書き込むため、

samples/samples02/README.md

@@ -4,8 +4,10 @@
   - [サンプルのビルド](#サンプルのビルド)
   - [ロボットのサーボモータの動かし方について](#ロボットのサーボモータの動かし方について)
   - [順運動学を解いてリンクの位置・姿勢を求める](#順運動学を解いてリンクの位置姿勢を求める)
+    - [動画](#動画)
     - [解説](#解説)
   - [逆運動学を解いて手先を任意の位置・姿勢に移動させる](#逆運動学を解いて手先を任意の位置姿勢に移動させる)
+    - [動画](#動画-1)
     - [解説](#解説-1)
 
 ## サンプルのビルド
@@ -67,6 +69,10 @@ CRANE-X7のサーボモータ角度を読み取り、順運動学を解くサン
 ...
 ```
 
+### 動画
+
+[![](https://img.youtube.com/vi/c76qW3ekAv4/sddefault.jpg)](https://youtu.be/c76qW3ekAv4)
+
 ### 解説
 
 RTマニピュレータc++ライブラリの運動学機能を使用する場合は`rt_manipulators_cpp/kinematics.hpp`、
@@ -221,6 +227,10 @@ $ ./s17_inverse_kinematics
 ...
 ```
 
+### 動画
+
+[![](https://img.youtube.com/vi/jxaVbs9GzFY/sddefault.jpg)](https://youtu.be/jxaVbs9GzFY)
+
 ### 解説
 
 逆運動学を解く前に、リンク構成の各リンク関節位置の下限値`q_min`(radian)と上限値`q_max`(radian)を入力します。