my_robot 〜自作パッケージでロボットを作る〜

パッケージのビルド

　自分でROSのパッケージをまとめる。まずは ワークスペースディレクトリ（ws ディレクトリ） を作成しよう。今回は例として catkin_ws という名前の ws ディレクトリを作成する。 ws ディレクトリには、 src というディレクトリも配置したいので、 オプション -p をつけて src ディレクトリも中に作る。 ws ディレクトリの名前はなんでもいいが、 src ディレクトリは src という名前固定である。

mkdir -p catkin_ws/src

　次に src ディレクトリに移動する。 ROS パッケージは src ディレクトリ内で作成する必要があるからである。

cd ~/catkin_ws/src

catkin_create_pkg コマンドで自分のパッケージを作成する。

catkin_create_pkg <pkg_name> <依存関係pkg> <依存関係pkg> ...

• <pkg_name> には自分の好きなパッケージの名前にする。ここでは my_robot という名前にした。
• <依存関係pkg> には、これから作成するパッケージに関わる他のパッケージまたはライブラリたちを指定する。
  　基本的に ROS 環境内で Python と c++ を使うには、 rospy と roscpp というライブラリが必要となるので、必ずこれを記述しよう。
  　また、ROS のトピック通信のメッセージ種類として最も基本な std_msgs を今回は指定する。ほかにもメッセージの種類はたくさんある。

　パッケージ名を my_robot 。初期に導入する依存関係たちは rospy、roscpp、std_msgs としてパッケージを作るとするならば、以下のコマンドでできる。

catkin_create_pkg my_robot rospy roscpp std_msgs

　すると、以下のようなログが表示される。以下のログの最後の行のような Successfully と書かれていれば自作パッケージの作成は完了である。

$ catkin_create_pkg my_robot rospy roscpp std_msgs
Created file my_robot/package.xml
Created file my_robot/CMakeLists.txt
Created folder my_robot/include/my_robot
Created folder my_robot/src
Successfully created files in /home/gai/catkin_ws/src/my_robot. Please adjust the values in package.xml.

　そしたら ws ディレクトリに移動して catkin build を実行する。 昔は catkin_make コマンドが主流だったが、これより改善された catkin build がおすすめである。

catkin build

　ビルドが成功したら、以下のコマンドでセットアップを通しておこう。

source devel/setup.bash

上記のコマンドに意味について説明しよう。
　source コマンドは、 指定されたシェルコマンドを現在のシェル（ターミナル）に反映させる コマンドである。
ここでは、 devel/setup.bash （devel ディレクトリにある setup.bash） を source コマンドにより実行し、今使用しているターミナルに setup.bash に書かれた設定を反映させた。 この setup.bash に記述された設定をターミナルに反映させることで、ワークスペースディレクトリ （catkin_ws のこと）入っている ROS パッケージを認識することができるようになる。

　そしたら、ROS のコマンドの一部である。 roscd コマンドを使って、先ほど作成した自作パッケージのディレクトリまで移動してみよう。

roscd my_robot

　作成した自作パッケージのディレクトリまで移動できたら ROS にも自作パッケージがちゃんと認識されていることとなる。

パッケージ内を編集する

　ls コマンドで自作パッケージの中身を見てみよう。すると２つのファイルと２つのディレクトリが生成されているのがわかる。

$ ls
CMakeLists.txt  include  package.xml  src

　今はこれらのファイルに関しては無視。新たに２つディレクトリを作成する。今回作成するディレクトリは以下２つである。

• scripts : python スクリプトを記述するディレクトリ。
• msg : 自作メッセージを記述するディレクトリ。（後ほど使用する）

　コマンドで２つのディレクトリを生成する。

mkdir scripts msg

　これで my_robot ディレクトリに２つの新しいディレクトリができた。

パブリッシャーを作ってみよう

　早速パブリッシャーを作ってみよう。パブリッシャー（Publisher）とは、配信者という意味を持つ。配信者はその名の通りデータを配信する。 ここでは、整数を１秒間隔でカウントして送信するパブリッシャーを作ってみよう。

これから作るパブリッシャの挙動
0
1
2
3
4
.
.
.

　まずは名前を決めよう。これから作るパブリッシャーは整数を1秒間隔でカウントしながら配信するので int_publisher.py としよう。 好きはテキストエディタでファイルを作ろう。ここでは nano をつかってファイルを作成する。

nano scripts/int_publisher.py

• gedit を使って新規ファイル int_publisher.py を作成して開く方法

  gedit int_publisher.py

　プログラムを書く準備ができたら、まずはシバンを記述しよう。 シバンとは、俺は Python 実行ファイルだぞ！と自己主張するための名札のようなものである。これを書かないと ROS がこのファイルを python スクリプトとして認識してくれない。

#!/usr/bin/env python3

　そしたら必要なモジュールたちをインポートしよう。まずは python で ROS を扱うのに必須である rospy ライブラリ をインポートする。

import rospy

　次に、整数型のメッセージを扱うためのモジュールを呼び出す。これは std_msgs ライブラリ内 にあるため、 以下のように記述して Int32 モジュールを呼び込む。

from std_msgs.msg import Int32

　これで必要なモジュールのインポートは完了である。次に以下のプログラムでこの python プログラムをノードとして登録しよう。
　ROS は１つの実行プログラムを ノード という単位で管理する。そのためこのように rospy の init_node 関数を使ってノード名を設定する必要がある。 今回は整数をカウントしながら送信するノードを作るので、int_pub という名前のノードを作る。

rospy.init_node('int_pub')

　次に、メインであるパブリッシュ（配信）設定をするプログラムを書く。パブリッシャーの設定は rospy の Publisher 関数でできる。 Publisher 関数は、以下3つの引数を必要とする。

rospy.Publisher('トピック名', メッセージタイプ, キューサイズ)

　トピック名とは、電車で言うところの路線名である。メッセージタイプは電車で言うところの電車の名前である。キューサイズはちょっとよくわからん。 例えをコロコロ変えてしまうが、例えば Publisher 関数の引数それぞれ以下のように設定したとしよう。

rospy.Publisher('東海道新幹線', こだま, queue_size=1)

　これを要約すると、東海道新幹線というトピックにこだまというメッセージをキューサイズ１でパブリッシュすように設定するよ。である。

　今回は int_count という名前のトピックを作成し、そこに整数メッセージ（Int32）を queue_size 1 で送信するようにするので、以下のように記述する。

pub = rospy.Publisher('int_count', Int32, queue_size=1)

　次に、メッセージを送信する周期を設定する。メッセージ送信周期の設定は、rospy の Rate 関数を使う。 Rate 関数は引数に周期を指定するので、1Hz （１秒間に１回）で送信するようにする。

rate = rospy.Rate(1)

　最後にカウントするための変数 count の初期値を設定する。

count = 0

　これでパブリッシュするための設定は完了である。次に、実際にメッセージをパブリッシュするためのプログラムを書く。 まず、このパブリッシュプログラムはユーザーがプログラムを停止するまでメッセージを送信し続けるようにしたいので、以下のような while 文を書く。

while not rospy.is_shutdown():

　これは、 ROS が死ぬまでループする という意味である。この中にカウンタープログラムを書いていく。 まずは counter 変数をパブリッシュする部分を書く。 先程パブリッシュの設定をする Publisher のところで、pub という変数を指定して インスタンス化 している。 つまり変数 pub はパブリッシュ設定が盛り込まれたメソッドということである。このメソッドには引数内のデータをメッセージとして飛ばす publish 関数があるので、これを記述して count 変数を飛ばす。

pub.publish(count)

あとは、変数の変化を確認すうるための print 文と、値を繰り上げるプログラムを書く。

print(count)
count += 1

　最後に Rate 関数を休ませる Rate.sleep() を末尾に追加して完了である。

rate.sleep()

　以下が int_publisher.py の全体図である。

#!/usr/bin/env python3

import rospy

from std_msgs.msg import Int32

# ノードの名前を定義する
rospy.init_node('int_pub')

# パブリッシュするトピックの名前を指定する
pub = rospy.Publisher('int_count', Int32, queue_size=1)

# 実行周期を設定する。今回は1秒おきに配信するようにする。
rate = rospy.Rate(1)

count = 0

while not rospy.is_shutdown():
    # count 変数をパブリッシュ
    pub.publish(count)

    print(count)
    count += 1

    rate.sleep()

　このプログラムを実行する前に、 chmod コマンドでこのプログラムに実行権限を与える必要がある。 これをしないと ROS が正常にこのプログラムをノードとして扱ってくれない。

chmod 777 scripts/int_publisher.py

　そしたら python コマンドで int_publisher.py を実行してみよう。まず新しいターミナルを開いて以下のコマンドを実行しよう

roscore

　次に他のターミナルで、以下のコマンドを実行すると、数字が１秒毎にカウントされる。

source ~/catkin_ws/build/setup.bash
rosrun my_robot int_publisher.py

実行結果

$ rosrun my_robot int_publisher.py 
0
1
2
3
4
.
.
.

Control + C でプログラムは停止する。
　rosrun コマンドの意味について説明しよう。rosrun コマンドでは以下のようなオプションをもつ。

rosrun <パッケージ名> <そのパッケージの中にあるノードファイル>

　先程のコマンド（ rosrun my_robot int_publisher.py ）を読み解くとこうなる。

my_robot パッケージの中にある int_publisher.py を実行する。

　つぎに、実際にデータがパブリッシュされているかどうか確認してみよう。新たにターミナルを開いて、 rostopic コマンド を使ってみよう。 rostopic コマンドを使うことで、ROS から提供されているトピック情報を知ることができる。 rostopic の list コマンドを使うと、現在発行されているトピックが一覧として表示される。

rostopic list

　すると、以下のように / から始まるテキストが表示される。これが トピックである。

$ rostopic list
/rosout
/rosout_agg

トピックが表示されない場合
　もしトピックが表示されずに、以下のようなテキストが表示されたら、別のターミナルから roscore を実行してからやり直してほしい。

$ rostopic list
ERROR: Unable to communicate with master!

　更に別のターミナルを開いて、int_publisher.py を実行しよう。その後にまた rostopic list でトピック一覧を見てみると、

$ rostopic list
/int_count
/rosout
/rosout_agg

先ほど作成した int_publisher.py から発行されている int_count というトピックが配信されているのがわかる。
　int_count トピックは、int_publsher.py の以下の行で定義しているのが対応している。

pub = rospy.Publisher('int_count', Int32, queue_size=1)

　特定のトピックのメッセージを見たい場合は、rostopic の echo コマンドをつかうと配信内容を参照できる

rostopic echo /<topic_name>

　int_count トピックの内容を見てみよう

rostopic echo /int_count

　すると int_count トピックからのメッセージが表示される。

$ rostopic echo /int_count
data: 10
---
data: 11
---
.
.
.

　次はサブスクライバーをつくってみよう

サブスクライバーを作ってみよう

　サブスクライバーとは、購読者 のことを指す。つまりパブリッシャー（配信者）からのデータを受け取るものである。

Youtube の動画配信者がパブリッシャーでその動画の視聴者がサブスクライバーという感じ

　今回作るサブスクライバープログラムは、先ほど作成した int_publisher.py から発行された int_count トピックを取得しこれを表示するプログラムを作成する。 以下のような結果が出るようにする。

$ rosrun my_robot int_subscriber,oy
int_countトピックからのメッセージ
.
.
.

　scripts ディレクトリに新たなサブスクライバープログラム int_subscriber.py を作る。

# nano を使って編集する場合
nano scripts/int_subscriber.py

　まずは、 先程教えた シバンを書こう。

#!/usr/bin/env python3

　次に ROS を python で扱うために必要なライブラリ rospy をインポートしよう。

ipmort rospy

　ここで、一旦プログラムを書く手を止めて、これからサブスクライブする int_count トピックについて知っておこう。roscore を立てて int_publisher ノードを実行しよう。

1. roscore を立てる

   roscore

2. 当たらにターミナルを立てて、そこに int_publisher ノードを立てる。

   rosrun <自作パッケージの名前> int_publisher.py

3. 新たにターミナルを立てて rostopic コマンドを使って int_publisher から発行されている int_count メッセージを取得する。

   rostopic echo /int_count

　すると、前回実行した ようにメッセージが発行される。ここで、手順３ で実行したコマンドを中止して、以下のコマンドを実行してほしい。

rostopic info <トピック名>

　この info コマンドは、対象のトピックに関する情報を確認することができるコマンドである。ここでは int_count トピックを知りたいので、

rostopic info /int_count

と入力する。すると、以下のように int_count トピックに関する情報が表示される。

Type: std_msgs/Int32

Publishers: 
 * /int_pub (http://2013-macbookpro:37341/)

Subscribers: None

　上記のテキストは、以下のような意味を持つ。

このトピックが使用しているメッセージタイプ：std_msgs の Int32

このトピックを配信しているノード：
/int_pub

このトピックを購読しているノード：誰もいねぇ

　ここでわかったことは、これから取得するトピック（int_count）は、std_msgs の Int32 を使用しており、これを飛ばしているパブリッシャーは int_pub というノードである ということである。作った本人だからそんなのわかると思うかもしれないが、もしこれが他が作ったプログラムからのメッセージを知りたい場合にはとても役に立つ。 それでは int_subscriber の作成に戻ろう。

　ここでわかったのは、これから取得するメッセージのタイプは Int32 であるということ。ということでプログラムに Int32 パッケージをインポートしよう。

from std_msgs.msg import Int32

　次に、このプログラムをノードとして認識させるためにノードを設定しよう。このプログラムのノード名は int_sub とする。

rospy.init_node('int_sub')

　そして、新たな関数 Subscriber を使う。この関数を使うことで、トピックを持ってくることができる。Subscriber トピックは、以下の引数を必要とする。

rospy.Subscriber(<トピック名>, <メッセージタイプ>, <コールバック関数>)

　トピック名は、今回 int_count というトピックからのメッセージを知りたいので、str で int_count と指定しよう。

rospy.Subscriber('int_count', <メッセージタイプ>, <コールバック関数>)

　つぎに、メッセージタイプ。これは取得するメッセージの種類を指定する。今回取得する int_count からのメッセージの種類は、先程の作業でわかっているので、

rospy.Subscriber('int_count', Int32, <コールバック関数>)

　最後に、コールバック関数を設定する。ここで言うコールバック関数とは、指定されたトピックを取得したときに実行する関数のことである。コールバック関数の名前は好きにしていい。ここでは int_cb という名前にする。

rospy.Subscriber('int_count', Int32,　int_cb)

　これで Subscriber 関数の設定が完了したかというとそうではない。先程書いたコールバック関数の設定がまだ終わっていないからだ。トピックが呼び出されたときに実行される関数だが、まだ本プログラム内ではそれを作っていない。そのため、Subscriber 関数より上にコールバック関数を作成する必要がある。

　例で作ったコールバック関数の名前は int_cb なので、int_cb 関数を作成する。

# rospy.Subscriber() より上にこの関数を作ろう
def int_cb(data):

　コールバックとして使用する関数には、かならずサブスクライブされたトピックからのメッセージがくるので、引数を書こう。今回は特に取得したメッセージを同化するわけでもないので、ちゃんとメッセージが取得できたかを確認するために print 文をかく。

# rospy.Subscriber() より上にこの関数を作ろう
def int_cb(data):
    print(data)

　最後に、rospy,Sbscriber() の下に、コールバック関数を常に実行させるようにすることができる関数。spin 関数を書いて完了。

# rospy.Subscriber() より下にこの関数を作ろう
rospy.spin()

　書き終わったら権限を加えて roscore して int_publisher を実行してこのプログラム（int_subscriber）を実行しよう。するとちゃんと通信できることが確認できる。
　これで君は ROS の pub sub 通信の基礎を学んだ。

サービス通信をしてみよう

　ROS では、トピックによるデータ通信の他に、 サービス というもう一つの通信方法がある。
　サービス通信の特徴は、サーバー・クライアント通信を行い、クライアントから要求があるとサーバーが応答するといったふるまいを見せる。このサービス通信は、以下のような用途で役に立つ。

• ロボットのセンサーのオンオフ
• 緊急停止機構の構築

　実際サービスを使ったタスクはあまりないが、覚えておいて損はない。