ROSのパッケージ・ワークスペース

ROSのパッケージ管理について理解しよう

Learn

ROSのパッケージ

ROSでは、特定の機能やタスクを実現するためのコードやファイルをまとめてパッケージとして管理します。 各パッケージは独立して開発・保守され、他のパッケージと組み合わせて使用することができます。また、各パッケージが独立していることで、一度開発した機能を他のプロジェクトで再利用することも容易になります。

例として、navigation_tutorialパッケージのファイル構成を示します。

navigation_tutorial
   ├── CMakeLists.txt
   ├── launch
   │   ├── amcl.launch
   │   ├── avoidance.launch
   │   ├── gmapping.launch
   │   ├── go_straight.launch
   │   ├── localization.launch
   │   ├── map_server.launch
   │   ├── move_base.launch
   │   └── navigation.launch
   ├── package.xml
   ├── params
   │   ├── base_global_planner_params.yaml
   │   ├── base_local_planner_params.yaml
   │   ├── costmap_common_params.yaml
   │   ├── dwa_local_planner_params.yaml
   │   ├── global_costmap_params.yaml
   │   ├── local_costmap_params.yaml
   │   └── move_base_params.yaml
   ├── scripts
   │   ├── avoidance.py
   │   ├── simple_control2.py
   │   └── simple_control.py
   └── src
       ├── avoidance.cpp
       └── go_straight.cpp
scriptsディレクトリ、srcディレクトリの役割

一般的に、scriptsディレクトリ内にpythonのプログラムが、srcディレクトリ内にC++のプログラムが配置されます。

作成したプログラムはrosrunコマンドで実行することができます。

$ rosrun <package name> <file name>

# pythonファイルの場合
$ rosrun navigation_tutorial simple_control2.py

# C++ファイルの場合
$ rosrun navigation_tutorial go_straight

実行時にパッケージ名を指定するので、現在どこのディレクトリにいるかに関係なく実行が可能です。

launchディレクトリの役割

launchディレクトリにはlaunchファイルが配置されています。
launchファイルは複数のROSノードを一括で起動するための設定が書かれたファイルです。複数のノードを起動したい時に、必要なファイルを一つ一つコマンドラインで実行していくことは大変ですが、launchファイルを用いることで一括で起動することができます。

launchファイルはroslaunchコマンドで実行することができます。

$ roslaunch <package name> <launch file name>

# 例
$ roslaunch navigation_tutorial move_base.launch

.pyファイルや.cppファイルと同様、実行時にパッケージを指定するので、現在どこのディレクトリにいるかに関係なく実行が可能です。

ROSのワークスペース

新しいROSのパッケージの開発は、一般にワークスペースと呼ばれる作業スペースのもとで行われます。
ワークスペースは、パッケージのビルドや実行に必要なファイルをまとめて管理するためのディレクトリです。catkin_makeコマンドを実行することで作成することができます。ワークスペースのディレクトリ名は任意ですが、よくcatkin_wsという名前が使われます。

roomba_hackリポジトリ下にあるcatkin_wsのファイル構成を示します。

catkin_ws
   ├── build
   ├── devel
   └── src
       ├── CMakeLists.txt
       ├── navigation_tutorial
       │   ├── CMakeLists.txt
       │   ├── launch
       │   ├── package.xml
       │   ├── params
       │   ├── scripts
       │   └── src
       └── roomba
           ├── roomba_bringup
           │   ├── CMakeLists.txt
           │   ├── config
           │   ├── launch
           │   └── package.xml
           ├── roomba_description
           │   ├── CMakeLists.txt
           │   ├── config
           │   ├── launch
           │   ├── meshes
           │   ├── package.xml
           │   └── urdf
           ├── roomba_gazebo
           │   ├── CMakeLists.txt
           │   ├── launch
           │   └── package.xml
           └── roomba_teleop
               ├── CMakeLists.txt
               ├── include
               ├── launch
               ├── package.xml
               └── src

catkin_ws内でよく使用されるcatkin_makeコマンドについて説明します。

$ cd catkin_ws  # catkin_wsに移動
$ catkin_make

のように使用します。この時、以下の手順が実行されています。

  1. ワークスペースのsrcディレクトリ内に配置されたROSパッケージを検出し、ビルド対象として認識する。
  2. 各パッケージの依存関係を解決し、ビルドが必要な場合はコンパイルを行う。
  3. ビルドが完了したパッケージをdevelディレクトリに配置する。

また、catkin_makeコマンドの実行後に

$ source devel/setup.bash

を実行することで環境変数に自分が今いるワークスペースのパスを追加することができます。
これにより、ワークスペース内のパッケージを使用できるようになります。

ROSのコマンド

ROSのコマンドのうち、よく使用するものを紹介します。

  • Topic関連

    $ rostopic list                 　　　　　　   topicの一覧を表示する
$ rostopic echo <topic name>   　 　　　　　   指定されたtopicの中身を表示する
$ rostopic hz <topic name>      　　　　　　　  topicの配信周波数を取得する
$ rostopic info <topic name>    　　　　　　　  topicの情報を表示する
$ rostopic pub <topic name> <topic> 　 　topicを配信する
$ rostopic type <topic name>          topicの型を確認する

  • Node関連

    $ rosnode list                nodeの一覧を表示する
$ rosnode ping <node name>    nodeの接続テストを行う
$ rosnode info <node name>    nodeの情報を表示する
$ rosnode kill <node name>    nodeをシャットダウンする

  • Package関連

    $ rospack list             packageの一覧を表示する
$ roscd <package name>     指定したpackage内に移動する

ROSのプログラムの書き方

それでは実際にプログラム例を見てみましょう。

#!/usr/bin/env python3

import rospy
from geometry_msgs.msg import Twist

def time_control(pub, velocity, yawrate, time):  # (2)
    vel = Twist()
    start_time = rospy.get_rostime().secs
    while(rospy.get_rostime().secs-start_time<time):
        vel.linear.x = velocity
        vel.angular.z = yawrate
        pub.publish(vel)
        rospy.sleep(0.1)

def simple_controller():  # (1)
    rospy.init_node('simple_controller', anonymous=True)
    pub = rospy.Publisher('/cmd_vel', Twist, queue_size=10)

    time_control(pub,  0.0,  0.0, 0.5)
    time_control(pub,  0.3,  0.0, 2.0)

    time_control(pub,  0.0,  0.0, 0.5)
    time_control(pub, -0.3,  0.0, 2.0)

    time_control(pub,  0.0,  0.0, 0.5)
    time_control(pub,  0.0,  0.5, 2.0)

    time_control(pub,  0.0,  0.0, 0.5)
    time_control(pub,  0.0, -0.5, 2.0)

if __name__=='__main__':  # (3)
    try:
        simple_controller()
    except rospy.ROSInitException:
        pass
(1) simple_controller関数

まずsimple_controller関数内をみていきましょう。
以下の部分で"simple_controller"という名前のノードを定義しています。

rospy.init_node('simple_controller', anonymous=True)

以下の部分で、このノードがPublisherであることを宣言しています。

pub = rospy.Publisher('/cmd_vel', Twist, queue_size=10)

今回の場合は、/cmd_velトピックをTwist型で送信するPublisherを宣言しています。

(2) time_control関数

続いて、time_control関数です。

この関数はpublisher、速度、角速度、時間を受け取り、速度指令をpublishします。

def time_control(pub, velocity, yawrate, time):
    vel = Twist()
    start_time = rospy.get_rostime().secs
    while(rospy.get_rostime().secs-start_time<time):
        vel.linear.x = velocity
        vel.angular.z = yawrate
        pub.publish(vel)
        rospy.sleep(0.1)

ここでTwist型のインスタンスを作成しています。

  vel = Twist()

while文で受け取った時間が過ぎるまでの間、受け取った速度と各速度をvelに格納し、pub.publish(vel)でpublishを行なっています。

    while(rospy.get_rostime().secs-start_time<time):
        vel.linear.x = velocity
        vel.angular.z = yawrate
        pub.publish(vel)
        rospy.sleep(0.1)

(3) グローバル変数__name__を用いたファイルの実行

(1)や(2)は関数の定義をしているだけで、実際にプログラムを実行した際には

if __name__=='__main__':

以下の部分が実行されます。

__name__はpythonの特殊な変数の一つで、ファイル実行時に自動で設定されます。 pythonのプログラムはコマンドで直接実行するか、importで他のプログラムから参照されるかのいずれかの方法により実行されますが、__name__はこの実行方法によって値が変わります。

  • 直接実行された場合、__name__には__main__と言う文字列が代入されます。
  • importされた場合、__name__にはファイル名が代入されます。

この性質を利用し、ファイルが直接実行された場合のみ実行したい処理をif文で囲んでいます。
大抵の場合、rosのプログラムでは、上に挙げたファイルのように、関数やクラスの定義と実際にプログラムを実行する部分を分けて記述します。

演習

【jetson・開発マシン】それぞれdockerコンテナを起動

jetsonでdockerコンテナを起動

(開発PC):~$ ssh roomba_dev1
(jetson):~$ cd ~/group_a/roomba_hack
(jetson):~/group_a/roomba_hack ./RUN-DOCKER-CONTAINER.sh
(jetson)(docker):~/roomba_hack#

開発PCでdockerコンテナを起動

(開発PC):~$ cd ~/group_a/roomba_hack
(開発PC):~/group_a/roomba_hack# ./RUN-DOCKER-CONTAINER.sh 192.168.10.7x
(開発PC)(docker):~/roomba_hack#

【jetson・開発マシン】ビルドをしてパスを通す

catkin_make後にdevelとbuildディレクトリが作成されることを確認しましょう。

(開発PC)(docker):~/roomba_hack# cd catkin_ws
(開発PC)(docker):~/roomba_hack/catkin_ws# rm -rf devel build
(開発PC)(docker):~/roomba_hack/catkin_ws# ls
(開発PC)(docker):~/roomba_hack/catkin_ws# catkin_make
(開発PC)(docker):~/roomba_hack/catkin_ws# ls
(開発PC)(docker):~/roomba_hack/catkin_ws# source ./devel/setup.bash

【jetson】ROSマスタ、各種ノードを起動

(jetson)(docker):~/roomba_hack# roslaunch roomba_bringup bringup.launch

ROSメッセージの可視化

【開発PC】topicの確認

Topic関連のコマンドのところのrostopic listコマンドを使用してtopic一覧を表示してみましょう

(開発PC)(docker):~/roomba_hack# rostopic list

特定のtopicの型を確認

(開発PC)(docker)# rostopic type /camera/color/image_raw
(開発PC)(docker)# rostopic type /scan

その型が実際にどのような構成をしているのかはrosmsg info <topic type>で調べられます。

参考

sensor_msgs/LaserScan型 http://docs.ros.org/en/melodic/api/sensor_msgs/html/msg/LaserScan.html

sensor_msgs/Image型 http://docs.ros.org/en/noetic/api/sensor_msgs/html/msg/Image.html

特定のtopicの中身を確認

(開発PC)(docker)# rostopic echo /camera/color/image_raw
(開発PC)(docker)# rostopic echo /scan

rvizを用いて可視化

(開発PC)(docker)# rviz

【開発PC】topicのpublish(配信)

topic/cmd_velの情報を確認

(開発PC)(docker)# rostopic info /cmd_vel

topic/cmd_velの型を確認

(開発PC)(docker)# rostopic type /cmd_vel

geometry_msgs/Twist型 http://docs.ros.org/en/noetic/api/geometry_msgs/html/msg/Twist.html

topic/cmd_velをpublish

(開発PC)(docker)# rostopic pub /cmd_vel geometry_msgs/Twist "linear:
    x: 1.0
    y: 0.0
    z: 0.0
  angular:
    x: 0.0
    y: 0.0
    z: 0.0"

(開発PC)(docker)# rosrun navigation_tutorial simple_control.py

Try it! 時間が余った人向け

try it! roomba_bringupパッケージのbringup.launchの中身を読んでみよう

hint roscdコマンドを使うとパッケージへ簡単に移動ができます。ファイルの中身を表示するにはcatコマンドを使用します。

try it! 開発PCでrosnode関連のコマンドを使ってみよう

try it! 開発PCでrosrun rqt_graph rqt_graphを実行してnodeとtopicの関連を可視化してみよう

try it! 開発PCでsimple_control.pyの中身を読んでコードを変更してみよう

hint コードを編集するときはエディタを使うことがおすすめです。新しくターミナルを開いて

(開発PC):~$ cd group_a/roomba_hack
(開発PC):~group_a/roomba_hack$ code .

でVScodeを起動することができます。

Next

Last updated on 2022/4/5

Edit this page