LoginSignup
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

@esol-h-matsumotoinイーソル株式会社

実習ROS 2 xacroを使う1

Last updated at Posted at 2025-01-10

環境

本記事は以下の環境を想定して記述している。

項目 値
OS Ubuntu 22.04
ROS ROS 2 Humble

概要

このページでは、xacro(Xml mACRO)を使ったURDFの作成方法を説明する。xacroを利用することで、複雑なURDFを効率的に作成できる。なお、URDFの概要や基本的な記述方法などは以下のページで説明しているので参考にしてほしい。

このページは、ROS 2公式チュートリアルを参考に、ROS講座68 xacroを使う1の内容をROS 2対応させたものである。また、基本的にROS 1とROS 2でxacroの記述方法に違いはない。

xacroとは

xacroとは、URDFを効率的に作成できるマクロ言語である。
URDFの記法では全てのリンクやジョイントを個別に記述する。形状やサイズが共通のリンク、特性が同じジョイントなどが複数ある場合でも、それぞれを記述していく必要があった。
xacroが提供する機能を利用すると、繰り返しなどの処理をプログラマブルに記述し、効率的かつ分かりやすいURDFを作成できる。xacroが提供する機能には以下のものがある。

  • 定数
  • 数式・条件式
  • マクロ

これらのうち、本ページでは定数、数式・条件式を利用する方法を説明する。

前準備

前提条件

このチュートリアルは、実習ROS 2 Pub＆Sub通信を実行していることを前提に、Pub＆Sub通信のチュートリアルで作成したワークスペースros2_lecture_wsを利用する。
また、実習ROS 2 URDFを記述する1と実習ROS 2 URDFを記述する2の実施を前提とする。

まだxacroのインストールが出来ていない場合は下記を参考にインストールする。

sudo apt install ros-humble-xacro
source /opt/ros/humble/setup.bash

ROS 2パッケージの作成

パッケージxacro1およびxacroファイルを格納するディレクトリ/xacroを作成する。

cd ~/ros2_lecture_ws/src
ros2 pkg create xacro1 --build-type ament_cmake --dependencies urdf_launch
mkdir ./xacro1/xacro

xacroファイルの概要

xacroファイルの例として、定数を利用したxacroファイルconstants.xacroを示す。

<!-- 名前空間の指定 -->
<robot name="constants_robot" xmlns:xacro="http://ros.org/wiki/xacro">
  <!-- 定数の定義 -->
  <xacro:property name="side" value="0.5" />

  <link name="base_link">
    <visual>
      <origin rpy="0 0 0" xyz="0 0 0"/>
      <geometry>
        <!-- 定数の利用 -->
        <box size="${side} ${side} ${side}" />
      </geometry>
      <material name="red">
        <color rgba="1.0 0.0 0.0 1.0"/>
      </material>
    </visual>
  </link>

  <link name="body1_link">
    <visual>
      <origin rpy="0 0 0" xyz="1 1 1"/>
      <geometry>
        <!-- 定数の利用 -->
        <box size="${side} ${side} ${side}" />
      </geometry>
      <material name="red">
        <color rgba="1.0 0.0 0.0 1.0"/>
      </material>
    </visual>
  </link>
  
  <link name="body2_link">
    <visual>
      <origin rpy="0 0 0" xyz="2 2 2"/>
      <geometry>
        <!-- 定数の利用 -->
        <box size="${side} ${side} ${side}" />
      </geometry>
      <material name="red">
        <color rgba="1.0 0.0 0.0 1.0"/>
      </material>
    </visual>
  </link>
</robot>

constants.xacro

xacroファイルは作成したディレクトリ/xacro内に作成する。拡張子は.xacroである。URDFと同様にxmlのフォーマットで作成し、タグもURDFと同じものを使用する。これらのURDFの記述方法をベースに、定数や数式、マクロなどを使用した処理を追加する。
また、xacroファイルでは<robot>タグの属性で名前空間を指定する。これにより有効なxacroファイルとして解釈される。

<robot name=*ロボット名* xmlns:xacro="http://ros.org/wiki/xacro">

URDFへの変換

xacroからURDFへ変換する方法を説明する。
変換前に先ほど示したconstants.xacroを準備しておく。

cd ~/ros2_lecture_ws/src/xacro1/xacro
touch constants.xacro
<!-- vim等を使用しconstants.xacroを記述する -->

以下のコマンドを実行すると、作成したxacroファイルをURDFファイルに変換できる。

xacro ~/ros2_lecture_ws/src/xacro1/xacro/constants.xacro > ~/ros2_lecture_ws/src/xacro1/xacro/constants.urdf

定数

定数の使い方

  1. 定数の定義
    定数は以下のフォーマットで定義する。valueには数字のほか、文字列や論理値（true/false）といった変数型を使用できる。

    <xacro:property name="定数名" value="値">

  2. 定数の利用
    定義した定数は以下のように書くと利用できる。

    ${定数名}

定数を利用した例

前述の定数を利用したxacroファイルconstants.xacroを再掲し、定数を利用した部分について説明する。このxacroファイルでは、一辺が0.5mの大きさの立方体を3個作成している。

<!-- 名前空間の指定 -->
<robot name="constants_robot" xmlns:xacro="http://ros.org/wiki/xacro">
  <!-- 定数の定義 -->
  <xacro:property name="side" value="0.5" />

  <link name="base_link">
    <visual>
      <origin rpy="0 0 0" xyz="0 0 0"/>
      <geometry>
        <!-- 定数の利用 -->
        <box size="${side} ${side} ${side}" />
      </geometry>
      <material name="red">
        <color rgba="1.0 0.0 0.0 1.0"/>
      </material>
    </visual>
  </link>

  <link name="body1_link">
    <visual>
      <origin rpy="0 0 0" xyz="1 1 1"/>
      <geometry>
        <!-- 定数の利用 -->
        <box size="${side} ${side} ${side}" />
      </geometry>
      <material name="red">
        <color rgba="1.0 0.0 0.0 1.0"/>
      </material>
    </visual>
  </link>
  
  <link name="body2_link">
    <visual>
      <origin rpy="0 0 0" xyz="2 2 2"/>
      <geometry>
        <!-- 定数の利用 -->
        <box size="${side} ${side} ${side}" />
      </geometry>
      <material name="red">
        <color rgba="1.0 0.0 0.0 1.0"/>
      </material>
    </visual>
  </link>
</robot>

  1. 定数の定義
    以下の通り記述して、値が0.5の定数sideを定義している。

    <!-- 定数の定義 -->
<xacro:property name="side" value="0.5" />

  2. 定数の利用
    以下の通り記述して、定義した定数sideを使用している。

    <!-- 定数の利用 -->
<box size="${side} ${side} ${side}" />

URDFへの変換結果

前述の手順に則りURDFへの変換を行う。定義した定数が展開されてURDFに変換されていると分かる。

<geometry>
    <box size="0.5 0.5 0.5"/>
</geometry>

RVizで表示

URDFの可視化は、実習ROS 2 URDFを記述する1のパッケージのビルドとRVizでURDFの可視化と同様の手順で行う。上記リンク先の手順を、パッケージ名を"xacro1"に読み替えて実行する。

なお、実習ROS 2 URDFを記述する1では、<パッケージ名>/urdf/にURDFを格納した。一方今回は、<パッケージ名>/xacro/にxacroを格納するため、CMakeLists.txtに追記する内容は以下の通りとする。

# install xacro files
install(
  DIRECTORY
  xacro
  DESTINATION share/${PROJECT_NAME}/
)

CMakeLists.txtに追記した後は、launch実行前にビルド及びsourceコマンドを実行する。

cd ~/ros2_lecture_ws
colcon build
source install/setup.bash

launch時のコマンドは以下となる。コマンドの引数で変換後のURDFファイルを指定する。

ros2 launch urdf_launch display.launch.py urdf_package:=xacro1 urdf_package_path:=xacro/constants.urdf

RViz上には以下のような立方体が表示される。

constants.xacroの表示結果

なお、今回使用しているlaunchファイルdisplay.launch.pyは、以下のコマンドのようにxacroファイルを直接パラメータとして与えることもできる。

ros2 launch urdf_launch display.launch.py urdf_package:=xacro1 urdf_package_path:=xacro/constants.xacro

このように直接xacroファイルを表示するとxacroの作成ミスなどに気づきにくい。Rvizでの表示がうまくいかないときはURDFに変換して中身を確認したり、check_urdfでURDFのエラーを確認すると良い。

数式

数式の使い方

以下のように記述すると、中カッコ内の記述は数式として扱われる。
数式内では四則演算やxacroファイル内で定義した定数が利用できる。他にも三角関数のようなPythonのmathモジュールに含まれる数式などが利用できる。詳細はros/xacroリポジトリにあるwikiを確認するとよい。

${*数式*}

数式を利用した例

xacro1/xacro下に数式を利用したxacroファイルmath.xacroを作成する。このxacroファイルは、一辺が0.1mの大きさの立方体を3つ、半径0.5mの円周上に30°間隔で並べたものである。

<robot name="math_robot" xmlns:xacro="http://ros.org/wiki/xacro">
  <xacro:property name="side" value="0.1" />
  <!-- 定数radiusを定義 -->
  <xacro:property name="radius" value="0.5" />
  <material name="red">
    <color rgba="1.0 0.0 0.0 1.0"/>
  </material>

  <link name="base_link"/>

  <link name="body0_link">
    <visual>
      <geometry>
        <box size="${side} ${side} ${side}" />
      </geometry>
      <material name="red"/>
    </visual>
  </link>
  <joint name="body0_joint" type="fixed">
    <!-- 数式を利用して位置を指定 -->
    <origin rpy="0 0 0" xyz="${radius*cos(radians(0))} ${radius*sin(radians(0))} 0"/>
    <parent link="base_link"/>
    <child  link="body0_link"/>
  </joint>

  <link name="body1_link">
    <visual>
      <geometry>
        <box size="${side} ${side} ${side}" />
      </geometry>
      <material name="red"/>
    </visual>
  </link>
  <joint name="body1_joint" type="fixed">
    <!-- 数式を利用して位置を指定 -->
    <origin rpy="0 0 0" xyz="${radius*cos(radians(30))} ${radius*sin(radians(30))} 0"/>
    <parent link="base_link"/>
    <child  link="body1_link"/>
  </joint>

  <link name="body2_link">
    <visual>
      <geometry>
        <box size="${side} ${side} ${side}" />
      </geometry>
      <material name="red"/>
    </visual>
  </link>
  <joint name="body2_joint" type="fixed">
    <!-- 数式を利用して位置を指定 -->
    <origin rpy="0 0 0" xyz="${radius*cos(radians(60))} ${radius*sin(radians(60))} 0"/>
    <parent link="base_link"/>
    <child  link="body2_link"/>
  </joint>
</robot>

math.xacro

数式は以下の3か所で使用している。

  • body0_joint

    <joint name="body0_joint" type="fixed">
  <!-- 数式を利用して位置を指定 -->
  <origin rpy="0 0 0" xyz="${radius*cos(radians(0))} ${radius*sin(radians(0))} 0"/>
  <parent link="base_link"/>
  <child  link="body0_link"/>
</joint>

  • body1_joint

    <joint name="body1_joint" type="fixed">
  <!-- 数式を利用して位置を指定 -->
  <origin rpy="0 0 0" xyz="${radius*cos(radians(30))} ${radius*sin(radians(30))} 0"/>
  <parent link="base_link"/>
  <child  link="body1_link"/>
</joint>

  • body2_joint

    <joint name="body2_joint" type="fixed">
  <!-- 数式を利用して位置を指定 -->
  <origin rpy="0 0 0" xyz="${radius*cos(radians(60))} ${radius*sin(radians(60))} 0"/>
  <parent link="base_link"/>
  <child  link="body2_link"/>
</joint>

定義した定数radiusと三角関数からなる数式で、base_linkに対するリンクの中心座標位置を指定している。
Pythonのmathモジュールの関数sin()とcos()がラジアンを引数に取るため、角度はラジアンに変換して与えている。ラジアンへの変換はmathモジュールの関数radians()を使用している。

RVizでの表示

作成したmath.xacroをRViz上に表示すると以下のように表示される。再度ビルド、sourceコマンドを実行し、先ほどと同様にlaunchを実行する。立方体が3つ、円周上に並んでいることが分かる。

math.xacroの表示結果

条件式

条件式の使い方

条件式は以下の形式で記述する。URDFに展開される範囲を条件式で切り替えることができる。

<xacro:if value="${条件式}">
    *条件式が真のときURDFに展開される*
</xacro:if>

条件式を使用した例

条件式を利用したxacroファイルcondition.xacroを作成する。このxacroファイルは、定数colorの値によってリンクに設定する色を変化させている。

<robot name="condition_robot" xmlns:xacro="http://ros.org/wiki/xacro">
  <xacro:property name="color" value="blue" />

  <material name="red">
    <color rgba="1.0 0.0 0.0 1.0"/>
  </material>
  <material name="blue">
    <color rgba="0.0 0.0 1.0 1.0"/>
  </material>

  <link name="base_link">
    <visual>
      <geometry>
        <box size="0.1 0.1 0.1" />
      </geometry>
      <!-- 条件式を利用してリンクに色を設定 -->
      <xacro:if value="${color=='red'}">
        <material name="red"/>
      </xacro:if>
      <xacro:if value="${color=='blue'}">
        <material name="blue"/>
      </xacro:if>
    </visual>
  </link>
</robot>

condition.xacro

以下の箇所で条件式が使われている。

<!-- 条件式を利用してリンクに色を設定 -->
<xacro:if value="${color=='red'}">
  <material name="red"/>
</xacro:if>
<xacro:if value="${color=='blue'}">
  <material name="blue"/>
</xacro:if>

condition.xacroの冒頭で定義した定数colorの値に応じて、<material>タグとして展開される値が変化する。

RVizで表示

作成したcondition.xacroをRViz上に表示すると以下のように表示される。再度ビルド、sourceコマンドを実行し、先ほどと同様にlaunchを実行する。colorの値にはblueを設定しているので、立方体が青で表示されている。

condition.xacroの表示結果

参考

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
Sign upLogin
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?