acsl_infra

Autonomous control system library for ROS2

高機能機械制御研究室の共通ROS2プログラム
新しい計算機に導入する場合はsetupを参照。
setup後、新しいプロジェクトを作成する場合は開発の仕方を参照
既存のプロジェクトに参加する場合はプロジェクトに参加を参照。

Autonomous control system library for ROS2

用語

表記	意味
LOCAL	Hostにリモートアクセスする計算機（WindowsPCなど）
HOST	このプロジェクトを動かしている計算機（ラズパイなど）
DOCKER	@HOST上のDOCKERインスタンス
FC	フライトコントローラ
(ROS)パッケージ	一連の機能をまとめたもの.(acs, acsl_interfaceなど)
	package.xmlファイルが直下に入っているディレクトリ

リポジトリ内フォルダ構成

.
|- .github                : git関係（触ることはない）
|- commands/              : scripts for HOST setup
|- launcher/              : (ROS) launch files for container
|- packages/              : ROS packages
|- dockerfiles/           : dockerfile to build image
|- docker/                : commands and setting for DOCKER container
ダ
|- hardware_setup       : documents for hardware setup
|- rules                : udev rules
|- .gitignore           : git管理から除外するファイルの設定
|- README.md            ：このファイル
|- TODO.md              ：TODOタスク

システム構成

graph TD;
    L(Local VSCode)-->H(Host Jetson or Raspberry Pi);
    H(Host Jetson or Raspberry Pi)-->D(Docker Ubuntu);

setup

各ハードウェアの基本セットアップを以下からおこなう。（imageの設定、dockerの設定まで）

ARM (Raspberry Pi)
x86（Ubuntu/WLS2）
JetPackにはデフォルトで入っているのでuserをdockerグループに追加する。

sudo usermod -aG docker $USER
su - $USER

Git clone

このリポジトリをクローンする

cd ~/
git clone https://github.com/acsl-tcu/ros2.git
cd ~/ros2

プロジェクトに参加

既にあるプロジェクトに参加する場合

docker image取得

プロジェクトに使うimageを取得する。

PROJECT="$PROJECT"
IMAGE=image_$PROJECT 
# IMAGE : image_drone, t265, gnss, microros, etc
docker pull kasekiguchi/acsl-common:$IMAGE

git branch 切り替え

必要に応じてbranchを切り替える

cd ~/ros2
git switch "$BRANCH"

systemd 登録

PROJECT="$PROJECT"
# "$PROJECT" : drone, bos, bos_robot, whill, leg-wheel, rover, turtlebot
cd ~/ros2/commands
bash setup.sh $PROJECT
source ~/.bashrc
(sudo reboot )
dps # 初回でdocker imageを取得できていない場合は表示されるようになるまで時間がかかる
dlogs "$CONTAINER"
# "$CONTAINER"は　dps で確認

dpsでコンテナが起動していることを確認したらRPを再起動する．

dps
sudo reboot

再起動後アクセスしコンテナが正常に起動していることを確認する．

dps

研究スタート

上記設定が終わったら、いよいよ研究スタート！適宜、開発の仕方を参照しながら開発を進めましょう。

Debug用コマンド

docker/common/scripts 内の便利コマンド

# = git pull + commitしていない編集の削除 + 権限関係の整理
gpull
# = docker ps -a
dps
# = docker stop <container_name>
dstop <container_name>
dstop all # すべてのコンテナ停止

# = docker compose up common -d + hostnameの設定
dup <container_name>
dup all # commands/project_launch.sh を実行
# = docker compose exec common bash
din <container_name>
# コンテナ内で表示される中身についての表示（末尾１０行を継続表示）
dlogs <container_name>

# コンテナ削除
drm <container_name>
drm all # 全コンテナ削除
# = docker images -a
dimages 
# image 削除
drmi <image_name>

commands/setup.sh を実行時にうまくいかないとき　systemd 関係のlog を確認するのに使えるコマンド

> journalctl -xeu project_launch.service

開発の仕方

このリポジトリを使ったシステム開発の手順用語 “$pack” 追加するパッケージ名(repository名)　
“$pack_tag” パッケージのブランチ名
“$PROJECT” パッケージを使うプロジェクト名
“$EXT” docker imageの拡張名

プロジェクトの追加

プロジェクトは一つの計算機上で実行するコンテナ群を管理するもの

vim commands/project_launch_“$PROJECT”_sh
内容はPROJECT名、ROS_DOMAIN_ID。

# sample project_launch_whill_sh
export PROJECT=whill
export ROS_DOMAIN_ID=11

bash setup.sh “$PROEJCT”
systemdへproject_launch_“$PROJECT”_shを登録。ROS_DOMAIN_ID, 関連コマンド群のパスを.bashrcに登録
source ~/.bashrc
vim dockerfiles/dockerfile.”$EXT” (optional)
必要に応じてイメージを拡張するファイルを追加
dsbuild
image_“$PROJECT” タグのdocker image作成
4を行った場合は多段処理でimageを作るのでdsbuild のヘルプを参照
dupin dev
ROS2パッケージ開発用コンテナを立ち上げ、コンテナ内のターミナルにattach
/root/project_ws/src/ros_packages/> ros2 pkg create “$PACKAGE” …
自作パッケージの開発＋デバック
```
dev> cd /root/project_ws/src/ros_packages/
dev> ros2 pkg create "$PACKAGE" --node-name <node_name> --build-type ament_python --dependencies rclpy std_msgs sensor_msgs --maintainer-email ksekiguc@tcu.ac.jp --maintainer-name Kazuma SEKIGUCHI
#maintainerなどは適宜修正する。
dev> rbuild "$PACKAGE" # 自作パッケージのbuild 
# 詳細なデバックをする場合はVSCodeでアタッチしてデバックする。
```
container内の /root/project_ws/src/ros_packages/にパッケージ追加
/root/project_ws/src/ros_packages/ は　packages と同期されている。
動作するようになったら以下のファイルを追加する。
- launcher/launch_“$CONTAINER”.sh
- “$PROJECT”.rules (optional) 1で作成した project_launch_“$PROJECT”_sh にコンテナ起動用コマンドを追加し、2,3 を実行する。
build_project “$PACKAGES”
“$PACKAGES”を指定しない場合はpackages内のすべてをcolcon buildする 7で作成した自作パッケージをimage_“$PROJECT”としてbuildした状態のimageに更新
docker hubに登録(optional) dpush image_“$PROJECT”
dup “$CONTAINER” コンテナ立ち上げ。目的の機能が達成されているか確認
sudo restart 計算機にアクセスせず機能が達成しているかを確認

機能拡張（サードパーティから持ってくる場合）

上記7,8の代わりに以下を実施

コンテナ内で機能するか確認

dupin dev
dev> cd /root/project_ws/src/
dev> git clone --depth 1 "$pack" -b "$pack_tag"
# depthや ブランチ指定は必要に応じて
dev> rbuild "$pack"
# 追加したパッケージのビルド

イメージ作成 devコンテナで機能することが確認できたらdockerfileに追加し、イメージを作り直す

# dockerfileに追加　エディタは何でも良い
vim ~/ros2/dockerfiles/dockerfile."$project"
# image_"$project" イメージを作成
docker compose build "$project" (--no-cache)

実行時Tips

LOCALにROS2を入れ、ros2をcloneしておく。

aptで python3-pandas をインストールしておく。

# pklファイルダウンロード
~/ros2/commands/scripts/get_data 73
# sample.pyでfigure.pdf作成
python3 ~/ros2/packages/acs/acs/Plotter/sample.py
# . を指定して実行すると currentフォルダにfigure.pdfができる。
cp figure.pdf ~/Downloads/