トレース: • api

API

このページではロボットをカスタマイズする際に利用できるAPIについて記述する。SysUI経由で内部APPからのみ送受信可能なものは、連携が×となっておりそれ以外は、HTTP通信によって外部機器から送受信可能となっている。

種類

APIには4種類あり、以下一覧ではそれぞれに分けて説明する。

  1. 設定
    • ロボットに対して設定を行うコマンド
  2. 取得
    • 取得はロボットの設定等を取得する。

- 指示

  • 記号なしリスト指示はロボットに対して指示を行う。
  • その際の応答は、命令を受信したというACK以外はinfoやresなどでpush形で返却されることを想定している。
  1. 通知
  • ロボットからpush形でくる通知系。目的地に着いた時や障害物検知停止した時など。内部APIとしては、イベント通知登録を事前にしておくことで、画面を強制遷移させる形で受信することができる。

API一覧

設定

対象項目名詳細連携
外部機器通知先設定ロボット側からpush通知を行う通知型APIの宛先サーバを設定する○

取得

対象項目名詳細連携
移動マップ一覧取得ロボットに割り当てされているマップ情報一覧を取得する○
現在地取得ロボットの現在位置情報（マークID、地点名称等）を取得する○
システム情報取得ロボットの走行状態を取得する×

指示

対象項目名詳細連携
移動マップ切替指示ロボットのカレントマップを切り替えを指示する○
移動指示目的地への移動を指示する○
移動キャンセル指示目的地移動をキャンセルする○
再設置指示ロボットが経路を外れた場合に、経路復帰させる場合に、ロボットに対して位置情報を把握させる○
USB機器電文送信指示USB機器へ電文を送信する×
汎用USBデータ取得指示汎用USB連携のキャッシュからデータ取得の依頼を行う×

通知

対象項目名詳細連携
障害物検知通知目的地移動時に障害物を検知し停止た場合に通知する○
移動再開通知障害物が排除され、目的地移動を再開する場合に通知する○
衝突検知通知ロボット走行時、バンパセンサ検知等が発生し、移動が中断された場合に通知する○
マップ切替完了通知ロボットのカレントマップを切り替え完了結果を通知する○
目的地移動開始通知目的地への移動開始を行ったことを通知する○
マップ一覧取得通知マップ情報（マークID、座標）、マップ画像の各ファイル名を返却する○
外部機器汎用USBデータ取得結果通知汎用USB連携のキャッシュに保持されたデータの返却を行う×
汎用USBキャッシュクリア通知汎用USB連携のキャッシュが溢れて切り詰めが行われたことを通知する×

基本フォーマット

移動指示

{ 

"type":"req_move",	
"data":{	
	"speech_text":"○○○○へ移動します",
	"audio_dataid":"",
	"notice":"ON",
	"goal_destination_id":"1234567890123456",
	"speed_rate":100,
	"another_route": 1
}

}