Skip to content

Commit 36eb26a

Browse files
committed
add install md
1 parent 71a0fbd commit 36eb26a

File tree

13 files changed

+143
-274
lines changed

13 files changed

+143
-274
lines changed

docs/01_about_micro_ros/.pages

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
nav:
2+
- 概要 : 01_about
3+
- micro-ROS-agentのインストール: 02_install_micro_ros_agent
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
## micro-ROSとは?
2+
3+
ロボットを作成する上でマイコンは欠かせない要素です。micro-ROSを使うことでマイコンをあたかも一つのROS2ノードのように振る舞わせることができます。
4+
5+
<br>
6+
7+
micro-ROSはrclc-client libraryをベースにしてさまざまなミドルウェアを統合したライブラリです。マイコンによるUDP・TCPを使ったDDS通信をサポートするMicroXRCE-DDSや、POSIXベースのRTOSに対応しています。
8+
9+
micro-ROSのURLは[こちら](https://micro.ros.org/)から。
10+
11+
![](https://micro.ros.org/img/micro-ROS_architecture.png)
12+
13+
[micro.ros.org](https://micro.ros.org)より
14+
15+
## micro-ROS-Arduinoとは?
16+
17+
micro-ROS-Arduinoは、Arduino向けに作成されたmicro-ROS向けライブラリです。
18+
Arduinoは2005年にリリースされたIDE(統合開発環境)であり、人気に火をつけたArduino UNOをはじめ、ESP32、STM32などの様々なマイコンの開発プラットフォームとなっています。
19+
20+
## PlatformIOとは?
21+
22+
ここで扱うIDE「PlatformIO」は、先程説明したArduinoにとどまらず様々なIDEを吸収した高機能IDEです。VSCode上で動作し、ライブラリのインポートも自動で行ってくれます。

docs/01_title1/.pages

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/01_title1/01_about/index.md

Lines changed: 0 additions & 45 deletions
This file was deleted.

docs/01_title1/02_main/index.md

Lines changed: 0 additions & 44 deletions
This file was deleted.

docs/01_title1/03_conclusion/index.md

Lines changed: 0 additions & 44 deletions
This file was deleted.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
nav:
2+
- About : 01_about_micro_ros
3+
- インストール: 02_install_micro_ros_agent
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Docker
2+
3+
AMD64 (x86-64)環境ではdockerを使用する方が早いです。
4+
5+
<br>
6+
7+
## 要件
8+
9+
- 管理者権限不要で実行できる Docker server
10+
- x86-64環境
11+
12+
<br>
13+
14+
## インストール
15+
16+
> Dockerは事前にインストールが終わっているものとします。
17+
18+
次のコマンドを実行してudevルールを適用します。
19+
20+
```bash
21+
# udevルールの適用を行い、sudoなしでも読み書き権限を付与する
22+
curl -s https://raw.githubusercontent.com/NITKK-ROS-Team/udev_rules/main/install.bash | sudo bash
23+
```
24+
25+
<br>
26+
27+
## 実行方法
28+
29+
次のコマンドを入力します。(接続先が`/dev/ttyUSB0`かつボーレートが`115200`の場合)
30+
31+
```bash
32+
docker run -it --rm -v /dev:/dev --privileged --net=host microros/micro-ros-agent:galactic serial --dev /dev/ttyUSB0 --baud 115200
33+
```
Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# RaspberryPiへのインストール
2+
3+
ここでは、RaspberryPiにmicro-ROS-agentをインストールする方法を示します。
4+
5+
x86_64(amd64)を対象にしていません。
6+
7+
<br>
8+
9+
## 動作確認リスト
10+
11+
| Distro | チェック | 補足 |
12+
| --- | --- | --- |
13+
| Foxy || Ubuntu20のみ |
14+
| Galactic || Ubuntu20のみ |
15+
| Humble | TODO | Ubuntu22のみ |
16+
| Humble || RaspberryPi OSのみ |
17+
18+
19+
| OS | ターゲット | チェック |
20+
| --- | --- | --- |
21+
| Ubuntu20.04 | RaspberryPi4 ||
22+
| Ubuntu20.04 | RaspberryPi4 | TODO |
23+
| RaspberryPi OS | RaspberryPi4 ||
24+
25+
<br>
26+
27+
## 要件
28+
29+
いずれの環境も `ros-<distro>-ros-base` 以上をインストールする必要があります。その他の依存パッケージは自動で解消できます。
30+
31+
<br>
32+
33+
## インストール
34+
35+
1.【共通】次のコマンドを実行してudevルールを適用します。
36+
37+
```bash
38+
# udevルールの適用を行い、sudoなしでも読み書き権限を付与する
39+
curl -s https://raw.githubusercontent.com/NITKK-ROS-Team/udev_rules/main/install.bash | sudo bash
40+
```
41+
42+
<br>
43+
44+
2.それぞれの環境に応じてdpkgをダウンロードします。
45+
46+
### RaspberryPi OS (ROS-Humble)
47+
48+
```bash
49+
wget https://s3.ap-northeast-1.wasabisys.com/download-raw/dpkg/ros2-desktop/debian/bullseye/ros-humble-micro-ros-agent-0.0.1_arm64.deb -O ./uros.deb
50+
```
51+
52+
### Ubuntu20 (ROS-Foxy)
53+
54+
```bash
55+
wget https://s3.ap-northeast-1.wasabisys.com/download-raw/dpkg/ros2-desktop/ubuntu/focal/ros-foxy-micro-ros-agent-0.0.1_20230203_arm64.deb -O ./uros.deb
56+
```
57+
58+
### Ubuntu20 (ROS-Galactic)
59+
60+
```bash
61+
wget https://s3.ap-northeast-1.wasabisys.com/download-raw/dpkg/ros2-desktop/ubuntu/focal/ros-galactic-micro-ros-agent-0.0.1_20230203_arm64.deb -O ./uros.deb
62+
```
63+
64+
3.インストールします。
65+
66+
```bash
67+
sudo apt install ./uros.deb
68+
rm ./uros.deb
69+
```
70+
71+
<br>
72+
73+
## 実行方法
74+
75+
次のコマンドを入力します。(接続先が`/dev/ttyUSB0`かつボーレートが`115200`の場合)
76+
77+
```bash
78+
source /opt/micro_ros_agent/setup.bash
79+
ros2 run micro_ros_agent micro_ros_agent serial --dev /dev/ttyUSB0 --baud 115200
80+
```
81+
82+
<br>

docs/02_title2/.pages

Lines changed: 0 additions & 4 deletions
This file was deleted.

0 commit comments

Comments
 (0)