コレグラフボックスライブラリ一覧【Multimedia】（ver. 2.3.0）


コレグラフボックスライブラリ一覧（ver. 2.3.0）

Creation Date : 2015/5/19
Last Modified Date : 2015/5/20
 [robot start inc.](http://robotstart.co.jp/ "robot start inc.")
-------------------------------------------------------------------------------

-------------------------------------------------------------------------------
###▼Multimedia（マルチメディア）
-------------------------------------------------------------------------------
###　▼Internet（インターネット）
##　　　■Fetch E-mail（Eメール取得）
　　　　　- サーバーから新しいEメールを取得します。
　　　　　　サーバをセットするためのパラメータを設定します。
　　　　　　注：必ずPOPがサーバーで有効になっていることを確認してください。
　　　　　　例えば、Gmailなら、「設定」＞「メール転送とPOP/ IMAP」で
　　　　　　「オプションを選択 」＞「今から到着のメールでPOPを有効にする」
　　　　　　＞「変更を保存」
　　　　　　警告：パスワードは暗号化や非表示にはできません。
　　　　　　そのため、安全に使うためにはロボットのための電子メールアカウントを
　　　　　　作成する必要があります。

　　　　　　入力：onFetch（バン）

　　　　　　出力：onEmails（文字列）
　　　　　　　　　onError（文字列）

　　　　　　ボックス設定：なし

　　　　　　パラメータ：Eメールアドレス
　　　　　　　　　　　　パスワード
　　　　　　　　　　　　POPアドレス
　　　　　　　　　　　　ポート番号（995、110）
　　　　　　　　　　　　SSL有効化有無
　　　　　　　　　　　　最後のメールのみ有無

##　　　■Send E-mail（Eメールを送信）
　　　　　- Eメールを送信します。
　　　　　　送信する前に電子メールの全てのパラメータを設定する必要があります。
　　　　　　警告：パスワードは暗号化や非表示にはできません。
　　　　　　そのため、快適に使うためにはロボットのための電子メールアカウントを
　　　　　　作成する必要があります。

　　　　　　入力：onSend（バン）

　　　　　　出力：onSent（バン）
　　　　　　　　　onError（文字列）

　　　　　　ボックス設定：なし

　　　　　　パラメータ：送信元メールアドレス
　　　　　　　　　　　　パスワード
　　　　　　　　　　　　送信先メールアドレス
　　　　　　　　　　　　メールタイトル
　　　　　　　　　　　　メール本文
　　　　　　　　　　　　添付ファイル
　　　　　　　　　　　　SMTPアドレス
　　　　　　　　　　　　ポート番号（587、465）
 
--------------------------
###　▼Sound（音）
##　　　■Play Sound（音声再生）
　　　　　- サウンドファイルを再生します。
　　　　　　再生可能なファイル形式はバーチャルロボット上ではwavとoggの２種類、
　　　　　　実際のロボットではmp3も可能です。
　　　　　　注：ロボットがoggやmp3を再生するときに遅延が発生する場合があります。
　　　　　　遅延無く音声ファイルを再生したいときはwavファイル推奨。

　　　　　　入力：onStart（バン）
　　　　　　　　　onStop（バン）

　　　　　　出力：onStopped（バン）

　　　　　　ボックス設定：なし

　　　　　　パラメータ：ファイル名（ファイル選択）
　　　　　　　　　　　　スタート位置（秒）
　　　　　　　　　　　　ボリューム（%）
　　　　　　　　　　　　左右バランス
　　　　　　　　　　　　ループ有無

##　　　■Record Sound（スピーカー音量調整）
　　　　　- ロボットで音声を録音します。
　　　　　　ロボット前頭にある１つのマイクでogg形式録音か、４つのマイク
　　　　　　（前１つ、横２つ、後１つ）のマイクでwav形式録音を選ぶことができます。
　　　　　　もし「一時保存」がチェックされていない場合、出力音ファイルは
　　　　　　「/recordings/microphones/」にあります。
　　　　　　そうでなければ、テンポラリーディレクトリ（一時的なディレクトリ）にあります。
　　　　　　onStopped出力は録音の最後に出力され、出力音ファイルへの絶対パスが
　　　　　　含まれています。

　　　　　　入力：onStart（バン）
　　　　　　　　　onStop（バン）

　　　　　　出力：onStopped（文字列）

　　　　　　ボックス設定：なし

　　　　　　パラメータ：ファイル名（デフォルト値はrecording）
　　　　　　　　　　　　マイク設定（「前頭マイク（1つのみ）.ogg」
　　　　　　　　　　　　「4つのマイク（前1つ・横2つ・後1つ）.wav」）
　　　　　　　　　　　　一時保存（Temporary storage）有無
　　　　　　　　　　　　タイムアウト（秒）

　　　　　　参考ドキュメント：http://bit.ly/1vrUdWC
 
--------------------------
###　▼Tablet（タブレット）
##　　　■Hide Web View（ウェブを隠す）
　　　　　- タブレットでウェブ（HTMLコンテンツ）を隠します。

　　　　　　入力：onStart（バン）

　　　　　　出力：onStopped（バン）

　　　　　　ボックス設定：なし

　　　　　　パラメータ：なし

##　　　■Show App（アプリの表示）
　　　　　- もしアプリが存在している場合、タブレット内のアプリケーションを読み込みます。
　　　　　　そのアプリをwebviewで表示します。

　　　　　入力：onStart（バン）

　　　　　出力：onSuccess（バン）
　　　　　　　　onFailure（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：なし

##　　　■Show Image（画像を表示する）
　　　　　- 事前に読み込ませた画像(JPG/PNG/GIF)をディスプレイに表示します。
　　　　　画像ファイルをhtmlディレクトリを作成した上で、インポート。
　　　　　パラメータボタンをクリックし、ImageUrlに画像ファイル名を入力
　　　　　すると表示されます。
　　　　　（ビヘイビアをディレクトリ外に移動するおまじないが必要です。）

　　　　　入力：onStart（バン）
　　　　　　　　onStop（バン）
　　　　　　　　onHideImage（バン）
　　　　　　　　onPreLoadImage（バン）

　　　　　出力：onStopped（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：画像URL

##　　　■Show Web View（ウェブの表示）
　　　　　- タブレットでウェブ（HTMLコンテンツ）を表示します。

　　　　　入力：onStart（バン）

　　　　　出力：onStopped（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：なし

--------------------------
###　▼Video（ビデオ）
##　　　■Play Video（動画を再生）
　　　　　- 動画を再生します。
　　　　　割り込み、一時停止、ビデオを再開ができます。
　　　　　ビデオが開始または終了するときに、イベントを取得することができます。
　　　　　（ビヘイビアをディレクトリ外に移動するおまじないが必要です。）

　　　　　入力：onStart（バン）
　　　　　　　　onStop（バン）
　　　　　　　　onPauseVideo（バン）
　　　　　　　　onResumeVideo（バン）

　　　　　出力：onStarted（バン）
　　　　　　　　onStopped（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：動画パス

##　　　■Record Video（ビデオ録画）
　　　　　- ビデオ録画を行います。
　　　　　　パラメーターで設定した時間が経過すると録画を停止します。
　　　　　　デフォルトでは、動画は「/home/nao/recordings/cameras.」に保存されます。

　　　　　　入力：onStart（バン）
　　　　　　　　　onStop（バン）

　　　　　　出力：onStopped（バン）

　　　　　　ボックス設定：なし

　　　　　　パラメータ：ファイル名（デフォルト値はrecording）
　　　　　　　　　　　　録画時間（秒）
　　　　　　　　　　　　解像度（160x120、320x240、640x480）
　　　　　　　　　　　　フレームレート（フレーム/秒）
　　　　　　　　　　　　フォーマット（MJPG、IYUV）
　　　　　　　　　　　　カメラ（デフォルト、トップ、ボトム）
 
-------------------------------------------------------------------------------
###▼Movement（動き）
-------------------------------------------------------------------------------
###　▼Motors（モーター）
##　　　■Hands（手）
　　　　　- ロボットの片手か両手が開いたり閉じたりできるようにモータを固くします。
　　　　　　手のモーターは緩和します。

　　　　　　入力：onStart（バン）

　　　　　　出力：onDone（バン）

　　　　　　ボックス設定：なし

　　　　　　パラメータ：手部位（両方、左、右）
　　　　　　　　　　　　動作（手を開く、手を閉じる）

##　　　■Motor Heat（モーターヒート）
　　　　　- モーターの温度を監視し、熱いか冷たいかを通知します。

　　　　　　入力：onStart（バン）
　　　　　　　　　onStop（バン）

　　　　　　出力：onStopped（バン）
　　　　　　　　　onHot（バン）
　　　　　　　　　onCold（バン）

　　　　　　ボックス設定：なし

　　　　　　パラメータ：モーター名（体全体、腕、頭、右足など）
　　　　　　　　　　　　低温限界（℃）
　　　　　　　　　　　　高温限界（℃）
　　　　　　　　　　　　更新頻度（秒）

##　　　■Motor On/Off（モーターのon/off）
　　　　　- 全てのモーターを固くしたり緩めたりします。

　　　　　入力：onSet（バン）

　　　　　出力：onReady（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：動作（オン、オフ）

##　　　■Rest（休憩）
　　　　　- ロボットが立っていても、全ての間接を柔らかくしてしゃがむ姿勢をとります。

　　　　　入力：onStart（バン）
　　　　　　　　onStop（バン）

　　　　　出力：onStopped（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：なし

##　　　■Set Stiffness（固さをセット）
　　　　　- パラメーターからモーターの固さをセレクトできます。

　　　　　入力：onSet（バン）

　　　　　出力：onReady（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：頭有無
　　　　　　　　　　　左手有無
　　　　　　　　　　　右手有無
　　　　　　　　　　　左足有無
　　　　　　　　　　　右足有無
　　　　　　　　　　　モーターの硬さ（%）
　　　　　　　　　　　持続時間（秒）

##　　　■WakeUp（目覚める）
　　　　　- ロボットが全ての間接を固くして立つポーズをとります。

　　　　　入力：onStart（バン）
　　　　　　　　onStop（バン）

　　　　　出力：onStopped（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：なし

--------------------------
###　▼Navigation（ナビゲーション）
##　　　■Compass Move To（コンパスの動き）
　　　　　- 現在の場所からの相対構成されたポイントへロボットを動かすことができます。
　　　　　ずれを補正するためにカメラを使用します。

　　　　　入力：onStart（バン）
　　　　　　　　onStop（バン）

　　　　　出力：onStopped（バン）
　　　　　　　　failure（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：X距離
　　　　　　　　　　　Y距離
　　　　　　　　　　　角度

##　　　■Move Along（軌跡に沿って移動）
　　　　　- 添付の.pmtファイルによって与えられた軌跡に沿って移動します。

　　　　　入力：onStart（バン）
　　　　　　　　onStop（バン）

　　　　　出力：success（バン）
　　　　　　　　failure（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：平面移動軌跡（ファイル指定）

##　　　■Move To（〜へ移動）
　　　　　- 現在位置からパラメータダイアログで指定した座標分移動します。

　　　　　入力：onStart（バン）
　　　　　　　　onStop（バン）

　　　　　出力：onArrivedAtDestination（バン）
　　　　　　　　onStoppedBeforeArriveing（ダイナミック）

　　　　　ボックス設定：なし

　　　　　パラメータ：距離X（m）
　　　　　　　　　　　距離Y（m）
　　　　　　　　　　　角度（ラジアン）
　　　　　　　　　　　腕の動きの有効化有無

##　　　■Move Toward（〜の方向へ移動）
　　　　　- パラメータで設定した方向にロボットを移動させます。
　　　　　なおこの場合、ロボットは自分で移動を停止しません。
　　　　　終了する座標（x,y）をセットするか、0かストップするためのボックスで
　　　　　制御する必要があります。
　　　　　注：パラメーターで移動方向のアップデート期間を設定することもできます。

　　　　　入力：onStart（バン）
　　　　　　　　onStop（バン）

　　　　　出力：onStopped（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：X
　　　　　　　　　　　Y
　　　　　　　　　　　角度
　　　　　　　　　　　方向アップデートの期間（秒）
　　　　　　　　　　　腕の動きの有効化有無

##　　　■Obstacle Avoidance（障害物を回避）
　　　　　- ロボットがそのまま前に進むと障害物があるときに右折します。

　　　　　入力：onStart（バン）
　　　　　　　　onStop（バン）

　　　　　出力：onStopped（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：なし

##　　　■Walk Toward（向かって歩く）
　　　　　- パラメーターで指定したい方向にロボットが歩きます。
　　　　　勝手には止まりませんので、停止させるならボックスで停止させる必要があります。
　　　　　また、パラメータで歩行方向のアップデートの期間を設定することができます。

　　　　　入力：onStart（バン）
　　　　　　　　onStop（バン）

　　　　　出力：なし

　　　　　ボックス設定：なし

　　　　　パラメータ：X
　　　　　　　　　　　Y
　　　　　　　　　　　角度
　　　　　　　　　　　ステップ頻度
　　　　　　　　　　　左腕有効化有無
　　　　　　　　　　　右腕有効化有無、
　　　　　　　　　　　足の接触が失われたときに歩行を停止の有無
　　　　　　　　　　　方向の更新期間（秒）

--------------------------
###　▼Oriented（方向）
##　　　■Look At（見る）
　　　　　- 様々なモードでロボットが希望の位置を見ます。

　　　　　入力：onStart（バン）
　　　　　　　　onStop（バン）

　　　　　出力：onStopped（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：X（m）
　　　　　　　　　　　Y（m）
　　　　　　　　　　　Z（m）
　　　　　　　　　　　速度（%）
　　　　　　　　　　　体全体有無
　　　　　　　　　　　フレーム（Torso、World、Robot）

##　　　■Point At（指差し）
　　　　　- 様々なモードでロボットが希望の位置を指差します。

　　　　　入力：onStart（バン）
　　　　　　　　onStop（バン）

　　　　　出力：onStopped（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：X（m）
　　　　　　　　　　　Y（m）
　　　　　　　　　　　Z（m）
　　　　　　　　　　　速度（%）
　　　　　　　　　　　エフェクター（両腕、左腕、右腕）
　　　　　　　　　　　フレーム（Torso、World、Robot）

 --------------------------
###　▼Posture（姿勢）
##　　　■Apply Posture（姿勢を適用）
　　　　　- ロボットの関節を直接動かして姿勢を作ることができます。

　　　　　入力：onStart（バン）
　　　　　　　　onStop（バン）

　　　　　出力：success（バン）
　　　　　　　　failure（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：名称（標準、座る、リラックスして座る、など）
　　　　　　　　　　　速度（ %）

##　　　■GoTo Posture（ポーズをとる）
　　　　　- 現在の姿勢から、お願いされた姿勢にロボットが動きます。

　　　　　入力：onStart（バン）
　　　　　　　　onStop（バン）

　　　　　出力：success（バン）
　　　　　　　　failure（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：名称（標準、座る、リラックスして座る、など）
　　　　　　　　　　　速度（%）
　　　　　　　　　　　最大試行回数

##　　　■Posture Family（姿勢）
　　　　　- ロボットの姿勢の名前の文字列を返します。

　　　　　入力：onGet（バン）

　　　　　出力：postureFamily（文字列）

　　　　　ボックス設定：なし

　　　　　パラメータ：なし

##　　　■Robot Posture（ロボットの姿勢）
　　　　　- ロボットの姿勢が変わる度に、変化する値が変化するの名前を返します。

　　　　　入力：onStart（バン）
　　　　　　　　onStop（バン）

　　　　　出力：onStopped（バン）
　　　　　　　　posture（文字列）

　　　　　ボックス設定：なし

　　　　　パラメータ：更新頻度（秒）

##　　　■Sit Down（座る）
　　　　　- ロボットが現在どんな姿勢であっても、その場で座ります。

　　　　　入力：onStart（バン）
　　　　　　　　onStop（バン）

　　　　　出力：success（バン）
　　　　　　　　failure（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：なし

##　　　■Stand Up（立ち上がる）
　　　　　- ロボットが現在どんな姿勢であっても、その場で立ち上がります。
　　　　　試行回数はパラメーターでセットすることができます。

　　　　　入力：onStart（バン）
　　　　　　　　onStop（バン）

　　　　　出力：success（バン）
　　　　　　　　failure（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：最大試行回数

--------------------------
###　▼Safety（安全）
##　　　■Fall Detector（落下感知）
　　　　　- ロボット、プロセスが落ちていないかをチェックします。
　　　　　robotHasFallen出力は、ロボットが落ちた時間を完治した後、0.5秒出力します。

　　　　　入力：onStart（バン）
　　　　　　　　onStop（バン）

　　　　　出力：onStopped（バン）
　　　　　　　　robotHasFallen（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：なし

##　　　■Is In Collision （衝突）
　　　　　- 選択された身体の部分がロボットの体の他の部分と衝突しているかを検知します。

　　　　　入力：onAsk（バン）

　　　　　出力：none（バン）
　　　　　　　　near（バン）
　　　　　　　　collision（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：ボディ部位（両腕、左腕、右腕）

##　　　■Set External Anti-Collision（外部衝突防止）
　　　　　- ロボットの外部衝突保護を有効/無効のいずれかにセットすることができます。
　　　　　例えば、ロボットの右腕で保護が有効になっている場合、
　　　　　腕を動かしすことで衝突を防止します。

　　　　　入力：onSet（バン）

　　　　　出力：output（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：体の部品（両腕、左腕、右腕）
　　　　　　　　　　　動き（有効化、無効化）

##　　　■Set Fall Manager（落下監視）
　　　　　- ロボットの落下監視を有効/無効のいずれかにセットすることができます。
　　　　　このボックスが停止されると、自動的に元の状態に設定されます。

　　　　　入力：onSet（バン）

　　　　　出力：onDone（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：動き（有効化、無効化）

##　　　■Set Self Anti-Collision（自己衝突防止）
　　　　　- ロボットの自己衝突保護を有効/無効のいずれかにセットすることができます。
　　　　　例えば、ロボットの右腕で保護が有効になっている場合、
　　　　　腕を動かすことで衝突を防止します。

　　　　　入力：onSet（バン）

　　　　　出力：success（バン）
　　　　　　　　failure（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：体の部品（両腕、左腕、右腕）
　　　　　　　　　　　動き（有効化、無効化）

-------------------------------------------------------------------------------