安曇野の森から > ROS(Robot Operating System)を使う > コマンドリファレンス(アルファベット順)

コマンドリファレンス(アルファベット順)

各コマンドの使用例はROS Wikiから引用しています。


catkin_create_pkg

説明

実行したワークスペース内にパッケージディレクトリ/src、及び関連したファイルpackage.xml, CMakeList.txtを作成します。


構文

catkin_create_pkg パッケージ名


オプション

なし


使用例




catkin_make

説明

ワークスペース内の全パッケージをビルドします。


構文

catkin_make


オプション

なし


使用例




rosbag check

説明



構文

rosbag check [オプション]


オプション

check バッグファイル名指定されたバッグファイルが使用可能か確認する。
-h, --helpヘルプを表示する。
-g ルールファイル名,
--genrules=ルールファイル名
指定された名前のバッグマイグレーションルールファイルを作成する。
-a, --append
-n, --nopluginsプラグイン経由でルールを読み込まないようにする。


使用例




rosbag compress

説明

指定されたバッグファイルを圧縮します。
圧縮する前に拡張子が.orig.bagのバックアップファイルが作られます。
すでにバックアップファイルがある場合には圧縮されません。
現時点では圧縮フォーマットはBZ2のみです。


構文

rosbag compress [オプション]


オプション

compress バッグファイル名指定されたバッグファイルを圧縮する。
-h, --help ヘルプを表示する。
--output-dir=ディレクトリ名指定されたディレクトリに出力する。
-f, --forceバックアップファイルがある場合は強制的に上書きする。
-q, --quiet致命的メッセージ以外は表示しない。


使用例




rosbag decompress

説明

指定されたバッグファイルを解凍します。
解凍する前に拡張子が.orig.bagのバックアップファイルが作られます。すでにバックアップファイルがある場合には解凍されません。


構文

rosbag decompress [オプション]


オプション

decompress バッグファイル名指定されたバッグファイルを解凍する。
-h, --helpヘルプを表示する。
--output-dir=ディレクトリ名指定されたディレクトリに出力する。
-f, --forceバックアップファイルがある場合は強制的に上書きする。
-q, --quiet致命的メッセージ以外は表示しない。


使用例




rosbag filter

説明

入力バッグファイルを指定されたPhython式で変換し出力バッグファイルに出力します。


構文

rosbag filter [オプション]


オプション

filter 入力バッグファイル名 出力バッグファイル名 Phython式入力バッグファイルを指定されたPhython式で変換し出力バッグファイルに出力する。
-h, --help ヘルプを表示する。
--print=PRINT-EXPRESSION


使用例




rosbag fix

説明

壊れたバッグファイルを修復します。


構文

rosbag fix [オプション]


オプション

fix 入力バッグファイル名 出力バッグファイル名 [バッグマイグレーションルールファイル名] 入力バッグファイルを指定されたルールで修復し出力バッグファイルに出力する。
-h, --helpヘルプを表示する。
-n, --nopluginsプラグイン経由でルールファイルを読み込まないようにする。


使用例




rosbag info

説明



構文

rosbag info [オプション]


オプション

info バッグファイル名指定されたバッグファイルの中身の概要を表示する。
-h, --helpヘルプを表示する。
-y, --yamlYAMLフォーマットで表示する。
-k フィールド名 バッグファイル名, --key=フィールド名 バッグファイル名指定されたバッグファイルの指定されたフィールドの情報のみを表示する。(-yオプションと一緒に使う。)


使用例




rosbag play

説明



構文

rosbag play [オプション]


オプション

play バッグファイル名 指定されたバッグファイルの内容を再生する。
-h, --helpヘルプを表示する。
-q, --quietコンソール出力しない。
-i, --immediate全てのメッセージを待ちなしで再生する。
--pauseポーズモードを開始する。
--queue=容量出力キューの容量を指定する。(ディフォルトは0)
--clockクロック時間を発行する。
--hz=周期クロック時間を指定された周期[Hz]で発行する。
-d スリープ時間, --delay=スリープ時間サブスクライバにコネクトを許可するため、advertiseコール毎に指定されたスリープ時間[sec]だけスリープする。
-r 倍数, --rate=倍数発行周期に指定された倍数をかける。
-s SEC, --start=SEC
-l, --loop再生を繰り返す。
-k, --keep-alive


使用例




rosbag record

説明

トピックを流れる情報をbagファイルへ記録します。


構文

rosbag record [オプション] [パラメータ]


オプション

-h, --helpヘルプを表示する。
-a, --all全てのトピックを流れる情報を記録する。
-e 正規表現トピック名, --regex=正規表現トピック名正規表現で名前が一致したトピックに流れる情報を記録する。
-x 正規表現トピック名, --exclude=正規表現トピック名正規表現で名前が一致したトピックを除いたトピックに流れる情報を記録する。
-q, --quietコンソール出力させない。
-o PREFIX, --output-prefix=PREFIX
-O バッグファイル名.bag, --output-name=バッグファイル名.bag情報を指定したバッグファイルへ記録する。
--split指定された容量、周期を超えた場合、バッグを分割する。
-b 容量, --buffsize=容量内部バッファ容量をMBで設定する。(ディフォルトは256MB、0に設定すると無限大)
--chunksize=容量チャンク容量をKBで設定する。(ディフォルトは768KB)
-l メッセージ数, --limit=メッセージ数指定された数のメッセージを記録する。
-j, --bz2ファイル圧縮にBZ2を使う。


使用例




rosbag reindex

説明

バッグファイルをインデックスし直して修復する。


構文

rosbag reindex


オプション

なし


使用例




roscd

説明

パッケージ名、又はスタック名を使うことによりカレントディレクトリを変えることが出来る。
環境変数ROS_WORKSPACEが設定してある場合には相対名を使ってディレクトリを指定することが出来る。
環境変数ROS_LOCATIONSに is a colon-separated list of key=path pairsが設定してある場合、
export ROS_LOCATIONS="pkgs=~/ros/pkgs:dev=~/ros/dev"
Will then allow you to type:
$ roscd dev
and end up in ~/ros/dev.


構文

roscd パッケージ名又はスタック名[/サブディレクトリ名]


オプション

なし


使用例




rosclean check

説明

ログファイルの利用状況(ファイルサイズ)を表示します。


構文

rosclean check


オプション

なし


使用例




rosclean purge

説明

ログファイルを削除します。


構文

rosclean purge


オプション

なし


使用例




roscore

説明

マスター、パラメーターサーバー、rosoutノードを起動します。


構文

roscore


オプション

なし


使用例




roscp

説明

フルパスを指定することなくパッケージ名とファイル名だけでパッケージ内のファイルをコピーすることが出来る。


構文

roscp コピー元パッケージ名 コピー元ファイル名 コピー先ファイルパス


オプション

なし


使用例

以下のコマンドは~/ros/pkgs/ros_tutorials/roscpp_tutorials/talker/talker.cppをカレントディレクトリへコピーする。




roscreate-stack

説明



構文

roscreate-stack [オプション]


オプション

--show-deps


使用例




rosdep init

説明

dependencyの初期化を行います。ROSインストール後、1度だけsudoで実行します。


構文

sudo rosdep init


オプション

なし


使用例




rosdep update

説明

dependencyの更新を行います。sudoで実行しないでください。


構文

rosdep update


オプション

なし


使用例




rosed

説明

フルパスを指定することなくパッケージ名とファイル名だけでパッケージ内のファイルを編集するエディタを開くことが出来ます。
パッケージ内に同一名のファイルが別階層ディレクトリに存在する場合、ファイルを選択するよう指示が表示されます。
ディフォルトではvimが起動されるが、以下例のように環境変数EDITORを設定することにより、好みのエディターを起動出来ます。
export EDITOR='emacs -nw'


構文

rosed パッケージ名 ファイル名


オプション

なし


使用例




rosinstall

説明



構文

rosinstall


オプション

なし


使用例




roslaunch

説明

指定したローンチファイルを起動します。
roscoreが起動していなければroscoreが自動で起動されます。


構文

roslaunch [オプション]


起動ありオプション

パッケージ名 ローンチファイル名 引数名=引数値指定したローンチファイルへ引数を与えて実行する。
roslaunch ローンチファイルパス名... [引数]
-p port
--wait
--local
--dump-params
-v パッケージ名 ローンチファイル名指定したローンチファイルを詳細表示で実行する。
-screen パッケージ名 ローンチファイル名指定したローンチファイルの出力をスクリーンへ表示する。


起動あり使用例






起動なしオプション

--nodes パッケージ名 ローンチファイル名
--nodes ローンチファイル名
--args ノード名 パッケージ名 ローンチファイル名
--args ノード名 ローンチファイル名
--find ノード名 パッケージ名 ローンチファイル名
--find ノード名 ローンチファイル名
--files ファイル名


起動なし使用例




roslaunch-deps

説明



構文

roslaunch-deps [オプション]


オプション

-w
-v<


使用例




roslaunch-logs

説明



構文

cd `roslaunch-logs`


オプション

なし


使用例




roslocate

説明



構文

roslocate


使用例




rosls

説明

指定されたパッケージ内、スタック内、又は通常のディレクトリ内ファイルを表示する。


構文

rosls パッケージ名、又はスタック名、又はディレクトリパス


オプション

なし


使用例




rosmsg show

説明

メッセージタイプの情報を表示します。


構文

rosmsg show [オプション]


オプション

show メッセージタイプ名指定されたメッセージタイプのフィールド情報を表示する。
-r生のメッセージ定義を表示する。
-b バッグファイル名 指定されたバッグファイルで定義されたメッセージを表示する。


使用例




rosmsg list

説明

パッケージの全メッセージを表示します。


構文

rosmsg list


オプション

なし


使用例




rosmsg package

説明

パッケージの全メッセージを表示します。


構文

rosmsg package [オプション]


オプション

package パッケージ名指定されたパッケージの全メッセージを表示する。
-s全メッセージを一行で表示する。


使用例




rosmsg packages

説明

全パッケージを表示します。


構文

rosmsg packages [オプション]


オプション

packages全パッケージを表示する。
-s全パッケージを一行で表示する。


使用例




rosmsg md5

説明

メッセージのmd5サムを表示します。


構文

rosmsg md5 [オプション]


オプション

md5メッセージタイプ名 指定されたメッセージのmd5サムを表示する。


使用例




rosnode cleanup

説明

Ctrl+Cでノードを停止させた場合に残るノード情報を完全にクリアします。


構文

rosnode cleanup


オプション

なし


使用例




rosnode info

説明

指定されたノードのノード情報(どんなトピックを使っているか、パブリシャーかサブスクライバ―か、サービスか)を表示します。


構文

rosnode info ノード名


オプション

なし


使用例




rosnode kill

説明

ノードを停止させます。


構文

rosnode kill [オプション]


オプション

kill ノード名...指定されたノードを停止させる。
kill 対話モードでkillを起動する。
kill -a, kill --all全ノードを停止させる。


使用例




rosnode list

説明

実行中のノードを表示します。


構文

rosnode list [オプション]


オプション

list実行中のノードを表示する。
list 名前空間名指定された名前空間にあるノードのみを表示する。
list -u実行中ノードのXML-RPC URIを表示する。
list -a, list --all実行中ノードの名前とXML-RPC URIを表示する。


使用例




rosnode machine

説明

マシン上で動作中のノードを表示します。


構文

rosnode machine [オプション]


オプション

machine マシン名指定されたマシンで動作しているノードのみ表示する。
machine全てのマシンを表示する。


使用例




rosnode ping

説明

ノードへ周期的にpingします。


構文

rosnode ping [オプション]


オプション

ping ノード名指定されたノードへ周期的にpingする。
ping --all全ノードにpingする。
ping -c カウント数カウント数分のみpingする。


使用例




rosnode cleanup

説明

全ノードを開放します。


構文

rosnode cleanup [オプション]


オプション

cleanup登録されている全ノードを開放する。


使用例




rospack find

説明

パッケージが格納されているディレクトリ(パッケージディレクトリ)を表示します。


構文

rospack find [オプション]


オプション

find パッケージ名パッケージディレクトリを表示する。


使用例




rospack list

説明

インストールされているパッケージを表示します。


構文

rospack list


オプション

なし


使用例




rosparam delete

説明

パラメータを削除します。


構文

rosparam delete [オプション]


オプション

delete パラメータ名指定されたパラメータを削除する。
-v 詳細表示する。


使用例




rosparam dump

説明

パラメーターサーバーの内容をファイルへYAMLフォーマットで書き込みます。


構文

rosparam dump [オプション]


オプション

dump ファイル名パラメーターサーバーの内容をYAMLフォーマットで指定されたファイルへ書き込む。
dump ファイル名 名前空間パラメーターサーバーの指定された名前空間の内容をファイルへ書き込む。
-v詳細情報を表示する。


使用例




rosparam get

説明

パラメータの値を取得します。


構文

rosparam get [オプション]


オプション

get パラメータ名パラメータの値を取得する。
-p
-v詳細情報を表示する。

使用例




rosparam list

説明

パラメータ名を表示します。


構文

rosparam list [オプション]


オプション

list全てのパラメータ名を表示する。
list 名前空間名指定された名前空間の全てのパラメータ名を表示する。


使用例




rosparam load

説明

YAMLフォーマットのファイルの内容をパラメーターサーバーへ読込みます。


構文

rosparam load [オプション]


オプション

load ファイル名YAMLフォーマットのファイルの内容をパラメーターサーバーへ読込む。
load ファイル名 名前空間YAMLフォーマットのファイルの内容をパラメーターサーバーの指定された名前空間へ読込む。
-v詳細情報を表示する。


使用例




rosparam set

説明

パラメータへ値を設定します。


構文

rosparam set [オプション]


オプション

set パラメータ名 パラメータ パラメータ値指定したパラメータへ値を設定する。
set 名前空間 パラメータ値指定した名前空間の全パラメータへ同じ値を設定する。
-v詳細表示する。
-t テキストファイル名, --textfile テキストファイル名テキストファイルの内容でパラメータを設定する。
-b バイナリ―ファイル名, --binfile バイナリ―ファイル名 XML-RPCバイナリ―タイプで記載されたバイナリ―ファイルの内容でパラメータを設定する。


使用例




rospd

説明

ros版のpushdです。
カレントディレクトリをディレクトリスタックに保存して指定されたディレクトリへ移動します。
引数にディレクトリスタック番号を指定することにより元のディレクトリへ戻ることが出来ます。


構文

rospd 移動先ディレクトリ名、又は戻り先のディレクトリスタック番号


オプション

なし


使用例




rosd

説明

ディレクトリスタックを表示します。
その後、rospdを使って表示されたディレクトリへ移動します。


構文

rosd


オプション

なし


使用例




rosrun

説明

フルパスを指定することなくパッケージ名と実行ファイル名だけでノードを起動出来ます。


構文

rosrun パッケージ名 実行ファイル名


オプション

rosrun パッケージ名 実行ファイル名 _パラメータ名:=パラメータ値パラメータを与えてノードを起動する。(パラメータ名の前に"_"を付ける。)


使用例




rosservice args

説明

サービスの引数を表示します。


構文

rosservice args [オプション]


オプション

args サービス名指定されたサービスの引数を表示する。


使用例




rosservice call

説明

サービスを起動します。


構文

rosservice call [オプション]


オプション

call サービス名 [サービス引数]指定されたサービスを指定された引数で起動する。
--waitサービスが起動するまで待つ。


使用例




rosservice find

説明

指定されたサービスタイプに一致するサービスを表示します。


構文

rosservice find [オプション]


オプション

find サービスタイプ名指定されたサービスタイプに一致するサービスを表示する。


使用例




rosservice info

説明

サービスの情報を表示します。


構文

rosservice info [オプション]


オプション

info サービス名指定されたサービスの情報を表示する。


使用例




rosservice list

説明

利用可能な全サービスを表示します。


構文

rosservice list [オプション]


オプション

list現時点で利用可能な全サービスを表示する。
list 名前空間名指定した名前空間の全サービスを表示する。
-nサービスを実装したノード名も表示する。


使用例




rosservice node

説明

サービスを提供しているノードを表示します。


構文

rosservice node [オプション]


オプション

node サービス名指定されたサービスを提供しているノード名を表示する。


使用例




rosservice type

説明

サービスのタイプ名を表示します。


構文

rosservice type [オプション]


オプション

type サービス名指定されたサービスのタイプ名を表示する。


使用例




rosservice uri

説明

サービスのURIを表示します。


構文

rosservice uri [オプション]


オプション

uri サービス名指定されたサービスのURIを表示する。


使用例




rossrv show

説明

サービスデータタイプの詳細(構造)を表示します。


構文

rossrv show [オプション]


オプション

showサービスデータタイプ名


使用例




rosstack

説明

ファイルシステム内にあるROSスタックの情報を収集し表示する。


構文

rosstack


オプション

なし


使用例




rostopic bw

説明

トピックが使っているバンド幅[バイト/秒]を表示します。


構文

rostopic bw [オプション]


オプション

bw トピック名指定されたトピックが使っているバンド幅[バイト/秒]を表示する。


使用例




rostopic echo

説明

トピックに発行されているメッセージを表示します。


構文

rostopic echo [オプション]


オプション

echo トピック名指定されたトピックに発行されているメッセージを表示する。
echo トピック名/フィールド名トピックの指定されたフィールドのみ表示する。
--offset
--filter指定されたPython式に一致するメッセージのみを表示する。
-cメッセージが発行される毎にスクリーンをクリアする。
-bバッグファイルにあるメッセージを表示する。
-pmatlab/octave描画フォーマットのメッセージを表示する。
--nostr, --noarr指定された文字列、アレイフィールドを描画出力から除く。
-n カウント数カウント数分のメッセージを表示する。


使用例




rostopic hz

説明

トピックが使っているバンド幅[Hz]を表示します。


構文

rostopic hz [オプション]


オプション

hz トピック名指定されたトピックが使っているバンド幅[Hz]を表示する。バンド幅は平均値が表示される。
--filter FILTER_EXPR
^

使用例




rostopic info

説明

トピックを流れるメッセージのタイプを表示します。


構文

rostopic info [オプション]


オプション

list現在使用中のトピックを表示する。
list 名前空間名名前空間が一致するトピックのみを表示する。
-bバッグファイルにあるトピックを表示する。
-pパブリッシャーのみを表示する。
-sサブスクライバ―のみを表示する。
-v詳細表示する。
--hostホスト毎にグループ表示する。


使用例




rostopic list

説明

現在使用中のトピックを表示します。


構文

rostopic list [オプション]


オプション

list 現在使用中のトピックを表示する。
list 名前空間名名前空間が一致するトピックのみを表示する。
-bバッグファイルにあるトピックを表示する。
-pパブリッシャーのみを表示する。
-sサブスクライバ―のみを表示する。
-v詳細表示する。
--hostホスト毎にグループ表示する。


使用例




rostopic pub

説明

指定されたメッセージタイプのメッセージを指定された周期でトピックへ発行します。
メッセージを送る方法として以下の3つがあります。
(1)コマンドラインの引数で設定(ディフォルトはラッチモード)
$ rostopic pub my_topic std_msgs/String "hello there"
(2)パイプで入力(ディフォルト周期は10Hz)
$ rostopic echo chatter | rostopic pub bar std_msgs/String
(3)YAMLデータファイルで発行(ディフォルト周期は10Hz)
以下の1行目のコマンドでメッセージを記録した後にCtrl+Cで止め、2行目の
コマンドで、その内容を発行します。
$ rostopic echo chatter > chatter.bagy
$ rostopic pub -f chatter.bagy bar std_msgs/String


構文

rostopic pub [オプション]


オプション

pub トピック名 メッセージタイプ名 [メッセージデータ...]データをトピックへ発行する。
-l, --latchラッチモードを有効にする。(コマンドラインで引数を使う時はディフォルトでラッチモードになる。)
-r 周期レートモードを有効にし、周期を設定する。(パイプ入力やファイル入力を使う場合、周期はディフォルトで10Hzになる。)
-1, --once単発モードを有効にする。
-f YAMLファイル名AMLファイルからメッセージを読み出してトピックへ発行する。


使用例




rostopic type

説明

トピックタイプを表示します。


構文

rostopic type [オプション]


オプション

type トピック名指定されたトピックのトピックタイプを表示する。


使用例




rosversion

説明

スタックのバージョンを表示します。


構文

rosversion


オプション

なし


使用例




roswtf

説明

Pythonプログラムの不具合を見つけるツールを起動します。


構文

roswtf


オプション

なし


使用例




rqt

説明

GUIツールを起動します。ツールを使う前にマスターを起動しておく必要があります。
rqtの使い方はGUIツールを参照ください。


構文

rqt


オプション

なし


使用例





inserted by FC2 system