Skip to main content

URDF converter for Euslisp

Project description

urdfeus

PyPI Python Versions Build Status

URDF ⇄ EusLisp を相互変換するPythonライブラリ

eus2urdf gallery

eus2urdfで変換したjskeusの全モデル(ロボット・物体・シーン)をブラウザで閲覧・操作・ダウンロードできます → https://iory.github.io/urdfeus/

概要

urdfeusは、ロボット記述ファイル(URDF)をEusLispのロボットモデル定義に変換するツールです。ROS環境で使用されるURDFファイルを、EusLispプログラミング環境で利用できる形式に変換できます。

URDF to EusLisp conversion

インストール

pip install urdfeus

開発版をインストールする場合:

git clone https://github.com/iory/urdfeus.git
cd urdfeus
pip install -e .

使用方法

コマンドライン

# 基本的な変換
urdf2eus robot.urdf robot.l

# YAMLファイルと一緒に変換
urdf2eus robot.urdf robot.l --yaml-path robot.yaml

# カスタムロボット名を指定
urdf2eus robot.urdf robot.l --name my_robot

# メッシュ簡素化オプション付き
urdf2eus robot.urdf robot.l --voxel-size 0.01

Pythonスクリプト

from urdfeus.urdf2eus import urdf2eus

# URDFファイルをEusLispに変換
with open('robot.l', 'w') as f:
    urdf2eus('robot.urdf', fp=f)

# YAMLファイルと一緒に変換
with open('robot.l', 'w') as f:
    urdf2eus('robot.urdf', 'robot.yaml', fp=f)

# カスタムロボット名を指定
with open('robot.l', 'w') as f:
    urdf2eus('robot.urdf', robot_name='my_robot', fp=f)

EusLisp → URDF 変換 (eus2urdf)

eus2urdfは、EusLispのロボットモデルをURDF(ROSパッケージ形式)へ変換する逆方向のツールです。 モデルはirteusglで実体化してから抽出するため、:init内で手続き的に追加されるリンク・関節(脚や吸盤など)も取りこぼさず変換できます。メッシュはglverticesからtrimesh経由で書き出します(デフォルトは色を保持できる.glb)。変換結果はギャラリーで確認できます。

前提

  • irteusgl(jskeus)がインストールされていること
  • メッシュ書き出しにtrimesh / pycollada(依存に含まれます)

コマンドライン

# EusLispモデル -> ROSパッケージ一式 (package.xml + urdf/ + meshes/)
eus2urdf robot.l output_package_dir

# package:// で使うパッケージ名を指定
eus2urdf robot.l output_package_dir --package-name my_robot_description

# ロボット名・コンストラクタ・メッシュ形式を指定
eus2urdf robot.l out --name my_robot --constructor my-robot --mesh-format obj

生成物のレイアウト:

output_package_dir/
  package.xml
  CMakeLists.txt             # 最小のcatkin定義(catkin build/catkin_makeで通る)
  urdf/<robot>.urdf          # package://<pkg>/meshes/<link>.glb を参照
  meshes/<link>.glb

Pythonスクリプト

from urdfeus.eus2urdf import eus2urdf

urdf_path = eus2urdf('robot.l', 'output_package_dir',
                     package_name='my_robot_description')

オプション

  • --package-name: package://で参照するROSパッケージ名(既定は出力ディレクトリ名)
  • --name: <robot name>とURDFファイル名(既定はモデルが返すロボット名)
  • --constructor: EusLispのコンストラクタ関数名(既定はファイル名のstem)
  • --mesh-format: trimesh.exportが扱う拡張子(既定glb)。glb/ply/objは面ごとの色を保持。daeはtrimeshのColladaエクスポータが色をtextureに潰すため多色メッシュがグレーになる(単色メッシュは保持)。stlは色なし
  • --draco: glbメッシュをDraco圧縮(KHR_draco_mesh_compression)。頂点色を保ったまま密なメッシュを概ね1桁小さくする。glb固定でDracoPyが必要(pip install urdfeus[draco])。読み込み側のglTFローダにはDracoデコーダが要る
  • --irteusgl: 使用するirteusgl実行ファイル

ジオメトリの扱い

  • colladaボディはglverticesから、make-cube等で生成されたプレーンなbody(例::initで追加される可視化用の脚キューブや吸盤)は各faceを三角形分割してメッシュ化します。いずれもメッシュとして書き出されます。
  • プレーンbodyのface三角形分割は凸面を仮定します(プリミティブ形状では成立)。

生成されたEusLispファイルの使用

;; EusLisp環境での使用例
(load "robot.l")
(setq *robot* (robot))  ; URDFのロボット名または--nameで指定した名前
(send *robot* :angle-vector)

;; カスタム名を指定した場合
(load "robot.l")
(setq *robot* (my_robot))  ; --name my_robot で生成した場合
(send *robot* :angle-vector)

ロボット名の制約

--nameオプションで指定するロボット名は、EusLispの識別子として有効である必要があります:

  • 文字または_で始まる
  • 文字、数字、_-のみ使用可能
  • EusLispの予約語(if, defun, nilなど)は使用不可
  • 空文字列やスペースを含む名前は使用不可

有効な例: my_robot, robot-v1, MyRobot, _robot, robot123 無効な例: 123robot, robot name, robot.name, if, defun

YAMLファイル

ロボットの関節グループ、エンドエフェクタ、初期ポーズを設定できます。

PR2ロボットの設定例

実際のPR2設定ファイルを参考にした例:

# 関節グループの定義
torso:
  - torso_lift_joint : torso-waist-z

larm:
  - l_shoulder_pan_joint   : larm-collar-y
  - l_shoulder_lift_joint  : larm-shoulder-p
  - l_upper_arm_roll_joint : larm-shoulder-r
  - l_elbow_flex_joint     : larm-elbow-p
  - l_forearm_roll_joint   : larm-elbow-r
  - l_wrist_flex_joint     : larm-wrist-p
  - l_wrist_roll_joint     : larm-wrist-r

rarm:
  - r_shoulder_pan_joint   : rarm-collar-y
  - r_shoulder_lift_joint  : rarm-shoulder-p
  - r_upper_arm_roll_joint : rarm-shoulder-r
  - r_elbow_flex_joint     : rarm-elbow-p
  - r_forearm_roll_joint   : rarm-elbow-r
  - r_wrist_flex_joint     : rarm-wrist-p
  - r_wrist_roll_joint     : rarm-wrist-r

head:
  - head_pan_joint  : head-neck-y
  - head_tilt_joint : head-neck-p

# エンドエフェクタ座標系
larm-end-coords: 
  parent : l_gripper_tool_frame
  rotate : [0, 1, 0, 0]

rarm-end-coords:
  parent : r_gripper_tool_frame
  rotate : [0, 1, 0, 0]

head-end-coords:
  translate : [0.08, 0, 0.13]
  rotate    : [0, 1, 0, 90]

# 事前定義ポーズ
angle-vector:
  reset-manip-pose : [300.0, 75.0, 50.0, 110.0, -110.0, -20.0, -10.0, -10.0, -75.0, 50.0, -110.0, -110.0, 20.0, -10.0, -10.0, 0.0, 50.0]
  reset-pose : [50.0, 60.0, 74.0, 70.0, -120.0, 20.0, -30.0, 180.0, -60.0, 74.0, -70.0, -120.0, -20.0, -30.0, 180.0, 0.0, 0.0]

グループ定義の効果

YAMLファイルでグループを定義すると、EusLispで以下のようなメソッドが使用できるようになります:

;; PR2ロボットの例
(setq *robot* (pr2))

;; 右腕の現在の関節角度を取得
(send *robot* :rarm :angle-vector)
;; => #f(-60.0 74.0 -70.0 -120.0 -20.0 -30.0 180.0)

;; 右腕の関節リストを取得
(send *robot* :rarm :joint-list)
;; => (#<rotational-joint r_shoulder_pan_joint> 
;;     #<rotational-joint r_shoulder_lift_joint> ...)

;; 関節名を取得
(send-all (send *robot* :rarm :joint-list) :name)
;; => ("r_shoulder_pan_joint" "r_shoulder_lift_joint" 
;;     "r_upper_arm_roll_joint" "r_elbow_flex_joint" ...)

;; 右腕の関節角度を設定
(send *robot* :rarm :angle-vector #f(0 0 0 -90 0 0 0))

;; 事前定義ポーズの使用
(send *robot* :reset-pose)

設定項目の詳細

関節グループ

  • グループ名: ロボットの部位名(rarm, larm, head など)
  • 関節名 : EusLisp関節名: URDFの関節名とEusLispでの関節名のマッピング

エンドエフェクタ座標系

  • parent: 座標系を取り付ける親リンク名
  • translate: [x, y, z] 平行移動(メートル単位)
  • rotate: [x, y, z, angle] 回転軸ベクトルと角度(度単位)

事前定義ポーズ

  • angle-vector: ポーズ名と対応する関節角度リスト
  • 関節角度は度単位で指定
  • 関節の順序はYAMLファイル内の関節グループの定義順序に従う

依存関係

  • Python 3.6+
  • scikit-robot
  • trimesh
  • numpy

ライセンス

MIT License

貢献

プルリクエストやイシューの報告を歓迎します。

関連プロジェクト

  • scikit-robot - Pythonロボットモデリングライブラリ
  • EusLisp - Lispベースのロボットプログラミング言語

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

urdfeus-1.1.11.tar.gz (44.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

urdfeus-1.1.11-py3-none-any.whl (44.3 kB view details)

Uploaded Python 3

File details

Details for the file urdfeus-1.1.11.tar.gz.

File metadata

  • Download URL: urdfeus-1.1.11.tar.gz
  • Upload date:
  • Size: 44.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for urdfeus-1.1.11.tar.gz
Algorithm Hash digest
SHA256 0596b6e3558a52542674908c68ab47c75f9c4cfdadafe41e1297f5ded2e4ed07
MD5 f9d66728e41bd322b565197eeb9ada23
BLAKE2b-256 c59e9734e15e369bf949833407729d9ebd4573543ca7418bc10cff7ebd4a706e

See more details on using hashes here.

File details

Details for the file urdfeus-1.1.11-py3-none-any.whl.

File metadata

  • Download URL: urdfeus-1.1.11-py3-none-any.whl
  • Upload date:
  • Size: 44.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for urdfeus-1.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 8cdd8e3cebf89b14714c66024c45f9b51ba53f6b737d86b32c5191862d4d9f4b
MD5 1f0cfd9f089988daaccc7028dac4bb39
BLAKE2b-256 078330817b6f4c52a6ae70d670c9900e0c921f88f5fd65834e2b8219a1b4f3a9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page