Merge pull request #17 from toppers/adjust_scripts

Adjust scripts for the operation of Docker and refine README

Author: takasehideki

README.md

@@ -2,45 +2,27 @@
 
 [TOPPERSプロジェクト箱庭WG](https://toppers.github.io/hakoniwa)では，IoT／クラウドロボティクス時代の仮想シミュレーション環境である『箱庭』の研究開発を進めています．
 
-本リポジトリでは，箱庭上で ROS プログラムを簡単にお試しできる環境を公開しています．
+本リポジトリでは，箱庭上で ROS 2 プログラムのシミュレーションを簡単にお試しできる環境を公開しています．
 
 
 ## 想定する PC 環境
 
-* Windows 環境
-  * Windows 10/11
-    * WSL2/WSLg/Ubuntu 20.04 LTS
-    * Docker Engine
-* Linux 環境
-  * Ubuntu 20.04 LTS
-  * Docker Engine
-* Mac 環境
-  * MacBook Air
-    * macOS Catalina ver.10.15.7
-    * Docker for Mac
+* Windows 環境: Windows 10/11
+  * Ubuntu 20.04 LTS on WSL2/WSLg
+* Linux 環境: Ubuntu 20.04 LTS
+* Mac 環境: macOS Catalina ver.10.15.7
 
+### Docker 環境
 
-## Unity 環境
+本シミュレータは Docker を利用します．
 
-* Unity Hub 3.1.1 以降
-* Unity Editor 2021.3.0f1
-  * Unity Hub の「Installs > Install Editor」画面に本バージョンが表示されない場合は，[Unity Dowonload Archive](https://unity3d.com/get-unity/download/archive) の本バージョンの "Unity Hub" をクリックしてインストールできます． 
+#### Mac 環境の場合
 
-## PC環境の準備
+[Docker Desktop for Mac](https://docs.docker.com/desktop/mac/install/) の利用を推奨します．
 
-### 本リポジトリのclone
+#### Windows/WSL2 または Linux 環境の場合
 
-ターミナルで下記を実行して本リポジトリをcloneしてください．  
-Windows 環境の場合は，WSL 2のファイルシステム配下（`/home/${USER}/` または `\\wsl$`）ではなくWindowsファイルシステム配下（`/mnt/c/` または `C:\`）で実行してください．
-
-```
-$ git clone --recursive https://github.com/toppers/hakoniwa-ros2sim.git
-```
-
-
-### Windows 向け Docker Engineのインストール
-
-本シミュレータは，WSL2にDocker Engineがインストールされている必要があります．WSL2のターミナルで下記のコマンドの結果が同じように出力されていれば，すでにインストール済みです．
+Docker Engineがインストールされている必要があります．WSL2またはLinuxのターミナルで下記のコマンドの結果が同じように出力されていれば，すでにインストール済みです．
 
 ```
 $ which docker
@@ -58,70 +40,78 @@ Docker Engineのインストールはやや手数が多いため，本リポジ
 $ bash utils/install-docker.bash
 ```
 
-## シミュレータの導入手順
+`$ service docker status` の結果が " * Docker is not running " の場合は，Dockerを起動してください．
 
-### Dockerイメージの展開
+```
+$ sudo service docker start
+ * Starting Docker: docker                           [ OK ] 
+```
 
-シミュレータの実行環境は，ビルド済みのDocker imageをDocker Hubにて公開しています．
+また，ユーザが `docker` のグループに所属していることを想定しています．そうでない場合は，次のコマンドを実行してください．
 
-https://hub.docker.com/r/toppersjp/hakoniwa-ros2sim
+```
+$ sudo gpasswd -a $USER docker
+$ sudo service docker restart
+```
 
-現在の最新版は **v1.0.0** です．
-「[バージョン情報・更新履歴](/appendix/version.md)」も参照してください（バージョン番号は[Git/GitHubのtag/release](https://github.com/toppers/hakoniwa-ros2sim/releases)および[Docker Hubのtag番号](https://hub.docker.com/r/toppersjp/hakoniwa-ros2sim/tags)に対応しています）
+上記のコマンド実行結果は，ターミナルに再ログインしてから有効となります．
 
-次のコマンドを実行してください．Dockerを立ち上げて，imageのpullと展開を行います．
+## Unity 環境
 
-```
-$ sudo service docker start
-$ cd ros2/docker
-$ bash pull-image.bash
-```
+* Unity Hub 3.1.1 以降
+* Unity Editor 2021.3.0f1
+  * Unity Hub の「Installs > Install Editor」画面に本バージョンが表示されない場合は，[Unity Dowonload Archive](https://unity3d.com/get-unity/download/archive) の本バージョンの "Unity Hub" をクリックしてインストールできます． 
 
-\[開発者向け情報\] Dockerイメージの作成
+## PC環境の準備
 
-#### Windows環境
+Windows 環境では，操作は全てWSL2/Linuxのシェル上で行います．WSL2のファイルシステム配下（`/home/${USER}/`以下）ではなくWindowsファイルシステム配下（`/mnt/c/`以下）で実行してください．
+
+### 本リポジトリのclone
+
+ターミナルで下記を実行して本リポジトリをcloneしてください．
 
 ```
-$ sudo service docker start
-$ cd ros2/docker
-$ bash create-image.bash
+$ git clone --recursive https://github.com/toppers/hakoniwa-ros2sim.git
 ```
 
-#### Linux環境
+## シミュレータの導入手順
+
+### Dockerイメージの展開
+
+シミュレータの実行環境は，ビルド済みのDocker imageをDocker Hubにて公開しています．
+
+https://hub.docker.com/r/toppersjp/hakoniwa-ros2sim
+
+現在の最新版は **v1.0.0** です．
+「[バージョン情報・更新履歴](/appendix/version.md)」も参照してください（バージョン番号は[Git/GitHubのtag/release](https://github.com/toppers/hakoniwa-ros2sim/releases)および[Docker Hubのtag番号](https://hub.docker.com/r/toppersjp/hakoniwa-ros2sim/tags)に対応しています）
+
+次のコマンドを実行してください．Dockerイメージののpullと展開を行います．
 
 ```
-$ cd ros2/docker
-$ bash create-image-linux.bash
+$ bash docker/pull-image.bash
 ```
 
-#### Mac環境
+\[補足：開発者向け情報\] Dockerイメージの作成
 
 ```
-$ cd ros2/docker
-$ bash create-image.bash
+$ bash docker/create-image.bash
 ```
 
 ### dockerを起動する
-端末を２個(端末A，端末B)起動して，端末Aでdockerコンテナを起動します．
-
-#### Windows環境
 
-```
-$ bash run.bash
-```
+ターミナルを2個起動します（以降の説明では，ターミナルAおよびターミナルBと呼びます）．
 
-#### Linux環境
+ターミナルAでdockerコンテナを起動します．
 
 ```
-$ bash run-linux.bash
+$ bash docker/run.bash
 ```
 
-#### Mac環境
-Mac環境の場合は，イーサーネット名を引数に指定してください．
-イーサーネット名は，ifconfigコマンドで確認できます．
+Mac環境の場合は，ネットワークポート名（例："en0"）を引数に指定する必要があります．
+ポート名は `ifconfig` コマンド等で確認できます．
 
 ```
-$ bash run-mac.bash <ether>
+$ bash docker/run.bash <port>
 ```
 
 ### 起動した dockerコンテナ上で箱庭のROS環境をインストール
@@ -162,24 +152,32 @@ Unity Hubを起動し，右上の「開く」をクリックして、先ほど
 
 
 ### 準備
-端末Aと端末Bでdockerコンテナに入ります．
-端末B側は，以下のコマンドで入ります．
+
+ターミナルAとBの両方ででdockerコンテナに入ります．
+
+ターミナルAで Dockerコンテナを終了させていた場合は，改めて起動してください，
+
+```
+$ bash docker/run.bash
+```
+
+ターミナルB側は，以下のコマンドで入ります．
 
 ```
-$ bash attach.bash
+$ bash docker/attach.bash
 ```
 
-### 端末A
+### ターミナルAでの操作
 
-端末AでROS-TCP-ENDPOINTを起動しましょう．
+ターミナルAでROS-TCP-ENDPOINTを起動しましょう．
 
 ```
 # bash launch.bash
 ```
 
-### 端末B
+### ターミナルBでの操作
 
-端末BでROSプログラムを起動しましょう．
+ターミナルBでROS2プログラムを起動しましょう．
 
 ```
 # bash run.bash tb3 TB3RoboModel
@@ -199,8 +197,8 @@ Unityのシミュレーション開始ボタンをクリックすると，以下
 
 この動画の各ウィンドウは，それぞれ次の通り対応しています．
 
-- 右上：端末A
-- 右下：端末B
+- 右上：ターミナルA
+- 右下：ターミナルB
 - 左：Unity
 
 

appendix/latest_version.txt

@@ -0,0 +1 @@
+v1.0.0

appendix/version.md

@@ -2,7 +2,7 @@
 
 ## バージョン番号の付与規則
 
-`vX.Y.Z` のようにバージョン番号を付与します．この番号は `docker/image_name.txt` でも管理されています．また，[Git/GitHubのtag/release](https://github.com/toppers/hakoniwa-ros2sim/releases)および[Docker Hubのtag番号](https://hub.docker.com/r/toppersjp/hakoniwa-ros2sim/tags)に対応しています．
+`vX.Y.Z` のようにバージョン番号を付与します．この番号は `appendix/latest_version.txt` で管理されています．また，[Git/GitHubのtag/release](https://github.com/toppers/hakoniwa-ros2sim/releases)および[Docker Hubのtag番号](https://hub.docker.com/r/toppersjp/hakoniwa-ros2sim/tags)に対応しています．
 
 各バージョン番号の更新は，次の規則で行います．
 

ros2/docker/Dockerfile docker/Dockerfile

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+IMAGE_NAME=`cat docker/image_name.txt`
+IMAGE_TAG=`cat appendix/latest_version.txt`
+DOCKER_IMAGE=${IMAGE_NAME}:${IMAGE_TAG}
+
+DOCKER_ID=`docker ps | grep "${DOCKER_IMAGE}" | awk '{print $1}'`
+
+docker exec -it ${DOCKER_ID} /bin/bash

docker/attach.bash

@@ -0,0 +1,8 @@
+#!/bin/bash
+
+IMAGE_NAME=`cat docker/image_name.txt`
+IMAGE_TAG=`cat appendix/latest_version.txt`
+DOCKER_IMAGE=${IMAGE_NAME}:${IMAGE_TAG}
+DOCKER_FILE=docker/Dockerfile
+docker build -t ${DOCKER_IMAGE} -f ${DOCKER_FILE} .
+

docker/create-image.bash

@@ -0,0 +1 @@
+toppersjp/hakoniwa-ros2sim

docker/image_name.txt

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+IMAGE_NAME=`cat docker/image_name.txt`
+IMAGE_TAG=`cat appendix/latest_version.txt`
+DOCKER_IMAGE=${IMAGE_NAME}:${IMAGE_TAG}
+
+docker pull ${DOCKER_IMAGE}

docker/pull-image.bash

@@ -0,0 +1,54 @@
+#!/bin/bash
+
+HAKONIWA_TOP_DIR=`pwd`
+IMAGE_NAME=`cat docker/image_name.txt`
+IMAGE_TAG=`cat appendix/latest_version.txt`
+DOCKER_IMAGE=${IMAGE_NAME}:${IMAGE_TAG}
+
+
+OS_TYPE=`bash utils/detect_os_type.bash`
+
+if [ ${OS_TYPE} != "Mac" ]
+then
+	docker ps > /dev/null
+	if [ $? -ne 0 ]
+	then
+	    sudo service docker start
+	    echo "waiting for docker service activation.. "
+	    sleep 3
+	fi
+fi
+
+if [ ${OS_TYPE} = "wsl2" ]
+then
+	IPADDR=`cat /etc/resolv.conf  | grep nameserver | awk '{print $NF}'`
+elif [ ${OS_TYPE} = "Mac" ]
+then
+	if [ $# -ne 1 ]
+	then
+		echo "Usage: $0 <port>"
+		exit 1
+	fi
+	ETHER=${1}
+	IPADDR=`ifconfig | grep -A1 ${ETHER} | grep netmask | awk '{print $2}'`
+else
+	IPADDR="127.0.0.1"
+fi
+
+if [ ${OS_TYPE} != "Mac" ]
+then
+docker run -v ${HAKONIWA_TOP_DIR}:/root/workspace/hakoniwa-ros-samples \
+	-it --rm \
+	--net host \
+	-e CORE_IPADDR=${IPADDR} \
+	-e OS_TYPE=${OS_TYPE} \
+	--name hakoniwa-ros2sim ${DOCKER_IMAGE} 
+else
+docker run -v ${HAKONIWA_TOP_DIR}:/root/workspace/hakoniwa-ros-samples \
+	-it --rm \
+	--ip ${IPADDR} -p 10000:10000 \
+	-e CORE_IPADDR=${IPADDR} \
+	-e ROS_UNITY_IPADDR=${IPADDR} \
+	-e OS_TYPE=${OS_TYPE} \
+	--name hakoniwa-ros-sim ${DOCKER_IMAGE} 
+fi