MoveIt 프로젝트에 대한 문서입니다.
이 repository는 현재 Github Actions에 의해 자동으로 빌드됩니다:
- Rolling (main):
- Humble:
여러분이 참여하여 MoveIt의 문서를 개선하는 것을 권장합니다. 이 튜토리얼을 개선하는 데 도움을 주시기 바랍니다. ROS 1의 이전 튜토리얼을 포팅하고 새로운 튜토리얼을 작성하는 방식으로 이 튜터리얼을 개선하는데 도움을 주세요. 아래의 품질 기준을 읽어보시고 MoveIt 튜터리얼 작성하기 페이지를 참조하십시오.
이 튜터리얼에서 이슈를 발견했는데 여러분이 수정하기 어렵다면 GitHub에 이슈를 오픈 혹은 PR을 제안해 주세요.
각 튜터리얼을 ROS 2로 포팅하면서 이슈가 발생합니다. 각 튜터리얼의 맨 위에 ":moveit1:" 태그가 있는데 이 태그는 튜터리얼이 성공적으로 업데이트한 후에 삭제됩니다.
아래에 포팅하는데 도움이 되는 링크가 있습니다.
MoveIt 2 소스 빌드 지침을 따라 moveit2의 소스 코드로 colcon 워크스페이스를 설정하세요.
moveit2 colcon 워크스페이스에서 command line을 열어주세요:
cd $COLCON_WS/src
MoveIt 튜터리얼 소스 코드를 다운로드하세요:
git clone https://github.com/ros-planning/moveit2_tutorials.git
vcs import < moveit2_tutorials/moveit2_tutorials.repos
rosdep install -r --from-paths . --ignore-src --rosdistro humble -y
workspace를 설정하고 빌드하세요:
cd $COLCON_WS
colcon build --event-handlers desktop_notification- status- --cmake-args -DCMAKE_BUILD_TYPE=Release
여러분의 장치에서 로컬로 html 페이지를 생성해서 튜터리얼을 테스트하고자 한다면, build_locally 스크립트를 사용하여 moveit2_tutorials 패키지의 root에서 다음 명령어를 실행하세요:
export ROS_DISTRO=humble # 22.04
cd $COLCON_WS/src/moveit2_tutorials
source /opt/ros/$ROS_DISTRO/setup.bash
./build_locally.sh
로컬 웹사이트 <LOCAL_PACKAGE_PATH>/build/html/index.html가 자동으로 웹 브라우저에서 열릴 것입니다.
- noinstall 의존 설치 단계를 건너뛰어 스크립트 속도를 높입니다.
- loop: 변경 사항이 감지되면 자동으로 HTML을 재빌드합니다.
이 튜토리얼은 Sphinx "Python 문서 생성기"에서 일반적으로 사용되는 reStructuredText 형식을 사용합니다. 불행히도 이 형식은 일반적인 Markdown 형식과 다르지만, 소스 파일에 있는 코드를 직접 포함하여 인라인 코드 튜토리얼을 지원한다는 장점이 있습니다.
Code Formatting
- 이 튜토리얼은 MoveIt 프로젝트와 동일한 스타일 가이드: style guidelines 사용합니다. 이 튜토리얼을 수정하거나 추가할 때는 코드를 clang format 사용하여 자동 포맷팅해야 합니다. 스타일 가이드를 확인하고 적용하기 위해 pre-commit을 사용합니다.
- 튜토리얼은 최고의 코딩 실습을 예제로 제시합니다. 만약 MoveIt 프로젝트에서 리뷰를 통과하지 못하는 컨트리뷰션이라면, 튜토리얼에서도 리뷰를 통과하지 못해야 합니다.
- 관련 코드는
.. tutorial-formatter::태그를 사용하여 포함 및 설명해야 합니다. - 관련 없는 코드는
BEGIN_TUTORIAL,END_TUTORIAL,BEGIN_SUB_TUTORIAL,END_SUB_TUTORIAL태그를 사용하여, 생성한 HTML에서 제외됩니다. - 가능한 경우,
conf.py에 정의된extlinks사전을 사용하여 링크를 만들어야 합니다. - 모든 데모 코드는
moveit2_tutorials패키지 내에서 실행 가능해야 합니다. - Python 코드는 ros2 run을 사용하여 실행해야 합니다.
Style
- 각 튜토리얼은 MoveIt 내의 한 가지 기능 또는 인터페이스 사용법을 가르치는 데 중점을 두어야 합니다.
- 튜토리얼은 설명보다 시연부터 시작하여 처음에는 비디오 및 데모를 보여주고 이어서 설명을 하는 방식으로 진행되어야 합니다.
- 가능한 경우 새로운 튜토리얼은 기존 튜토리얼의 형식, 스타일 및 흐름과 일치해야 합니다.
pre-commit
pre-commit은 moveit2_tutorials에서 스타일 가이드를 자동으로 확인 및 적용하는 도구입니다. 시스템에 pre-commit을 설치하려면 다음과 같이 하십시오.:
pip3 install pre-commit
그런 다음 moveit2_tutorials 디렉토리 아래에서 다음과 같이 git hooks를 설치합니다.:
cd $COLCON_WS/src/moveit2_tutorials && pre-commit install
이 pre-commit을 사용하면 git commit을 실행할 때마다 clang-format, 파일 끝, 여분 공백 등 스타일 목록을 자동으로 실행 및 확인합니다. git commit 이외의 다른 시간에 git commit을 실행하려면:
cd $COLCON_WS/src/moveit2_tutorials && pre-commit run -a
reStructuredText에 이미지를 포함하는 표준 방법은
.. image:: filename.png
:width: 700px
여기서 .rst 파일과 같은 폴더에 filename.png 이미지가 있다고 가정합니다. 이 방식으로 링크된 이미지는 자동으로 빌드 과정에서 적절한 폴더로 복사됩니다.
애니메이션 GIF는 사용하지 마십시오. 이 파일 형식은 파일 크기가 매우 커집니다. webm과 같은 비디오 형식을 사용하고 아래의 로컬 비디오 섹션을 참조하십시오.
"Pick and Place 튜토리얼"의 이 예와 같이 raw HTML을 사용하여 비디오를 포함할 수 있습니다.
.. raw:: html
<div style="position: relative; padding-bottom: 5%; height: 0; overflow: hidden; max-width: 100%; height: auto;">
<iframe width="700px" height="400px" src="https://www.youtube.com/embed/QBJPxx_63Bs?rel=0" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
</div>
이렇게 하면 Youtube's suggested embed HTML가 포함됩니다.
이 저장소에 포함된 비디오를 포함하기 위해서 RViz 튜토리얼의 예제와 같이 raw HTML을 사용합니다.
.. raw:: html
<video width="700px" controls="true" autoplay="true" loop="true">
<source src="https://github.com/_static/videos/rviz_joints_nullspace.webm" type="video/webm">
The joints move while the end effector stays still
</video>
같은 폴더가 아닌 _static/videos 폴더에 비디오 파일이 있음에 유의하십시오.
External Documentation on <video> tag
이 저장소에 있는 모든 내용은 오픈소스이며, BSD License v3 따라 배포됩니다. 각 소스 코드 파일에는 라이센스 사본이 포함되어야 합니다.