```

RTCTree =======

Introduction

RTCTree is a Python library providing an easy-to-use API for interacting with running RT Components and RTM-based systems running on OpenRTM-aist-1. It allows developers to manage these systems from other programs without needing to learn the CORBA API. Components can be started, stopped, connected together, have their configuration changed, and so on.

This software is developed at the National Institute of Advanced Industrial Science and Technology. Approval number H23PRO-1229. 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 GNU Lesser General Public License version 3 (LGPL3). See LICENSE.txt.

Requirements

RTCTree requires omniorb-py, including omniidl with the Python backend. If you have installed OpenRTM-python, you will have these installed already. If not, you will need to install them manually.

RTCTree requires Python 2.7. 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.

Sphinx must be installed to build the documentation.

Installation

There are several methods of installation available:

1. (Preferred method) Use pip to install the PyPi package.

a. Install pip if it is not already installed. See https://pip.pypa.io/en/latest/installing/

b. Execute the following command to install RTCTree::

$ pip install rtctree

1. Download the source from either the repository (see “Repository,” below) or a source archive, extract it somewhere, and install it into your Python distribution:

a. Extract the source, e.g. to a directory /home/blag/src/rtctree

b. Run setup.py to install RTCTree to your default Python installation::

$ python setup.py install

1. On Windows, use the Windows installer.

Environment variables

The following environment variables are used:

RTCTREE_ORB_ARGS A list of arguments, separated by semi-colons, to pass to the ORB when creating it. Optional.

RTCTREE_NAMESERVERS A list of name server addresses, separated by semi-colons, to parse when creating the RTCTree. Each server in the list will be added to the tree. Optional.

The only variable that should normally be set by the user is RTCTREE_NAMESERVERS. Set this to a list of name server addresses, separated by semi-colons, that you want rtcshell to interact with. For example, in a Bash shell, you can run the following::

$ export RTCTREE_NAMESERVERS=localhost;192.168.0.1:65346;example.com

The RTC Tree

The core of the library is the RTC Tree::

import rtctree.tree tree = rtctree.tree.RTCTree()

This is a file system-like tree built by parsing name servers to find directories, components and managers. You can treat it exactly the same way as you treat a normal file system. The tree represents the naming contexts, managers and components registered all on known name servers

File truncated at 100 lines see the full file