コレグラフボックスライブラリ一覧【Programming】（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.")
-------------------------------------------------------------------------------

-------------------------------------------------------------------------------
###▼Programming（プログラミング）
-------------------------------------------------------------------------------
###　▼Behavior Control（行動管理）
##　　　■Behavior State（行動の状態）
　　　　　- 行動の状態に応じて、異なる出力を返します。

　　　　　入力：checkBehaviorState（文字列）

　　　　　出力：behaviorRunning（文字列）
　　　　　　　　behaviorStopped（文字列）
　　　　　　　　behaviorNotInstalled（文字列）

　　　　　ボックス設定：なし

　　　　　パラメータ：なし

##　　　■Run Behavior（行動の実行）
　　　　　- 行動を管理します。
　　　　　onStartに入力されると動作を開始します。onStopに入力されると、動作を停止します。
　　　　　動作開始〜終了時にエラーが起きなければ、onStoppedを出力します。
　　　　　もし、エラーが発生した場合はエラー内容の説明を送信し、onErrorを出力します。

　　　　　入力：onStart（文字列）
　　　　　　　　onStop（バン）

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

　　　　　ボックス設定：なし

　　　　　パラメータ：なし

##　　　■Start Behavior（行動をスタート）
　　　　　- インプットされた名前の行動をスタートします。

　　　　　入力：startBehavior（文字列）

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

　　　　　ボックス設定：なし

　　　　　パラメータ：なし

##　　　■Stop Behavior（行動をストップ）
　　　　　- 引数として指定された動作を停止します。

　　　　　入力：stopBehavior（文字列）

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

　　　　　ボックス設定：なし

　　　　　パラメータ：なし
 
--------------------------
###　▼Data Edition （データ編集）
##　　　■Angle Edit（角度の編集）
　　　　　- 角度を出力します。角度の値はボックス設定で行った単位で出力されます。

　　　　　入力：onStart（バン）

　　　　　出力：onStopped（数）

　　　　　ボックス設定：角度
　　　　　　　　　　　　角度の単位（度、ラジアン）

　　　　　パラメータ：なし

##　　　■Get Parameter（パラメーターの取得）
　　　　　- 親ボックスパラメーターの値を取得します。
　　　　　このボックスのパラメーターであなたが返してほしいパラメータの名前を
　　　　　セットします。
　　　　　独自ボックスにパラメータ定義を追加した後に使います。

　　　　　入力：onGet（バン）

　　　　　出力：onData（ダイナミック）

　　　　　ボックス設定：なし

　　　　　パラメータ：パラメーター名

##　　　■Multi Edit（様々な編集）
　　　　　- ボックスに値を送ることができます。
　　　　　（pythonの言語タイプ：string, int, float, arrayなどがセット可能です。）
　　　　　ライン上で左ダブルクリックをして値を編集することができます。
　　　　　ライン上で右クリックすると１行追加でき、値を加えることができます。
　　　　　ライン上で右クリックすると１行削除でき、値を消すことができます。

　　　　　入力：input1（バン）
　　　　　　　　input2（バン）
　　　　　　　　（増やせます）

　　　　　出力：onStopped（ダイナミック）

　　　　　ボックス設定：複数の値が入力可能なフィールド

　　　　　パラメータ：なし

##　　　■Number Edit（番号の編集）
　　　　　- インプットがあると入力された番号を出力します。

　　　　　入力：onStart（バン）

　　　　　出力：onStopped（数）

　　　　　ボックス設定：１つの数値が入力可能なフィールド

　　　　　パラメータ：なし

##　　　■Text Edit（テキスト文字の編集）
　　　　　- インプットがあると入力されたテキストを出力します。

　　　　　入力：onStart（バン）

　　　　　出力：onStopped（文字列）

　　　　　ボックス設定：テキストが入力可能なフィールド

　　　　　パラメータ：なし
 
--------------------------
###　▼Logic（論理式）
##　　　■Counter（カウンター）
　　　　　- カウンタを表示します。
　　　　　onNextに入力されるたびに、カウンターの値がcurrentValueの出力に送られ、
　　　　　パラメータで指定したStep値に応じて初期値から最終値まで加減されます。
　　　　　いったん、カウンター値はその最終値より高くなった後、
　　　　　onReinitializedが出力され、カウンターは初期値に再設定されます。
　　　　　onInitに入力するとカウンターを再初期化することができます。

　　　　　入力：onNext（バン）
　　　　　　　　onInit（バン）

　　　　　出力：currentValue（数）
　　　　　　　　onReinitialized（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：初期値
　　　　　　　　　　　ステップ値
　　　　　　　　　　　終了値

##　　　■If（IF文）
　　　　　- パラメータで指定した条件演算子を満たすかどうかの分岐を行います。

　　　　　入力：onData（ダイナミック）

　　　　　出力：output_then（バン）
　　　　　　　　output_else（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：条件演算子（＜、＜or＝、＝、＜or＝、＜、≠）
　　　　　　　　　　　value to compare（デフォルトでは0）

##　　　■Only Once（一回だけ実行）
　　　　　- 入力されると一回だけ実行されます。
　　　　　なおボックスを含むダイアグラムがアンロードされた時にはリセットされます。

　　　　　入力：onSignal（バン）

　　　　　出力：fisrtTime（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：なし

##　　　■Switch Case（入力切り替え）
　　　　　- 入力値をテストし、この値にあった出力を行います。
　　　　　もし入力がマッチしない場合、onDefaultが出力されます。　
　　　　　行で右ダブルクリックしてケースを編集することができます。
　　　　　行と選択を右クリックしてケースを追加できます。
　　　　　行と「削除したい行」を選択して、右クリックでケースを消すことができます。
　　　　　入力された値に対して、条件に応じて異なる出力を分岐させるために使います。
　　　　　文字列はダブルクォーテーション""でかこってセットします。

　　　　　入力：onStart（ダイナミック）

　　　　　出力：onDefault（バン）
　　　　　　　　output_1（ダイナミック）
　　　　　　　　output_2（ダイナミック）
　　　　　　　　（増やせます。）

　　　　　ボックス設定：複数の値が入力可能なフィールド

　　　　　パラメータ：なし

##　　　■Wait For Signals（シグナル待ち）
　　　　　- 2つの入力両方にシグナルが入力されるまで待ち、2つの入力があると自身から
　　　　　シグナルを出力します。停止条件の制御に利用できます。

　　　　　入力：signal1（バン）
　　　　　　　　signal2（バン）

　　　　　出力：signalsReceived（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：なし
 
--------------------------
###　▼Math（計算）
##　　　■Divide（割り算）
　　　　　- 最初の入力値で割り算を行い、結果を出力します。

　　　　　入力：Dividend（数）
　　　　　　　　Divisor（数）

　　　　　出力：output_Quotient（数）

　　　　　ボックス設定：なし

　　　　　パラメータ：なし

##　　　■Multiply（掛け算）
　　　　　- 最初の入力値で掛け算を行い、結果を出力します。

　　　　　入力：Multiplicand（数）
　　　　　　　　Multiplier（数）

　　　　　出力：output_Product（数）

　　　　　ボックス設定：なし

　　　　　パラメータ：なし

##　　　■Random Float（ランダム・浮動小数点数）
　　　　　- 最小値から最大値までランダムな浮動小数点数を生成します。

　　　　　入力：onStart（バン）

　　　　　出力：output_RandomValue（数）

　　　　　ボックス設定：なし

　　　　　パラメータ：最小値
　　　　　　　　　　　最大値

##　　　■Random Int.（ランダム・整数）
　　　　　- パラメータでセットした最小数と最大数の間でのランダムな整数を生成します。
　　　　　最小数と最大数は可能な値の範囲に含まれることに注意してください。

　　　　　入力：onStart（バン）

　　　　　出力：output_RandomValue（数）

　　　　　ボックス設定：なし

　　　　　パラメータ：最小値
　　　　　　　　　　　最大値
　　　　　　　　　　　シャッフル有無

--------------------------
###　▼Memory（メモリ）
##　　　■Get Data（データ取得）
　　　　　- NAOqiの共有メモリから与えられたキーで指定した値を取得します。

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

　　　　　出力：onStopped（ダイナミック）
　　　　　　　　onError（文字列）

　　　　　ボックス設定：なし

　　　　　パラメータ：キー（パス：デフォルトはMyApplication/MyData）

##　　　■Insert Data（データ挿入）
　　　　　- NAOqiの共有メモリから与えられたキーで指定された値を格納します。

　　　　　入力：onStart（ダイナミック）
　　　　　　　　onStop（バン）

　　　　　出力：onStopped（ダイナミック）
　　　　　　　　onError（文字列）

　　　　　ボックス設定：なし

　　　　　パラメータ：キー（パス：デフォルトはMyApplication/MyData）

##　　　■Raise Event（イベントが起こる）
　　　　　- NAOqiの共有メモリに与えられたキーで指定された値を格納し、
　　　　　そのすべてのサブスクライバーにイベントを拡散します。

　　　　　入力：onStart（ダイナミック）
　　　　　　　　onStop（バン）

　　　　　出力：onStopped（ダイナミック）
　　　　　　　　onError（文字列）

　　　　　ボックス設定：なし

　　　　　パラメータ：キー（パス：デフォルトはMyApplication/MyData）

##　　　■Remove Data / Event（データ/イベントを削除）
　　　　　- NAOqiの共有メモリから指定されたキーを削除します。

　　　　　入力：onStart（バン）

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

　　　　　ボックス設定：なし

　　　　　パラメータ：キー（パス：デフォルトはMyApplication/MyData）

##　　　■Subscribe to Event（イベントの予約）
　　　　　- NAOqiの共有メモリ内にイベントを予約します。
　　　　　サブスクライブされた時、出力はイベントが発生時に毎回トリガーとなります。

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

　　　　　出力：onStopped（バン）
　　　　　　　　onError（文字列）
　　　　　　　　enEvent（ダイナミック）

　　　　　ボックス設定：なし

　　　　　パラメータ：キー（パス：デフォルトはMyApplication/MyData）

##　　　■Expression Watcher（式の監視）【2.3】
　　　　　- ALExpressionWatcherへのインターフェイス。

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

　　　　　出力：onStopped（バン）
　　　　　　　　onConditionTriggered（ダイナミック）

　　　　　ボックス設定：なし

　　　　　パラメータ：Condition（デフォルトはbang(myEvent) && 'myEvent' == 1）
　　　　　　　　　　　Report mode（Any change、Any edge、Rising edge）

--------------------------
###　▼Robot Infomation（ロボットの情報）
##　　　■Battery（バッテリー）
　　　　　- バッテリーセンサーをチェックします。
　　　　　もしバッテリーレベルが非常に低い場合、onLow出力を行います。

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

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

　　　　　ボックス設定：なし

　　　　　パラメータ：なし

##　　　■Choregraphe Connection（コレグラフへの接続）
　　　　　- ロボットがChoregrapheの接続の有無を検知し、接続または切断された場合に
　　　　　　に出力を行います。

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

　　　　　　出力：onStopped（バン）
　　　　　　　　　output_connected（バン）
　　　　　　　　　output_not_connected（バン）

　　　　　　ボックス設定：なし

　　　　　　パラメータ：なし

##　　　■Get Body ID（ボディIDをゲットする）
　　　　　- ロボット本体のIDを取得します。

　　　　　入力：onGet（バン）

　　　　　出力：onData（文字列）

　　　　　ボックス設定：なし

　　　　　パラメータ：Full ID有無

##　　　■Get Date（日時取得）
　　　　　- ロボットのある地域の日時を取得できます。

　　　　　入力：onGet（バン）

　　　　　出力：onTime（数）

　　　　　ボックス設定：なし

　　　　　パラメータ：なし

##　　　■Get Name（名前取得）
　　　　　- ロボットの名前を返します。ロボットの名前はWEBページで変更可能です。

　　　　　入力：onGet（バン）

　　　　　出力：onData（文字列）

　　　　　ボックス設定：なし

　　　　　パラメータ：なし

##　　　■Get Temperature（温度計測）
　　　　　- パラメータで選択したハードウェアの温度を取得します。

　　　　　入力：onGet（バン）

　　　　　出力：onData（数）

　　　　　ボックス設定：なし

　　　　　パラメータ：ハードウェア部位（バッテリー、ヘッドプロセッサーなど）

##　　　■Has Hardware（ハードウェアチェック）
　　　　　- パラメータで設定したロボットのハードウェアについてチェックし、
　　　　　trueまたはfalseを出力します。

　　　　　入力：check（バン）

　　　　　出力：true（バン）
　　　　　　　　false（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：ボディ部位（腕、拡張腕、頭、レーザー、足）

##　　　■Internet Connection（インターネットへの接続）
　　　　　- ロボットのインターネット接続の有無を検知し、接続または切断された場合に
　　　　　　出力を行います。

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

　　　　　　出力：onStopped（バン）
　　　　　　　　　connected（バン）
　　　　　　　　　notconnected（バン）

　　　　　　ボックス設定：なし

　　　　　　パラメータ：リフレッシュ時間（秒）、
　　　　　　　　　　　　URLs（http://aldebaran-robotics.com/;
　　　　　　　　　　　　　　　　http://www.google.com がデフォルト値）
 
--------------------------
###　▼System Actions（システム動作）
##　　　■Reboot（再起動）
　　　　　- ロボットを再起動します。
　　　　　（ロボットがバーチャルロボットではない場合のみ。）

　　　　　入力：onStart（バン）

　　　　　出力：なし

　　　　　ボックス設定：なし

　　　　　パラメータ：なし

##　　　■Shutdown（シャットダウン）
　　　　　- ロボットをシャットダウンします。
　　　　　（ロボットがバーチャルロボットではない場合のみ。）

　　　　　入力：onStart（バン）

　　　　　出力：なし

　　　　　ボックス設定：なし

　　　　　パラメータ：なし

 --------------------------
###　▼Templates（テンプレート）
##　　　■Diagram（ダイアグラム）
　　　　　- 任意のボックスを作るための空のボックスです。
　　　　　編集するにはダブルクリックします。

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

　　　　　出力：onStopped（バン）

　　　　　ボックス設定：なし（ボックス作成へ）

　　　　　パラメータ：なし

##　　　■Python Script（Pythonのスクリプト）
　　　　　- 基本的なPythonスクリプトが含まれているボックスです。
　　　　　Pythonスクリプトボックスを作成するために使用することができます。

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

　　　　　出力：onStopped（バン）

　　　　　ボックス設定：なし（Pythonスクリプトを編集するには、ダブルクリック。）

　　　　　パラメータ：なし

 --------------------------
###　▼Time（時間）
##　　　■Delay（遅延）
　　　　　- 出力する前に少し待ちます。
　　　　　　いつでも停止することができます。複数の入力の場合、複数出力します。

　　　　　　入力：onStart（文字列）
　　　　　　　　　onStop（バン）

　　　　　　出力：timerOutput（バン）

　　　　　　ボックス設定：なし

　　　　　　パラメータ：タイムアウト（秒）
　　　　　　　　　　　　キャンセルされた場合の時間出力有無

##　　　■Timer（タイマー）
　　　　　-指定した間隔で出力を繰り返します。
　　　　　いつでも停止することができます。
　　　　　出力前に、もう一度入力するとタイマーを再起動できます。

　　　　　入力：onStart（文字列）
　　　　　　　　onStop（バン）

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

　　　　　ボックス設定：なし

　　　　　パラメータ：期間（秒）

##　　　■Wait（待機）
　　　　　- 信号を出力する前に少し待ちます。
　　　　　いつでも停止することができます。
　　　　　出力前に、もう一度入力するとタイマーを再起動できます。

　　　　　入力：onStart（文字列）
　　　　　　　　onStop（バン）

　　　　　出力：timerOutput（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：タイムアウト（秒）
　　　　　　　　　　　キャンセルされた場合の時間出力有無
 
--------------------------
###　▼Tools（ツール）
##　　　■Comment（コメント）
　　　　　- コメントを記載できます。
　　　　　このボックスにテキストを入力し、コメントしたい場所にボックスをセットします。
　　　　　線を結ぶことはできず、ただ置いて、コメントを表示するためだけのものです。
　　　　　ボックスが縦に伸びて、一定量を超えるとスクロールバーがでますので結構な
　　　　　量が書けます。

　　　　　入力：なし

　　　　　出力：なし

　　　　　ボックス設定：コメント

　　　　　パラメータ：なし

##　　　■Log（ログ）
　　　　- デバッグ画面でメッセージを確認します。
　　　　　パラメータのメッセージのプレフィックスと優先順位を設定することができます。
　　　　　（デバッグ画面でメッセージを確認します。パラメータで、プレフィックスと
　　　　　メッセージの優先順位を設定することができます。）

　　　　　入力：message（ダイナミック）

　　　　　出力：onDone（バン）

　　　　　ボックス設定：なし

　　　　　パラメータ：メッセージ接頭語（デフォルト値はMessage text）
　　　　　　　　　　　プライオリティー（Fatal、Error、Warning、Info、Debug）

-------------------------------------------------------------------------------
###▼廃止されたボックス(2.3でなくなったもの)
-------------------------------------------------------------------------------
##　　■Breath（呼吸）
　　　　- ロボットが呼吸をするアニメーションを実行します。

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

　　　　出力：onStopped（バン）

　　　　ボックス設定：なし

　　　　パラメータ：チェーン名（Body、Legs、Arms、LArm、RArm、Head）
　　　　　　　　　　振り幅
　　　　　　　　　　テンポ（BPM）

##　　■Hello（ハロー）
　　　　- ロボットがシンプルな挨拶のアニメーションを実行します。
　　　　なおこのボックスはしゃべりません。アニメーションだけです。

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

　　　　出力：onStopped（バン）

　　　　ボックス設定：なし

　　　　パラメータ：なし

##　　■Wipe Forehead（額をぬぐう）
　　　　- ロボットが自分の額を拭うアニメーションを実行します。

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

　　　　出力：onStopped（バン）

　　　　ボックス設定：なし

　　　　パラメータ：なし

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