# 独自のサービスファイルの作り方 ## ROSチュートリアルの流れ 1. [ROSパッケージの作り方](https://raspimouse-sim-tutorial.gitbook.io/project/ros_tutorial/how_to_create_pkg) 2. [トピックの書き方](https://raspimouse-sim-tutorial.gitbook.io/project/ros_tutorial/how_to_write_topic) 3. [独自のメッセージファイルの作り方](https://raspimouse-sim-tutorial.gitbook.io/project/ros_tutorial/how_to_create_msg) 4. [まとめて起動するやり方](https://raspimouse-sim-tutorial.gitbook.io/project/ros_tutorial/how_to_use_launch) 5. [サービスを書き方](https://raspimouse-sim-tutorial.gitbook.io/project/ros_tutorial/how_to_write_service) 6. [独自のサービスファイルの作り方](https://raspimouse-sim-tutorial.gitbook.io/project/ros_tutorial/how_to_create_srv) ←今ここ ## はじめに この章では、独自のサービスファイルを作成し、ROSで使用する方法を解説します。 [独自のメッセージファイルの作り方](https://raspimouse-sim-tutorial.gitbook.io/project/ros_tutorial/how_to_create_msg)で作成した日付と時間を配信するトピックを改良して、日付と時間を返すサービスを作成してみたいと思います。 ## サービスファイルの書き方 独自のサービスファイルは、`srv`ディレクトリに置きます。 無い場合は`srv`ディレクトリを作りましょう。 ``` roscd ros_tutorial/ mkdir srv ``` 要求に対し日時と時間を返すサービスを作成してみましょう。 ``` vim srv/DateTrigger.srv ``` `DateTrigger.srv`の中はこのように書きます。 ``` --- bool success int32 date float64 time ``` これは入力は何もなく、出力は`bool`の`success`と`int32`の`date`、`float64`の`time`を定義しています。 つまりサービスに対して、要求があったら`success`と`date`、`time`を返すということです。 次に`CMakeLists.txt`を編集します。 ``` roscd ros_tutorial/ vim CMakeLists.txt ``` 57行目からの`add_service_files`のコメントアウトを外し、59行目に`DateTrigger.srv`を追加します。 ![](https://164413620-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-LQj-2xtXRtxfWAIKc7B%2F-Lszga_okrFsVFIwSON6%2F-LszhLnxk8cbOH2otaAs%2Fsrv_Cmake.png?generation=1573026886884341\&alt=media) `catkin_ws`に移動し、`catkin_make`を行います。 ``` cd ~/catkin_ws/ catkin_make ``` これで準備完了です。 `DateTrigger.srv`が使用できるか確認していきます。 ``` rossrv show ros_tutorial/DateTrigger ``` 以下のように表示されたら、正しく作成できています。 ``` --- bool success int32 date float64 time ``` ## プログラムを改良 ### サーバ まず`ros_tutorial`パッケージに移動します。 ``` roscd ros_tutorial ``` `time_pub2.py`をコピーして`date_server.py`という名前で保存しましょう。 ``` cp scripts/time_pub2.py scripts/date_server.py vim scripts/date_server.py ``` プログラムを以下のように改良します。 {% code title="date\_server.py" %} ```python #!/usr/bin/env python import rospy from ros_tutorial.srv import DateTrigger, DateTriggerResponse from datetime import datetime def callback_srv(data): #changed l = [] d = DateTriggerResponse() d.date = '' #9~12 changed d.time = '' try: #add now = datetime.now() l = str(now) for i in range(0,10): d.date += l[i] for i in range(11,25): d.time += l[i] d.date = int(d.date.replace('-', '')) d.time = float(d.time.replace(':','')) d.success = True #22~25 changed except: d.success = False return d if __name__ == '__main__': rospy.init_node('date_server') #changed srv = rospy.Service('date_call', DateTrigger, callback_srv) #changed rospy.spin() ``` {% endcode %} 実行権限を与えます。 ``` chmod +x scripts/date_server.py ``` ### コード解説 `time_pub2.py`から変更したところを解説していきます。 ``` from ros_tutorial.srv import DateTrigger, DateTriggerResponse ``` 今回作成したサービスファイルをインポートします。 ``` def callback_srv(data): ``` `callback_srv`という関数名で定義してます。 ``` d = DateTriggereResponse() ``` `DateTriggereResponse`を`d`という名前でインスタンス化しています。 ``` try: now = datetime.now() l = str(now) for i in range(0,10): d.date += l[i] for i in range(11,25): d.time += l[i] d.date = int(d.date.replace('-', '')) d.time = float(d.time.replace(':','')) d.success = True ``` 処理自体は同じですが、最後に`return d`で`DateTriggerResponse`を返しています。 ``` except: d.success = False return d ``` 失敗の場合は`False`を返します。 ### クライアント 10カウントごとに時刻を取得するプログラムを書きます。 `date_client.py`という名前で作成しましょう。 ``` vim scripts/date_client.py ``` {% code title="date\_client.py" %} ```python #!/usr/bin/env python import rospy from ros_tutorial.srv import DateTrigger class Client(): def __init__(self): self.call = rospy.ServiceProxy('date_call', DateTrigger) self.res = "" def call(self): for i in range(11): print(i) rospy.sleep(0.1) self.res = self.call() print("~~~~~~~~~~~~~~~~~~~~~~") print(self.res) print("~~~~~~~~~~~~~~~~~~~~~~") rospy.sleep(1) if __name__ == '__main__': rospy.init_node("date_client") rospy.wait_for_service("date_call") c = Client() rate = rospy.Rate(10) while not rospy.is_shutdown(): c.call() rate.sleep() ``` {% endcode %} 実行権限を与えます。 ``` chmod +x scripts/date_client.py ``` ### コード解説 まずClientクラスから説明していきます。 ``` def __init__(self): self.call = rospy.ServiceProxy('date_call', DateTrigger) self.res = "" ``` `__init__`関数では今回呼び出すサービスの`date_call`を`self.call`という名前で宣言しています。 `self.res`は`self.call`で呼び出したサービスのレスポンスを受け取るための変数です。 ``` def call(self): for i in range(11): print(i) rospy.sleep(0.1) self.res = self.call() print("~~~~~~~~~~~~~~~~~~~~~~") print(self.res) print("~~~~~~~~~~~~~~~~~~~~~~") rospy.sleep(1) ``` `date_call`関数では10カウントした後、`self.res = self.call()`で結果を受け取り表示させています。 ``` if __name__ == '__main__': rospy.init_node("date_client") rospy.wait_for_service("date_call") ``` `date_client`というノード名で宣言し、`date_call`が立ち上がるのを待っています。 ``` c = Client() rate = rospy.Rate(10) while not rospy.is_shutdown(): c.call() rate.sleep() ``` `Client`クラスを`c`という名前でインスタンス化し、プログラムが終了するまで`call`関数を呼び出しています。 ## 実行方法 それぞれ別のターミナルで実行してください。 ``` roscore ``` ``` rosrun ros_tutorial date_server.py ``` ``` rosrun ros_tutorial date_client.py ``` ## 実行結果 `date_client.py`を実行したターミナルで以下のように表示されたら正しく実行できています。 ``` 0 1 2 3 4 5 6 7 8 9 10 ~~~~~~~~~~~~~~~~~~~~~~ success: True date: 20181114 time: 123304.60767 ~~~~~~~~~~~~~~~~~~~~~~ ``` 2018年11月14日の12時33分4.60767秒を指しています。