rtsprofile 모듈

• 개요
• 필요 조건
• 인스톨
• 사용법
• 테스트의 실행
• API naming conventions
• 보다 상세한 문서와 샘플
• 리포지터리
• Changelog
  • 2.0

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이상을 추천합니다.

인스톨

인스톨은 몇개의 방법이 이용 가능합니다.

• 리포지터리(참조：이하의리포지터리(repository)) 또는 소스 어카이브로부터 다운로드 후, 적당한 디렉토리에서 압축을 해제하고 인스톨 합니다：

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:Python26Libsite-packages\와 C:Python26Scripts\입니다(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에 참조해 주십시오.

가장 중요한 점은, Private한 내부 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"로 변경했습니다.
• 버그의 수정