Skip to content

Commit

Permalink
[Raspberry Pi Mouse]ROS 2 Jazzyのチュートリアルを追加 (#40)
Browse files Browse the repository at this point in the history 
Co-authored-by: YusukeKato <[email protected]>
  • Loading branch information
@KuraZuzu @YusukeKato
KuraZuzu and YusukeKato authored Dec 5, 2024
1 parent 58dcda1 commit bfe0bc3
Show file tree
Hide file tree
Showing 8 changed files with 251 additions and 77 deletions.
Binary file added docs/img/raspimouse/driver/pi_imager_settings_ubuntu_24.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/raspimouse/driver/pi_imager_settings_ubuntu_24_64bit.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
85 changes: 57 additions & 28 deletions docs/raspimouse/driver/install.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,17 @@ Raspberry Pi MouseのLEDやモータを駆動するためには、

## OSのインストール {: #os-installation}

Raspberry Pi Mouseのデバイスドライバは"Ubuntu"と"Raspberry Pi OS"（旧称"Raspbian"）に対応しています。
Raspberry Pi Mouseのデバイスドライバは、"Ubuntu"と"Raspberry Pi OS"（旧称"Raspbian"）に対応しています。
ここではUbuntuとRaspberry Pi OSのインストール手順を紹介します。

ここではUbuntu（Ubuntu Server 22.04, Ubuntu Server 20.04）と、Raspberry Pi OSのインストール手順を紹介します。
後ほどRaspberry Pi MouseでROSを扱う場合は、Ubuntuのインストールを推奨します。各種ROSとUbuntuのバージョン対応表は以下の通りです。

| ROS | Ubuntu |
| ---- | ---- |
| ROS Noetic | Ubuntu Server 20.04（64bit版） |
| ROS 2 Humble | Ubuntu Server 22.04（64bit版） |
| ROS 2 Jazzy | Ubuntu Server 24.04（64bit版）|

後ほどRaspberry Pi Mouseで**ROSを扱う場合はUbuntu Server 20.04（64bit版）を、ROS 2を扱う場合はUbuntu Server 22.04（64bit版）のインストールを推奨します**。

!!! info
出荷時に付属しているRaspberry Pi OSインストール済みのmicroSDカードを利用する場合は、OSインストール手順を飛ばしてそのまま[ソースファイルのダウンロードとインストール](#driver-installation)に進むことができます。
Expand All @@ -41,15 +47,29 @@ Raspberry Pi Mouseのデバイスドライバは"Ubuntu"と"Raspberry Pi OS"（
Raspberry PiやRaspberry Pi Mouse本体を**故障させないように**注意してください。
詳細はRaspberry Pi Mouseの**[製品マニュアル](https://rt-net.jp/products/raspberrypimousev3/#downloads)を参照してください**。

=== "Ubuntu Server 24.04"
1. [https://www.raspberrypi.org/software/](https://www.raspberrypi.org/software/){target=_blank rel=noopener} にアクセスします
1. Raspberry Pi Imagerをダウンロードします
![](../../img/raspimouse/driver/download_raspberry_pi_imager.png)
1. SDカードをPCに接続します
1. Raspberry Pi Imagerを起動します
1. 書き込むOSを"Other general-purpose OS" -> "Ubuntu" -> "Ubuntu Server 24.04.* LTS"、書き込み先をSDカードに設定します __ROS 2を使う場合は64bit版__ を選択します
![](../../img/raspimouse/driver/pi_imager_settings_ubuntu_24_64bit.png)
1. "WRITE" を押して書き込みを開始します
![](../../img/raspimouse/driver/pi_imager_settings_ubuntu_24.png)
1. SDカードをRaspberry Piに取り付け、Raspberry Piの電源を入れます
1. login:`ubuntu`、password:`ubuntu`でログインし、パスワードを変更します
1. `$ sudo apt update && sudo apt upgrade`を実行します

=== "Ubuntu Server 22.04"
1. [https://www.raspberrypi.org/software/](https://www.raspberrypi.org/software/){target=_blank rel=noopener} にアクセスします
1. Raspberry Pi Imagerをダウンロードします
![](../../img/raspimouse/driver/download_raspberry_pi_imager.png)
1. SDカードをPCに接続します
1. Raspberry Pi Imagerを起動します
1. 書き込むOSを"Other general-purpose OS" -> "Ubuntu" -> "Ubuntu Server 22.04.* LTS"、書き込み先をSDカードに設定します __ROS 2を使う場合は64bit版__ を選択します
1. 書き込むOSを"Other general-purpose OS" -> "Ubuntu" -> "Ubuntu Server 22.04.* LTS"、書き込み先をSDカードに設定します __ROS 2を使う場合は64bit版__ を選択します
![](../../img/raspimouse/driver/pi_imager_settings_ubuntu_22_64bit.png)
1. "書き込む" を押して書き込みを開始します
1. "WRITE" を押して書き込みを開始します
![](../../img/raspimouse/driver/pi_imager_settings_ubuntu_22.png)
1. SDカードをRaspberry Piに取り付け、Raspberry Piの電源を入れます
1. login:`ubuntu`、password:`ubuntu`でログインし、パスワードを変更します
Expand All @@ -61,9 +81,9 @@ Raspberry Pi Mouseのデバイスドライバは"Ubuntu"と"Raspberry Pi OS"（
![](../../img/raspimouse/driver/download_raspberry_pi_imager.png)
1. SDカードをPCに接続します
1. Raspberry Pi Imagerを起動します
1. 書き込むOSを"Other general-purpose OS" -> "Ubuntu" -> "Ubuntu Server 20.04.* LTS"、書き込み先をSDカードに設定します __ROSを使う場合は64bit版__ を選択します
1. 書き込むOSを"Other general-purpose OS" -> "Ubuntu" -> "Ubuntu Server 20.04.* LTS"、書き込み先をSDカードに設定します __ROSを使う場合は64bit版__ を選択します
![](../../img/raspimouse/driver/pi_imager_settings_ubuntu_64bit.png)
1. "WRITE" を押して書き込みを開始します
1. "WRITE" を押して書き込みを開始します
![](../../img/raspimouse/driver/pi_imager_settings_ubuntu.png)
1. SDカードをRaspberry Piに取り付け、Raspberry Piの電源を入れます
1. login:`ubuntu`、password:`ubuntu`でログインし、パスワードを変更します
Expand All @@ -76,7 +96,7 @@ Raspberry Pi Mouseのデバイスドライバは"Ubuntu"と"Raspberry Pi OS"（
![](../../img/raspimouse/driver/download_raspberry_pi_imager.png)
1. SDカードをPCに接続します
1. Raspberry Pi Imagerを起動します
1. 書き込むOSを"Raspberry Pi OS (32-bit)"、書き込み先をSDカードに設定し、"WRITE"を押して書き込みを開始します
1. 書き込むOSを"Raspberry Pi OS (32-bit)"、または"Raspberry Pi OS (64-bit)"、書き込み先をSDカードに設定し、"WRITE"を押して書き込みを開始します
![](../../img/raspimouse/driver/pi_imager_settings.png)
1. SDカードをRaspberry Piに取り付け、Raspberry Piの電源を入れます
![](../../img/raspimouse/driver/raspi_os_settings.png)
Expand All @@ -89,7 +109,7 @@ Raspberry Pi Mouseのデバイスドライバは"Ubuntu"と"Raspberry Pi OS"（
HDMIケーブルとHDMI入力付きのモニタ、USBキーボードとマウスをRaspberry Piに接続して設定する方法を紹介します。

[https://ubuntu.com/server/docs/network-configuration](https://ubuntu.com/server/docs/network-configuration)
に詳細な説明が書かれています。
に詳細な説明が書かれています。
IPアドレスの固定については[Ubuntu ServerでWi-Fiに接続し、IPアドレスを固定する](#wifi-static-ip)を参照してください。

1. `$ sudo vim /etc/netplan/99_config.yaml`で設定ファイルを新規作成し、下記のように記述します。
Expand Down Expand Up @@ -123,39 +143,48 @@ Raspberry Pi Mouseのデバイスドライバのソースファイルは
に公開されています。

=== "Ubuntu Server"
1. パルスカウンタの動作を安定させるためI2Cのボーレートを変更します
1. `/boot/firmware/config.txt`を編集し、`dtparam=i2c_baudrate=62500`を追記します
1. Raspberry Pi を再起動します
1. `$ printf "%d\n" 0x$(xxd -ps /sys/class/i2c-adapter/i2c-1/of_node/clock-frequency)`を実行し、`62500`と表示されたら設定完了です。
1. 次のコマンドを実行し、デバイスドライバをインストールします
1. 次のコマンドを実行し、デバイスドライバをダウンロードします
```sh
$ git clone https://github.com/rt-net/RaspberryPiMouse.git
```
2. 次のコマンドを実行し、Raspberry Pi Mouseを動かすための設定を行います
```sh
$ cd RaspberryPiMouse/utils
$ ./set_configs.bash
```
3. 次のコマンドを実行し、Raspberry Piを再起動します
```sh
$ sudo reboot
```
4. 次のコマンドを実行し、デバイスドライバをインストールします
```sh
$ cd RaspberryPiMouse/utils
$ sudo apt install linux-headers-$(uname -r) build-essential
$ ./build_install.bash
```
1. コマンド実行後にブザーが鳴ればインストール完了です。
5. コマンド実行後にブザーが鳴ればインストール完了です


=== "Raspberry Pi OS"
1. パルスカウンタの動作を安定させるためI2Cのボーレートを変更します
1. `/boot/config.txt`を編集し、`dtparam=i2c_baudrate=62500`を追記します
1. Raspberry Pi を再起動します
1. `$ printf "%d\n" 0x$(xxd -ps /sys/class/i2c-adapter/i2c-1/of_node/clock-frequency)`を実行し、`62500`と表示されたら設定完了です。
1. `Raspberry Piの設定`を開きます
![](../../img/raspimouse/driver/raspi_os_settings2.png)
1. `インターフェイス`に進み、`SPI`と`I2C`の機能を有効にします
![](../../img/raspimouse/driver/raspi_os_settings3.png)
1. ターミナル(`LXTerminal`)を起動します
![](../../img/raspimouse/driver/open_terminal.png)
1. 次のコマンドを実行し、デバイスドライバをインストールします
2. 次のコマンドを実行し、デバイスドライバをダウンロードします
```sh
$ git clone https://github.com/rt-net/RaspberryPiMouse.git
```
3. 次のコマンドを実行し、Raspberry Pi Mouseを動かすための設定を行います
```sh
$ cd RaspberryPiMouse/utils
$ sudo apt install raspberrypi-kernel-headers build-essential
$ ./set_configs.bash
```
4. Raspberry Piを再起動します
5. 次のコマンドを実行し、デバイスドライバをインストールします
```sh
$ cd RaspberryPiMouse/utils
$ sudo apt install linux-headers-$(uname -r) build-essential
$ ./build_install.bash
```
1. コマンド実行後にブザーが鳴ればインストール完了です。
6. コマンド実行後にブザーが鳴ればインストール完了です

**デバイスドライバはOSを起動するたびにインストールしてください。** 上記インストール手順で設定した場合は以下のコマンドでインストールできます。

Expand All @@ -169,12 +198,12 @@ $ ~/RaspberryPiMouse/utils/build_install.bash
### Ubuntu ServerでWi-Fiに接続し、IPアドレスを固定する {: #wifi-static-ip}

[https://ubuntu.com/server/docs/network-configuration](https://ubuntu.com/server/docs/network-configuration)
に詳細な説明が書かれています。
に詳細な説明が書かれています。

!!! info
IPアドレスを固定するとネットワークに影響が出る場合があります。会社等で利用する場合はネットワーク管理者にお問い合わせください。

1. `$ sudo vim /etc/netplan/99_config.yaml`で設定ファイルを新規作成し、下記のように`dhcp4: false`としてIPアドレスを記述します。
1. `$ sudo vim /etc/netplan/99_config.yaml`で設定ファイルを新規作成し、下記のように`dhcp4: false`としてIPアドレスを記述します。
この例では、IPアドレスを`192.168.11.89`に固定します。__この設定値は環境によって変わりますのでご注意ください__。
```yaml
network:
Expand Down
46 changes: 23 additions & 23 deletions docs/raspimouse/ros/install.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,28 +19,27 @@ robot: Raspberry Pi Mouse
* 組み立て済みRaspberry Pi Mouse本体
* [製品マニュアル](https://rt-net.jp/products/raspberrypimousev3/#downloads)を読んで組み立て済みの状態を前提としています
* OS（**Ubuntu Server**）がインストール済みであることを前提としています
* `ROS 2 Jazzy`を使用する場合: **Ubuntu Server 24.04**
* `ROS 2 Humble`を使用する場合: **Ubuntu Server 22.04**
* `ROS Noetic`を使用する場合: **Ubuntu Server 20.04**
* Raspberry Pi OSでのROSの動作は確認していません
* Raspberry Pi Mouse用電源
* バッテリでも電源変換ケーブルつきACアダプタでも可
* ノートパソコン等のPC
* OS（**Ubuntu Desktop**）がインストール済みであることを前提としています
* `ROS 2 Jazzy`を使用する場合: **Ubuntu Desktop 24.04**
* `ROS 2 Humble`を使用する場合: **Ubuntu Desktop 22.04**
* `ROS Noetic`を使用する場合: **Ubuntu Desktop 20.04**

!!! info
`ROS 2 Foxy`は2023年6月にEOL（サポート終了）を迎えたため、`ROS 2 Humble`の使用を推奨しています。

## ROS / ROS 2のインストール（公式のドキュメントに沿って進める場合） {: #official-document}

=== "ROS"
[https://wiki.ros.org/noetic/Installation/Ubuntu](https://wiki.ros.org/noetic/Installation/Ubuntu){target=_blank rel=noopener}
を参考に、`ROS Noetic`をインストールします。

GUIを使用する場合は`Desktop-Full`を、 使用しない場合は`ROS-Base`パッケージをインストールします。

=== "ROS 2 Humble（推奨）"
=== "ROS 2 Humble"
[https://docs.ros.org/en/humble/Installation/Ubuntu-Install-Debians.html](https://docs.ros.org/en/humble/Installation/Ubuntu-Install-Debians.html){target=_blank rel=noopener}
を参考に、`ROS 2 Humble`をインストールします。

Expand All @@ -49,13 +48,13 @@ robot: Raspberry Pi Mouse
[https://docs.ros.org/en/humble/Tutorials/Colcon-Tutorial.html](https://docs.ros.org/en/humble/Tutorials/Colcon-Tutorial.html){target=_blank rel=noopener}
を参考に、パッケージビルドツールの`colcon`をインストールします。

=== "ROS 2 Foxy（非推奨）"
[https://docs.ros.org/en/foxy/Installation/Ubuntu-Install-Debians.html](https://docs.ros.org/en/foxy/Installation/Ubuntu-Install-Debians.html){target=_blank rel=noopener}
を参考に、`ROS 2 Foxy`をインストールします。
=== "ROS 2 Jazzy"
[https://docs.ros.org/en/jazzy/Installation/Ubuntu-Install-Debs.html](https://docs.ros.org/en/jazzy/Installation/Ubuntu-Install-Debs.html){target=_blank rel=noopener}
を参考に、`ROS 2 Jazzy`をインストールします。

GUIを使用する場合は`Desktop`を、 使用しない場合は`ROS-Base`パッケージをインストールします。

[https://docs.ros.org/en/foxy/Tutorials/Colcon-Tutorial.html](https://docs.ros.org/en/foxy/Tutorials/Colcon-Tutorial.html){target=_blank rel=noopener}
[https://docs.ros.org/en/humble/Tutorials/Colcon-Tutorial.html](https://docs.ros.org/en/humble/Tutorials/Colcon-Tutorial.html){target=_blank rel=noopener}
を参考に、パッケージビルドツールの`colcon`をインストールします。

## ROS / ROS 2のインストール（インストールスクリプトを使う場合） {: #install-script}
Expand Down Expand Up @@ -95,7 +94,8 @@ robot: Raspberry Pi Mouse
```sh
$ source ~/.bashrc
```
=== "ROS 2 Humble（推奨）"

=== "ROS 2 Humble"
このROS 2インストールスクリプトは`curl`と`git`を使用します。以下のコマンドでインストールします。

```sh
Expand All @@ -114,8 +114,8 @@ robot: Raspberry Pi Mouse
スクリプトが問題なく実行できれば以下のメッセージが表示されます。

```txt
Success installing ROS humble
Run 'source ~/.bashrc'
success installing ROS2 humble
Run 'source /opt/ros/humble/setup.bash'
```

以下のコマンドでインストールした設定を読み込みます。
Expand All @@ -124,7 +124,7 @@ robot: Raspberry Pi Mouse
$ source ~/.bashrc
```

=== "ROS 2 Foxy（非推奨）"
=== "ROS 2 Jazzy"
このROS 2インストールスクリプトは`curl`と`git`を使用します。以下のコマンドでインストールします。

```sh
Expand All @@ -137,14 +137,14 @@ robot: Raspberry Pi Mouse
```sh
$ git clone https://github.com/Tiryoh/ros2_setup_scripts_ubuntu.git
$ cd ros2_setup_scripts_ubuntu
$ ./ros2-foxy-desktop-main.sh
$ ./ros2-jazzy-desktop-main.sh
```

スクリプトが問題なく実行できれば以下のメッセージが表示されます。

```txt
Success installing ROS foxy
Run 'source ~/.bashrc'
success installing ROS2 jazzy
Run 'source /opt/ros/jazzy/setup.bash'
```

以下のコマンドでインストールした設定を読み込みます。
Expand Down Expand Up @@ -189,7 +189,7 @@ robot: Raspberry Pi Mouse
$ source ~/.bashrc
```

=== "ROS 2 Humble（推奨）"
=== "ROS 2 Humble"
このROS 2インストールスクリプトは`curl`と`git`を使用します。以下のコマンドでインストールします。

```sh
Expand All @@ -208,8 +208,8 @@ robot: Raspberry Pi Mouse
スクリプトが問題なく実行できれば以下のメッセージが表示されます。

```txt
Success installing ROS humble
Run 'source ~/.bashrc'
success installing ROS2 humble
Run 'source /opt/ros/humble/setup.bash'
```

以下のコマンドでインストールした設定を読み込みます。
Expand All @@ -218,7 +218,7 @@ robot: Raspberry Pi Mouse
$ source ~/.bashrc
```

=== "ROS 2 Foxy（非推奨）"
=== "ROS 2 Jazzy"
このROS 2インストールスクリプトは`curl`と`git`を使用します。以下のコマンドでインストールします。

```sh
Expand All @@ -231,14 +231,14 @@ robot: Raspberry Pi Mouse
```sh
$ git clone https://github.com/Tiryoh/ros2_setup_scripts_ubuntu.git
$ cd ros2_setup_scripts_ubuntu
$ ./ros2-foxy-ros-base-main.sh
$ ./ros2-jazzy-ros-base-main.sh
```

スクリプトが問題なく実行できれば以下のメッセージが表示されます。

```txt
Success installing ROS foxy
Run 'source ~/.bashrc'
success installing ROS2 jazzy
Run 'source /opt/ros/jazzy/setup.bash'
```

以下のコマンドでインストールした設定を読み込みます。
Expand Down
Loading

0 comments on commit bfe0bc3

Please sign in to comment.