Skip to content
Snippets Groups Projects
README.md 2.23 KiB
Newer Older
Simon Wittl's avatar
Simon Wittl committed
# RoboQuality Project
Simon Wittl's avatar
Simon Wittl committed

Simon Wittl's avatar
Simon Wittl committed
Main repo for the RoboQuality project. Every workpackages is organized in an own repository and added as submodules to this main repository. 
Simon Wittl's avatar
Simon Wittl committed

## Installation

Simon Wittl's avatar
Simon Wittl committed
1. Clone repo. Check if all submodules are downloaded to the `pkg` folder recursivly. 
2. Install ROS2 Humble (LTS version):   
https://docs.ros.org/en/rolling/Releases/Release-Humble-Hawksbill.html 
3. Sources ROS2
Simon Wittl's avatar
Simon Wittl committed
4. Install ros2-numpy  
https://github.com/nitesh-subedi/ros2_numpy -> modify `setup.py` for python 3.8 if used on win
5. Build the modules. Use the following command from the main folder of this repo:   
Simon Wittl's avatar
Simon Wittl committed
```colcon build . ```
Simon Wittl's avatar
Simon Wittl committed
6. Launch all or single modules.
Simon Wittl's avatar
Simon Wittl committed

Simon Wittl's avatar
Simon Wittl committed
### Folder Structure (after building)


```
.  
├── build                    # Builded packages ...
│   ├── ...  
├── install                  # Local workspace ...
│   ├── local_setup.bash  
│   ├── ...  
├── log                      # Build and node logs ...
│   ├── ...  
├── pkg                      # Submodules
│   ├── rq_controller  
│   ├── rq_ddetection  
│   ├── rq_hardware  
│   ├── rq_interfaces  
│   └── rq_trajectory  
└── README.md  

```

Simon Wittl's avatar
Simon Wittl committed
## Packages Overview

| Submodule          | Describtion                                   |  Link                                                                      |
|--------------------|-----------------------------------------------|----------------------------------------------------------------------------|
| `Controller`       |  Workflow controller. Holds all information.  | [rq_controller](https://mygit.th-deg.de/roboct/robo_quality/rq_controller) |
| `Defect Detection` |  Defect detection module                      | [rq_ddetection](https://mygit.th-deg.de/roboct/robo_quality/rq_ddetection) |
| `Hardware`         |  Interface to real / simulated system         | [rq_hardware](https://mygit.th-deg.de/roboct/robo_quality/rq_hardware)     |
| `Trajectory`       |  CT-Trajectory optimization                   | [rq_trajectory](https://mygit.th-deg.de/roboct/robo_quality/rq_trajectory) |
| `Interfaces`       |  project intern interfaces for all msg / srv. | [rq_interfaces](https://mygit.th-deg.de/roboct/robo_quality/rq_interfaces) |