Kachaka API v3.18.1

ActivateLaserScan

kachaka_api.KachakaApi/ActivateLaserScan unary

指定した秒数だけレーザーセンサーを起動します。duration_sec は正の値にしてください。

Request

Field	Type	Notes
duration_sec	number	レーザーセンサーを起動する秒数です。正の値を指定してください。

Response

Field	Type	Notes
result	Result	実行結果です。
result.success	boolean	成功したかどうかを示します。
result.error_code	integer	エラーコードです。成功時は 0 です。

{
  "duration_sec": 0.0
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"duration_sec": 0.0}' <hostname>:26400 kachaka_api.KachakaApi/ActivateLaserScan

AddSound

kachaka_api.KachakaApi/AddSound unary

効果音を追加します。

Request

Field	Type	Notes
name	string	表示名です。
data	string	バイナリデータです（JSON では base64 です）。

Response

Field	Type	Notes
result	Result	実行結果です。
result.success	boolean	成功したかどうかを示します。
result.error_code	integer	エラーコードです。成功時は 0 です。
sound_id	string	効果音 ID です。

{
  "name": "",
  "data": ""
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"name": "", "data": ""}' <hostname>:26400 kachaka_api.KachakaApi/AddSound

CancelCommand

kachaka_api.KachakaApi/CancelCommand unary

実行中のタスクを停止します。

Request

Field	Type	Notes

Response

Field	Type	Notes
result	Result	実行結果です。
result.success	boolean	成功したかどうかを示します。
result.error_code	integer	エラーコードです。成功時は 0 です。
command	Command	実行するコマンドです。oneof のうち 1 つを指定します。
command.move_shelf_command	MoveShelfCommand	家具を目的地へ運ぶコマンドです。
command.move_shelf_command.target_shelf_id	string	対象の家具 ID です。
command.move_shelf_command.destination_location_id	string	運び先の目的地 ID です。
command.move_shelf_command.undock_on_destination	boolean	到着後に家具を置くかどうかを指定します。
command.return_shelf_command	ReturnShelfCommand	家具を片付け先へ戻すコマンドです。
command.return_shelf_command.target_shelf_id	string	対象の家具 ID です。
command.undock_shelf_command	UndockShelfCommand	家具を置くコマンドです。
command.undock_shelf_command.target_shelf_id	string	対象の家具 ID です。要求時は空のままで構いません。状態や結果を取得する時点で、置いた家具の ID が入ります。
command.move_to_location_command	MoveToLocationCommand	目的地へ移動するコマンドです。
command.move_to_location_command.target_location_id	string	目的地 ID です。
command.move_to_location_command.source_location_id	string	移動の開始地点にする目的地 ID です。空文字の場合は現在位置から移動します。
command.return_home_command	ReturnHomeCommand	充電ドックへ戻るコマンドです。
command.dock_shelf_command	DockShelfCommand	家具を載せるコマンドです。
command.speak_command	SpeakCommand	発話コマンドです。
command.speak_command.text	string	発話する文章です。
command.move_to_pose_command	MoveToPoseCommand	座標指定で移動するコマンドです。
command.move_to_pose_command.x	number	X 座標（メートル）です。
command.move_to_pose_command.y	number	Y 座標（メートル）です。
command.move_to_pose_command.yaw	number	向き（ラジアン）です。
command.lock_command	LockCommand	その場で待機するコマンドです。
command.lock_command.duration_sec	number	秒数です。
command.move_forward_command	MoveForwardCommand	前後移動コマンドです。
command.move_forward_command.distance_meter	number	進む距離（メートル）です。正の値は前進、負の値は後退です。
command.move_forward_command.speed	number	速度（メートル毎秒）です。
command.move_forward_command.mute_sensors	boolean	センサーによる停止を無効にするかどうかを指定します。
command.rotate_in_place_command	RotateInPlaceCommand	その場回転コマンドです。
command.rotate_in_place_command.angle_radian	number	回転角（ラジアン）です。
command.dock_any_shelf_with_registration_command	DockAnyShelfWithRegistrationCommand	家具を登録しながら載せるコマンドです。Kachaka Pro 専用です。
command.dock_any_shelf_with_registration_command.target_location_id	string	目的地 ID です。
command.dock_any_shelf_with_registration_command.dock_forward	boolean	前向きに載せるかどうかを指定します。
command.localize_command	LocalizeCommand	自己位置推定コマンドです。
command.move_by_velocity_with_muted_sensors_command	MoveByVelocityWithMutedSensorsCommand	センサーを無効にして速度指定で移動するコマンドです。
command.move_by_velocity_with_muted_sensors_command.signed_velocity	number	移動速度（メートル毎秒）です。正の値は前進、負の値は後退です。
command.move_by_velocity_with_muted_sensors_command.move_duration_sec	number	その速度で移動する秒数です。
command.depart_from_charger_command	DepartFromChargerCommand	充電ドックから離れるコマンドです。

{}

grpcurl -plaintext -proto kachaka-api.proto -d '{}' <hostname>:26400 kachaka_api.KachakaApi/CancelCommand

DeleteSound

kachaka_api.KachakaApi/DeleteSound unary

効果音を削除します。

Request

Field	Type	Notes
sound_id	string	効果音 ID です。

Response

Field	Type	Notes
result	Result	実行結果です。
result.success	boolean	成功したかどうかを示します。
result.error_code	integer	エラーコードです。成功時は 0 です。

{
  "sound_id": ""
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"sound_id": ""}' <hostname>:26400 kachaka_api.KachakaApi/DeleteSound

ExportMap

kachaka_api.KachakaApi/ExportMap server-stream

指定したマップのデータを書き出します（サーバストリーム）。

Request

Field	Type	Notes
map_id	string	マップ ID です。

Response

Field	Type	Notes
middle_of_stream	ExportMapResponse_MiddleOfStream	ストリーム途中のチャンクです。
middle_of_stream.data	string	バイナリデータです（JSON では base64 です）。
end_of_stream	ExportMapResponse_EndOfStream	ストリーム終端です。
end_of_stream.result	Result	実行結果です。
end_of_stream.result.success	boolean	成功したかどうかを示します。
end_of_stream.result.error_code	integer	エラーコードです。成功時は 0 です。

{
  "map_id": ""
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"map_id": ""}' <hostname>:26400 kachaka_api.KachakaApi/ExportMap

GetAutoHomingEnabled

kachaka_api.KachakaApi/GetAutoHomingEnabled unary

充電ドックへ自動で戻る機能が有効かを取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
enabled	boolean	有効かどうかを示します。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetAutoHomingEnabled

GetBackCameraRosCameraInfo

kachaka_api.KachakaApi/GetBackCameraRosCameraInfo unary

後方カメラのカメラ情報を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
camera_info	RosCameraInfo	カメラの内部パラメータです。
camera_info.header	RosHeader	ROS ヘッダです。
camera_info.header.stamp_nsec	string|integer	タイムスタンプ（ナノ秒）です。
camera_info.header.frame_id	string	座標系の名前です。
camera_info.height	integer	高さです。
camera_info.width	integer	幅です。
camera_info.distortion_model	string	歪みモデル名です。
camera_info.D	array<number>	歪み係数です。
camera_info.K	array<number>	カメラ行列（3x3）です。
camera_info.R	array<number>	回転行列（3x3）です。
camera_info.P	array<number>	投影行列（3x4）です。
camera_info.binning_x	integer	x方向のビニングです。
camera_info.binning_y	integer	y方向のビニングです。
camera_info.roi	RegionOfInterest	画像上の領域です。
camera_info.roi.x_offset	integer	ROI の X オフセットです。
camera_info.roi.y_offset	integer	ROI の Y オフセットです。
camera_info.roi.height	integer	高さです。
camera_info.roi.width	integer	幅です。
camera_info.roi.do_rectify	boolean	歪み補正するかどうかを指定します。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetBackCameraRosCameraInfo

GetBackCameraRosCompressedImage

kachaka_api.KachakaApi/GetBackCameraRosCompressedImage unary

後方カメラの圧縮画像を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
image	RosCompressedImage	画像です。
image.header	RosHeader	ROS ヘッダです。
image.header.stamp_nsec	string|integer	タイムスタンプ（ナノ秒）です。
image.header.frame_id	string	座標系の名前です。
image.format	string	圧縮画像のフォーマット名です。
image.data	string	バイナリデータです（JSON では base64 です）。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetBackCameraRosCompressedImage

GetBackCameraRosImage

kachaka_api.KachakaApi/GetBackCameraRosImage unary

後方カメラの画像を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
image	RosImage	画像です。
image.header	RosHeader	ROS ヘッダです。
image.header.stamp_nsec	string|integer	タイムスタンプ（ナノ秒）です。
image.header.frame_id	string	座標系の名前です。
image.height	integer	高さです。
image.width	integer	幅です。
image.encoding	string	画素のエンコーディングです。
image.is_bigendian	boolean	ビッグエンディアンかどうかを示します。
image.step	integer	1 行あたりのバイト数です。
image.data	string	バイナリデータです（JSON では base64 です）。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetBackCameraRosImage

GetBatteryInfo

kachaka_api.KachakaApi/GetBatteryInfo unary

バッテリー残量と充電状態を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
remaining_percentage	number	バッテリー残量（0〜100）です。
power_supply_status	PowerSupplyStatus	充電状態です。
power_supply_status.POWER_SUPPLY_STATUS_UNSPECIFIED	enum	充電状態が不明です。
power_supply_status.POWER_SUPPLY_STATUS_CHARGING	enum	充電中です。
power_supply_status.POWER_SUPPLY_STATUS_DISCHARGING	enum	放電中です。
power_supply_status.POWER_SUPPLY_STATUS_NOT_CHARGING	enum	充電していません。
power_supply_status.POWER_SUPPLY_STATUS_FULL	enum	満充電です。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetBatteryInfo

GetCommandState

kachaka_api.KachakaApi/GetCommandState unary

実行中のコマンドの状態を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
state	CommandState	コマンドの実行状態です。PENDING は待機中、RUNNING は実行中です。
state.COMMAND_STATE_UNSPECIFIED	enum	状態が不明です。
state.COMMAND_STATE_PENDING	enum	実行中のコマンドはありません。
state.COMMAND_STATE_RUNNING	enum	コマンドを実行中です。
command	Command	実行するコマンドです。oneof のうち 1 つを指定します。
command.move_shelf_command	MoveShelfCommand	家具を目的地へ運ぶコマンドです。
command.move_shelf_command.target_shelf_id	string	対象の家具 ID です。
command.move_shelf_command.destination_location_id	string	運び先の目的地 ID です。
command.move_shelf_command.undock_on_destination	boolean	到着後に家具を置くかどうかを指定します。
command.return_shelf_command	ReturnShelfCommand	家具を片付け先へ戻すコマンドです。
command.return_shelf_command.target_shelf_id	string	対象の家具 ID です。
command.undock_shelf_command	UndockShelfCommand	家具を置くコマンドです。
command.undock_shelf_command.target_shelf_id	string	対象の家具 ID です。要求時は空のままで構いません。状態や結果を取得する時点で、置いた家具の ID が入ります。
command.move_to_location_command	MoveToLocationCommand	目的地へ移動するコマンドです。
command.move_to_location_command.target_location_id	string	目的地 ID です。
command.move_to_location_command.source_location_id	string	移動の開始地点にする目的地 ID です。空文字の場合は現在位置から移動します。
command.return_home_command	ReturnHomeCommand	充電ドックへ戻るコマンドです。
command.dock_shelf_command	DockShelfCommand	家具を載せるコマンドです。
command.speak_command	SpeakCommand	発話コマンドです。
command.speak_command.text	string	発話する文章です。
command.move_to_pose_command	MoveToPoseCommand	座標指定で移動するコマンドです。
command.move_to_pose_command.x	number	X 座標（メートル）です。
command.move_to_pose_command.y	number	Y 座標（メートル）です。
command.move_to_pose_command.yaw	number	向き（ラジアン）です。
command.lock_command	LockCommand	その場で待機するコマンドです。
command.lock_command.duration_sec	number	秒数です。
command.move_forward_command	MoveForwardCommand	前後移動コマンドです。
command.move_forward_command.distance_meter	number	進む距離（メートル）です。正の値は前進、負の値は後退です。
command.move_forward_command.speed	number	速度（メートル毎秒）です。
command.move_forward_command.mute_sensors	boolean	センサーによる停止を無効にするかどうかを指定します。
command.rotate_in_place_command	RotateInPlaceCommand	その場回転コマンドです。
command.rotate_in_place_command.angle_radian	number	回転角（ラジアン）です。
command.dock_any_shelf_with_registration_command	DockAnyShelfWithRegistrationCommand	家具を登録しながら載せるコマンドです。Kachaka Pro 専用です。
command.dock_any_shelf_with_registration_command.target_location_id	string	目的地 ID です。
command.dock_any_shelf_with_registration_command.dock_forward	boolean	前向きに載せるかどうかを指定します。
command.localize_command	LocalizeCommand	自己位置推定コマンドです。
command.move_by_velocity_with_muted_sensors_command	MoveByVelocityWithMutedSensorsCommand	センサーを無効にして速度指定で移動するコマンドです。
command.move_by_velocity_with_muted_sensors_command.signed_velocity	number	移動速度（メートル毎秒）です。正の値は前進、負の値は後退です。
command.move_by_velocity_with_muted_sensors_command.move_duration_sec	number	その速度で移動する秒数です。
command.depart_from_charger_command	DepartFromChargerCommand	充電ドックから離れるコマンドです。
command_id	string	コマンドの識別子です。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetCommandState

GetCurrentMapId

kachaka_api.KachakaApi/GetCurrentMapId unary

現在読み込んでいるマップの ID を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
id	string	現在のマップ ID です。マップが無い場合は空文字です。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetCurrentMapId

GetDynamicTransform

kachaka_api.KachakaApi/GetDynamicTransform server-stream

動的な座標変換（TF）を取得します（サーバストリーム）。

Request

Field	Type	Notes

Response

Field	Type	Notes
transforms	array<RosTransformStamped>	座標変換の一覧です。
transforms[].header	RosHeader	ROS ヘッダです。
transforms[].header.stamp_nsec	string|integer	タイムスタンプ（ナノ秒）です。
transforms[].header.frame_id	string	座標系の名前です。
transforms[].child_frame_id	string	子座標系の名前です。
transforms[].translation	Vector3	平行移動です。
transforms[].translation.x	number	平行移動 X（メートル）です。
transforms[].translation.y	number	平行移動 Y（メートル）です。
transforms[].translation.z	number	平行移動 Z（メートル）です。
transforms[].rotation	Quaternion	回転（クォータニオン）です。
transforms[].rotation.x	number	クォータニオンの x です。
transforms[].rotation.y	number	クォータニオンの y です。
transforms[].rotation.z	number	クォータニオンの z です。
transforms[].rotation.w	number	クォータニオンの w です。

{}

grpcurl -plaintext -proto kachaka-api.proto -d '{}' <hostname>:26400 kachaka_api.KachakaApi/GetDynamicTransform

GetError

kachaka_api.KachakaApi/GetError unary

現在発生しているエラーコードの一覧を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
error_codes	array<integer>	発生中のエラーコードの一覧です。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetError

GetFrontCameraRosCameraInfo

kachaka_api.KachakaApi/GetFrontCameraRosCameraInfo unary

前方カメラのカメラ情報を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
camera_info	RosCameraInfo	カメラの内部パラメータです。
camera_info.header	RosHeader	ROS ヘッダです。
camera_info.header.stamp_nsec	string|integer	タイムスタンプ（ナノ秒）です。
camera_info.header.frame_id	string	座標系の名前です。
camera_info.height	integer	高さです。
camera_info.width	integer	幅です。
camera_info.distortion_model	string	歪みモデル名です。
camera_info.D	array<number>	歪み係数です。
camera_info.K	array<number>	カメラ行列（3x3）です。
camera_info.R	array<number>	回転行列（3x3）です。
camera_info.P	array<number>	投影行列（3x4）です。
camera_info.binning_x	integer	x方向のビニングです。
camera_info.binning_y	integer	y方向のビニングです。
camera_info.roi	RegionOfInterest	画像上の領域です。
camera_info.roi.x_offset	integer	ROI の X オフセットです。
camera_info.roi.y_offset	integer	ROI の Y オフセットです。
camera_info.roi.height	integer	高さです。
camera_info.roi.width	integer	幅です。
camera_info.roi.do_rectify	boolean	歪み補正するかどうかを指定します。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetFrontCameraRosCameraInfo

GetFrontCameraRosCompressedImage

kachaka_api.KachakaApi/GetFrontCameraRosCompressedImage unary

前方カメラの圧縮画像を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
image	RosCompressedImage	画像です。
image.header	RosHeader	ROS ヘッダです。
image.header.stamp_nsec	string|integer	タイムスタンプ（ナノ秒）です。
image.header.frame_id	string	座標系の名前です。
image.format	string	圧縮画像のフォーマット名です。
image.data	string	バイナリデータです（JSON では base64 です）。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetFrontCameraRosCompressedImage

GetFrontCameraRosImage

kachaka_api.KachakaApi/GetFrontCameraRosImage unary

前方カメラの画像を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
image	RosImage	画像です。
image.header	RosHeader	ROS ヘッダです。
image.header.stamp_nsec	string|integer	タイムスタンプ（ナノ秒）です。
image.header.frame_id	string	座標系の名前です。
image.height	integer	高さです。
image.width	integer	幅です。
image.encoding	string	画素のエンコーディングです。
image.is_bigendian	boolean	ビッグエンディアンかどうかを示します。
image.step	integer	1 行あたりのバイト数です。
image.data	string	バイナリデータです（JSON では base64 です）。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetFrontCameraRosImage

GetHistoryList

kachaka_api.KachakaApi/GetHistoryList unary

実行履歴の一覧を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
histories	array<History>	実行履歴の一覧です。
histories[].id	string	識別子です。
histories[].command	Command	実行するコマンドです。oneof のうち 1 つを指定します。
histories[].command.move_shelf_command	MoveShelfCommand	家具を目的地へ運ぶコマンドです。
histories[].command.move_shelf_command.target_shelf_id	string	対象の家具 ID です。
histories[].command.move_shelf_command.destination_location_id	string	運び先の目的地 ID です。
histories[].command.move_shelf_command.undock_on_destination	boolean	到着後に家具を置くかどうかを指定します。
histories[].command.return_shelf_command	ReturnShelfCommand	家具を片付け先へ戻すコマンドです。
histories[].command.return_shelf_command.target_shelf_id	string	対象の家具 ID です。
histories[].command.undock_shelf_command	UndockShelfCommand	家具を置くコマンドです。
histories[].command.undock_shelf_command.target_shelf_id	string	対象の家具 ID です。要求時は空のままで構いません。状態や結果を取得する時点で、置いた家具の ID が入ります。
histories[].command.move_to_location_command	MoveToLocationCommand	目的地へ移動するコマンドです。
histories[].command.move_to_location_command.target_location_id	string	目的地 ID です。
histories[].command.move_to_location_command.source_location_id	string	移動の開始地点にする目的地 ID です。空文字の場合は現在位置から移動します。
histories[].command.return_home_command	ReturnHomeCommand	充電ドックへ戻るコマンドです。
histories[].command.dock_shelf_command	DockShelfCommand	家具を載せるコマンドです。
histories[].command.speak_command	SpeakCommand	発話コマンドです。
histories[].command.speak_command.text	string	発話する文章です。
histories[].command.move_to_pose_command	MoveToPoseCommand	座標指定で移動するコマンドです。
histories[].command.move_to_pose_command.x	number	X 座標（メートル）です。
histories[].command.move_to_pose_command.y	number	Y 座標（メートル）です。
histories[].command.move_to_pose_command.yaw	number	向き（ラジアン）です。
histories[].command.lock_command	LockCommand	その場で待機するコマンドです。
histories[].command.lock_command.duration_sec	number	秒数です。
histories[].command.move_forward_command	MoveForwardCommand	前後移動コマンドです。
histories[].command.move_forward_command.distance_meter	number	進む距離（メートル）です。正の値は前進、負の値は後退です。
histories[].command.move_forward_command.speed	number	速度（メートル毎秒）です。
histories[].command.move_forward_command.mute_sensors	boolean	センサーによる停止を無効にするかどうかを指定します。
histories[].command.rotate_in_place_command	RotateInPlaceCommand	その場回転コマンドです。
histories[].command.rotate_in_place_command.angle_radian	number	回転角（ラジアン）です。
histories[].command.dock_any_shelf_with_registration_command	DockAnyShelfWithRegistrationCommand	家具を登録しながら載せるコマンドです。Kachaka Pro 専用です。
histories[].command.dock_any_shelf_with_registration_command.target_location_id	string	目的地 ID です。
histories[].command.dock_any_shelf_with_registration_command.dock_forward	boolean	前向きに載せるかどうかを指定します。
histories[].command.localize_command	LocalizeCommand	自己位置推定コマンドです。
histories[].command.move_by_velocity_with_muted_sensors_command	MoveByVelocityWithMutedSensorsCommand	センサーを無効にして速度指定で移動するコマンドです。
histories[].command.move_by_velocity_with_muted_sensors_command.signed_velocity	number	移動速度（メートル毎秒）です。正の値は前進、負の値は後退です。
histories[].command.move_by_velocity_with_muted_sensors_command.move_duration_sec	number	その速度で移動する秒数です。
histories[].command.depart_from_charger_command	DepartFromChargerCommand	充電ドックから離れるコマンドです。
histories[].success	boolean	成功したかどうかを示します。
histories[].error_code	integer	エラーコードです。成功時は 0 です。
histories[].command_executed_time	string|integer	実行時刻です。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetHistoryList

GetLastCommandResult

kachaka_api.KachakaApi/GetLastCommandResult unary

直前に完了したコマンドの結果を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
result	Result	直前のコマンドの実行結果です。直前のコマンドが無い場合は空です。
result.success	boolean	成功したかどうかを示します。
result.error_code	integer	エラーコードです。成功時は 0 です。
command	Command	実行するコマンドです。oneof のうち 1 つを指定します。
command.move_shelf_command	MoveShelfCommand	家具を目的地へ運ぶコマンドです。
command.move_shelf_command.target_shelf_id	string	対象の家具 ID です。
command.move_shelf_command.destination_location_id	string	運び先の目的地 ID です。
command.move_shelf_command.undock_on_destination	boolean	到着後に家具を置くかどうかを指定します。
command.return_shelf_command	ReturnShelfCommand	家具を片付け先へ戻すコマンドです。
command.return_shelf_command.target_shelf_id	string	対象の家具 ID です。
command.undock_shelf_command	UndockShelfCommand	家具を置くコマンドです。
command.undock_shelf_command.target_shelf_id	string	対象の家具 ID です。要求時は空のままで構いません。状態や結果を取得する時点で、置いた家具の ID が入ります。
command.move_to_location_command	MoveToLocationCommand	目的地へ移動するコマンドです。
command.move_to_location_command.target_location_id	string	目的地 ID です。
command.move_to_location_command.source_location_id	string	移動の開始地点にする目的地 ID です。空文字の場合は現在位置から移動します。
command.return_home_command	ReturnHomeCommand	充電ドックへ戻るコマンドです。
command.dock_shelf_command	DockShelfCommand	家具を載せるコマンドです。
command.speak_command	SpeakCommand	発話コマンドです。
command.speak_command.text	string	発話する文章です。
command.move_to_pose_command	MoveToPoseCommand	座標指定で移動するコマンドです。
command.move_to_pose_command.x	number	X 座標（メートル）です。
command.move_to_pose_command.y	number	Y 座標（メートル）です。
command.move_to_pose_command.yaw	number	向き（ラジアン）です。
command.lock_command	LockCommand	その場で待機するコマンドです。
command.lock_command.duration_sec	number	秒数です。
command.move_forward_command	MoveForwardCommand	前後移動コマンドです。
command.move_forward_command.distance_meter	number	進む距離（メートル）です。正の値は前進、負の値は後退です。
command.move_forward_command.speed	number	速度（メートル毎秒）です。
command.move_forward_command.mute_sensors	boolean	センサーによる停止を無効にするかどうかを指定します。
command.rotate_in_place_command	RotateInPlaceCommand	その場回転コマンドです。
command.rotate_in_place_command.angle_radian	number	回転角（ラジアン）です。
command.dock_any_shelf_with_registration_command	DockAnyShelfWithRegistrationCommand	家具を登録しながら載せるコマンドです。Kachaka Pro 専用です。
command.dock_any_shelf_with_registration_command.target_location_id	string	目的地 ID です。
command.dock_any_shelf_with_registration_command.dock_forward	boolean	前向きに載せるかどうかを指定します。
command.localize_command	LocalizeCommand	自己位置推定コマンドです。
command.move_by_velocity_with_muted_sensors_command	MoveByVelocityWithMutedSensorsCommand	センサーを無効にして速度指定で移動するコマンドです。
command.move_by_velocity_with_muted_sensors_command.signed_velocity	number	移動速度（メートル毎秒）です。正の値は前進、負の値は後退です。
command.move_by_velocity_with_muted_sensors_command.move_duration_sec	number	その速度で移動する秒数です。
command.depart_from_charger_command	DepartFromChargerCommand	充電ドックから離れるコマンドです。
command_id	string	コマンドの識別子です。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetLastCommandResult

GetLocations

kachaka_api.KachakaApi/GetLocations unary

登録されている目的地の一覧を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
locations	array<Location>	目的地の一覧です。
locations[].id	string	識別子です。
locations[].name	string	表示名です。
locations[].pose	Pose	マップ上の位置と向きです。
locations[].pose.x	number	X 座標（メートル）です。
locations[].pose.y	number	Y 座標（メートル）です。
locations[].pose.theta	number	向き（ラジアン）です。
locations[].type	LocationType	種類です。通常の目的地、充電ドック、家具の片付け先、自己位置補正マーカーがあります。
locations[].type.LOCATION_TYPE_UNSPECIFIED	enum	通常の目的地です。
locations[].type.LOCATION_TYPE_CHARGER	enum	充電ドックです。
locations[].type.LOCATION_TYPE_SHELF_HOME	enum	家具の片付け先です。
locations[].type.LOCATION_TYPE_SLAM_MARKER	enum	自己位置補正マーカーです。
locations[].undock_shelf_aligning_to_wall	boolean	家具を置くとき壁に揃えるかどうかを示します。
locations[].undock_shelf_avoiding_obstacles	boolean	家具を置くとき障害物を避けるかどうかを示します。
locations[].ignore_voice_recognition	boolean	音声認識の対象から外すかどうかを示します。
default_location_id	string	デフォルト目的地の ID です。音声で目的地を指定しなかったときの運び先です。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetLocations

GetLocationsDigest

kachaka_api.KachakaApi/GetLocationsDigest unary

登録されている目的地の要約（ID、名前、種類）を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
locations	array<LocationDigest>	目的地の一覧です。
locations[].id	string	識別子です。
locations[].name	string	表示名です。
locations[].type	LocationType	種類です。通常の目的地、充電ドック、家具の片付け先、自己位置補正マーカーがあります。
locations[].type.LOCATION_TYPE_UNSPECIFIED	enum	通常の目的地です。
locations[].type.LOCATION_TYPE_CHARGER	enum	充電ドックです。
locations[].type.LOCATION_TYPE_SHELF_HOME	enum	家具の片付け先です。
locations[].type.LOCATION_TYPE_SLAM_MARKER	enum	自己位置補正マーカーです。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetLocationsDigest

GetManualControlEnabled

kachaka_api.KachakaApi/GetManualControlEnabled unary

手動操作が有効かを取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
enabled	boolean	有効かどうかを示します。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetManualControlEnabled

GetMapList

kachaka_api.KachakaApi/GetMapList unary

登録されているマップの一覧を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
map_list_entries	array<MapListEntry>	マップの一覧です。
map_list_entries[].id	string	識別子です。
map_list_entries[].name	string	表示名です。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetMapList

GetMovingShelfId

kachaka_api.KachakaApi/GetMovingShelfId unary

現在載せている家具の ID を取得します。載せていない場合は空文字です。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
shelf_id	string	載せている家具の ID です。載せていない場合は空文字です。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetMovingShelfId

GetObjectDetection

kachaka_api.KachakaApi/GetObjectDetection unary

カメラが検出した物体（人、家具、充電ドック、ドア）の一覧を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
header	RosHeader	ROS ヘッダです。
header.stamp_nsec	string|integer	タイムスタンプ（ナノ秒）です。
header.frame_id	string	座標系の名前です。
objects	array<ObjectDetection>	検出した物体の一覧です。
objects[].label	integer	物体の種類です。ObjectLabel の数値（0: 未指定、1: 人、2: 家具、3: 充電ドック、4: ドア）です。
objects[].roi	RegionOfInterest	画像上の領域です。
objects[].roi.x_offset	integer	ROI の X オフセットです。
objects[].roi.y_offset	integer	ROI の Y オフセットです。
objects[].roi.height	integer	高さです。
objects[].roi.width	integer	幅です。
objects[].roi.do_rectify	boolean	歪み補正するかどうかを指定します。
objects[].score	number	検出の確信度です。
objects[].distance_median	number	物体までの距離の中央値（メートル）です。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetObjectDetection

GetObjectDetectionFeatures

kachaka_api.KachakaApi/GetObjectDetectionFeatures unary

物体検出に使う特徴量を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
header	RosHeader	ROS ヘッダです。
header.stamp_nsec	string|integer	タイムスタンプ（ナノ秒）です。
header.frame_id	string	座標系の名前です。
features	array<ObjectDetectionFeatures>	特徴量の一覧です。
features[].name	string	物体名です。
features[].shape	array<integer>	特徴量テンソルの形状です。
features[].data	array<number>	バイナリデータです（JSON では base64 です）。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetObjectDetectionFeatures

GetPngMap

kachaka_api.KachakaApi/GetPngMap unary

現在のマップ画像（PNG）と解像度・原点を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
map	Map	マップ画像とメタデータです。
map.data	string	バイナリデータです（JSON では base64 です）。
map.name	string	表示名です。
map.resolution	number	1 ピクセルあたりのメートルです。
map.width	integer	幅です。
map.height	integer	高さです。
map.origin	Pose	マップ原点のポーズです。
map.origin.x	number	X 座標（メートル）です。
map.origin.y	number	Y 座標（メートル）です。
map.origin.theta	number	向き（ラジアン）です。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetPngMap

GetRobotErrorCodeJson

kachaka_api.KachakaApi/GetRobotErrorCodeJson unary

エラーコードの定義（JSON）を取得します。

Request

Field	Type	Notes

Response

Field	Type	Notes
json	string	エラーコード定義の JSON 文字列です。
result	Result	実行結果です。
result.success	boolean	成功したかどうかを示します。
result.error_code	integer	エラーコードです。成功時は 0 です。

{}

grpcurl -plaintext -proto kachaka-api.proto -d '{}' <hostname>:26400 kachaka_api.KachakaApi/GetRobotErrorCodeJson

GetRobotPose

kachaka_api.KachakaApi/GetRobotPose unary

マップ上の現在位置と向きを取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
pose	Pose	マップ上の位置と向きです。
pose.x	number	X 座標（メートル）です。
pose.y	number	Y 座標（メートル）です。
pose.theta	number	向き（ラジアン）です。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetRobotPose

GetRobotSerialNumber

kachaka_api.KachakaApi/GetRobotSerialNumber unary

ロボットのシリアル番号を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
serial_number	string	ロボットのシリアル番号です。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetRobotSerialNumber

GetRobotVersion

kachaka_api.KachakaApi/GetRobotVersion unary

ロボットのソフトウェアバージョンを取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
version	string	ソフトウェアバージョンです。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetRobotVersion

GetRosImu

kachaka_api.KachakaApi/GetRosImu unary

IMU（加速度・角速度）の値を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
imu	RosImu	IMU の計測値です。
imu.header	RosHeader	ROS ヘッダです。
imu.header.stamp_nsec	string|integer	タイムスタンプ（ナノ秒）です。
imu.header.frame_id	string	座標系の名前です。
imu.orientation	Quaternion	姿勢（クォータニオン）です。
imu.orientation.x	number	クォータニオンの x です。
imu.orientation.y	number	クォータニオンの y です。
imu.orientation.z	number	クォータニオンの z です。
imu.orientation.w	number	クォータニオンの w です。
imu.orientation_covariance	array<number>	姿勢の共分散です。
imu.angular_velocity	Vector3	角速度です。
imu.angular_velocity.x	number	角速度 X（ラジアン毎秒）です。
imu.angular_velocity.y	number	角速度 Y（ラジアン毎秒）です。
imu.angular_velocity.z	number	角速度 Z（ラジアン毎秒）です。
imu.angular_velocity_covariance	array<number>	角速度の共分散です。
imu.linear_acceleration	Vector3	並進加速度です。
imu.linear_acceleration.x	number	並進加速度 X（メートル毎秒毎秒）です。
imu.linear_acceleration.y	number	並進加速度 Y（メートル毎秒毎秒）です。
imu.linear_acceleration.z	number	並進加速度 Z（メートル毎秒毎秒）です。
imu.linear_acceleration_covariance	array<number>	並進加速度の共分散です。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetRosImu

GetRosLaserScan

kachaka_api.KachakaApi/GetRosLaserScan unary

レーザーセンサーのスキャンを取得します。アプリの「レーザーセンサーの検出情報」に相当します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
scan	RosLaserScan	レーザースキャンです。
scan.header	RosHeader	ROS ヘッダです。
scan.header.stamp_nsec	string|integer	タイムスタンプ（ナノ秒）です。
scan.header.frame_id	string	座標系の名前です。
scan.angle_min	number	最小角度（ラジアン）です。
scan.angle_max	number	最大角度（ラジアン）です。
scan.angle_increment	number	角度の刻み（ラジアン）です。
scan.time_increment	number	1 点あたりの時間（秒）です。
scan.scan_time	number	1 スキャンの時間（秒）です。
scan.range_min	number	距離の下限（メートル）です。
scan.range_max	number	距離の上限（メートル）です。
scan.ranges	array<number>	各点の距離（メートル）です。
scan.intensities	array<number>	各点の反射強度です。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetRosLaserScan

GetRosOdometry

kachaka_api.KachakaApi/GetRosOdometry unary

オドメトリを取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
odometry	RosOdometry	オドメトリです。
odometry.header	RosHeader	ROS ヘッダです。
odometry.header.stamp_nsec	string|integer	タイムスタンプ（ナノ秒）です。
odometry.header.frame_id	string	座標系の名前です。
odometry.child_frame_id	string	子座標系の名前です。
odometry.pose	Pose3dWithCovariance	オドメトリ座標系での位置と向きです。
odometry.pose.pose	Pose3d	マップ上の位置と向きです。
odometry.pose.pose.position	Vector3	位置です。
odometry.pose.pose.position.x	number	位置 X（メートル）です。
odometry.pose.pose.position.y	number	位置 Y（メートル）です。
odometry.pose.pose.position.z	number	位置 Z（メートル）です。
odometry.pose.pose.orientation	Quaternion	姿勢（クォータニオン）です。
odometry.pose.pose.orientation.x	number	クォータニオンの x です。
odometry.pose.pose.orientation.y	number	クォータニオンの y です。
odometry.pose.pose.orientation.z	number	クォータニオンの z です。
odometry.pose.pose.orientation.w	number	クォータニオンの w です。
odometry.pose.covariance	array<number>	共分散です。
odometry.twist	TwistWithCovariance	速度です。
odometry.twist.twist	Twist	速度です。
odometry.twist.twist.linear	Vector3	並進速度（メートル毎秒）です。
odometry.twist.twist.linear.x	number	並進速度 X（メートル毎秒）です。
odometry.twist.twist.linear.y	number	並進速度 Y（メートル毎秒）です。
odometry.twist.twist.linear.z	number	並進速度 Z（メートル毎秒）です。
odometry.twist.twist.angular	Vector3	角速度（ラジアン毎秒）です。
odometry.twist.twist.angular.x	number	角速度 X（ラジアン毎秒）です。
odometry.twist.twist.angular.y	number	角速度 Y（ラジアン毎秒）です。
odometry.twist.twist.angular.z	number	角速度 Z（ラジアン毎秒）です。
odometry.twist.covariance	array<number>	共分散です。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetRosOdometry

GetRosWheelOdometry

kachaka_api.KachakaApi/GetRosWheelOdometry unary

車輪オドメトリを取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
odometry	RosOdometry	オドメトリです。
odometry.header	RosHeader	ROS ヘッダです。
odometry.header.stamp_nsec	string|integer	タイムスタンプ（ナノ秒）です。
odometry.header.frame_id	string	座標系の名前です。
odometry.child_frame_id	string	子座標系の名前です。
odometry.pose	Pose3dWithCovariance	オドメトリ座標系での位置と向きです。
odometry.pose.pose	Pose3d	マップ上の位置と向きです。
odometry.pose.pose.position	Vector3	位置です。
odometry.pose.pose.position.x	number	位置 X（メートル）です。
odometry.pose.pose.position.y	number	位置 Y（メートル）です。
odometry.pose.pose.position.z	number	位置 Z（メートル）です。
odometry.pose.pose.orientation	Quaternion	姿勢（クォータニオン）です。
odometry.pose.pose.orientation.x	number	クォータニオンの x です。
odometry.pose.pose.orientation.y	number	クォータニオンの y です。
odometry.pose.pose.orientation.z	number	クォータニオンの z です。
odometry.pose.pose.orientation.w	number	クォータニオンの w です。
odometry.pose.covariance	array<number>	共分散です。
odometry.twist	TwistWithCovariance	速度です。
odometry.twist.twist	Twist	速度です。
odometry.twist.twist.linear	Vector3	並進速度（メートル毎秒）です。
odometry.twist.twist.linear.x	number	並進速度 X（メートル毎秒）です。
odometry.twist.twist.linear.y	number	並進速度 Y（メートル毎秒）です。
odometry.twist.twist.linear.z	number	並進速度 Z（メートル毎秒）です。
odometry.twist.twist.angular	Vector3	角速度（ラジアン毎秒）です。
odometry.twist.twist.angular.x	number	角速度 X（ラジアン毎秒）です。
odometry.twist.twist.angular.y	number	角速度 Y（ラジアン毎秒）です。
odometry.twist.twist.angular.z	number	角速度 Z（ラジアン毎秒）です。
odometry.twist.covariance	array<number>	共分散です。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetRosWheelOdometry

GetShelves

kachaka_api.KachakaApi/GetShelves unary

登録されている家具の一覧を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
shelves	array<Shelf>	家具の一覧です。
shelves[].id	string	識別子です。
shelves[].name	string	表示名です。
shelves[].pose	Pose	マップ上の位置と向きです。移動中は追従せず、移動完了時、置く直前、充電ドックへ戻ったあと、外れたときに更新されます。
shelves[].pose.x	number	X 座標（メートル）です。
shelves[].pose.y	number	Y 座標（メートル）です。
shelves[].pose.theta	number	向き（ラジアン）です。
shelves[].size	ShelfSize	外形サイズ（メートル）です。
shelves[].size.width	number	幅です。
shelves[].size.depth	number	奥行き（メートル）です。
shelves[].size.height	number	高さです。
shelves[].appearance	ShelfAppearance	家具の見た目の種類です。
shelves[].appearance.SHELF_APPEARANCE_UNSPECIFIED	enum	見た目が未指定です。
shelves[].appearance.SHELF_APPEARANCE_DEFAULT_SHELF	enum	標準の家具です。
shelves[].appearance.SHELF_APPEARANCE_KACHAKA_SHELF_3DRAWERS	enum	3段のカチャカシェルフです。
shelves[].appearance.SHELF_APPEARANCE_KACHAKA_SHELF_2DRAWERS	enum	2段のカチャカシェルフです。
shelves[].appearance.SHELF_APPEARANCE_KACHAKA_BASE	enum	カチャカベースです。
shelves[].recognizable_names	array<RecognizableName>	音声認識で使える名前です。
shelves[].recognizable_names[].name	string	表示名です。
shelves[].recognizable_names[].deletable	boolean	削除できる名前かどうかを示します。
shelves[].home_location_id	string	片付け先の目的地 ID です。
shelves[].speed_mode	ShelfSpeedMode	運搬時の速度モードです。
shelves[].speed_mode.SHELF_SPEED_MODE_UNSPECIFIED	enum
shelves[].speed_mode.SHELF_SPEED_MODE_LOW	enum
shelves[].speed_mode.SHELF_SPEED_MODE_NORMAL	enum
shelves[].ignore_voice_recognition	boolean	音声認識の対象から外すかどうかを示します。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetShelves

GetShelvesDigest

kachaka_api.KachakaApi/GetShelvesDigest unary

登録されている家具の要約（ID と名前）を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
shelves	array<ShelfDigest>	家具の一覧です。
shelves[].id	string	識別子です。
shelves[].name	string	表示名です。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetShelvesDigest

GetShortcuts

kachaka_api.KachakaApi/GetShortcuts unary

登録されているショートカットの一覧を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
shortcuts	array<Shortcut>	ショートカットの一覧です。
shortcuts[].id	string	識別子です。
shortcuts[].name	string	表示名です。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetShortcuts

GetSoundList

kachaka_api.KachakaApi/GetSoundList unary

登録されている効果音の一覧を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
sounds	array<Sound>	効果音の一覧です。
sounds[].id	string	識別子です。
sounds[].name	string	表示名です。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetSoundList

GetSpeakerVolume

kachaka_api.KachakaApi/GetSpeakerVolume unary

スピーカー音量を取得します。アプリの「カチャカの音量」に相当します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
volume	integer	スピーカー音量（0〜10）です。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetSpeakerVolume

GetStaticTransform

kachaka_api.KachakaApi/GetStaticTransform unary

静的な座標変換（TF）を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
transforms	array<RosTransformStamped>	座標変換の一覧です。
transforms[].header	RosHeader	ROS ヘッダです。
transforms[].header.stamp_nsec	string|integer	タイムスタンプ（ナノ秒）です。
transforms[].header.frame_id	string	座標系の名前です。
transforms[].child_frame_id	string	子座標系の名前です。
transforms[].translation	Vector3	平行移動です。
transforms[].translation.x	number	平行移動 X（メートル）です。
transforms[].translation.y	number	平行移動 Y（メートル）です。
transforms[].translation.z	number	平行移動 Z（メートル）です。
transforms[].rotation	Quaternion	回転（クォータニオン）です。
transforms[].rotation.x	number	クォータニオンの x です。
transforms[].rotation.y	number	クォータニオンの y です。
transforms[].rotation.z	number	クォータニオンの z です。
transforms[].rotation.w	number	クォータニオンの w です。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetStaticTransform

GetTofCameraRosCameraInfo

kachaka_api.KachakaApi/GetTofCameraRosCameraInfo unary

ToF カメラのカメラ情報を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
camera_info	RosCameraInfo	カメラの内部パラメータです。
camera_info.header	RosHeader	ROS ヘッダです。
camera_info.header.stamp_nsec	string|integer	タイムスタンプ（ナノ秒）です。
camera_info.header.frame_id	string	座標系の名前です。
camera_info.height	integer	高さです。
camera_info.width	integer	幅です。
camera_info.distortion_model	string	歪みモデル名です。
camera_info.D	array<number>	歪み係数です。
camera_info.K	array<number>	カメラ行列（3x3）です。
camera_info.R	array<number>	回転行列（3x3）です。
camera_info.P	array<number>	投影行列（3x4）です。
camera_info.binning_x	integer	x方向のビニングです。
camera_info.binning_y	integer	y方向のビニングです。
camera_info.roi	RegionOfInterest	画像上の領域です。
camera_info.roi.x_offset	integer	ROI の X オフセットです。
camera_info.roi.y_offset	integer	ROI の Y オフセットです。
camera_info.roi.height	integer	高さです。
camera_info.roi.width	integer	幅です。
camera_info.roi.do_rectify	boolean	歪み補正するかどうかを指定します。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetTofCameraRosCameraInfo

GetTofCameraRosCompressedImage

kachaka_api.KachakaApi/GetTofCameraRosCompressedImage unary

ToF カメラの圧縮画像を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
image	RosCompressedImage	画像です。
image.header	RosHeader	ROS ヘッダです。
image.header.stamp_nsec	string|integer	タイムスタンプ（ナノ秒）です。
image.header.frame_id	string	座標系の名前です。
image.format	string	圧縮画像のフォーマット名です。
image.data	string	バイナリデータです（JSON では base64 です）。
is_available	boolean	センサが利用可能かどうかを示します。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetTofCameraRosCompressedImage

GetTofCameraRosImage

kachaka_api.KachakaApi/GetTofCameraRosImage unary

ToF カメラの画像を取得します。

Request

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。

Response

Field	Type	Notes
metadata	Metadata	カーソルなどのメタデータです。
metadata.cursor	string|integer	ロングポーリング用のカーソルです。0 を指定すると最新の値をすぐに返します。前回の応答の metadata.cursor を指定すると、値が更新されるまで応答を待ちます。
image	RosImage	画像です。
image.header	RosHeader	ROS ヘッダです。
image.header.stamp_nsec	string|integer	タイムスタンプ（ナノ秒）です。
image.header.frame_id	string	座標系の名前です。
image.height	integer	高さです。
image.width	integer	幅です。
image.encoding	string	画素のエンコーディングです。
image.is_bigendian	boolean	ビッグエンディアンかどうかを示します。
image.step	integer	1 行あたりのバイト数です。
image.data	string	バイナリデータです（JSON では base64 です）。
is_available	boolean	センサが利用可能かどうかを示します。

{
  "metadata": {
    "cursor": 0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"metadata": {"cursor": 0}}' <hostname>:26400 kachaka_api.KachakaApi/GetTofCameraRosImage

ImportImageAsMap

kachaka_api.KachakaApi/ImportImageAsMap client-stream

画像をマップとして読み込みます（クライアントストリーム）。

Request

Field	Type	Notes
data	string	バイナリデータです（JSON では base64 です）。
charger_pose	Pose	画像マップ上の充電ドックの位置です。
charger_pose.x	number	X 座標（ピクセル）です。
charger_pose.y	number	Y 座標（ピクセル）です。
charger_pose.theta	number	向き（ラジアン）です。
resolution	number	1 ピクセルあたりのメートルです。

Response

Field	Type	Notes
result	Result	実行結果です。
result.success	boolean	成功したかどうかを示します。
result.error_code	integer	エラーコードです。成功時は 0 です。
map_id	string	マップ ID です。

{
  "data": "",
  "charger_pose": {
    "x": 0.0,
    "y": 0.0,
    "theta": 0.0
  },
  "resolution": 0.0
}

printf '%s\n' "{\"data\": \"\", \"charger_pose\": {\"x\": 0.0, \"y\": 0.0, \"theta\": 0.0}, \"resolution\": 0.0}" | grpcurl -plaintext -proto kachaka-api.proto -d @ <hostname>:26400 kachaka_api.KachakaApi/ImportImageAsMap

ImportMap

kachaka_api.KachakaApi/ImportMap client-stream

マップのデータを読み込みます（クライアントストリーム）。

Request

Field	Type	Notes
data	string	バイナリデータです（JSON では base64 です）。

Response

Field	Type	Notes
result	Result	実行結果です。
result.success	boolean	成功したかどうかを示します。
result.error_code	integer	エラーコードです。成功時は 0 です。
map_id	string	マップ ID です。

{
  "data": ""
}

printf '%s\n' "{\"data\": \"\"}" | grpcurl -plaintext -proto kachaka-api.proto -d @ <hostname>:26400 kachaka_api.KachakaApi/ImportMap

IsReady

kachaka_api.KachakaApi/IsReady unary

ロボットがコマンドを受け付けられる状態かを取得します。この RPC は待たずに直ちに返します。

Request

Field	Type	Notes

Response

Field	Type	Notes
ready	boolean	コマンドを受け付けられる状態かどうかを示します。

{}

grpcurl -plaintext -proto kachaka-api.proto -d '{}' <hostname>:26400 kachaka_api.KachakaApi/IsReady

LoadMapPreview

kachaka_api.KachakaApi/LoadMapPreview unary

指定したマップのプレビュー画像を取得します。

Request

Field	Type	Notes
map_id	string	マップ ID です。

Response

Field	Type	Notes
result	Result	実行結果です。
result.success	boolean	成功したかどうかを示します。
result.error_code	integer	エラーコードです。成功時は 0 です。
map	Map	マップ画像とメタデータです。
map.data	string	バイナリデータです（JSON では base64 です）。
map.name	string	表示名です。
map.resolution	number	1 ピクセルあたりのメートルです。
map.width	integer	幅です。
map.height	integer	高さです。
map.origin	Pose	マップ原点のポーズです。
map.origin.x	number	X 座標（メートル）です。
map.origin.y	number	Y 座標（メートル）です。
map.origin.theta	number	向き（ラジアン）です。

{
  "map_id": ""
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"map_id": ""}' <hostname>:26400 kachaka_api.KachakaApi/LoadMapPreview

PlaySound

kachaka_api.KachakaApi/PlaySound unary

効果音を再生します。

Request

Field	Type	Notes
sound_id	string	効果音 ID です。
loop	boolean	繰り返し再生するかどうかを指定します。

Response

Field	Type	Notes
result	Result	実行結果です。
result.success	boolean	成功したかどうかを示します。
result.error_code	integer	エラーコードです。成功時は 0 です。

{
  "sound_id": "",
  "loop": false
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"sound_id": "", "loop": false}' <hostname>:26400 kachaka_api.KachakaApi/PlaySound

Proceed

kachaka_api.KachakaApi/Proceed unary

「その場で待機」を途中で終了し、次の処理へ進めます。

Request

Field	Type	Notes

Response

Field	Type	Notes
result	Result	実行結果です。
result.success	boolean	成功したかどうかを示します。
result.error_code	integer	エラーコードです。成功時は 0 です。

{}

grpcurl -plaintext -proto kachaka-api.proto -d '{}' <hostname>:26400 kachaka_api.KachakaApi/Proceed

ResetShelfPose

kachaka_api.KachakaApi/ResetShelfPose unary

家具の位置を片付け先にリセットします。

Request

Field	Type	Notes
shelf_id	string	家具 ID です。空文字の場合はすべての家具が対象です。

Response

Field	Type	Notes
result	Result	実行結果です。
result.success	boolean	成功したかどうかを示します。
result.error_code	integer	エラーコードです。成功時は 0 です。

{
  "shelf_id": ""
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"shelf_id": ""}' <hostname>:26400 kachaka_api.KachakaApi/ResetShelfPose

RestartRobot

kachaka_api.KachakaApi/RestartRobot unary

ロボットを再起動します。アプリの「カチャカを再起動」に相当します。

Request

Field	Type	Notes

Response

Field	Type	Notes
result	Result	実行結果です。
result.success	boolean	成功したかどうかを示します。
result.error_code	integer	エラーコードです。成功時は 0 です。

{}

grpcurl -plaintext -proto kachaka-api.proto -d '{}' <hostname>:26400 kachaka_api.KachakaApi/RestartRobot

SetAutoHomingEnabled

kachaka_api.KachakaApi/SetAutoHomingEnabled unary

何もしていないとき、充電中でなければ充電ドックへ自動で戻る機能の有効／無効を切り替えます。場所は問わず、充電が止まったあとに戻る動作も、この設定がオフだと止まります。

Request

Field	Type	Notes
enable	boolean	有効にするかどうかを指定します。

Response

Field	Type	Notes
result	Result	実行結果です。
result.success	boolean	成功したかどうかを示します。
result.error_code	integer	エラーコードです。成功時は 0 です。

{
  "enable": false
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"enable": false}' <hostname>:26400 kachaka_api.KachakaApi/SetAutoHomingEnabled

SetBackTorchIntensity

kachaka_api.KachakaApi/SetBackTorchIntensity unary

後方ライトの明るさを設定します。

Request

Field	Type	Notes
intensity	integer	明るさ（0〜255）です。

Response

Field	Type	Notes
result	Result	実行結果です。
result.success	boolean	成功したかどうかを示します。
result.error_code	integer	エラーコードです。成功時は 0 です。

{
  "intensity": 0
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"intensity": 0}' <hostname>:26400 kachaka_api.KachakaApi/SetBackTorchIntensity

SetEmergencyStop

kachaka_api.KachakaApi/SetEmergencyStop unary

停止ボタンを押した状態にします。

Request

Field	Type	Notes

Response

Field	Type	Notes
result	Result	実行結果です。
result.success	boolean	成功したかどうかを示します。
result.error_code	integer	エラーコードです。成功時は 0 です。

{}

grpcurl -plaintext -proto kachaka-api.proto -d '{}' <hostname>:26400 kachaka_api.KachakaApi/SetEmergencyStop

SetFrontTorchIntensity

kachaka_api.KachakaApi/SetFrontTorchIntensity unary

前方ライトの明るさを設定します。

Request

Field	Type	Notes
intensity	integer	明るさ（0〜255）です。

Response

Field	Type	Notes
result	Result	実行結果です。
result.success	boolean	成功したかどうかを示します。
result.error_code	integer	エラーコードです。成功時は 0 です。

{
  "intensity": 0
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"intensity": 0}' <hostname>:26400 kachaka_api.KachakaApi/SetFrontTorchIntensity

SetManualControlEnabled

kachaka_api.KachakaApi/SetManualControlEnabled unary

手動操作の有効／無効を切り替えます。アプリの「カチャカの手動操作」に相当します。

Request

Field	Type	Notes
enable	boolean	有効にするかどうかを指定します。
use_shelf_registration	boolean	手動操作を有効にするとき、家具の位置登録を使うかどうかを指定します。enable が true のときだけ有効です。

Response

Field	Type	Notes
result	Result	実行結果です。
result.success	boolean	成功したかどうかを示します。
result.error_code	integer	エラーコードです。成功時は 0 です。

{
  "enable": false,
  "use_shelf_registration": false
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"enable": false, "use_shelf_registration": false}' <hostname>:26400 kachaka_api.KachakaApi/SetManualControlEnabled

SetRobotPose

kachaka_api.KachakaApi/SetRobotPose unary

マップ上の現在位置を指定した座標に設定します。

Request

Field	Type	Notes
pose	Pose	マップ上の位置と向きです。
pose.x	number	X 座標（メートル）です。
pose.y	number	Y 座標（メートル）です。
pose.theta	number	向き（ラジアン）です。

Response

Field	Type	Notes
result	Result	実行結果です。
result.success	boolean	成功したかどうかを示します。
result.error_code	integer	エラーコードです。成功時は 0 です。

{
  "pose": {
    "x": 0.0,
    "y": 0.0,
    "theta": 0.0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"pose": {"x": 0.0, "y": 0.0, "theta": 0.0}}' <hostname>:26400 kachaka_api.KachakaApi/SetRobotPose

SetRobotVelocity

kachaka_api.KachakaApi/SetRobotVelocity unary

並進・回転の速度指令を送ります。手動操作中にご利用ください。

Request

Field	Type	Notes
linear	number	並進速度（-1〜1）です。
angular	number	回転速度（-1〜1）です。

Response

Field	Type	Notes
result	Result	実行結果です。
result.success	boolean	成功したかどうかを示します。
result.error_code	integer	エラーコードです。成功時は 0 です。

{
  "linear": 0.0,
  "angular": 0.0
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"linear": 0.0, "angular": 0.0}' <hostname>:26400 kachaka_api.KachakaApi/SetRobotVelocity

SetSpeakerVolume

kachaka_api.KachakaApi/SetSpeakerVolume unary

スピーカー音量を設定します。

Request

Field	Type	Notes
volume	integer	スピーカー音量（0〜10）です。

Response

Field	Type	Notes
result	Result	実行結果です。
result.success	boolean	成功したかどうかを示します。
result.error_code	integer	エラーコードです。成功時は 0 です。

{
  "volume": 0
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"volume": 0}' <hostname>:26400 kachaka_api.KachakaApi/SetSpeakerVolume

StartCommand (depart_from_charger_command)

kachaka_api.KachakaApi/StartCommand unary

充電ドックから離れます。

command.depart_from_charger_command を指定して StartCommand を呼び出します。

Request

Field	Type	Notes
command	Command_depart_from_charger_command	実行するコマンドです。oneof のうち 1 つを指定します。
command.depart_from_charger_command	DepartFromChargerCommand	充電ドックから離れるコマンドです。
cancel_all	boolean	実行中のコマンドをすべて取り消してから開始するかどうかを指定します。アプリの「今すぐ」実行に相当します。
tts_on_success	string	成功時に発話する文章です。空文字の場合は発話しません。
title	string	コマンドの表示名です。
deferrable	boolean	後ろに回さないコマンドがキューにあるとき、その後ろへ回してよいかどうかを指定します。
lock_on_end	LockOnEnd	コマンド完了後にその場で待機する設定です。未指定の場合は待機しません。
lock_on_end.duration_sec	number	完了後に待機する秒数です。

Response

Field	Type	Notes
result	Result	実行結果です。
result.success	boolean	成功したかどうかを示します。
result.error_code	integer	エラーコードです。成功時は 0 です。
command_id	string	コマンドの識別子です。

{
  "command": {
    "depart_from_charger_command": {}
  },
  "cancel_all": false,
  "tts_on_success": "",
  "title": "",
  "deferrable": false,
  "lock_on_end": {
    "duration_sec": 0.0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"command": {"depart_from_charger_command": {}}, "cancel_all": false, "tts_on_success": "", "title": "", "deferrable": false, "lock_on_end": {"duration_sec": 0.0}}' <hostname>:26400 kachaka_api.KachakaApi/StartCommand

StartCommand (dock_any_shelf_with_registration_command)

kachaka_api.KachakaApi/StartCommand unary

指定した目的地にある家具を載せます。家具が未登録の場合は登録します。Kachaka Pro でのみ利用できます。

command.dock_any_shelf_with_registration_command を指定して StartCommand を呼び出します。

Request

Field	Type	Notes
command	Command_dock_any_shelf_with_registration_command	実行するコマンドです。oneof のうち 1 つを指定します。
command.dock_any_shelf_with_registration_command	DockAnyShelfWithRegistrationCommand	家具を登録しながら載せるコマンドです。Kachaka Pro 専用です。
command.dock_any_shelf_with_registration_command.target_location_id	string	目的地 ID です。
command.dock_any_shelf_with_registration_command.dock_forward	boolean	前向きに載せるかどうかを指定します。
cancel_all	boolean	実行中のコマンドをすべて取り消してから開始するかどうかを指定します。アプリの「今すぐ」実行に相当します。
tts_on_success	string	成功時に発話する文章です。空文字の場合は発話しません。
title	string	コマンドの表示名です。
deferrable	boolean	後ろに回さないコマンドがキューにあるとき、その後ろへ回してよいかどうかを指定します。
lock_on_end	LockOnEnd	コマンド完了後にその場で待機する設定です。未指定の場合は待機しません。
lock_on_end.duration_sec	number	完了後に待機する秒数です。

Response

Field	Type	Notes
result	Result	実行結果です。
result.success	boolean	成功したかどうかを示します。
result.error_code	integer	エラーコードです。成功時は 0 です。
command_id	string	コマンドの識別子です。

{
  "command": {
    "dock_any_shelf_with_registration_command": {
      "target_location_id": "",
      "dock_forward": false
    }
  },
  "cancel_all": false,
  "tts_on_success": "",
  "title": "",
  "deferrable": false,
  "lock_on_end": {
    "duration_sec": 0.0
  }
}

grpcurl -plaintext -proto kachaka-api.proto -d '{"command": {"dock_any_shelf_with_registration_command": {"target_location_id": "", "dock_forward": false}}, "cancel_all": false, "tts_on_success": "", "title": "", "deferrable": false, "lock_on_end": {"duration_sec": 0.0}}' <hostname>:26400 kachaka_api.KachakaApi/StartCommand

StartCommand (dock_shelf_command)

kachaka_api.KachakaApi/StartCommand unary

目の前の家具を載せます。アプリの「家具を載せる」に相当します。

command.dock_shelf_command を指定して StartCommand を呼び出します。

Request

Field	Type	Notes
command	Command_dock_shelf_command	実行するコマンドです。oneof のうち 1 つを指定します。
command.dock_shelf_command	DockShelfCommand	家具を載せるコマンドです。
cancel_all	boolean	実行中のコマンドをすべて取り消してから開始するかどうかを指定します。アプリの「今すぐ」実行に相当します。
tts_on_success	string	成功時に発話する文章です。空文字の場合は発話しません。
title	string	コマンドの表示名です。
deferrable	boolean	後ろに回さないコマンドがキューにあるとき、その後ろへ回してよいかどうかを指定します。
lock_on_end	LockOnEnd	コマンド完了後にその場で待機する設定です。未指定の場合は待機しません。
lock_on_end.duration_sec	number	完了後に待機する秒数です。

Response

Field	Type	Notes
result	Result	実行結果です。
result.success	boolean	成功したかどうかを示します。
result.error_code	integer	エラーコードです。成功時は 0 です。
command_id	string	コマンドの識別子です。