Skip to content
Snippets Groups Projects
Commit cbd0ede9 authored by Malte Laurin Matthey's avatar Malte Laurin Matthey
Browse files

Prepare to split the plugin into a new repository, adjust README

parent 1a174b98
Branches
No related tags found
No related merge requests found
......@@ -186,7 +186,7 @@
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2022 AIFB_RobotGroup
Copyright 2025 AIFB_LearnEnvironmentGroup (Max Humbert, Florian Beyer, Malte Matthey)
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
......
# ROS Noetic Standard Container with Preinstalled Learn Environment Plugin
> **⚠️ WARNING:** This README is for setting up the container with all functionalities. For the Learn Environment Plugin, follow the instructions in this README first. Then, refer to [GETTING_STARTED.md](./catkin_ws/src/learn_environment/tasks/GETTING_STARTED.md) for starting the tutorial or [CONTRIBUTE.md](./catkin_ws/src/learn_environment/developer_docs/CONTRIBUTE.md) for contribution guidelines (creating new tasks & extending the plugin).
> **⚠️ WARNING:** This README is for setting up the container with all functionalities. For the Learn Environment Plugin, follow the instructions in this README first. Then, refer to [GETTING_STARTED.md](./catkin_ws/src/learn_environment/tasks/GETTING_STARTED.md) for starting the tutorial or [CONTRIBUTE.md](./catkin_ws/src/learn_environment/developer_docs/CONTRIBUTE.md) for contribution guidelines (creating new tasks & extending the plugin) in the [plugin's repository](TODO:ADD_LINK).
This repository provides a Visual Studio Code development container with ROS Noetic installed to control a Franka Panda Robot in both simulation and real environments. It also has the Learn Environment plugin for RViz preinstalled so you can start learning how to work with the robot immediatly.
This repository provides a Visual Studio Code development container with ROS Noetic installed to control a Franka Panda Robot in both simulation and real environments. It also has the Learn Environment plugin for RViz preinstalled and is optimised so you can start learning how to work with the robot immediatly.
## Features
......
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright 2025 AIFB_LearnEnvironmentGroup (Max Humbert, Florian Beyer, Malte Matthey)
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
# Learn Environment for Franka Panda Robot - RViz Plugin
The Learn Environment for the Franka Panda Robot is a tutorial on how to program the robot via its Python API. There are predefined tasks that the user has to complete. These tasks are provided as Jupyter Notebooks with code cells that the user needs to fill in. The plugin can start the tasks and automatically evaluate if they are solved correctly.
![Plugin with VS Code](./developer_docs/images/plugin_with_vs_code.png)
### Install the Plugin:
If you only want to use the plugin, the **easiest option** is to use a **devcontainer** or **Docker setup** from [this](TODO:ADD_LINK) repository.
Alternatively without Docker, you can implement this repository as a submodule in your catkin workspace or copy the entire plugin into your catkin workspace.
### Start the Tutorial:
Instructions on how to start the tutorial can be found here: [GETTING_STARTED.md](./tasks/GETTING_STARTED.md).
### Contribute:
Instructions and guidelines on how to contribute to this plugin (creating new tasks & extending the plugin) can be found here: [CONTRIBUTE.md](./developer_docs/CONTRIBUTE.md).
\ No newline at end of file
catkin_ws/src/learn_environment/developer_docs/images/plugin_with_vs_code.png

275 KiB

# Welcome to the Tutorial
To get started, follow these steps:
**Before you start:** We recommend reading the [theoretical introduction](theoretical_introduction.md) first.
**After that:** Follow these steps to start with the tasks:
1. **Open a Terminal in VS Code**
Go to `Terminal` > `New Terminal` in the VS Code menu. The shortcut is ``Ctrl + ` ``
......
# Introduction
### Goal of the tutorial
This tutorial introduces the Franka Emika Panda robot arm and provides a hands-on guide to understanding its systems. It focuses on learning how to control the robot using the Python API provided by its software. In the end, you'll gain theoretical and practical skills in working with robotic applications.
### Target group of the tutorial
This tutorial is designed for students and assistants working on projects involving the Panda robot arm, as well as anyone curious about robotic manipulation, regardless of prior experience.
### General structure of the tutorial
The tutorial progresses through various topics and difficulty levels, so you can start exactly where you want to. There is a Jupyter Notebook for each task you must complete. When you start your script, there is always an automatic evaluation at the end to see if and where you went wrong. In addition, we always provide a solution Jupyter Notebook if you get stuck on a task.
# Systems
There are several systems working together in our project. Here is a brief overview of what they are and what they do.
### ROS
ROS (Robot Operating System) is a set of software libraries and tools that can be used to create robot applications. Through this tutorial, you’ll explore the main features of ROS and its integration with the Panda robot arm.
### Rviz
Rviz (ROS Visualization) is a 3D visualization tool for ROS that is used for debugging and understanding robot data and states. It allows the display of sensor data, such as camera images, and the visualization of robot models and trajectories. In our case, Rviz will show us the robot arm and the trajectory of its movement. Rviz itself also offers its own plugins that can help when working with the robot. Our tutorial is also a Rviz plugin.
### MoveIt
MoveIt is an advanced robotics manipulation framework in ROS designed for motion planning, control and simulation of robotic arms. It provides tools for kinematics, collision detection, trajectory generation and task execution, making it indispensable for creating complex robotic applications. MoveIt will be an important part of the tutorial. Therefore, we will introduce you to MoveIt within the tasks.
### Gazebo
Gazebo is a simulation environment in which robot motions and systems can be tested virtually. In our case, the Franka Emika Panda robot arm will be simulated within Gazebo. Since not everyone always has the Panda robot arm available, we have created our tutorial for the Gazebo simulator. Nevertheless, you can of course also follow the tutorial with the real robot.
### Docker
Docker is a containerization platform that allows you to package the tutorial’s applications and dependencies into lightweight, portable containers. It enables cross-platform accessibility, although certain features may require Linux.
# Getting Started
If you have built and run the Docker environment correctly, you should end up in a folder with a [GETTING_STARTED.md](GETTING_STARTED.md) file. This file describes exactly how to start the tutorial from there. There is also a FAQ below with the most frequently asked questions about the project. In case you want to further develop the tutorial yourself, for example by adding new tasks, we have a `developer_docs` folder where you can find all the important information.
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment