rtsprofile

rtsprofile is a Python library providing an interface to the RT System Profile specification.

Introduction

rtsprofile is a Python library providing an interface to the RT System Profile specification. This specification describes a complete RT system and can be used to reconstruct that system at a later time. The library supports both XML- and YAML-formatted files.


This software is developed at the National Institute of Advanced Industrial Science and Technology. Approval number . The development was financially supported by the New Energy and Industrial Technology Development Organisation Project for Strategic Development of Advanced Robotics Elemental Technologies. This software is licensed under the Eclipse Public License -v 1.0 (EPL). See http://www.opensource.org/licenses/eclipse-1.0.txt.

Requirements

rtsprofile uses the new string formatting operations that were introduced in Python 2.6. It will not function with an earlier version of Python. It has not been tested with Python 3 and it is likely that several changes will be necessary to make it function using this version of Python.

For Ubuntu users, if you are using a version of Ubuntu prior to 9.04, you will need to install a suitable Python version by hand. You may want to consider upgrading to Ubuntu 9.04 or later (10.04 offers LTS).

Installation

There are several methods of installation available:

  • Download the source from either the repository (see Repository, below) or a source archive, extract it somewhere, and install it into your Python distribution:
    1. Extract the source, e.g. to a directory /home/blag/src/rtsprofile
       $ cd /home/blurgle/src/
       $ tar -xvzf rtsprofile-2.0.0-tar.gz
    2. Run setup.py to install rtsprofile to your default Python installation:
       $ python setup.py install
    3. If necessary, set environment variables. These should be set by default, but if not you will need to set them yourself. On Windows, you will need to ensure that your Python site-packages directory is in the PYTHONPATH variable and the Python scripts directory is in the PATH variable. Typically, these will be something like C:\Python26\Lib\site-packages\ and C:\Python26\Scripts\, respectively (assuming Python 2.6 installed in C:\Python26\).
  • Use the Windows installer. This will perform the same job as running setup.py (see #1), but saves opening a command prompt. You may still need to add paths to your environment variables (see step iii, above).

Using the library

The library has one main entry point: the RtsProfle class. Create an instance of this class, giving the constructor just one data source. The library will parse that source and give you a complete RT System Profile. You can then use the properties (they're Python properties, not class methods) to access information about the RT System. For further details, see the doxygen-generated documentation.

Running the tests

A pair of test specifications, one in each format, are included with the library. You can execute the test on these files as below:

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

Be aware that, depending on your Python paths, the tests may be executed against an installed copy of rtsprofile rather than the copy in the current working directory.

These tests are not yet complete coverage.

API naming conventions

rtsprofile follows the standard Python naming conventions as laid out in PEP8.


Most importantly, the private, internal API functions begin with an underscore (_). If a function begins with an underscore, it is not intended for use outside the class and doing so could lead to undefined behaviour. Only use those API functions that do not begin with an underscore and have a docstring in your programs.

Further documentation and examples

For further documentation, see the Doxygen-generated API documentation.


For examples of using the library, see the rtshell tools.

Repository

The latest source is stored in a Git repository at github. You can download it as a zip file or tarball by clicking the "Download Source" link in the top right of the page. Alternatively, use Git to clone the repository. This is better if you wish to contribute patches.

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

Changelog

2.0

  • Fixed parsing of Message Sending nodes.
  • PrecedingCondition timeout type is now integer.
  • Added YAML support.
  • Added tests.
  • Changed the default string for Preceding conditions to "SYNC".
  • Minor bug fixes

latest Releases

For Begginers

Windows msi(installer) package (only trying samples)

Development environment is required for RT-Component development. See download page for details.

Number of Projects

Join our slack

Enter email address for slack invite.

OpenHRP3

Dynamics simulator

OpenHRI

Human-Robot-Interaction RTCs

OpenRTP

Integrated Development Platform

OpenINVENT

Mobile Robot RTCs