Pythonライブラリ(pypapero.py)リファレンスマニュアル
目次
使い方の概要
Paperoコマンド送信関数・レスポンス・イベント相互関係早見表
コマンド送信関数
レスポンス
イベント
１、pypaperoモジュールをインポートします。
import pypapero
※通信ログ出力について
2016/06/15公開版以降のpypapero.pyでは、デフォルトでは通信ログを出力しない設定となっています。
通信ログが必要な場合は、スクリプトの先頭で
from logging import basicConfig, DEBUG
basicConfig(level=DEBUG)
とします。
２、Paperoオブジェクトを生成します。
papero = pypapero.Papero(simulator_id, robot_name, ws_server_addr)
引数の意味は以下のとおりです。
simulator_id:シミュレータID(文字列)→実機のPaPeRoを制御する場合は場合は””にします。
robot_name:ロボット名(文字列)→””にすると、シミュレータ上のデフォルトのロボットを指定した事になります。
ws_server_addr:WebSocketサーバアドレス(文字列)→””にすると、デフォルトのWebScketサーバを指定した事になります。実機のPaPeRoを制御する場合は、ここにPaPeRoのWebSocketサーバアドレスを指定します。
Paperoオブジェクトの生成中に通信エラーが発生した場合、papero.errOccurredに0以外の値が入り、papero.errDetailにエラーの詳細を示す文字列が格納されます。
※get_params_from_commandline関数を用いる事により、上記 simulator_id, robot_name, ws_server_addr の値をコマンドライン引数から抽出する事ができます。
使用例：
simulator_id, robot_name, ws_server_addr = pypapero.get_params_from_commandline(sys.argv)
papero = pypapero.Papero(simulator_id, robot_name, ws_server_addr)
３、paperoのメンバ関数を用いてPaPeRoを制御する為のコマンドを送信します。
また、PaPeRoからのメッセージの受信を行い、受信メッセージの内容に応じた処理を行います。
変数paperoにPaperoオブジェクトが入っていると仮定した場合、メッセージの受信は以下のようにして行います。
messages = papero.papero_robot_message_recv(recvWait)
引数recvWaitには、タイムアウトの秒数を与えます。
recvWait秒以内にメッセージが受信できない場合、戻り値(上の例ではmessages)はNoneとなります。
受信中に通信エラーが発生した場合は、戻り値がNoneとなり、papero.errOccurredに0以外の値が入り、papero.errDetailにエラーの詳細を示す文字列が格納されます。
messagesがNoneでない場合、messagesには受信メッセージの配列が格納されております。
配列は、現在0番目の要素のみ有効です。
メッセージは辞書形式となっており、messages[0][“Name”]でメッセージの名前を参照できます。
名前以外に含まれる情報は、メッセージにより異なります。
※メッセージによっては、パラメータの値が”X,Y”の形式で格納される場合があります。
その場合、get_numstr_list_from_coord関数を用いる事により、XYそれぞれの値を取り出す事ができます。
例：
pos_str = “123,456”
pos = pypapero.get_numstr_list_from_coord(pos_str)
pos_x = int(pos[0])
pos_y = int(pos[1])
※モーターの動作コマンドmoveHeadの動作完了はmoveFinishイベントで、LED点灯動作コマンドturnLedOnの動作完了はearFinish、foreheadFinish、cheekFinish、mouthFinish 、chestFinishイベントで知る事ができます。
発話コマンド(startSpeech)については、完了時に送られるイベントがありませんので、発話が完了したかどうかを確認するにはgetSpeechStatusコマンドを使用する必要があります。
※時間を計測する必要がある場合、NTPによる自動時刻合わせの影響を回避する為、time.time()ではなくtime.monotonic()の使用を推奨します。
４、Paperoオブジェクトの使用を終了する時は、papero.papero_cleanup()を呼び出します。
Paperoコマンド送信関数・レスポンス・イベント相互関係早見表
モーター関連
moveHead
送信関数呼び出し形式：
papero.send_move_head(vertical, horizontal, repeat, priority)
papero:Paperoオブジェクト
repeat:繰り返しの有無(True又はFalse)、省略時はFalse
vertical:縦移動パラメータ
horizontal:横移動パラメータ
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
首振り動作を行います。
縦移動パラメータと横移動パラメータは、”[位置指定][数値1][移動方法][数値2][加速度]”の書式の文字列をシーケンス数分リストに入れて指定します。
縦・横とも64シーケンスまで指定可能です。
| 位置指定 | R=相対角度指定、A=絶対角度指定 |
| 数値1 | 絶対角度または相対角度(整数) 正の値は上方向(縦)/左方向(横)、負の値は下方向(縦)/右方向(横)。 |
| 移動方法 | S=速度指定、T=時間指定 |
| 数値2 | 目標最高速度(速度指定時、deg/S 単位)、または動作時間(時間指定時、mS 単位)。 |
| 加速度 | L=低速 |
例：[“R120S15L”, “A60T200L”, …]
応答として、moveHeadResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
注意事項
推奨速度は 26～120 [deg/s]、推奨加速度は L となっていますので、推奨範囲外の速度・加速度の利 用に関しては利用者が個別に判断お願い致します。
推奨値以外を利用した際には騒音や脱調が発生する恐れがあります。
stopHead
送信関数呼び出し形式：
papero.send_stop_head(priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
実行中の首振りを停止します。
応答として、stopHeadResを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
resetHead
送信関数呼び出し形式：
papero.send_reset_head(priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
原点（正面位置）の補正を行います。
応答として、resetHeadResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
getHeadStatus
送信関数呼び出し形式：
papero.send_get_head_status(priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
首振りの動作中/停止中の状態を取得します。
応答として、getHeadStatusResレスポンスを返信し、戻り値(Return)に0(停止中)、または1(動作中)のい ずれか、縦(Vertical)及び横(Horizontal)に頭の位置情報を格納します。
エラーの場合は、戻り値(ret)に負の値を格納します。
LED関連
turnLedOn
送信関数呼び出し形式：
papero.send_turn_led_on(part, pattern, repeat, priority)
papero:Paperoオブジェクト
part:”ear”、”forehead”、”cheek”、”mouth”、”chest”のいずれか
pattern:以下に説明する値
repeat:True、Falseのいずれか、省略時はFalse
priority:優先度(“higher”又は”normal”)、省略時は”normal”
pattern:パラメータ
戻り値：メッセージID
説明
LEDの点灯動作を行います。
パラメータとしては、以下に示す書式の文字列と時間(デシ秒単位)をシーケンス数分リストに入れて指定します。
最大26シーケンスまで(リスト長としては52まで)指定可能です。
part=”ear”の場合のpattern
| 書式 | [左輝度][右輝度] |
| 左輝度/右輝度 | W3=明るい、W2=標準、W1=暗い、W0=基本輝度に従う、N=消灯 |
例：[“W0W0”, “5”, “NN”, “5”, “W1W3”, “5”, …]
part=”forehead”の場合のpattern
| 書式 | R3=明るい赤、R2=標準赤、R1=暗い赤、R0=基本輝度赤、 G3=明るい緑、G2=標準緑、G1=暗い緑、G0=基本輝度緑、 Y3=明るい黄、Y2=標準黄、Y1=暗い黄、Y0=基本輝度黄、 N=消灯 |
例：[“R0”, “5”, “N”, “10”, “Y1”, “5”, …]
part=”cheek”の場合のpattern
| 書式 | [輝度1][輝度2][輝度3][輝度4][輝度5][輝度6][輝度7][輝度8][輝度9] |
| [輝度1]～[輝度9] | R3=明るい、R2=標準、R1=暗い、R0=基本輝度赤、 G3=明るい、G2=標準、G1=暗い、G0=基本輝度緑、 Y3=明るい、Y2=標準、Y1=暗い、Y0=基本輝度黄、 N=消灯 |
例：[“NG0Y0Y0R1G2Y3Y1R2”, “5”, “Y0Y1NNR1Y1Y1NN”, “5”, “G1R2Y1Y3G2G1R1Y2Y3”, “5”, …]
part=”chest”の場合のpattern
| 意味 | 組み合わせる文字列 |
| 赤色点灯 | “R” |
| 赤色消灯 | “” |
| 緑色点灯 | “G” |
| 緑色消灯 | “” |
| 青色点灯 | “B” |
| 青色消灯 | “” |
| 白色点灯 | “W” |
| 白色消灯 | “” |
| 全消灯 | “N” |
| 輝度明るい | “3” |
| 輝度標準 | “2” |
| 輝度暗い | “1” |
| 基本輝度に従う | “0” |
例：[“R2”, “5”, “RGW0”, 5, “N”, “5”, …]
応答として、turnLedOnResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
turnLedOff
送信関数呼び出し形式：
papero.send_turn_led_off(part, priority)
papero:Paperoオブジェクト
part:(“ear”、”forehead”、”cheek”、”mouth”のいずれか)
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
LEDを消灯させます。
応答として、turnLedOffResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
setDefaultStatus
送信関数呼び出し形式：
papero.send_set_default_status_led(status, priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
輝度のデフォルト値を設定します。
応答として、setDefaultStatusResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
getDefaultStatus
送信関数呼び出し形式：
papero.send_get_default_status_led(priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
輝度のデフォルト値を取得します。
応答として、getDefaultStatusResレスポンスを返信し、戻り値(Return)にデフォルトの輝度を格納します。
エラーの場合は、戻り値(ret)に負の値を格納します。
getLedStatus
送信関数呼び出し形式：
papero.send_get_led_status(part, priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
LED点灯動作の実行中/停止中の状態を取得します。
応答として、getLedStatusResレスポンスを返信し、戻り値(Return)に0(停止中)、または1(実行中)のいずれかを格納します。
エラーの場合は、戻り値(ret)に負の値を格納します。
音声合成関連
startSpeech
送信関数呼び出し形式：
(pypapero.py Ver.1.00～)
papero.send_start_speech(text, language, speaker_id, pitch, speed, volume, pause, comma_pause, urgent, priority)
(pypapero.py ～2016/08/02公開版(β版))
papero.send_start_speech(text, priority)
papero:Paperoオブジェクト
text:読み上げ対象テキスト
language:言語(“0″(日本語)、”1″(英語)、”2″(中国語)のいずれか)、省略時はNone
speaker_id:話者ID(“3″(日本語：haruka、英語：julie)、”4″(中国語：hong)のいずれか)、省略時はNone
pitch:高程音(“50″～”200″、単位は%)、省略時はNone
speed:発話速度(“50″～”400″、単位は%)、省略時はNone
volume:発話音量(“0″～”500″、単位は%)、省略時はNone
pause:文章間ポーズ時間(“0″～”65535″、単位はms)、省略時はNone
comma_pause:カンマポーズ時間(“0″～”65535″、単位はms)、省略時はNone
urgent:音声のカテゴリ(“0″(通常音)、”1″(緊急音)のいずれか)、省略時はNone
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
音声合成による発話を開始します。
language、speaker_id、pitch、speed、volume、pause、comma_pauseを省略した場合又はNoneを与えた場合は、setDefaultStatusコマンド(送信関数はsend_set_default_status_speech)で設定された値が発話に使用されます。
urgentを省略した場合又はNoneを指定した場合は”0″(通常音)を指定した事になります。
応答として、startSpeechResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
pauseSpeech
送信関数呼び出し形式：
papero.send_pause_speech(priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
実行中の発話を一時停止させます。
応答として、pauseSpeechResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
resumeSpeech
送信関数呼び出し形式：
papero.send_resume_speech(priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
一時停止させた発話を再開させます。
応答として、resumeSpeechResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
stopSpeech
送信関数呼び出し形式：
papero.send_stop_speech(priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
実行中の発話を終了させます。
応答として、stopSpeechResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
getSpeechStatus
送信関数呼び出し形式：
papero.send_get_speech_status(priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
発話中/停止中の状態を取得します。
応答として、getSpeechStatusResレスポンスを返信し、戻り値(Return)に0(停止中)、1(発話中)、2(一時停止中)のいずれかがを格納します。
エラーの場合は、戻り値(ret)に負の値を格納します。
setDefaultStatus
送信関数呼び出し形式：
papero.send_set_default_status_speech(tempo, language, speaker_id, pitch, speed, volume, pause, comma_pause, priority)
papero:Paperoオブジェクト
language:言語(“0″(日本語)、”1″(英語)、”2″(中国語)のいずれか、省略時は”0”)
speaker_id:話者ID(“3″(日本語：haruka、英語：julie)、”4″(中国語：hong)のいずれか)
pitch:高程音(“50″～”200″、単位は%、省略時は”100”)
speed:発話速度(“50″～”400″、単位は%、省略時は”100”)
volume:発話音量(“0″～”500″、単位は%、省略時は”100”)
pause:文章間ポーズ時間(“0″～”65535″、単位はms、デフォルトは”800”)
comma_pause:カンマポーズ時間(“0″～”65535″、単位はms、デフォルトは”300”)
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
音量、発話速度などのデフォルト値を設定します。
応答として、setDefaultStatusResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
getDefaultStatus
送信関数呼び出し形式：
papero.send_get_default_status_speech(priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
音量、発話速度などのデフォルト値を取得します。
応答として、getDefaultStatusResレスポンスを返信し、tempoにグローバルなテンポを格納します。
エラーの場合は、戻り値(ret)に負の値を格納します。
センサー関連
getSensorValue
送信関数呼び出し形式：
papero.send_get_sensor_value(priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
センサー値を取得します。
応答として、getSensorValueResレスポンスを返信し、IRに赤外線センサ自体の温度と素子の値①～④、位置情報をコンマ区切りで格納し、TEM・HYG・LUXに温度・湿度・照度の値を格納します。
エラーの場合は、戻り値(ret)に負の値を格納します。
赤外線センサーはロボットから見て以下のように配置されております。
| ① | ||
| ④ | ② | |
| ③ |
センサ素子の測定データと温度は以下のような関係となっています。
| 内蔵温度センサの測定データ[Dicimal] | 温度[℃] |
| 17792 | 60 |
| | | | |
| 256 | 26.75 + 0.5 |
| | | | |
| 64 | 26.75 + 0.125 |
| 0 | 26.75 |
| -64 | 26.75 – 0.125 |
| | | | |
| -256 | 26.75 ? 0.5 |
| | | | |
| -18048 | -10 |
例1：内蔵温度 26.75℃、左で反応した場合、getSensorValueResレスポンスのIRの値は”0, -31, 32767, 32, -2294, Left”となります。
例2：内蔵温度-10.00℃、中央で反応した場合、IRの値は”-18048, 2294, -16514, 16514, -2294, Center”となります。
例3：内蔵温度 30.00℃、不在の場合、IRの値は”1664, -31, -63, -16, 0, Lost”となります。
startAccSensor
送信関数呼び出し形式：
papero.send_start_acc_sensor(priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
加速度センサによる計測を開始します。
応答として、startAccSensorResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
stopAccSensor
送信関数呼び出し形式：
papero.send_stop_acc_sensor(priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
加速度センサによる計測を停止します。
応答として、stopAccSensorResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
setAccSensor
送信関数呼び出し形式：
papero.send_set_acc_sensor(mem_size, full_scale, data_rate, priority)
papero:Paperoオブジェクト
mem_size:Queバッファメモリサイズ(1000～1200)
full_scale:0:±2g , 1:±4g , 2:±8g , 3:±16g
data_rate:2:10Hz、3:25Hz、4:50Hz、5:100Hz、9:1344Hz
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
加速度センサの設定を行います。各引数の詳細は以下のとおりです。
| mem_size | Queue バッファメモリデータサイズ（格納する X,Y,Z 軸加速度計測値を1 セットとする取得回数）を指定する。 X,Y,Z 軸加速度計測値は、加速度計センサが DataRate（10～100 Hz）で指定する計測レートでデバイス内の FIFO に格納し、コンポーネントは200 ミリ秒間隔で FIFO からの取り出しを実行する。 例として、30 秒間の場合の X,Y,Z 軸加速度計測値のサイズ指定は、3000(=30÷0.01)となる。 ・最小(Min)設定値は、10 秒間で、X,Y,Z 軸加速度計測値のサイズ指定は、1000(=10÷0.01)とする。 ・最大(Max) 設定値は、120 秒間で、X,Y,Z 軸加速度計測値のサイズ指定は、12000(=120÷0.01)とする。 |
| full_scale | 加速度設定(0:±2g , 1:±4g , 2:±8g , 3:±16g) |
| data_rate | 周期設定 100Hz の場合、10ms に 1 回加速度データを FIFO に格納する。 2 : HR / Normal / Low-power mode (10 Hz) 3 : HR / Normal / Low-power mode (25 Hz) 4 : HR / Normal / Low-power mode (50 Hz) 5 : HR / Normal / Low-power mode (100 Hz) 9 : HR / Normal (1.344 kHz) |
応答として、setAccSensorResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
getAccSensorState
送信関数呼び出し形式：
papero.send_get_acc_sensor_state(priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
加速度センサの状態を取得します。
応答として、getAccSensorStateResレスポンスを返信し、戻り値(Return)に0(停止中)又は1(動作中)のいずれかを格納します。
エラーの場合は、戻り値(ret)に負の値を格納します。
AccSensorThreshold
送信関数呼び出し形式：
papero.send_set_acc_sensor_threshold(det_value, los_value, frequency, arg_time, priority)
papero:Paperoオブジェクト
det_value:揺れ開始閾値
los_value:揺れ終了閾値
frequency:揺れ開始閾値を超える回数
arg_time:揺れ終了閾値が連続して閾値を下回る期間
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
加速度センサ閾値を設定します。
各引の詳細は以下のとおりです。
| det_value | 揺れ開始閾値(mg : ミリジー) XYZ 軸加速度閾値 √(X^2 + Y^2 + Z^2) 最小値 : 1 最大値 : 41569 (XYZ 軸全計測値 Max 24000mg の場合) Default : 1100 |
| los_value | 揺れ終了閾値(mg : ミリジー) XYZ 軸加速度閾値 √(X^2 + Y^2 + Z^2) 最小値 : 1 最大値 : 41569 (XYZ 軸全計測値 Max 24000mg の場合) Default : 1030 |
| frequency | 揺れ開始閾値を超える回数（回） 最小値 : 1 最大値 : 65535 Default : 10 |
| arg_time | 揺れ終了閾値が連続して閾値を下回る期間（秒） 最小値 : 1 最大値 : 65535 (約 18 時間) Default : 3 |
応答として、setAccSensorThresholdResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
startLumSensor
送信関数呼び出し形式：
papero.send_start_lum_sensor(priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
照度センサによる計測を開始します。
応答として、startLumSensorResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
stopLumSensor
送信関数呼び出し形式：
papero.send_stop_lum_sensor(priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
照度センサによる計測を停止します。
応答として、stopLumSensorResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
getLumSensorValue
送信関数呼び出し形式：
papero.send_get_lum_sensor_value(priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
照度センサの測定値を読み出します。
応答として、getLumSensorValueResレスポンスを返信し、戻り値(Return)に照度データ値を格納します。
エラーの場合は、戻り値(ret)に負の値を格納します。
getLumSensorState
送信関数呼び出し形式：
papero.send_get_lum_sensor_state(priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
照度センサの状態を取得します。
応答として、getLumSensorStateResレスポンスを返信し、戻り値(Return)に0(停止中)又は1(動作中)のいずれかを格納します。
cancelCommand
送信関数呼び出し形式：
papero.send_cancel_command(priority, target_id)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
未処理のコマンドをキャンセルします。
応答として、cancelCommandResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
音声認識関連
startSpeechRecognition
送信関数呼び出し形式：
papero.send_start_speech_recognition(priority)
戻り値：メッセージID
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
説明
音声認識を開始します。
応答として、startSpeechRecognitionResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
stopSpeechRecognition
送信関数呼び出し形式：
papero.send_stop_speech_recognition(priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
実行中の音声認識を停止します。
応答として、stopSpeechRecognitionResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
stopSpeechRecognition
送信関数呼び出し形式：
papero.send_stop_speech_recognition(priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
実行中の音声認識を停止します。
応答として、stopSpeechRecognitionResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
getSpeechRecognitionStatus
送信関数呼び出し形式：
papero.send_get_speech_recognition_status(priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
認識状態を取得します。
応答として、getSpeechRecognitionStatusResレスポンスを返信し、戻り値(Return)に0(認識をしていない状態)、1(認識をを開始し発話を待っている状態)、2(発話を検知し認識動作中)のいずれかを格納します。
エラーの場合は、戻り値(ret)に負の値を格納します。
readDictionary
送信関数呼び出し形式：
papero.send_read_dictionary(mrg_file_name, priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
mrg_file_name:辞書ファイルパス名
戻り値：メッセージID
説明
音声認識辞書ファイルを読み込みます。
応答として、readDictionaryResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
freeDictionary
送信関数呼び出し形式：
papero.send_free_dictionary(mrg_file_name, priority)
papero:Paperoオブジェクト
mrg_file_name:辞書ファイルパス名
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
読み込んだ音声認識辞書を解放します。
応答として、freeDictionaryResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
addSpeechRecognitionRule
送信関数呼び出し形式：
papero.send_add_speech_recognition_rule(rule_name, priority)
papero:Paperoオブジェクト
rule_name:ルール名
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
音声認識開始時に使用する認識ルールを登録します。
応答として、addSpeechRecognitionRuleResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
deleteSpeechRecognitionRule
送信関数呼び出し形式：
papero.send_delete_speech_recognition_rule(rule_name, priority)
papero:Paperoオブジェクト
rule_name:ルール名
priority:優先度(“higher”又は”normal”)
戻り値：メッセージID
説明
認識ルールを削除させます。
応答として、deleteSpeechRecognitionRuleResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
カメラ関連
takePicture
送信関数呼び出し形式：
papero.send_take_picture(format, filename, camera, priority)
papero:Paperoオブジェクト
format:”RGB”/”JPEG”
filename:ファイル名、省略可
camera:”VGA”/”SXGA”、省略可
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
静止画を撮影します。
応答として、takePictureResレスポンスを返信し、CaptureDataSizeに出力したバイト数を、Filenameに出力したファイル名(フルパス)を格納します。
エラーの場合は、戻り値(ret)に負の値を格納します。
deleteCaptureData
送信関数呼び出し形式：
papero.send_delete_capture_data(filename, priority)
filename:ファイル名
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
指定の静止画を削除します。
応答として、deleteCaptureDataResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
startCapturing
送信関数呼び出し形式：
papero.send_start_capturing(share_mem_id, share_mem_size, camera, priority)
papero:Paperoオブジェクト
share_mem_id:共有メモリID(指定しない場合はNone)
share_mem_size:共有メモリサイズ
camera:”VGA”/”SXGA”(指定しない場合はNone)
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
画像キャプチャを開始します。
応答として、startCapturingResレスポンスが返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
stopCapturing
送信関数呼び出し形式：
papero.send_stop_capturing(share_mem_id, camera, priority)
papero:Paperoオブジェクト
share_mem_id:共有メモリID(指定しない場合はNone)
camera:”VGA”/”SXGA”(指定しない場合はNone)
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
画像キャプチャを終了します。
応答として、stopCapturingResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
getCaptureData
送信関数呼び出し形式：
papero.send_get_capture_data(share_mem_id, camera, priority)
papero:Paperoオブジェクト
share_mem_id:共有メモリID(指定しない場合はNone)
camera:”VGA”/”SXGA”(指定しない場合はNone)
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
最新のキャプチャデータ(サイズ)を取得します。
応答として、getCaptureDataResレスポンスを返信し、CaptureDataSizeにキャプチャデータのサイズ（バイト）を格納します。
エラーの場合は、戻り値(ret)に負の値を格納します。
setCameraStatus
送信関数呼び出し形式：
papero.send_set_camera_status(self, brightness, contrast, hue, saturation, sharpness, gamma, white_balance, auto_white_balance, iris, camera, priority)
papero:Paperoオブジェクト
brightness:明るさ、省略可
contrast:コントラスト、省略可
hue:色相、色合い、省略可
saturation:彩度、鮮やかさ、省略可
sharpness:シャープネス、鮮明度、省略可
gamma:ガンマ補正、省略可
white_balance:ホワイトバランス、省略可
auto_white_balance:自動ホワイトバランス、省略可
iris:虹彩、省略可
camera:”VGA”/”SXGA”、省略可
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
カメラプロパティを設定します。
| 引数 | 項目名 | 意味 | 最小値 | 最大値 | Default |
| brightness | Brightness | 明るさ | 0 | 255 | 128 |
| contrast | Contrast | コントラスト | 0 | 31 | 16 |
| hue | Hue | 色相、色合い | -180 | 180 | 0 |
| saturation | Saturation | 彩度、鮮やかさ | 0 | 31 | 16 |
| sharpness | Sharpness | シャープネス、鮮明度 | 0 | 15 | 1/0 |
| gamma | Gamma | ガンマ補正 | 0 | 127 | 64 |
| white_balance | WhiteBalance | ホワイトバランス | 0 | 255 | 128 |
| auto_white_balance | AutoWhiteBalance | 自動ホワイトバランス 0＝無効 1＝有効 | 0 | 1 | 1 |
| iris | Iris | 虹彩 | 1/10 | 60/600 | 30/300 |
| camera | Camera | (指定なし)：既存と同じVGAカメラのデータを設定する “VGA”：VGAカメラのデータを設定する “SXGA”：SXGA カメラのデータを設定する |
省略したパラメータについては変更されません。
応答として、setCameraStatusResレスポンスを返信します。その際、変更されたパラメータの設定前の値を共通レスポンスに追加します。追加する項目名は、上記の表の項目名となります。
エラーの場合は、戻り値(ret)に負の値を格納します。
getCameraStatus
送信関数呼び出し形式：
papero.send_get_camera_status(object, camera, priority)
papero:Paperoオブジェクト
object:取得するプロパティ名(Noneを指定すると全取得となる)
camera:”VGA”/”SXGA”(指定しない場合はNone)
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
カメラプロパティを取得します。
応答として、getCameraStatusResレスポンスを返信します。その際、指定された項目を共通レスポンスに追加します。追加する項目名は、setCameraStatusの説明の表の項目名となります。
エラーの場合は、戻り値(ret)に負の値を格納します。
getOneShotCaptureData
送信関数呼び出し形式：
papero.send_get_one_shot_capture_data(share_mem_id, share_mem_size, camera, priority)
papero:Paperoオブジェクト
share_mem_id:共有メモリID
share_mem_size:共有メモリサイズ
camera:”VGA”/”SXGA”(指定しない場合はNone)
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
画像キャプチャを開始、データ取得、停止を 1 つのコマンドで実行します。
応答として、getOneShotCaptureDataResレスポンスを返信し、CaptureDataSizeにキャプチャデータのサイズ（バイト）を格納します。
顔検出関連
startFaceDetection
送信関数呼び出し形式：
papero.send_start_face_detection(min_eye_distance, priority)
papero:Paperoオブジェクト
min_eye_distance:最小目間距離(指定しない場合はNone)
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
顔検出を開始します。
応答として、startFaceDetectionResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
stopFaceDetection
送信関数呼び出し形式：
papero.send_stop_face_detection(priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
実行中の顔検出を停止します。
応答として、stopFaceDetectionResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
録音関連
startRecording
送信関数呼び出し形式：
papero.send_start_recording(filename, bitlength, bitrate, channel, recordingtime, priority)
papero:Paperoオブジェクト
filename:ファイル名、省略時はデフォルト
bitrate:ビットレート、省略はデフォルト
channel:チャネル、”Monaural”又は”Stereo”のいずれか、省略時はデフォルト
recordingtime:録音時間(秒)、省略時はデフォルト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
録音を開始します。
応答として、startRecordingResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
stopRecording
送信関数呼び出し形式：
papero.send_stop_recording(priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
実行中の録音を停止します。
応答として、stopRecordingResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
deleteRecordingData
送信関数呼び出し形式：
papero.send_delete_recording_data(filename, priority)
papero:Paperoオブジェクト
filename:ファイル名
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
指定された録音データを削除します。
応答として、deleteRecordingDataResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
getRecordingStatus
送信関数呼び出し形式：
papero.send_get_recording_status(priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
録音状態を取得します。
応答として、getRecordingStatusResレスポンスを返信し、戻り値(Return)に0(アイドル)又は1(録音中)を格納します。
エラーの場合は、戻り値(ret)に負の値を格納します。
setDefaultStatus
送信関数呼び出し形式：
papero.send_set_default_status_wavrec(bitrate, channel, bitlength, recordingtime, priority)
papero:Paperoオブジェクト
bitrate:ビットレート、省略可、起動時のデフォルトは256000(16bit*16kHz)
channel:チャネル数(“Monaural”又は”Stereo”)、省略可、起動時のデフォルト値は”Monaural”
bitlength:ビット長、省略可、起動時のデフォルト値は16
recordingtime:録音時間(秒)、省略可、起動時のデフォルト値は10
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
録音パラメータのデフォルト値を設定します。
応答として、setDefaultStatusResレスポンスを返信し、変更されたパラメータの設定前の値を共通レスポンスに追加します。
エラーの場合は、戻り値(ret)に負の値を格納します。
getGetDefaultStatus
送信関数呼び出し形式：
papero.send_get_default_status_wavrec(object, priority)
papero:Paperoオブジェクト
object:取得する項目名(“Bitrate”、”Channel”、”BitLength”、”RecordingTime”のいずれか)
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
録音パラメータのデフォルト値を取得します。
応答として、getDefaultStatusResレスポンスを返信します。その際、指定された項目を共通レスポンスに追加します。
エラーの場合は、戻り値(ret)に負の値を格納します。
再生関連
startPlaying
送信関数呼び出し形式：
papero.send_start_playing(filename, volume, category, priority)
papero:Paperoオブジェクト
filename:ファイル名
volume:ボリューム(1～10)、省略時はデフォルト
category:1(通常時)又は2(緊急時)、省略時は1
recordingtime:録音時間(秒)、省略時はデフォルト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
再生を開始します。
ファイル名は、ディレクトリ付きで指定します(“tmp.wav”を再生する場合、filenameには”/tmp/tmp.wav”を指定します)。
categoryに1を指定した場合は指定音量で、2を指定した場合は最大音量で再生します。
応答として、startPlayingResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
stopPlaying
送信関数呼び出し形式：
papero.send_stop_playing(priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
再生を終了します。
応答として、stopPlayingResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
getPlayingStatus
送信関数呼び出し形式：
papero.send_get_playing_status(priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
再生状態を取得します。
応答として、getPlayingStatusResレスポンスを返信し、戻り値(Return)に0(アイドル)又は1(録音中)を格納します。
エラーの場合は、戻り値(ret)に負の値を格納します。
deleteWaveData
送信関数呼び出し形式：
papero.send_delete_wave_data(filename, priority)
papero:Paperoオブジェクト
filename:ファイル名
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
指定された音声ファイルを削除します。
ファイル名は、ディレクトリ付きで指定します(“tmp.wav”を再生する場合、filenameには”/tmp/tmp.wav”を指定します)。
応答として、deleteWaveDataResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
setDefaultStatus
送信関数呼び出し形式：
papero.send_set_default_status_wavplay(volume, priority)
papero:Paperoオブジェクト
volume:ボリューム(1～10)
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
再生パラメータのデフォルト値を設定します。
応答として、setDefaultStatusResレスポンスを返信し、変更されたパラメータの設定前の値を共通レスポンスに追加します。
エラーの場合は、戻り値(ret)に負の値を格納します。
getGetDefaultStatus
送信関数呼び出し形式：
papero.send_get_default_status_wavplay(object, priority)
papero:Paperoオブジェクト
object:取得する項目名(“Volume”)
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
録音パラメータのデフォルト値を取得します。
応答として、getDefaultStatusResレスポンスを返信します。その際、指定された項目を共通レスポンスに追加します。
エラーの場合は、戻り値(ret)に負の値を格納します。
汎用モーション関連
startMotion
送信関数呼び出し形式：
papero.send_start_motion(self, motion_id, sound, text, priority)
papero:Paperoオブジェクト
motion_id:モーションID(1～19)
sound:”None”、”Japanese”、”Plan”のいずれか、省略時は”None”となる。
text:sound=”Japanese”の場合は発話テキスト、sound=”Play”の場合はwavファイル名、sound=”None”の場合は省略可
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
汎用モーション一覧
| モーションID | 名前 | 動作 | LED点灯 |
| 1 | Front | 正面を向く | なし |
| 2 | Right | 右を向く | なし |
| 3 | Left | 左を向く | なし |
| 4 | Up | 上を向く | なし |
| 5 | Down | 下を向く | なし |
| 6 | RightUp | 右上を向く | なし |
| 7 | RightDown | 右下を向く | なし |
| 8 | LeftUp | 左上を向く | なし |
| 9 | LeftDown | 左下を向く | なし |
| 10 | General1 | 上下左右をアトランダムに | アトランダムに |
| 11 | Start1 | 上を向く | なし |
| 12 | Nod1 | うなづく | あり |
| 13 | Nod2 | うなづく（2 回） | あり |
| 14 | Time1 | 斜め（右上→左下） | なし |
| 15 | Time2 | 斜め（左上→右下） | なし |
| 16 | Time3 | 大きく斜め（左上→右下） | なし |
| 17 | No1 | 横に振る（右→左） | なし |
| 18 | No2 | 横に振る（左→右） | なし |
| 19 | Inspire1 | 上下に細かく動く | あり |
説明
指定した汎用モーションを開始します。
応答として、startMotionResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
stopMotion
送信関数呼び出し形式：
papero.send_stop_motion(self, priority)
papero:Paperoオブジェクト
priority:優先度(“higher”又は”normal”)、省略時は”normal”
戻り値：メッセージID
説明
動作中の汎用モーションを停止します。
応答として、stopMotionResレスポンスを返信します。
エラーの場合は、戻り値(ret)に負の値を格納します。
共通項目
| 項目名 | 値 |
| Name | レスポンス名称を指定するための文字列。レスポンス毎に異なる。 |
| Type | “Response” |
| Destination | “Script” |
| Source | “MotorController”(モーター関連)、”LEDController”(LED関連)、”SpeechSynthesizer”(音声合成関連)、”SensorController”(センサー関連)、”SpeechRecognizer”(音声認識関連)、”CameraController”(カメラ関連)、”FaceDetection”(顔検出関連)のいずれか |
| Time | レスポンスの送信時刻を示す文字列。 フォーマットは YYYY-MM-DD hh:mm:ssとし、タイムゾーンは端末に従う。 例) Time=2012-03-05 13:00:00 |
| MessageID | PaPeRoが生成するメッセージID |
| OrgMessageID | 対応するコマンドに含まれていたメッセージID |
| Return | 戻り値(0) |
| ret | エラー時の戻り値(負の値)(正常時は、この項目は省略される) |
モーター関連
moveHeadRes
| 項目名 | 値 |
| Name | “moveHeadRes” |
| Return | 0 |
stopHeadRes
| 項目名 | 値 |
| Name | “stopHeadRes” |
| Return | 0 |
resetHeadRes
| 項目名 | 値 |
| Name | “resetHeadRes” |
| Return | 0 |
getHeadStatusRes
| 項目名 | 値 |
| Name | “getHeadStatusRes” |
| Return | 0(停止中)又は1(動作中) |
| Vertical | 位置情報(縦) |
| Horizontal | 位置情報(横) |
LED関連
turnLedOnRes
| 項目名 | 値 |
| Name | “turnLedOnRes” |
| Return | 0 |
turnLedOffRes
| 項目名 | 値 |
| Name | “turnLedOffRes” |
| Return | 0 |
setDefaultStatusRes
| 項目名 | 値 |
| Name | “setDefaultStatusRes” |
| Return | 0 |
getDefaultStatusRes
| 項目名 | 値 |
| Name | “getDefaultStatusRes” |
| Return | 輝度のデフォルト値 |
getLedStatusRes
| 項目名 | 値 |
| Name | “getLedStatusRes” |
| Return | 0(停止中)又は1(動作中) |
音声合成関連
startSpeechRes
| 項目名 | 値 |
| Name | “startSpeechRes” |
| Return | 0 |
pauseSpeechRes
| 項目名 | 値 |
| Name | “pauseSpeechRes” |
| Return | 0 |
resumeSpeechRes
| 項目名 | 値 |
| Name | “resumeSpeechRes” |
| Return | 0 |
stopSpeechRes
| 項目名 | 値 |
| Name | “stopSpeechRes” |
| Return | 0 |
getSpeechStatusRes
| 項目名 | 値 |
| Name | “getSpeechStatusRes” |
| Return | 0(停止中)、1(発話中)、2(一時停止中)のいずれか |
setDefaultStatusRes
| 項目名 | 値 |
| Name | “setDefaultStatusRes” |
| Return | 0 |
getDefaultStatusRes
| 項目名 | 値 |
| Name | “getDefaultStatusRes” |
| Return | 0 |
| Language | “0”:日本語、”1″:英語、”2″:中国語のいずれか |
| SpeakerID | 話者ID |
| Pitch | 音程高低(“50″～”200”) |
| Speed | 発話速度(“50″～”400”) |
| Volume | 発話音量(“0″～”500”) |
| Pause | 文章間ポーズ時間(“0″～”65535”) |
| CommaPause | カンマのポーズ時間(“0″～”65535”) |
センサー関連
getSensorValueRes
| 項目名 | 値 |
| Name | “getSensorValueRes” |
| Return | 0 |
| USS | 不定 |
| IR | 赤外線センサ自体の温度と素子の値①～④、位置情報をコンマ区切り で格納。 |
| TEM | 温度計の温度 |
| HYG | 湿度計の湿度 |
| LUX | 照度 |
startAccSensorRes
| 項目名 | 値 |
| Name | “startAccSensorRes” |
| Return | 0 |
stopAccSensorRes
| 項目名 | 値 |
| Name | “stopAccSensorRes” |
| Return | 0 |
setAccSensorRes
| 項目名 | 値 |
| Name | “setAccSensorRes” |
| Return | 0 |
getAccSensorStateRes
| 項目名 | 値 |
| Name | “getAccSensorStateRes” |
| Return | 0(停止中)又は1(動作中) |
setAccSensorThresholdRes
| 項目名 | 値 |
| Name | “setAccSensorThresholdRes” |
| Return | 0 |
startLumSensorRes
| 項目名 | 値 |
| Name | “startLumSensorRes” |
| Return | 0 |
stopLumSensorRes
| 項目名 | 値 |
| Name | “stopLumSensorRes” |
| Return | 0 |
getLumSensorValueRes
| 項目名 | 値 |
| Name | “getLumSensorValueRes” |
| Return | 照度データ値 |
getLumSensorStateRes
| 項目名 | 値 |
| Name | “getLumSensorStateRes” |
| Return | 0(停止中)又は1(動作中) |
cancelCommandRes
| 項目名 | 値 |
| Name | “cancelCommandRes” |
| Return | 0 |
音声認識関連
startSpeechRecognitionRes
| 項目名 | 値 |
| Name | “startSpeechRecognitionRes” |
| Return | 0 |
stopSpeechRecognitionRes
| 項目名 | 値 |
| Name | “stopSpeechRecognitionRes” |
| Return | 0 |
getSpeechRecognitionStatusRes
| 項目名 | 値 |
| Name | “getSpeechRecognitionStatusRes” |
| Return | 0(認識をしていない状態)、1(認識をを開始し発話を待っている状態)、2(発話を検知し認識動作中)のいずれか |
readDictionaryRes
| 項目名 | 値 |
| Name | “readDictionaryRes” |
| Return | 0 |
freeDictionaryRes
| 項目名 | 値 |
| Name | “freeDictionaryRes” |
| Return | 0 |
addSpeechRecognitionRuleRes
| 項目名 | 値 |
| Name | “addSpeechRecognitionRuleRes” |
| Return | 0 |
deleteSpeechRecognitionRuleRes
| 項目名 | 値 |
| Name | “deleteSpeechRecognitionRuleRes” |
| Return | 0 |
カメラ関連
takePictureRes
| 項目名 | 値 |
| Name | “takePictureRes” |
| Return | 0 |
| CaptureDataSize | 出力したバイト数 |
| Filename | 出力したファイル名(フルパス) |
deleteCaptureDataRes
| 項目名 | 値 |
| Name | “deleteCaptureDataRes” |
| Return | 0 |
startCapturingRes
| 項目名 | 値 |
| Name | “startCapturingRes” |
| Return | 0 |
stopCapturingRes
| 項目名 | 値 |
| Name | “stopCapturingRes” |
| Return | 0 |
getCaptureDataRes
| 項目名 | 値 |
| Name | “getCaptureDataRes” |
| Return | 0 |
| CaptureDataSize | キャプチャデータのサイズ（バイト） |
setCameraStatusRes
| 項目名 | 値 |
| Name | “setCameraStatusRes” |
| Return | 0 |
getCameraStatusRes
| 項目名 | 値 |
| Name | “getCameraStatusRes” |
| Return | 0 |
上記以外に、getCameraStatusのObjectで指定した項目が追加されます。
getOneShotCaptureDataRes
| 項目名 | 値 |
| Name | “getOneShotCaptureDataRes” |
| Return | 0 |
| CaptureDataSize | キャプチャデータのサイズ（バイト） |
顔検出関連
startFaceDetectionRes
| 項目名 | 値 |
| Name | “startFaceDetectionRes” |
| Return | 0 |
stopFaceDetectionRes
| 項目名 | 値 |
| Name | “stopFaceDetectionRes” |
| Return | 0 |
録音関連
startRecordingRes
| 項目名 | 値 |
| Name | “startRecordingRes” |
| Return | 0 |
stopRecordingRes
| 項目名 | 値 |
| Name | “stopRecordingRes” |
| Return | 0 |
deleteRecordingDataRes
| 項目名 | 値 |
| Name | “deleteRecordingDataRes” |
| Return | 0 |
getRecordingStatusRes
| 項目名 | 値 |
| Name | “getRecordingStatusRes” |
| Return | 0(アイドル)又は1(録音中) |
setDefaultStatusRes
| 項目名 | 値 |
| Name | “setDefaultStatusRes” |
| Return | 0 |
上記以外にsetDefaultStatusで変更された項目が追加されます。
getDefaultStatusRes
| 項目名 | 値 |
| Name | “getDefaultStatusRes” |
| Return | 0 |
上記以外にgetDefaultStatusのObjectで指定された項目が追加されます。
再生関連
startPlayingRes
| 項目名 | 値 |
| Name | “startPlayingRes” |
| Return | 0 |
stopPlayingRes
| 項目名 | 値 |
| Name | “stopPlayingRes” |
| Return | 0 |
deleteWaveDataRes
| 項目名 | 値 |
| Name | “deleteWaveDataRes” |
| Return | 0 |
getPlayingStatusRes
| 項目名 | 値 |
| Name | “getPlayingStatusRes” |
| Return | 0(アイドル)又は1(再生中) |
setDefaultStatusRes
| 項目名 | 値 |
| Name | “setDefaultStatusRes” |
| Return | 0 |
上記以外にsetDefaultStatusで変更された項目が追加されます。
getDefaultStatusRes
| 項目名 | 値 |
| Name | “getDefaultStatusRes” |
| Return | 0 |
上記以外にgetDefaultStatusのObjectで指定された項目が追加されます。
汎用モーション関連
startMotionRes
| 項目名 | 値 |
| Name | “startMotionRes” |
| Return | 0 |
stopMotionRes
| 項目名 | 値 |
| Name | “stopMotionRes” |
| Return | 0 |
共通項目
| 項目名 | 値 |
| Name | レスポンス名称を指定するための文字列。レスポンス毎に異なる。 |
| Type | “Response” |
| Destination | “Script” |
| Source | “MotorController”(モーター関連)、”LEDController”(LED関連)、”SensorController”(センサー関連)、”SpeechRecognizer”(音声認識関連)、”CameraController”(カメラ関連)、”FaceDetection”(顔検出関連)のいずれか |
| Time | レスポンスの送信時刻を示す文字列。 フォーマットは YYYY-MM-DD hh:mm:ssとし、タイムゾーンは端末に従う。 例) Time=2012-03-05 13:00:00 |
| Expiration | イベントの有効期間(秒)を示す数値文字列 |
| Priority | イベントに対する優先度を示す文字列。”higher”又は”normal” |
モーター関連
moveFinish
(首振り動作(moveHead)が正常に終了した事を通知する)
| 項目名 | 値 |
| Name | “moveFinish” |
| MessageID | 対応する首振りコマンドの応答(moveHeadRes)で返されたMessageID |
moveError
(首振り動作中(moveHead実行中)にエラーが発生したことを通知する)
| 項目名 | 値 |
| Name | “moveError” |
| MessageID | 対応する首振りコマンドの応答(moveHeadRes)で返されたMessageID |
LED関連
earFinish
(耳 LED点灯動作が正常に終了したことを通知する)
| 項目名 | 値 |
| Name | “earFinish” |
| MessageID | 耳 指定のLEDの発光コマンドに対するturnLedOnResのMessageID |
foreheadFinish
(額 LED点灯動作が正常に終了したことを通知する)
| 項目名 | 値 |
| Name | “foreheadFinish” |
| MessageID | 額 指定のLEDの発光コマンドに対するturnLedOnResのMessageID |
cheekFinish
(頬 LED点灯動作が正常に終了したことを通知する)
| 項目名 | 値 |
| Name | “cheekFinish” |
| MessageID | 頬 指定のLEDの発光コマンドに対するturnLedOnResのMessageID |
mouthFinish
(口 LED点灯動作が正常に終了したことを通知する)
| 項目名 | 値 |
| Name | “mouthFinish” |
| MessageID | 口 指定のLEDの発光コマンドに対するturnLedOnResのMessageID |
chestFinish
(胸 LED点灯が正常に終了したことを通知する)
| 項目名 | 値 |
| Name | “chestFinish” |
| MessageID | 胸 指定のLEDの発光コマンドに対するturnLedOnResのMessageID |
センサー関連
detectObjectIR
(赤外線センサで熱源物体を見つけたことを通知する)
| 項目名 | 値 |
| Name | “detectObjectIR” |
| Mode | “DETECT”(熱源を検知した事を示す)、”LOST”(見失った事を示す)のいずれか |
| ObjectPos | “Center”(中央)、”Left”(左)、”Right”(右)のいずれか。見失った場合は省略される。 |
detectButton
(足元にあるボタンが押されたことを通知する)
| 項目名 | 値 |
| Name | “detectButton” |
| Status | “L”(左ボタン)、”C”(真ん中ボタン)、”R”(右ボタン)のいずれか |
detectHeadButton
(頭スイッチが押されたことを通知する)
| 項目名 | 値 |
| Name | “detectHeadButton” |
| Priority | “higher” |
detectStepOut
(モータが脱調状態または位置不定状態になったことを通知する)
| 項目名 | 値 |
| Name | “detectStepOut” |
| LostPosition | 位置不定フラグ ”0″：未検知、”1″：検知 （縦と横のフラグのOR値） |
| LostControl | 脱調フラグ ”0″：未検知 1：検知 （縦と横のフラグの OR 値） |
LostPosition と LostControl の両方が 0 のケースはありません（どちらかまたは両方が1）。
モータが脱調または位置不定を起こすのは主に次のようなケースです。
・動作中に頭スイッチを押して緊急停止させた
・加速度が大きすぎてモータが物理的に追従しなくなった
detectAccYaw
(加速度計センサによって揺れが検知された事、又は揺れがおさまった事を通知する)
| 項目名 | 値 |
| Name | “detectAccYaw” |
| Mode | “DETECT”：加速度計センサから取得するXYZ軸加速度計測値の絶対値加算√(X^2+Y^2+Z^2)値が、閾値を所定回数上回った場合に通知します。 “LOST”：加速度計センサから取得するXYZ軸加速度計測値の絶対値加算√(X^2+Y^2+Z^2)値が、閾値を所定秒数期間連続して下回った場合に通知します。 |
音声認識関連
detectPhrase
(認識結果が得られたことおよび、認識結果を通知する)
| 項目名 | 値 |
| Name | “detectPhrase” |
| RuleName | ルール名 |
| Expression | 単語表記 |
| Pronunciation | 単語読み |
カメラ関連
capturingError
(エラーの発生を通知する)
| 項目名 | 値 |
| Name | “capturingError” |
| ErrorCode | エラーコード(負の値) |
顔検出関連
detectFace
(顔を検出したことを通知する。連続検出している場合は、1度だけ発行する。)
| 項目名 | 値 |
| Name | “detectFace” |
| LeftEyePos | 検出した左目のピクセル座標を”X,Y”形式で示す。 (顔検出エンジンが検出した 1 件目のみ通知) |
| RightEyePos | 検出した右目のピクセル座標を”X,Y”形式で示す。 (顔検出エンジンが検出した 1 件目のみ通知) |
| Framesize | “検出に用いた画像のピクセルサイズを”X,Y”形式で示す。 FacePos から画像の相対位置を判断するために使用する。 |
| HeadPos | 検出時点のロボットの頭の向きを角度”Virtical,Horizontal”形式で示す。 |
undetectFace
(直前フレームまで検出していた顔が検出されなくなったことを通知する)
| 項目名 | 値 |
| Name | “undetectFace” |