rtsprofileモジュール

rtsprofileはPythonでRTSProfile仕様を利用するためのライブラリです。

概要

rtsprofileはRTシステムプロファイル(RTSProfile)の仕様のインタフェースライブラリです。この仕様は完全なRTシステムを記述し、システムを復元することや管理することができます。XMLもYAMLを利用可能です。

このソフトウエアはNEDO (独立行政法人 新エネルギー・産業技術総合開発機構) の次世代ロボット知能化技術開発プロジェクトの支援により、独立行政法人産業技術総合研究所によって開発されています。

必要条件

  • Python 2.5以下では存在しない機能を使うので、Python 2.6 以上が必要となります。
  • Ubuntu 9.04を使っていたら、手動でPython 2.6をインストールすることが必要となります。Ubuntu 9.04以上をおすすめします。

インストール

インストールはいくつかの方法が利用可能です。

  • リポジトリ(参照:以下のリポジトリ)またはソースアーカイブからダウンロード後、適当なディレクトリで解凍し、インストールする:
    1. ソースを展開する。
       $ cd /home/blurgle/src/
       $ tar -xvzf rtsprofile-2.0.0-tar.gz
    2. setup.pyを実行する。
       $ python setup.py install
    3. 必要に応じて、環境変数を設定します。これはデフォルトで設定されていますが、設定されていない場合は自分で設定する必要があります。Windows上では、Python の site-packages ディレクトリが PYTHONPATH 環境変数に、Pythonスクリプトのディレクトリが PATH 環境変数に設定されていることを確認してください。通常、これらは C:\Python26\Lib\site-packages\C:\Python26\Scripts\ です(PythonがC:\Python26\にインストールされた場合)。
  • Windows ではインストーラの使用を推奨します。setup.py を利用すれば結果より容易に設定することができます。ただし、環境によってはさらに環境変数の設定が必要な場合があります。

使い方

ライブラリはRtsProfleのクラスを提供します。このクラスのインスタンスを作った後、RTSProfileのファイルを渡すことで完全なRTシステムプロファイルが作られます。もしくは、手動で既存のRTシステムのRTシステムプロファイルを作成し、ファイル名を渡し、そのファイルにRTSProfileを保存します。

クラスの情報はPythonのpropertyでアクセスします。メソッドではありません。

APIの詳細はDoxygenで構成されたドキュメンテーションを参照してください。

テストの実行

ソースにサンプルファイルとテストのスクリプトが含めています。以下のようなコマンドで実行が可能です。

 $ python test/test.py ./test/rtsystem.xml
 $ python test/test.py ./test/rtsystem.yaml

PYTHONPATHの値によって、テストはインストールされたrtsprofileを使う可能性はあります。

API naming conventions

rtsprofileはPythonの標準スタイルに従います。PEP8に参照してください。

最も重要な点は、プライベートな内部API関数はアンダースコア(「_」)で始まることです。アンダースコアで始まる関数はクラス外から証すべきではありません。もし使用した場合には、未定義の振る舞いを引き起こす可能性があります。アンダースコアで始まらず、docstringがある関数だけを使ってください。

より詳細なドキュメンテーションとサンプル

より詳細なドキュメンテーションはDoxygenで記述されたドキュメンテーションを参照してください。

サンプルはrtsshellのソースに参照してください。

リポジトリ

最新版のソースはgithubでGitのリポジトリにあります。「Download source」をクリックしてダウンロードをすることができます。「git clone」を使うこともできます。パッチを送りたがったら、この方法がおすすめします。

 $ git clone git://github.com/gbiggs/rtsprofile.git

Changelog

2.0

  • Message Sendingの情報の解析を修正しました。
  • PrecedingConditionのタイムアウトのデータ型を整数にしました。
  • YAMLフォーマットを使えるようにしました。
  • テストを追加しました。
  • Preceding Conditionsのデフォルトを"SYNC"に変更しました。
  • バグフィクス

最新バージョン

初めての方へ

Windows msi(インストーラ) パッケージ (サンプルの実行ができます。)

C++,Python,Java,
Toolsを含む
1.1.2-RELEASE

RTコンポーネントを開発するためには開発環境のインストールが必要です。詳細はダウンロードページ

統計

Webサイト統計
ユーザ数:1620
プロジェクト統計
RTコンポーネント286
RTミドルウエア21
ツール20
文書・仕様書1

Join our slack

Enter email address for slack invite.

旧Webサイト

OpenRTM.org旧Webサイト

OpenHRP3

動力学シミュレータ

Choreonoid

モーションエディタ/シミュレータ

OpenHRI

対話制御コンポーネント群

OpenRTP

統合開発プラットフォーム

産総研RTC集

産総研が提供するRTC集

TORK

東京オープンソースロボティクス協会

DAQ-Middleware

ネットワーク分散環境でデータ収集用ソフトウェアを容易に構築するためのソフトウェア・フレームワーク

VirCA

遠隔空間同士を接続し、実験を行うことが可能な仮想空間プラットホーム