Introduction

Supported Platforms

LinuxとしてUbuntuがサポートされています。macOSやWindowsであってもおおよその機能は利用できます。

LinuxやmacOSを使用している場合でも、ROSをインストールせずに使用することができます。

Installation for Rust

もしRustを利用したことがなければ、こちらからRustのインストールをしてください。

Installation for latest OpenRR

GitHubからOpenRRをクローンします。

git clone https://github.com/openrr/openrr

Installation for dependency

依存関係のソフトウェアをインストールします。

sudo apt install cmake build-essential libudev-dev xorg-dev libglu1-mesa-dev libasound2-dev libxkbcommon-dev

[Optional] Installation for ROS

arci-ros

• ROS Noetic

arci-ros2

• ROS2 Foxy or Humble

Using OpenRR Apps

1. Installation
2. Operating robot from GUI
3. Operating robot from CLI
4. Robot teleoperation
5. Operating mobile robot with ROS2 and openrr-teleop
6. Operating robot arm with ROS/ROS2 and openrr-teleop

Installation

openrr-appsによってロボットの操作ができます。Rustによって実装されたOpenRRを用いたアプリケーションの一例です。

urdf-viz

urdf-viz is a URDF visualization application.

実際にはurdf-vizはOpenRRの機能ではありませんが、この章ではよく用いるため合わせてインストールします。

cargo install urdf-viz

openrr-apps

openrr-appsは、GUIやコントローラなどから操作するためのアプリケーションです。コマンドやROSのトピックを介した操作、実機やurdf-viz上、gazebo上に関わらず同じように操作できます。

git clone https://github.com/openrr/openrr
cd openrr

LinuxやmacOSユーザーの方はこちら。

cargo install --path openrr-apps

Windowsユーザーの方はこちら。

cargo install --path openrr-apps --no-default-features --features gui,assimp

Operating robot from GUI

Move the robot arm

もしOpenRRをクローンしていなければ以下を実行してください。

git clone https://github.com:openrr/openrr
cd openrr

サンプルのロボットアームを表示させます。

urdf-viz ./openrr-planner/sample.urdf &

openrr_apps_joint_position_sender

openrr_apps_joint_position_sender \
    --config-path ./openrr-apps/config/sample_robot_client_config_for_urdf_viz.toml

スライドバーを動かすことで、関節角を変更することができます。

Move the mobile robot

urdf-viz ./openrr-planner/sample.urdf &

openrr_apps_velocity_sender

openrr_apps_velocity_sender \
    --config-path ./openrr-apps/config/sample_robot_client_config_for_urdf_viz.toml

スライドバーを動かすことで、ロボットの速度と角速度を変更することができます。

Operating robot from CLI

Move the robot arm

From the command text file

もしOpenRRをクローンしていなければ以下を実行してください。

git clone https://github.com:openrr/openrr
cd openrr

サンプルのロボットアームを表示してみましょう。

urdf-viz ./openrr-planner/sample.urdf &

load_commandsをtxtファイルに記したコマンドを実行するのに用いることができます。以下のコマンドを実行してみましょう。

openrr_apps_robot_command \
    --config-path ./openrr-apps/config/sample_robot_client_config_for_urdf_viz.toml \
    load_commands ./openrr-apps/command/sample_cmd_urdf_viz.txt

最後に以下のように出力されれば成功です。

PrintSpeaker: "This is sample robot"

From your command line

load_commandsを用いずに直接コマンドを書くことでも実行できます。試しにロボットアームの状態を取得してみましょう。

openrr_apps_robot_command \
    --config-path ./openrr-apps/config/sample_robot_client_config_for_urdf_viz.toml \
    get_state l_arm

以下のように出力されるでしょう。

Joint names : ["l_shoulder_yaw", "l_shoulder_pitch", "l_shoulder_roll", "l_elbow_pitch", "l_wrist_yaw", "l_wrist_pitch"]
Joint positions : [0.0, 0.0, 0.0, 0.0, 0.0, 0.0]

関節角を送信してみます。

openrr_apps_robot_command \
    --config-path ./openrr-apps/config/sample_robot_client_config_for_urdf_viz.toml \
    send_joints l_arm -j 0=1.2 -j 1=-1.2 -j 2=0.0 -j 3=1.2 -j 4=0.0 -j 5=0.0

ロボットアームが動きましたね。

Robot client config file

これは単一ロボットアーム用のconfig fileの例です。シミュレータであっても実機であってもこのように記しておくことでOpenRRから操作ができます。

ただし、urdf-vizの項目である、[urdf_viz_clients_configs]だけROSやそれに類するもののために変更する必要があります。

[[urdf_viz_clients_configs]]
name = "arm"
joint_names = [
    "shoulder_yaw",
    "shoulder_pitch",
    "shoulder_roll",
    "elbow_pitch",
    "wrist_yaw",
    "wrist_pitch",
]
wrap_with_joint_position_limiter = true
# If joint_position_limits is not specified, limits will be got from URDF.
# The following values are the same as if getting limits from URDF.
joint_position_limits = [
    { lower = -3.0, upper = 3.0 },
    { lower = -2.0, upper = 1.5 },
    { lower = -1.5, upper = 2.0 },
    { lower = -2.0, upper = 1.5 },
    { lower = -3.0, upper = 3.0 },
    { lower = -2.0, upper = 2.0 },
]

[openrr_clients_config]
urdf_path = "{path_to_urdf}/sample.urdf"
self_collision_check_pairs = ["shoulder_yaw:gripper_linear1"]

# Client config for left arm
[[openrr_clients_config.collision_check_clients_configs]]
name = "arm_collision_checked"
client_name = "arm"

[[openrr_clients_config.ik_clients_configs]]
name = "arm_ik"
client_name = "arm_collision_checked"
solver_name = "arm_ik_solver"

[[openrr_clients_config.joints_poses]]
pose_name = "zero"
client_name = "arm_collision_checked"
positions = [0.0, 0.0, 0.0, 0.0, 0.0, 0.0]

[openrr_clients_config.ik_solvers_configs.l_arm_ik_solver]
ik_target = "tool_fixed"

Note

See also reference of openrr_apps_robot_command

Robot teleoperation

openrr-teleopを用いる場合はconfig fileを新たに作る必要があります。

Move the robot arm and mobile robot

urdf-viz ./openrr-planner/sample.urdf &

openrr_apps_robot_teleop --config-path ./openrr-apps/config/sample_teleop_config_urdf_viz.toml

baseモードではロボットが移動します。ロボットアームは動きません。

このsample fileでは、move_base_modeが記されています。これは移動ロボットとしての挙動を設定するものです。

Teleop config

Client config file

このファイルは"Operating robot from CLI"のものと同じです。

[[urdf_viz_clients_configs]]
name = "arm"
joint_names = [
    "shoulder_yaw",
    "shoulder_pitch",
    "shoulder_roll",
    "elbow_pitch",
    "wrist_yaw",
    "wrist_pitch",
]
wrap_with_joint_position_limiter = true
# If joint_position_limits is not specified, limits will be got from URDF.
# The following values are the same as if getting limits from URDF.
joint_position_limits = [
    { lower = -3.0, upper = 3.0 },
    { lower = -2.0, upper = 1.5 },
    { lower = -1.5, upper = 2.0 },
    { lower = -2.0, upper = 1.5 },
    { lower = -3.0, upper = 3.0 },
    { lower = -2.0, upper = 2.0 },
]

[openrr_clients_config]
urdf_path = "{path_to_urdf}/sample.urdf"
self_collision_check_pairs = ["shoulder_yaw:gripper_linear1"]

# Client config for left arm
[[openrr_clients_config.collision_check_clients_configs]]
name = "arm_collision_checked"
client_name = "arm"

[[openrr_clients_config.ik_clients_configs]]
name = "arm_ik"
client_name = "arm_collision_checked"
solver_name = "arm_ik_solver"

[[openrr_clients_config.joints_poses]]
pose_name = "zero"
client_name = "arm_collision_checked"
positions = [0.0, 0.0, 0.0, 0.0, 0.0, 0.0]

[openrr_clients_config.ik_solvers_configs.arm_ik_solver]
ik_target = "tool_fixed"

Teleop config file

以下のようにしてteleop fileを作成します。1行目のようにしてclient config fileを対応させる必要があります。

robot_config_path = "sample_robot_client_config_for_urdf_viz.toml"

[control_nodes_config]
move_base_mode = "base"

[control_nodes_config.joints_pose_sender_config]

[[control_nodes_config.ik_node_teleop_configs]]
solver_name = "arm_ik_solver"
joint_trajectory_client_name = "arm"

[control_nodes_config.ik_node_teleop_configs.config]
mode = "i k"

[[control_nodes_config.joy_joint_teleop_configs]]
client_name = "arm_collision_checked"

[control_nodes_config.joy_joint_teleop_configs.config]
mode = "arm"

Note

See also reference of openrr_apps_robot__teleop

Operating mobile robot with ROS2 and openrr-teleop

Turtlebot3

move_base = "arci_ros2"
navigation = "arci_ros2"

[openrr_clients_config]

[plugins.arci_ros2]
path = "../../target/debug/libarci_ros2"

[[plugins.arci_ros2.instances]]
name = "arci_ros2"
type = "MoveBase"
args = """
topic = "/cmd_vel"
"""

[[plugins.arci_ros2.instances]]
name = "arci_ros2"
type = "Navigation"
args = """
action_name = "/navigate_to_pose"
"""

iRobot Create3

Turtlebot3と同様です。

move_base = "arci_ros2"

[openrr_clients_config]

[plugins.arci_ros2]
path = "../../target/release/libarci_ros2"

[[plugins.arci_ros2.instances]]
name = "arci_ros2"
type = "MoveBase"
args = """
topic = "/cmd_vel"
"""

robot_config_path = "irobot_create_robot_client_config_ros2.toml"
initial_mode = "base"

[control_nodes_config]
move_base_mode = "base"

[[control_nodes_config.command_configs]]
name = "dock command"
file_path = "irobot_create_dock_command.txt"

[[control_nodes_config.command_configs]]
name = "undock command"
file_path = "irobot_create_undock_command.txt"

According to APIs page of Create Docs, the following commands allow you to command specific actions.

Create DocsのAPIページによると、以下のコマンドで特定の動作（ドックに戻る、ドックから抜ける）ができるそうなので、割り当ててみます。

ros2 action send_goal /undock irobot_create_msgs/action/Undock "{}"
ros2 action send_goal /dock irobot_create_msgs/action/DockServo "{}"

openrr_apps_robot_commands execute_command -- <command>

• irobot_create_dock_command.txt

openrr_apps_robot_commands execute_command -- ros2 action send_goal /undock irobot_create_msgs/action/Undock "{}"

• irobot_create_undock_command.txt

openrr_apps_robot_commands execute_command -- ros2 action send_goal /dock irobot_create_msgs/action/DockServo "{}"

Operating robot arm with ROS/ROS2 and openrr-teleop

Ufactory Lite6 (ROS)

Setup

xarm_rosに従って、ROS用にロボットアームのセットアップをします。

mkdir -p ~/xarm_ws/src
cd ~/xarm_ws/src
git clone https://github.com/xArm-Developer/xarm_ros
cd xarm-ros
git pull
git submodule sync
git submodule update --init --remote
rosdep update
rosdep install --from-paths . --ignore-src --rosdistro noetic -y
cd ~/xarm_ws
catkin_make

ROSにfeatureしてOpenRRをビルドします。

cd openrr
cargo build --release --feature ros
cargo install --path ./openrr-apps

Config file for client

ROSで用いられるジョイント名やトピックはros_clients_configsに明記していきます。

また特定の姿勢に名前をつけて実行することも可能です。今回は、初期姿勢を決定し、initial_poseという名前で登録しました。(robot_client_for_ros.toml)

[[ros_clients_configs]]
name = "lite6"
joint_names = ["joint1", "joint2", "joint3", "joint4", "joint5", "joint6"]
complete_allowable_errors = [0.02, 0.02, 0.02, 0.02, 0.02, 0.02]
controller_name = "/ufactory/lite6_traj_controller"
state_topic_name = "/ufactory/lite6_traj_controller/state"

[openrr_clients_config]
urdf_path = "$(rospack find xarm_description)/urdf/lite6_robot.urdf.xacro"
self_collision_check_pairs = ["joint1:joint4"]

[[openrr_clients_config.ik_clients_configs]]
name = "arm_ik"
client_name = "arm_collision_checked"
solver_name = "arm_ik_solver"

[openrr_clients_config.ik_solvers_configs.arm_ik_solver]
ik_target = "joint_eef"

[[openrr_clients_config.collision_check_clients_configs]]
name = "arm_collision_checked"
client_name = "lite6"

[[openrr_clients_config.joints_poses]]
pose_name = "zero"
client_name = "arm_collision_checked"
positions = [0.0, 0.0, 0.0, 0.0, 0.0, 0.0]

[[openrr_clients_config.joints_poses]]
pose_name = "initial_pose"
client_name = "arm_collision_checked"
positions = [0.0, 0.17, 0.56, 0.0, 0.38, 0.0]

Config file for teleop

• teleop_client_for_ros.toml

robot_config_path = "robot_client_config_for_ros.toml"

[control_nodes_config]

[control_nodes_config.joints_pose_sender_config]

[[control_nodes_config.ik_node_teleop_configs]]
solver_name = "arm_ik_solver"
joint_trajectory_client_name = "lite6"

[control_nodes_config.ik_node_teleop_configs.config]
mode = "i k"

[[control_nodes_config.joy_joint_teleop_configs]]
client_name = "arm_collision_checked"

[control_nodes_config.joy_joint_teleop_configs.config]
mode = "lite6"

実行したいコマンドを割り当てます。

• Command to be enable servo (enable_servo.txt)

openrr_apps_robot_commands execute_command -- rosservice call /ufactory/motion_ctrl 8 1

openrr_apps_robot_commands execute_command -- rosservice call /ufactory/set_mode 1

openrr_apps_robot_commands execute_command -- rosservice call /ufactory/set_state 0

openrr_apps_robot_command speak Default "Initialization completed!"

• Command for stop servo (stop_servo.txt)

openrr_apps_robot_commands execute_command -- rosservice call /ufactory/motion_ctrl 8 0

作成したTeleop fileに以下を追加します。(teleop_client_for_ros.toml)

...

[[control_nodes_config.command_configs]]
name = "stop servo"
file_path = "../command/stop_servo.txt"

[[control_nodes_config.command_configs]]
name = "enable servo"
file_path = "../command/enable_servo.txt"

ROSを有効化した後に以下の2つのコマンドを実行します。

roslaunch xarm_gazebo lite6_beside_table.launch

openrr_apps_robot_teleop --config-path ./config/teleop_config_for_ros.toml

もしLite6をお持ちでしたら、以下の通りに実機を動かすことができます。

roslaunch lite6_moveit_config realMove_exec.launch robot_ip:=192.168.1.xxx

openrr_apps_robot_teleop --config-path ./config/teleop_config_for_ros.toml

Ufactory Lite6 (ROS2)

Setup

xarm_ros2に従って、ROS2用にロボットアームのセットアップをします。

mkdir -p ~/xarm_ws/src
cd ~/xarm_ws/src
git clone https://github.com/xArm-Developer/xarm_ros2
cd xarm-ros2
git pull
git submodule sync
git submodule update --init --remote
rosdep update
rosdep install --from-paths . --ignore-src --rosdistro $ROS_DISTRO -y
cd ~/xarm_ws
colcon build

ROS2にfeatureしてOpenRRをビルドします。

cd openrr
cargo build --release --feature ros2
cargo install --path ./openrr-apps

Config file for client

ROS2ではプラグインとして明記していきます。

[plugins.arci_ros2]
# Path to OpenRR
path = "../../openrr/target/release/libarci_ros2"

[[plugins.arci_ros2.instances]]
name = "lite6"
type = "JointTrajectoryClient"
args = """
action_name = "/lite6_traj_controller"
"""

[openrr_clients_config]
urdf_path = "../lite6_robot.urdf"
self_collision_check_pairs = ["joint1:joint4"]

[[openrr_clients_config.ik_clients_configs]]
name = "arm_ik"
client_name = "arm_collision_checked"
solver_name = "arm_ik_solver"

[openrr_clients_config.ik_solvers_configs.arm_ik_solver]
ik_target = "joint_eef"

[[openrr_clients_config.collision_check_clients_configs]]
name = "arm_collision_checked"
client_name = "lite6"

[[openrr_clients_config.joints_poses]]
pose_name = "zero"
client_name = "arm_collision_checked"
positions = [0.0, 0.0, 0.0, 0.0, 0.0, 0.0]

[[openrr_clients_config.joints_poses]]
pose_name = "initial_pose"
client_name = "arm_collision_checked"
positions = [0.0, 0.17, 0.56, 0.0, 0.38, 0.0]

Config file for teleop

Teleop fileはROSののものと同様にできます。

robot_config_path = "robot_client_config_for_ros2.toml"

[control_nodes_config]
joints_pose_sender_config.mode = "pose"

[[control_nodes_config.ik_node_teleop_configs]]
solver_name = "arm_ik_solver"
joint_trajectory_client_name = "lite6"

[control_nodes_config.ik_node_teleop_configs.config]
mode = "i k"

[[control_nodes_config.joy_joint_teleop_configs]]
client_name = "arm_collision_checked"

[control_nodes_config.joy_joint_teleop_configs.config]
mode = "lite6"

Note

See also xarm_ros and xarm_ros2, openrr-apps-ufactory-lite6

OpenRR Apps Usage

1. openrr_apps_robot_command
2. openrr_apps_robot_teleop
3. openrr_apps_joint_position_sender
4. openrr_apps_velocity_sender

openrr_apps_robot_command

openrr_apps_robot_commandではロボットにいくつかの司令を送ることができます。

openrr_apps_robot_command [OPTIONS] [SUBCOMMAND]

例

シミュレータ上でロボットを起動します。

urdf-viz ./openrr-planner/sample.urdf &

そのあとコマンドを読み込みます。

openrr_apps_robot_command \
    --config-path ./openrr-apps/config/sample_robot_client_config_for_urdf_viz.toml \
    load_commands ./openrr-apps/command/sample_cmd_urdf_viz.txt

例 (--config)

1つ前の例に--config引数を追加してみます。urdf-viz上で実行するのを見てもいいのですが、簡単のためにload_commandsをlistに変更しています。

urdf-viz ./openrr-planner/sample.urdf &
openrr_apps_robot_command \
    --config-path ./openrr-apps/config/sample_robot_client_config_for_urdf_viz.toml \
    list

まず何もせずに実行すれば、先程の前半部分のような出力が得られます。

Raw joint trajectory clients
    r_arm
    l_arm
Joint trajectory clients
    r_arm
    r_arm_ik
    l_arm_collision_checked
    l_arm_ik
    r_arm_collision_checked
    l_arm
Collision check clients
    l_arm_collision_checked
    r_arm_collision_checked
Ik clients
    r_arm_ik
    l_arm_ik

--config引数では、--config-pathの内容を上書きすることができます。したがって、

urdf-viz ./openrr-planner/sample.urdf &
openrr_apps_robot_command \
    --config-path ./openrr-apps/config/sample_robot_client_config_for_urdf_viz.toml \
    --config openrr_clients_config.ik_clients_configs[0].name=\"user_defined_ik\" \
    list

とすると、

Raw joint trajectory clients
    l_arm
    r_arm
Joint trajectory clients
    l_arm
    r_arm_collision_checked
    l_arm_collision_checked
    r_arm
    r_arm_ik
    user_defined_ik
Collision check clients
    r_arm_collision_checked
    l_arm_collision_checked
Ik clients
    r_arm_ik
    user_defined_ik

というようにして左アーム用のIKクライアント名がuser_defined_ikに変更されました。もちろんこれは直接tomlファイルを書き換えることでも実現できます。

load_commandsのまま実行する場合は、openrr-apps/command/sample_cmd_urdf_viz.txt内のl_arm_ikをuser_defined_ikに変える必要があります。

move_ikの使い方

openrr_apps_robot_command move_ik [OPTIONS] <NAME>

Name

IKクライアント名

Option

send_base_velocityの使い方

openrr_apps_robot_command send_base_velocity [OPTIONS] <X> <Y> <THETA>

X

x方向の速度

Y

y方向の速度

Theta

角速度

send_jointsの使い方

openrr_apps_robot_command send_joints [OPTIONS] <NAME>

Name

クライアント名

Option

send_joints_poseの使い方

openrr_apps_robot_command send_joints_pose [OPTIONS] <NAME> <POSE_NAME>

Name

クライアント名

Pose name

ポーズ名

Option

send_navigation_goalの使い方

openrr_apps_robot_command send_navigation_goal [OPTIONS] <X> <Y> <YAW>

Option

shell_completionの使い方

openrr_apps_robot_command shell_completion <SUBCOMMAND>

Subcommand

openrr_apps_robot_teleop

openrr_apps_robot_teleopでは今まではGUIアプリケーション上で操作していたものをジョイスティックなどで遠隔で操作できるようになっています。

openrr_apps_robot_teleop

使い方

openrr_apps_robot_teleop [OPTIONS]

例

ボタンの名前は、gilrs layoutに従っています。

urdf-vizを起動します。その後、ゲームパッドをPCに接続し、Teleop用の設定ファイルを読み込み実行します。

urdf-viz ./openrr-planner/sample.urdf &
openrr_apps_robot_teleop \
    --config-path ./openrr-apps/config/sample_teleop_config_urdf_viz.toml

割り当てたモード選択ボタン（デフォルトではNorth）を押すとモードが切り替わり、サブモード選択ボタン（デフォルトではEast）ではサブモードが切り替わります。

PrintSpeaker: l_arm0
PrintSpeaker: r_arm0
PrintSpeaker: base
PrintSpeaker: left i k
PrintSpeaker: right i k
PrintSpeaker: pose l_arm_collision_checked zero
PrintSpeaker: l_arm0
PrintSpeaker: r_arm0
PrintSpeaker: r_arm1
PrintSpeaker: r_arm2

例(--teleop-config)

openrr_apps_robot_teleop \
    --config-path ./openrr-apps/config/sample_teleop_config_urdf_viz.toml \
    --teleop-config gamepad=\"keyboard\"

これは、openrr_apps_robot_command Example (--config)の例(--config)と同じようにして、既存の設定を上書きするというものです。

この例ではデフォルトであったゲームパッドでの操作をキーボードからの操作に切り替えています。

openrr_apps_joint_position_sender

openrr_apps_joint_position_senderではマニピュレータなど関節ロボットについての各関節の値を指定することができます。

openrr_apps_joint_position_sender

使い方

openrr_apps_joint_position_sender [OPTIONS]

openrr_apps_velocity_sender

openrr_apps_velocity_senderでは移動ロボットを動かすための速度を指定することができます。

openrr_apps_velocity_sender

使い方

openrr_apps_velocity_sender [OPTIONS]

OpenRR Apps Configuration

1. Client config
2. Teleop config
3. Environmental Variables
4. Overwrite configuration at startup

Client config

configを書く

configを自分で書くことで、サンプルにないロボットや独自に作成したロボットがOpenRRで動くようになります。configには以下の要素を書くことができます。

また、VSCodeを使用している方はこちらから拡張機能のEvenBetterTOMLを導入することを推奨します。

Default config

デフォルトは以下のようになっています。読み込んだconfigに応じて設定が追加または上書きされます。

openrr_apps_robot_command --show-default-config

[speak_configs]

[openrr_clients_config]
self_collision_check_pairs = []

[openrr_clients_config.ik_solvers_configs]

[plugins]

robot_config

Client configに書く項目の一覧になります。リポジトリにあるサンプルもぜひご参考に。サンプルはこちらから。

joint_trajectory_clients

Type: array string

localization, move_base, navigation

Type: string or boolean

Example

move_base = false

navigation = "arci_ros2"

openrr_clients_config

OpenRR Clients Config

Example

[openrr_clients_config]
urdf_path = "./twin_arms_robot.urdf"
self_collision_check_pairs = [
    "left_shoulder:left_gripper",
    "right_shoulder:right_gripper"
]

Collision Check Client Config

Example

[[openrr_clients_config.collision_check_clients_configs]]
client_name = "arm_with_torso"
name = "arm_with_torso_collision_checked"

Self Collision Checker Config

IK Client Config

Example

[[openrr_clients_config.ik_clients_configs]]
name = "arm_with_torso_ik"
client_name = "arm_with_torso_collision_checked"
solver_name = "arm_with_torso_ik_solver"

IK Solver Config

Example

[openrr_clients_config.ik_solvers_configs.arm_with_torso_ik_solver]
ik_target = "gripper_palm_joint"
allowable_position_error_m = 0.01

Constraints

Joint Trajectory Client Container Config

Joints Pose

Example

[[openrr_clients_config.joints_poses]]
pose_name = "stand by"
client_name = "arm"
positions = [0.0, 1.2, 0.0, -0.7, 0.0, -0.2, 0.0]

ros_action_clients_configs

ROS Control Action Client Config

Joint Position Limiter Strategy

Joint Position Limit

Example

[[urdf_viz_clients_configs]]
name = "foo"
joint_names = ["bar1", "bar2"]
joint_position_limits = [
    { lower = -3.0, upper = 3.0 },
    { lower = -2.0, upper = 1.5 },
]

plugins

Plugin Instance Kind

ros_clients_configs

ROS Control Client Config

Joint Position Limit

Example

[[ros_clients_configs]]
name = "arm"
joint_names = [
    "shoulder_joint",
    "shoulder_joint",
    "upper_arm_roll_joint",
    "elbow_flex_joint",
    "forearm_roll_joint",
    "wrist_flex_joint",
    "wrist_roll_joint",
]
complete_allowable_errors = [0.01, 0.01, 0.01, 0.01, 0.01, 0.01, 0.01]
controller_name = "arm_controller"
state_topic_name = "arm_controller/openrr/state"

ros_cmd_vel_move_base_client_config

ROS cmd_vel MoveBase Client Config

ros_localization_client_config

ROS Localization Client Config

ros_navigation_client_config

ROS Navigation Client Config

speak_configs

Speak Config

ROS Espeak Client Config

Example (Audio)

[speak_configs."foo"]
type = "Audio"

[speak_configs."foo".args.map]
bar = "./bar.mp3" # Path to audio file

openrr_apps_robot_command --config-path {path to toml} speak foo bar

Example (ROSEspeak)

[speak_configs.espeak]
type = "RosEspeak"

[speak_configs.espeak.args.config]
topic = "/sample/message"

openrr_apps_robot_command --config-path {path to toml} -i
>  speak espeak Hello!

data: "Hello!"
---

speakers

Type: string

urdf_viz_clients_configs

Example

[[urdf_viz_clients_configs]]
# `urdf-viz` client name
name = "arm"
# List of joints
joint_names = [
    "shoulder_yaw",
    "shoulder_pitch",
    "shoulder_roll",
    "elbow_pitch",
    "wrist_yaw",
    "wrist_pitch",
]
wrap_with_joint_position_limiter = true

# Range of joints
joint_position_limits = [
    { lower = -3.0, upper = 3.0 },
    { lower = -2.0, upper = 1.5 },
    { lower = -1.5, upper = 2.0 },
    { lower = -2.0, upper = 1.5 },
    { lower = -3.0, upper = 3.0 },
    { lower = -2.0, upper = 2.0 },
]

[openrr_clients_config]
# Path to URDF file
urdf_path = "./sample.urdf"
self_collision_check_pairs = [
    "shoulder_yaw:gripper_linear1",
]

[[openrr_clients_config.collision_check_clients_configs]]
# Collision check client name
name = "arm_collision_checked"
# `urdf-viz` client name
client_name = "arm"

[[openrr_clients_config.ik_clients_configs]]
# IK client name
name = "arm_ik"
# Collision check client name
client_name = "arm_collision_checked"
# IK solver name
solver_name = "arm_ik_solver"

[[openrr_clients_config.joints_poses]]
# Position name
pose_name = "zero"
# Collision check client name
client_name = "arm_collision_checked"
# Position that you want to set
positions = [0.0, 0.0, 0.0, 0.0, 0.0, 0.0]

[openrr_clients_config.ik_solvers_configs.arm_ik_solver] # IK solver name (arm_ik_solver)
ik_target = "tool_fixed"

Teleop config

configを書く

1つ前ではClientのConfigについて取り上げました。このページはTeleop用の追加Configについて載せてあります。

requiredと書いてあるものは必須事項です。

Default config

デフォルトは以下のようになっています。読み込んだconfigに応じて設定が追加または上書きされます。HashMapで実装されているため、既に設定されたものは上書きされ、新規の設定の場合は追加されます。

initial_mode = ""
gamepad = "gilrs"

[control_nodes_config]

[gil_gamepad_config]
device_id = 0

[gil_gamepad_config.map]
button_map = [
    ["DPadLeft",      "DPadLeft"     ],
    ["Select",        "Select"       ],
    ["East",          "East"         ],
    ["DPadUp",        "DPadUp"       ],
    ["LeftTrigger",   "LeftTrigger"  ],
    ["DPadDown",      "DPadDown"     ],
    ["RightTrigger",  "RightTrigger" ],
    ["RightTrigger2", "RightTrigger2"],
    ["Start",         "Start"        ],
    ["LeftTrigger2",  "LeftTrigger2" ],
    ["Mode",          "Mode"         ],
    ["DPadRight",     "DPadRight"    ],
    ["South",         "South"        ],
    ["North",         "North"        ],
    ["RightThumb",    "RightThumb"   ],
    ["LeftThumb",     "LeftThumb"    ],
    ["West",          "West"         ]
]
axis_map = [
    ["LeftStickY",  "LeftStickY" ],
    ["LeftStickX",  "LeftStickX" ],
    ["RightStickX", "RightStickX"],
    ["DPadY",       "DPadY"      ],
    ["DPadX",       "DPadX"      ],
    ["RightStickY", "RightStickY"]
]
axis_value_map = [["LeftStickX", -1.0], ["RightStickX", -1.0]]

[plugins]

robot_teleop_config

control_nodes_config

Control Nodes Config

IK Node Teleop Config

Joint Pose Sender Config

Joy Joint Teleop Config

IK Node Config

Joy Joint Teleop Node Config

Robot Command Config

Example

[[control_nodes_config.command_configs]]
name = "audio bar"
file_path = "sample_audio_command.txt"

[[control_nodes_config.command_configs]]
name = "ros speak"
file_path = "sample_speak_command.txt"

openrr_apps_robot_command speak foo bar

openrr_apps_robot_command speak espeak "This is topic message"

PrintSpeaker: command audio sine
PrintSpeaker: command ros speak

gamepad

string or BuiltinGamepad ("gilrs" or "keyboard"). Default is "gilrs".

gil_gamepad_config

Gil Gamepad Config

Map

Gilrsとの比較表はこのようになります。使用するJoystickにより異なりますので参考までに。特別にこのボタンやスティックを割り当てたいという場合はteleop_configのファイルに例に習って対応付けることでキーを変更できます。

ボタンやスティックのレイアウトはgilrs layoutに従っています。

Comparison table between GilrsAxis and Axis

Comparison table between GilrsButton and Button

Example

[gil_gamepad_config.map]
axis_map = [
    # GilrsAxis      Axis (user axis)
    ['LeftStickX',  'LeftStickX'   ],
    ['LeftStickY',  'LeftStickY'   ],
    ['LeftZ',       'LeftTrigger'  ],
    ['RightStickX', 'RightStickX'  ],
    ['RightStickY', 'RightStickY'  ],
    ['RightZ',      'RightTrigger' ],
    ['DPadX',       'DPadX'        ],
    ['DPadY',       'DPadY'        ],
]
axis_value_map = [
    # Axis (user axis)  value
    ['LeftStickX',      -1.0 ],
    ['RightStickX',     -1.0 ],
    ['LeftStickY',      -1.0 ],
    ['RightStickY',     -1.0 ],
]
button_map = [
    # GilrsButton     Button(user button)
    ['East',          'South'         ],
    ['C',             'East'          ],
    ['North',         'North'         ],
    ['South',         'West'          ],
    ['West',          'LeftTrigger'   ],
    ['LeftTrigger',   'LeftTrigger2'  ],
    ['Z',             'RightTrigger'  ],
    ['RightTrigger',  'RightTrigger2' ],
    ['LeftTrigger2',  'Select'        ],
    ['RightTrigger2', 'Start'         ],
    ['Mode',          'Mode'          ],
    ['Select',        'LeftThumb'     ],
    ['Start',         'RightThumb'    ],
    ['DPadUp',        'DPadUp'        ],
    ['DPadDown',      'DPadDown'      ],
    ['DPadLeft',      'DPadLeft'      ],
    ['DPadRight',     'DPadRight'     ],
]

initial_mode

initial_mode では初期のモードを指定できます。

Example

initial_mode = "base"

plugins

Teleop Plugin Config

robot_config_path

robot_config_path では、configファイルへの相対パスを指定します。

Example

robot_config_path = "sample_robot_client_config_for_urdf_viz.toml"

Environmental Variables

環境変数をexport OPENRR_APPS_ROBOT_CONFIG_PATH=some_path_to_config.tomlと設定すると、--config-pathの後のファイルの パスの指定をスキップすることができます。明示的に--config-pathを指定すれば環境変数は無視されます。

openrr_apps_robot_command

• Run sample commands with env var

export OPENRR_APPS_ROBOT_CONFIG_PATH=$(pwd)/openrr-apps/config/sample_robot_client_config_for_urdf_viz.toml

openrr_apps_robot_command load_commands ./openrr-apps/command/sample_cmd_urdf_viz.txt

openrr_apps_joint_position_sender

• Run for sample urdf with env var

export OPENRR_APPS_ROBOT_CONFIG_PATH=$(pwd)/openrr-apps/config/sample_robot_client_config_for_urdf_viz.toml

openrr_apps_joint_position_sender

Note

他の設定にしたい場合にOPENRR_APPS_ROBOT_CONFIG_PATHを設定し直すことを忘れないでください。

Overwrite configuration at startup

--configのオプションを追加することで、起動時にconfigファイルの上書きをすることができます。

例えば、以下のようにしてurdfへのパスを更新します。

openrr_apps_robot_command \
  --config-path ./openrr-apps/config/sample_robot_client_config_for_urdf_viz.toml \
  --config 'openrr_clients_config.urdf_path="path/to/urdf"' \
  load_commands ./openrr-apps/command/sample_cmd_urdf_viz.txt

openrr_apps_robot_teleopでは2つのオプションがあります。--robot-configでは、client config fileを上書きします。--teleop-configではteleop configを上書きします。

例として、openrr_apps_robot_teleopをarci-gamepad-keyboardを追加して実行します。

openrr_apps_robot_teleop \
  --config-path ./openrr-apps/config/sample_teleop_config_urdf_viz.toml \
  --teleop-config 'gamepad="Keyboard"'

joint_position_limiterを無効にしてみます。

openrr_apps_robot_teleop \
  --config-path ./openrr-apps/config/sample_teleop_config_urdf_viz.toml \
  --robot-config 'urdf_viz_clients_configs[0].wrap_with_joint_position_limiter=false'

複数の設定を上書きしたい場合は、以下のようにセミコロンか改行によって分離する必要があります。

# semicolon-separated
openrr_apps_robot_teleop \
  --config-path ./openrr-apps/config/sample_teleop_config_urdf_viz.toml \
  --robot-config 'urdf_viz_clients_configs[0].wrap_with_joint_position_limiter=false;openrr_clients_config.urdf_path="path/to/urdf"'
# newline-separated
{
  echo 'urdf_viz_clients_configs[0].wrap_with_joint_position_limiter=false'
  echo 'openrr_clients_config.urdf_path="path/to/urdf"'
} > overwrite.txt
openrr_apps_robot_teleop \
  --config-path ./openrr-apps/config/sample_teleop_config_urdf_viz.toml \
  --robot-config "$(cat ./overwrite.txt)"

Develop OpenRR

1. For Developer

For Developer

coming soon...

• OpenRRを用いたアプリケーションをどのように開発するか。
• マイコンや他ソフトウェアとのインターフェースをどのように実装するか。

Troubleshooting

基本的にはエラーログなどに従ってほしいですが、よくある例を以下にあげておきます。

Featuring ROS2

cargo build --release --features ros2
cargo install --path ./openrr-apps

ROS2featureしてビルドしたか確認してみてください。

GUI Troubleshooting

GUIまわりの場合は、GitHub上のREADMEを参考にしてください。

それでもだめな場合

もしかするとOpenRRのバグかもしれないので、GitHubにあるリポジトリのIssuesにその問題を投稿してくださると助かります。