差分

この文書の現在のバージョンと選択したバージョンの差分を表示します。

--- yp-spur:how-to-use [2014/10/16 14:33]
rpp
+++ yp-spur:how-to-use [2014/10/31 07:18] (現在)
rpp
@@ ライン 1: / ライン 1: @@
-======ypspur-coodinator======
+====== 使い方 ======
-YP-Spurの本体。これがマイコンとの通信・オドメトリ計算・走行制御を行なっている。\\
-起動するには
+===== ypspur-coodinator =====
+YP-Spurの本体。これがマイコンとの通信・オドメトリ計算・走行制御を行なっている。
+起動するには,
   $ ypspur-coordinator -p [ロボットのパラメータファイル] -d [マイコンとの通信デバイス]
   ex) $ ypspur-coordinator -p M1.param -d /dev/ttyACM0
-Spurコマンドを利用したユーザのプログラムを使う前に、ypspur-coordinatorを立ち上げる必要がある。\\
+Spurコマンドを利用したユーザのプログラムを使う前に、ypspur-coordinatorを立ち上げる必要がある。
-===== ロボットの走行テスト  =====
+==== ロボットの走行テスト  ====
-<color red>※ロボットが走り出しますので地面において、ロボットにパソコンを置いて実行して下さい</color>
-  * terminalを2つ開く
+<color red>※ロボットが走り出しますので地面において、ロボットにパソコンを置いて実行して下さい。</color>
-  * 一つ目のターミナルで以下を実行
+  * terminalを2つ開く。
+  * 一つ目のターミナルで以下を実行。
   $ ypspur-coordinator -p (使っているロボット用のパラメータファイル) -d （マイコンとの通信デバイス）
   (例) ypspur-coordinator -p beego.param -d /dev/ttyACM0
-  * 二つ目のターミナルで以下を実行
+  * 二つ目のターミナルで以下を実行。
-  * <color red>※ロボットが1m程度前進するので、ロボットの前には何も無いところで実行して下さい</color>
+  * <color red>※ロボットが1m程度前進するので、ロボットの前には何も無いところで実行して下さい。</color>
   $ cd yp-spur-【YP-Spurのバージョン】/samples/
   $ ./run-test
-これがサンプルプログラムになります\\
+これがサンプルプログラムになります。このプログラムを参考にプログラミングして下さい。
-このプログラムを参考にプログラミングして下さい。
-===== オプション  =====
-** ''-v, --version'' **\\
-ypspur-coordinatorのバージョン表示
-** ''-d, --device <device>'' **\\
+==== オプション ====
-マイコンとの通信ポートを指定\\
+**-v, %%--%%version**
+ypspur-coordinatorのバージョン表示。
+**-d, %%--%%device <device>**
+マイコンとの通信ポートを指定。
 デフォルト（指定しないとき）は/dev/ttyUSB0
-** ''-p, --param <file>'' **\\
+**-p, %%--%%param <file>**
-ロボットのパラメータファイルを指定\\
-デフォルト（指定しないとき）ではrobot.param\\
-カレントディレクトリ、/usr/local/share/robot-params/の順でパラメータファイルを探す。\\
-インストールしておけばフルパスを入力しなくても良いので、少し便利かも
-** ''--verbose'' **\\
+ロボットのパラメータファイルを指定。
-ターミナル出力の詳細表示
-** ''--quiet'' **\\
+デフォルト（指定しないとき）ではrobot.param、カレントディレクトリ、/usr/local/share/robot-params/の順でパラメータファイルを探す。
-ターミナル出力の最小限表示
-** ''-h, --help'' **\\
+インストールしておけばフルパスを入力しなくても良いので、少し便利かも。
-ヘルプ表示
-** ''--long-help'' **
+**%%--%%verbose**
-隠しオプションも含めたヘルプ表示
-** ''--param-help'' **
+ターミナル出力の詳細表示。
-パラメータファイルの説明表示
+**%%--%%quiet**
-===== 隠しオプション  =====
+ターミナル出力の最小限表示。
-隠していないけど、隠しオプション。\\
-デバッグ用や現在作成中なオプション達です。\\
-動かないからといって文句は言わないでね。
-** ''-o, --show-odometry'' **\\
+**-h, %%--%%help**
-オドメトリを表示
-** ''-t, --show-timestamp'' **\\
+ヘルプ表示。
-B-Locoとの通信が正常にできていると数回に１回そのときのUnixTimeを表示
-** ''--reconnect'' **\\
+**%%--%%long-help**
-接続が切れたときに自動的に再接続する\\
-再接続後、オドメトリ情報は保持される
+隠しオプションも含めたヘルプ表示。
+**%%--%%param-help**
+パラメータファイルの説明表示。
+==== 隠しオプション  ====
+隠していないけど、隠しオプション。デバッグ用や現在作成中なオプション達です。
+**-o, %%--%%show-odometry**
+オドメトリを表示。
+**-t, %%--%%show-timestamp**
+B-Locoとの通信が正常にできていると数回に１回そのときのUnixTimeを表示。
+**%%--%%reconnect**
+接続が切れたときに自動的に再接続する。
+再接続後、オドメトリ情報は保持される。
+**%%--%%without-ssm**
-** ''--without-ssm'' **\\
 Run without ssm output.
-** ''-q, --msq-key <MSQKEY>'' **\\
+**-q, %%--%%msq-key <MSQKEY>**
-プロセス間通信のkeyをMSQKEYに設定\\
-デフォルトでは（たぶん）0x7045(28741@10進)に設定\\
+プロセス間通信のkeyをMSQKEYに設定。
-指定するときは&color(#ff0000){10進数};で指定する\\
-これを使用することで、 １つのPCで複数のYP-Spurを制御できるようになる
+デフォルトでは（たぶん）0x7045(28741@10進)に設定。
+指定するときは<color red>10進数</color>で指定する。
+これを使用することで、 １つのPCで複数のYP-Spurを制御できるようになる。
+**-s, %%--%%speed <BAUDRATE>**
+マイコンとの通信の速度を設定する。
+マイコンのクロックの分周の関係で使えない速度もあり。
+**%%--%%admask <ADMASK>**
+読み込むADのポート番号を指定。
+たとえばAD0とAD5を使うなら %%--%%admask 00100001
+詳細は[[yp-spur:tips:get-ad]]
+**%%--%%enable-get-digital-io**
+デジタルIOポートの読み込みを使用する。
+詳細は[[yp-spur:tips:get-digial-io]]
+**-c, %%--%%without-contro l**
+テスト用の制御無しモード。
+B-Locoとの接続は確立するが、制御はかけない。
+**%%--%%without-device**
+テスト用のデバイス無しモード。
+**%%--%%no-yp-protocol**
+マイコンとの通信で、YPプロトコルかどうかの確認を行わない。
-** ''-s, --speed <BAUDRATE>'' **\\
+sh-velのバージョンが変わると危険な動作を引き起こす可能性有り。
-マイコンとの通信の速度を設定する. マイコンのクロックの分周の関係で使えない速度もあり
-** ''--admask <ADMASK>'' **\\
+デバッグ専用。
-読み込むADのポート番号を指定. たとえばAD0とAD5を使うなら --admask 00100001\\
-詳細は[[index:yp-spur:tips:get-ad]]
-** ''--enable-get-digital-io'' **\\
+**%%--%%update-param**
-デジタルIOポートの読み込みを使用する\\
-詳細は[[index:yp-spur:tips:get-digial-io]]
-** ''-c, --without-contro l'' **\\
+パラメータファイルの更新を監視して、変更があったときに自動的に再読込・適用する。
-テスト用の制御無しモード\\
-B-Locoとの接続は確立するが、制御はかけない
-** ''--without-device'' **\\
+**%%--%%high-resolution**
-テスト用のデバイス無しモード
-** ''--no-yp-protocol'' **\\
+速度制御の分解能を細かくし、極低速での走行を可能にする。
-マイコンとの通信で、YPプロトコルかどうかの確認を行わない\\
-sh-velのバージョンが変わると危険な動作を引き起こす可能性有り\\
-デバッグ専用
-** ''--update-param'' **\\
+**%%--%%passive**
-パラメータファイルの更新を監視して、変更があったときに自動的に再読込・適用する
-** ''--high-resolution'' **\\
+並進方向に力を出さずに、人間が押した力を利用して旋回方向のトルクのみ出力する。
-速度制御の分解能を細かくし、極低速での走行を可能にする
-** ''--passive'' **\\
+**%%--%%enable-set-bs**
-並進方向に力を出さずに、人間が押した力を利用して旋回方向のトルクのみ出力する
-** ''--enable-set-bs'' **\\
+BS座標の書き換え許可、使用しないこと。
-BS座標の書き換え許可、使用しないこと